Contains methods to build an instance of the LoyaltyManagement.IssueVoucherInput class.
Namespace
LoyaltyManagement
IssueVoucherInputBuilder Methods
The following are methods for IssueVoucherInputBuilder.
build()
Returns an instance of the LoyaltyManagement.IssueVoucherInput object.
Signature
public LoyaltyManagement.IssueVoucherInput build()
Return Value
Type: LoyaltyManagement.IssueVoucherInput
setAdditionalNotes(additionalNotes)
Represents extra information about the voucher.
Signature
public LoyaltyManagement.IssueVoucherInputBuilder setAdditionalNotes(String additionalNotes)
Parameters
additionalNotes
Type: String
Return Value
Type: LoyaltyManagement.IssueVoucherInputBuilder
setBenefitId(benefitId)
Represents the benefit associated with the voucher.
Signature
public LoyaltyManagement.IssueVoucherInputBuilder setBenefitId(String benefitId)
Parameters
benefitId
Type: String
Return Value
Type: LoyaltyManagement.IssueVoucherInputBuilder
setContactId(contactId)
Represents the contact associated with the loyalty program member.
Signature
public LoyaltyManagement.IssueVoucherInputBuilder setContactId(String contactId)
Parameters
contactId
Type: String
Return Value
Type: LoyaltyManagement.IssueVoucherInputBuilder
setDiscountPercent(discountPercent)
Represents the discount percentage provided by the voucher.
Signature
public LoyaltyManagement.IssueVoucherInputBuilder setDiscountPercent(Integer discountPercent)
Parameters
discountPercent
Type: Integer
The discount percentage provided by the voucher. Specify a value to override the discount percentage specified in the associated voucher definition. Specify this when the associated voucher definition is of the type Discount Percentage. This field is available in API version 53.0 and later.
Return Value
Type: LoyaltyManagement.IssueVoucherInputBuilder
setEffectiveDate(effectiveDate)
Represents the start date of the validity of the voucher.
Signature
public LoyaltyManagement.IssueVoucherInputBuilder setEffectiveDate(String effectiveDate)
Parameters
effectiveDate
Type: String
The supported date format is YYYY-MM-DD.
Return Value
Type: LoyaltyManagement.IssueVoucherInputBuilder
setExpiryDate(expiryDate)
Represents the expiry date of the voucher.
Signature
public LoyaltyManagement.IssueVoucherInputBuilder setExpiryDate(String expiryDate)
Parameters
expiryDate
Type: String
The supported date format is YYYY-MM-DD.
Return Value
Type: LoyaltyManagement.IssueVoucherInputBuilder
setFaceValue(faceValue)
Represents the amount of discount provided by the voucher.
Signature
public LoyaltyManagement.IssueVoucherInputBuilder setFaceValue(Double faceValue)
Parameters
faceValue
Type: Double
The amount of discount provided by the voucher. Specify a value to override the face value specified in the associated voucher definition. Specify this when the associated voucher definition is of the type Fixed Value. This field is available in API version 53.0 and later.
Return Value
Type: LoyaltyManagement.IssueVoucherInputBuilder
setJournalId(journalId)
Represents the transaction journal associated with the member voucher when the voucher results from accrual of points.
Signature
public LoyaltyManagement.IssueVoucherInputBuilder setJournalId(String journalId)
Parameters
journalId
Type: String
Return Value
Type: LoyaltyManagement.IssueVoucherInputBuilder
setLoyaltyProgramMemberId(loyaltyProgramMemberId)
Represents the ID of the loyalty program member to issue the voucher.
Signature
public LoyaltyManagement.IssueVoucherInputBuilder setLoyaltyProgramMemberId(String loyaltyProgramMemberId)
Parameters
loyaltyProgramMemberId
Type: String
Return Value
Type: LoyaltyManagement.IssueVoucherInputBuilder
setProgramName(programName)
Represents the name of the loyalty program associated with the voucher.
Signature
public LoyaltyManagement.IssueVoucherInputBuilder setProgramName(String programName)
Parameters
programName
Type: String
Return Value
Type: LoyaltyManagement.IssueVoucherInputBuilder
setPromotionId(promotionId)
Represents the promotion associated with the voucher.
Signature
public LoyaltyManagement.IssueVoucherInputBuilder setPromotionId(String promotionId)
Parameters
promotionId
Type: String
Return Value
Type: LoyaltyManagement.IssueVoucherInputBuilder
setVoucherCode(voucherCode)
Represents the voucher identifier generated by an external system. This is a required field.
Signature
public LoyaltyManagement.IssueVoucherInputBuilder setVoucherCode(String voucherCode)
Parameters
voucherCode
Type: String
Return Value
Type: LoyaltyManagement.IssueVoucherInputBuilder
setVoucherDefinitionName(voucherDefinitionName)
Represents the name of the voucher definition associated with the voucher code. This is a required field.
Signature
public LoyaltyManagement.IssueVoucherInputBuilder setVoucherDefinitionName(String voucherDefinitionName)
Parameters
voucherDefinitionName
Type: String
Return Value
Type: LoyaltyManagement.IssueVoucherInputBuilder
j