Contents
usernamepasswordpublic struct FTMCLoginItem
Person’s login item, used to start a session
usernamepublic let username : String
Person username
passwordpublic let password : String
Person password
Contents
firstNamelastNamepasswordusernameinit(name:lastName:username:password:)public struct FTMCPersonItem
PersonItem, used for signup
firstNamepublic let firstName : String
Person’s first name
lastNamepublic let lastName : String
Person’s lat name
passwordpublic let password : String
Person’s password
usernamepublic let username : String
Person’s username
init(name:lastName:username:password:)public init(name: String, lastName : String, username: String, password : String)
Initialized a person item for signup
- Parameters:
- name: first name of the person
- lastName: last name of the person
- username: username credential of the person
- password: password credential of the person
| Name | Description |
|---|---|
| name | first name of the person |
| lastName | last name of the person |
| username | username credential of the person |
| password | password credential of the person |
Contents
firstNamelastNameenabledidcredentialsNonExpiredaccountNonExpiredaccountNonLockedusernamewalletIdpersonIdpublic final class FTMCPerson
Fintiv Mobile Commerce Person, representing a end-user in the system
firstNamepublic let firstName : String
Person’s first name
lastNamepublic let lastName : String
Person’s last name
enabledpublic let enabled : Bool
Whether the person is currently enabled
idpublic let id : Int
Person id (equal to personId property)
credentialsNonExpiredpublic let credentialsNonExpired : Bool
Whether the credentials for the person are non expired
accountNonExpiredpublic let accountNonExpired : Bool
Whether the Person’s account has not expired
accountNonLockedpublic let accountNonLocked : Bool
Whether the person account is not locked
usernamepublic let username : String
The person’s username
walletIdpublic let walletId : String
The wallet id the person was created on
personIdpublic let personId : String
Person Identifier
Contents
tokengenerationDateexpirationDatedescriptionencode(with:)init(coder:)@objc public class FTMCToken : NSObject, NSSecureCoding
Fintiv Mobile Commerce session token
tokenpublic let token : String
The access token string
generationDatepublic let generationDate : Date
Generation date
expirationDatepublic let expirationDate : Date
Expiration date
descriptionoverride public var description: String
Human readable description of the token
encode(with:)public func encode(with aCoder: NSCoder)
NSSecureCoding comformance
init(coder:)public required init?(coder aDecoder: NSCoder)
NSSecureCoding comformance
Contents
serviceIdserviceFamilyIdserviceCategoryIdtemplateElementsserviceNamepublic struct FTMCService
A Fintiv Mobile Commerce service
serviceIdpublic let serviceId : String
The service Identifier
serviceFamilyIdpublic let serviceFamilyId : String
Service family identifier
serviceCategoryIdpublic let serviceCategoryId : String
Service category identifier
templateElementspublic let templateElements : [FTMCTemplateElement]
Array of template elements
serviceNamepublic let serviceName : String
Name of the service
STRUCT
Contents
servicespublic struct FTMCServiceCatalog
List of Fintiv Mobile Commerce services available for the wallet
servicespublic let services : [FTMCService]
Array of FMTCService available
Contents
templateNametemplateValuepublic struct FTMCTemplateElement
Mobile Comerce Template element
templateNamepublic let templateName : String
Element name
templateValuepublic let templateValue : String
Element value
Contents
merchantNamemerchantImageUrlStringmerchantIdmerchantImageDatedescriptionpublic struct FTMCMerchant : CustomStringConvertible
A Fintiv Mobile Commerce Merchant
merchantNamepublic let merchantName : String
Merchant’s name
merchantImageUrlStringpublic let merchantImageUrlString : String
URL String of the merchant’s Image
merchantIdpublic let merchantId : String
Merchant’s unique identifier
merchantImageDatepublic var merchantImageDate : Date
Date of the merchant’s image update
descriptionpublic var description: String
Human readable descriptio of the merchant
Contents
hashValuecouponNamecouponIdentifiercouponDescriptioncouponImageUrlStringcouponThumbnailUrlStringbrandNamebrandIdentifierbrandImageUrlStringonlineEnabledcategoryIdrecommendablenfcEnableddistancefeaturedtypeinstancemerchantsbrandImageDateexpirationDatecouponImageTimecouponImagebrandImagecouponThumbnaildescription==(_:_:)fetchImages()fetchImage(imageType:completion:)public final class FTMCCoupon : CustomStringConvertible, Hashable, Equatable
Fintiv Mobile Commerce coupon
hashValuepublic var hashValue: Int
Hashable protocol comformance
couponNamepublic let couponName : String
Coupon name
couponIdentifierpublic let couponIdentifier : String
Coupon identifier
couponDescriptionpublic let couponDescription : String
Coupon description
couponImageUrlStringpublic let couponImageUrlString : String
URL String of the coupon’s image
couponThumbnailUrlStringpublic let couponThumbnailUrlString : String
URL String of the coupon’s thumbnail’s image
brandNamepublic let brandName : String
Name of the coupon’s brand
brandIdentifierpublic let brandIdentifier : String
Brean Identifier
brandImageUrlStringpublic let brandImageUrlString : String
URL String of the coupon’s image
onlineEnabledpublic let onlineEnabled : Bool
Whether the coupon if online enabled
categoryIdpublic let categoryId : String?
Category Identifier of the coupon
recommendablepublic let recommendable : Bool
Whether it’s a reommendable coupon
nfcEnabledpublic let nfcEnabled : Bool
Whether the coupon is NFC-Enabled
distancepublic let distance : Double
The distance to the coupon’s location
featuredpublic let featured : Bool
Whether it’s a featured coupon
typepublic var type : FTMCCouponType
The coupon type
instancepublic var instance : FTMCCouponInstance? = nil
Coupon instance (!nil if coupon.type == .person)
merchantspublic var merchants : [FTMCMerchant]
Coupon merchants
brandImageDatepublic var brandImageDate : Date
Date of the brand’s image update
expirationDatepublic var expirationDate : Date
Expiration date of the coupon
couponImageTimepublic var couponImageTime : Date
Date the coupon image was updated
couponImagepublic var couponImage : UIImage?
The coupon’s Image
brandImagepublic var brandImage : UIImage?
The coupon’s Brand’s Image
couponThumbnailpublic var couponThumbnail : UIImage?
The coupon’s thumbnail
descriptionpublic var description: String
Human readable description of the coupon
==(::)public static func == (lhs: FTMCCoupon, rhs: FTMCCoupon) -> Bool
Equatable protocol comformance
fetchImages()public func fetchImages()
fetches all images for the coupon
fetchImage(imageType:completion:)public func fetchImage(imageType : FTMCCouponImage, completion : @escaping FTCouponImageBlock)
Fetches given image type for the coupon
- Parameters:
- imageType: the FTMCCouponImage type to be fetched
- completion: a FTCouponImageBlock returning the image. Executed on the calling Queue
| Name | Description |
|---|---|
| imageType | the FTMCCouponImage type to be fetched |
| completion | a FTCouponImageBlock returning the image. Executed on the calling Queue |
Contents
couponInstanceIdredemptionTyperedemptionCodecouponIddescriptionredemptionImage(size:)public struct FTMCCouponInstance : CustomStringConvertible
PropertiesA Fintiv Mobile Commerce Coupon Instance, describes a coupon that has been added to a Person
couponInstanceIdpublic let couponInstanceId : String
Coupon Instance Identifier
redemptionTypepublic let redemptionType : FTMCCouponRedemptionType
Coupon Instance code redemption type
redemptionCodepublic let redemptionCode : String
Coupon Instance Redemption code
couponIdpublic let couponId : String
Coupon Identifier
descriptionpublic var description: String
Human readable coupon description
redemptionImage(size:)public func redemptionImage(size : CGSize) -> UIImage?
Retrieves the image’s redemption image in the size
- Parameter size: the size of the image to be return
- Returns: the image (optional) is succefully generated for the code
| Name | Description |
|---|---|
| size | the size of the image to be return |
Contents
isExpireddescriptioncardTypehashValuerewardsstampStartDateredemptionTypestampAreaImageURLisPublishToMarketstampCountstampCardIdnamebackgroundImageURLcatalogDescriptionmerchantstampEndDateidentifierinstancestampsstampsFetched==(_:_:)final public class FTMCStampCard : Equatable, Hashable, CustomStringConvertible
A Fintiv Mobile Commerce’s Stamp Card
isExpiredpublic var isExpired : Bool
Whether the stamp card is expired
descriptionpublic var description: String
Human readable description of the Stamp Card
cardTypepublic var cardType : FTMCStampCardType
The Stamp card type
hashValuepublic var hashValue: Int
Hashable protocol comformance
rewardspublic let rewards: [FTMCReward]
Array of FTMCRewards available on the Stamp Card
stampStartDatepublic let stampStartDate : Date
Start date of the stamp card
redemptionTypepublic let redemptionType: FTMCStampRedemptionType
The Stamp Card redemption type (QR or barcode)
stampAreaImageURLpublic let stampAreaImageURL: String
URL String of the stamp card’s area image
isPublishToMarketpublic let isPublishToMarket: Bool
Whether the stamp card is publishable to market
stampCountpublic let stampCount: Int
The number of stamps in the stamp card
stampCardIdpublic let stampCardId: String
Stamp Card Identifier
namepublic let name: String
Stamp Card name
backgroundImageURLpublic let backgroundImageURL: String
Stamp Card background Image url string
catalogDescriptionpublic let catalogDescription: String
Catalog description
merchantpublic let merchant : FTMCMerchant
Merchant of the Stamp Card
stampEndDatepublic let stampEndDate: Date
End date of the stamp card
identifierpublic var identifier : String
The stamp card Identifier
instancepublic var instance : FTMCStampCardInstance? = nil
Stamp card Instance (!= nil is the stamp has been added to the Person)
stampspublic var stamps : [FTMCStamp]
Array of stamps in the card
stampsFetchedpublic var stampsFetched : Bool
Whether the stamps for the card have been fetched
==(::)public static func == (lhs: FTMCStampCard, rhs: FTMCStampCard) -> Bool
Equatable protocol comformance
Contents
activeRewardsredeemedRewardshashValueisActiveisExpireddescriptionissueDateupdateDateexpirationDatetotalStampscurrentStampsstampCardIdcardInstanceId==(_:_:)public struct FTMCStampCardInstance : Equatable, Hashable, CustomStringConvertible
A Fintiv Mobile Commerce Stamp card Instance. Represent a stamp card that was added to a person
activeRewardspublic var activeRewards : [FTMCRewardInstance]
Array of Rewards Instances that are active (not redeemed already)
redeemedRewardspublic var redeemedRewards : [FTMCRewardInstance]
Array of Reward Instance that have been redeemed
hashValuepublic var hashValue: Int
Hashable protocol comformance
isActivepublic var isActive : Bool
Whether the Stamp Card Instance is active
isExpiredpublic var isExpired : Bool
Whether the Stamp Card Instance has Expired
descriptionpublic var description: String
Human readable description of the Stamp Card Instance
issueDatepublic let issueDate : Date
Date the stamp card instance was issued
updateDatepublic let updateDate : Date
Date the stamp card instance was updated
expirationDatepublic let expirationDate : Date
Stamp card instance expiration date
totalStampspublic var totalStamps : Int
Total stamps in the Stamp Card Instance
currentStampspublic var currentStamps : Int
Current stamps in the Stamp Card Instance
stampCardIdpublic let stampCardId : String
Identifier of the stamp card the instance was generated from
cardInstanceIdpublic let cardInstanceId : String
Identifier for the instance
==(::)public static func == (lhs: FTMCStampCardInstance, rhs: FTMCStampCardInstance) -> Bool
Equatable protocol comformance
Contents
awardStampsrewardIdstampEventTypestampIdstampStatestampValueisActivedescriptionpublic struct FTMCStamp : CustomStringConvertible
Fintiv Mobile Commerce Stamp
awardStampspublic let awardStamps : Int
Number of award stamps
rewardIdpublic let rewardId : String
Reward Identifier
stampEventTypepublic let stampEventType : String
Stamp Event type
stampIdpublic let stampId : String
Stamp Identifier
stampStatepublic let stampState : String
Stamp state
stampValuepublic let stampValue : String
Stamp value
isActivepublic var isActive : Bool
Whether the stamp is active
descriptionpublic var description: String
Human readable description of the stamp
Contents
namethresholdimageURLStringrewardDescriptionserviceIdrewardIdwalletIdinstancedescriptionpublic struct FTMCReward : CustomStringConvertible
A Fintiv Mobile Commerce reward
namepublic let name: String
Reward’s name
thresholdpublic let threshold: Int
Threshold, number of stamps required so a reward instance is created for the person
imageURLStringpublic let imageURLString: String
URL String of the reward’s image
rewardDescriptionpublic let rewardDescription : String
Reward description
serviceIdpublic let serviceId : String
Service Id of the reward
rewardIdpublic let rewardId : String
Reward Identifier
walletIdpublic let walletId: String
Wallet id of the reward
instancepublic var instance : FTMCRewardInstance?
Reward’s instance (!= nil once the reward is generated)
descriptionpublic var description: String
Human readable description of the Reward
Contents
statuscardInstanceIdrewardInstanceIdrewardedDateisActivenamethresholdimageURLStringrewardDescriptionserviceIdrewardIdwalletIdpublic struct FTMCRewardInstance
A Fintiv Mobile Commer Reward Instance. Represents a Reward that is available for the Person
statuspublic let status : String
Reward Instance status
cardInstanceIdpublic let cardInstanceId : String
Identifier of the card instance the reward instance belongs to
rewardInstanceIdpublic let rewardInstanceId : String
Reward Instance Identifier
rewardedDatepublic let rewardedDate : Date
Date the reward was added to the Person
isActivepublic var isActive : Bool
Whether the reward is active
namepublic let name: String
Name of the reward
thresholdpublic let threshold: Int
Threshold, number of stamps needed on the Stamp Card Instance before a reward instance if generated
imageURLStringpublic let imageURLString: String
URL String of the Image
rewardDescriptionpublic let rewardDescription : String
Reward Instance Description
serviceIdpublic let serviceId : String
Service Id of the reward
rewardIdpublic let rewardId : String
Identifier of the reward this instance was created from
walletIdpublic let walletId : String
Wallet id of the rewardserviceId