FTLCampaignViewImmutable representation of a FTLoyalty Campaign
Contents
idnamecampaignDescriptioncampaignTypecreationStampcurrencyrewardRatioglyphbalancebalanceDoublecumulativecumulativeDoubledescriptionfirstTransactionlastTransactionlastTransactionPointslastTransactionPointsDoublelastRedemptionlastRedemptionPointslastRedemptionPointsDoubletransactionspromotionViewsrewardViewsfinal public class FTLCampaignView : ModelComforming
idpublic let id : String
Campaign identifier
namepublic let name : String
Campaign name
campaignDescriptionpublic let campaignDescription : String
Campaign description
campaignTypepublic let campaignType : FTLCampaignType
Campaign type (points, card, etc)
creationStamppublic var creationStamp : String
Creation stamp (date string)
currencypublic var currency : String
Current symbol
rewardRatiopublic var rewardRatio : Double
Reward multiplier
glyphpublic var glyph : String?
Currency symbol
balancepublic var balance : String
Campaign balance as string
balanceDoublepublic var balanceDouble : Double
Double value of campaign balance
cumulativepublic var cumulative : String
Cumulative value of the balances in the campaign
cumulativeDoublepublic var cumulativeDouble : Double
Double value of the balances in the campaign
descriptionpublic var description : String
Extended Reward Description
firstTransactionpublic var firstTransaction : String
First transaction recorded in the campaign for the containing customer
lastTransactionpublic var lastTransaction : String
Last transaction recorded in the campaign for the containing customer
lastTransactionPointspublic var lastTransactionPoints : String
Points of the last transaction executed in the campaign for the containing customer, as a String
lastTransactionPointsDoublepublic var lastTransactionPointsDouble : Double
Points of the last transaction executed in the campaign for the containing customer, as a Double
lastRedemptionpublic var lastRedemption : String
Date of the lastRedemption executed in the campaign for the containing customer, as a String
lastRedemptionPointspublic var lastRedemptionPoints: String
String value of the last redeemed points
lastRedemptionPointsDoublepublic var lastRedemptionPointsDouble : Double
Double value of the last redeemed points
transactionspublic var transactions = [FTLTransactionView]()
Transactions executed in the campaign
promotionViewspublic var promotionViews : [FTLPromotionView]
promotions available in the campaign
rewardViewspublic var rewardViews : [FTLRewardView]
Rewards available for the campaign
FTLCustomerEntity representing a FTLoyalty end user Customer.
Contents
idcustomerUsernamecardNumbernamelastnameemaildescriptioncampaignSetcampaignViewspublic class FTLCustomer : ModelComforming
idpublic var id : String
Unique customer identifier within FTPay
customerUsernamepublic var customerUsername : String
Customer crendetial used for login (alphanumeric username, email, phone, etc)
cardNumberpublic var cardNumber : String
Customer card number, used for promotions & rewards
namepublic var name : String
Customer’s first name
lastnamepublic var lastname : String
Customer’s last name
emailpublic var email : String
Customer email
descriptionpublic var description: String
Custom Customer description (human readable)
campaignSetpublic var campaignSet : Set<FTLCampaignView>
Campaigns set the customer is a part of (read-only)
campaignViewspublic var campaignViews : [FTLCampaignView]
Campaigns array the customer is part of (read-only)
FTLPromotionViewEntity representing a Loyalty Campaign Promotion
Contents
campaignIdidcustomIdentifierpromotionDescriptionoperandstartDateStringendDateStringvaluestartDateendDatevalueDoubledescriptionfinal public class FTLPromotionView : ModelComforming
campaignIdpublic var campaignId : String
Identifier of the campaign the promotion corresponds to
idpublic let id : String
Unique promotion Identifier
customIdentifierpublic let customIdentifier : String
Custom promotion Identifier
- TODO: Request more information
promotionDescriptionpublic let promotionDescription : String
promotion description as created on the FTPay portal
operandpublic let operand : String
String representing whether the promotion, adds, substract or multiplies a campaign balance
startDateStringpublic let startDateString : String
Start date of the promotion, as a String
endDateStringpublic let endDateString : String
End date of the promotion, as a String
valuepublic let value : String
Value of the promotion, as a String
startDatepublic var startDate : Date?
Start date of the promotion, as a Date
- Remark: Will return a date from Distant past if dateString is unparsable as a Date (01-01,0001)
endDatepublic var endDate : Date?
End date of the promotion, as a Date
- Remark: Will return a date from Distant past if dateString is unparsable as a Date (01-01,0001)
valueDoublepublic var valueDouble : Double
Value of the promotion, as a double
descriptionpublic var description: String
Extended human-readable description
FTLRewardViewEntity representing a Loyalty Campaign Reward
Contents
idlevellevelDoublerewardDescriptionrewardIddescriptionpublic final class FTLRewardView : ModelComforming
idpublic let id : String
Rewards Unique Identifier
levelpublic let level : String
- Todo: REQUEST INFORMATION
levelDoublepublic var levelDouble : Double
- Todo: REQUEST INFORMATION
rewardDescriptionpublic let rewardDescription: String
Reward description as set on FTPay portal
rewardIdpublic let rewardId : String?
Identifier String used for third party integration
descriptionpublic var description: String
Extended human-readable description
FTLTransactionViewEntity representing a transaction executed against a Loyalty Campaign
Contents
redeemedidamountserviceProductcampaignIdentifieroriginalAmountauthorizationrealdateStringdateamountDoubleoriginalAmountDoubledescriptionfinal public class FTLTransactionView : ModelComforming
redeemedpublic let redeemed : Bool
Whether the trascantion was executed
- TODO: REQUEST FURTHER INFO
idpublic let id : String
Unique transaction identifier
amountpublic let amount : String
The amount of the transaction, as a String
serviceProductpublic let serviceProduct : String
The service or product the transaction corresponds to
campaignIdentifierpublic let campaignIdentifier : String
Identifier of the campaign the transaction was executed against
originalAmountpublic let originalAmount : String
- TODO: REQUEST FURTHER INFO
authorizationpublic let authorization : String
- TODO: REQUEST FURTHER INFO
realpublic let real : Bool
Whether the charge is a real or simulated one
- TODO: REQUEST FURTHER INFO
dateStringpublic let dateString : String
Date the transaction was recorded, as a String
datepublic var date : Date
Date the transaction was recorded, as a Date
- Remark: Will return a date from Distant past if dateString is unparsable as a Date (01-01,0001)
amountDoublepublic var amountDouble : Double
Amount of the transaction, as a Double
originalAmountDoublepublic var originalAmountDouble : Double
- TODO: REQUEST FURTHER INFO
descriptionpublic var description: String
Extended human-readable description
FTLCampaignBonusObject used to grant customer points for a given campaign at registration time
Contents
pointscampaignIdauthorizationinit(campaignId:points:authorization:)public struct FTLCampaignBonus
pointspublic let points : Int
Points to grant to given campaign
campaignIdpublic let campaignId : String
Campaign id to grant points to at registration
authorizationpublic let authorization : String
Authorization string
init(campaignId:points:authorization:)public init(campaignId : String, points : Int, authorization : String)