Contents
username
password
public struct FTMCLoginItem
Person’s login item, used to start a session
username
public let username : String
Person username
password
public let password : String
Person password
Contents
firstName
lastName
password
username
init(name:lastName:username:password:)
public struct FTMCPersonItem
PersonItem, used for signup
firstName
public let firstName : String
Person’s first name
lastName
public let lastName : String
Person’s lat name
password
public let password : String
Person’s password
username
public 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
firstName
lastName
enabled
id
credentialsNonExpired
accountNonExpired
accountNonLocked
username
walletId
personId
public final class FTMCPerson
Fintiv Mobile Commerce Person, representing a end-user in the system
firstName
public let firstName : String
Person’s first name
lastName
public let lastName : String
Person’s last name
enabled
public let enabled : Bool
Whether the person is currently enabled
id
public let id : Int
Person id (equal to personId property)
credentialsNonExpired
public let credentialsNonExpired : Bool
Whether the credentials for the person are non expired
accountNonExpired
public let accountNonExpired : Bool
Whether the Person’s account has not expired
accountNonLocked
public let accountNonLocked : Bool
Whether the person account is not locked
username
public let username : String
The person’s username
walletId
public let walletId : String
The wallet id the person was created on
personId
public let personId : String
Person Identifier
Contents
token
generationDate
expirationDate
description
encode(with:)
init(coder:)
@objc public class FTMCToken : NSObject, NSSecureCoding
Fintiv Mobile Commerce session token
token
public let token : String
The access token string
generationDate
public let generationDate : Date
Generation date
expirationDate
public let expirationDate : Date
Expiration date
description
override 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
serviceId
serviceFamilyId
serviceCategoryId
templateElements
serviceName
public struct FTMCService
A Fintiv Mobile Commerce service
serviceId
public let serviceId : String
The service Identifier
serviceFamilyId
public let serviceFamilyId : String
Service family identifier
serviceCategoryId
public let serviceCategoryId : String
Service category identifier
templateElements
public let templateElements : [FTMCTemplateElement]
Array of template elements
serviceName
public let serviceName : String
Name of the service
STRUCT
Contents
services
public struct FTMCServiceCatalog
List of Fintiv Mobile Commerce services available for the wallet
services
public let services : [FTMCService]
Array of FMTCService available
Contents
templateName
templateValue
public struct FTMCTemplateElement
Mobile Comerce Template element
templateName
public let templateName : String
Element name
templateValue
public let templateValue : String
Element value
Contents
merchantName
merchantImageUrlString
merchantId
merchantImageDate
description
public struct FTMCMerchant : CustomStringConvertible
A Fintiv Mobile Commerce Merchant
merchantName
public let merchantName : String
Merchant’s name
merchantImageUrlString
public let merchantImageUrlString : String
URL String of the merchant’s Image
merchantId
public let merchantId : String
Merchant’s unique identifier
merchantImageDate
public var merchantImageDate : Date
Date of the merchant’s image update
description
public var description: String
Human readable descriptio of the merchant
Contents
hashValue
couponName
couponIdentifier
couponDescription
couponImageUrlString
couponThumbnailUrlString
brandName
brandIdentifier
brandImageUrlString
onlineEnabled
categoryId
recommendable
nfcEnabled
distance
featured
type
instance
merchants
brandImageDate
expirationDate
couponImageTime
couponImage
brandImage
couponThumbnail
description
==(_:_:)
fetchImages()
fetchImage(imageType:completion:)
public final class FTMCCoupon : CustomStringConvertible, Hashable, Equatable
Fintiv Mobile Commerce coupon
hashValue
public var hashValue: Int
Hashable protocol comformance
couponName
public let couponName : String
Coupon name
couponIdentifier
public let couponIdentifier : String
Coupon identifier
couponDescription
public let couponDescription : String
Coupon description
couponImageUrlString
public let couponImageUrlString : String
URL String of the coupon’s image
couponThumbnailUrlString
public let couponThumbnailUrlString : String
URL String of the coupon’s thumbnail’s image
brandName
public let brandName : String
Name of the coupon’s brand
brandIdentifier
public let brandIdentifier : String
Brean Identifier
brandImageUrlString
public let brandImageUrlString : String
URL String of the coupon’s image
onlineEnabled
public let onlineEnabled : Bool
Whether the coupon if online enabled
categoryId
public let categoryId : String?
Category Identifier of the coupon
recommendable
public let recommendable : Bool
Whether it’s a reommendable coupon
nfcEnabled
public let nfcEnabled : Bool
Whether the coupon is NFC-Enabled
distance
public let distance : Double
The distance to the coupon’s location
featured
public let featured : Bool
Whether it’s a featured coupon
type
public var type : FTMCCouponType
The coupon type
instance
public var instance : FTMCCouponInstance? = nil
Coupon instance (!nil if coupon.type == .person)
merchants
public var merchants : [FTMCMerchant]
Coupon merchants
brandImageDate
public var brandImageDate : Date
Date of the brand’s image update
expirationDate
public var expirationDate : Date
Expiration date of the coupon
couponImageTime
public var couponImageTime : Date
Date the coupon image was updated
couponImage
public var couponImage : UIImage?
The coupon’s Image
brandImage
public var brandImage : UIImage?
The coupon’s Brand’s Image
couponThumbnail
public var couponThumbnail : UIImage?
The coupon’s thumbnail
description
public 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
couponInstanceId
redemptionType
redemptionCode
couponId
description
redemptionImage(size:)
public struct FTMCCouponInstance : CustomStringConvertible
PropertiesA Fintiv Mobile Commerce Coupon Instance, describes a coupon that has been added to a Person
couponInstanceId
public let couponInstanceId : String
Coupon Instance Identifier
redemptionType
public let redemptionType : FTMCCouponRedemptionType
Coupon Instance code redemption type
redemptionCode
public let redemptionCode : String
Coupon Instance Redemption code
couponId
public let couponId : String
Coupon Identifier
description
public 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
isExpired
description
cardType
hashValue
rewards
stampStartDate
redemptionType
stampAreaImageURL
isPublishToMarket
stampCount
stampCardId
name
backgroundImageURL
catalogDescription
merchant
stampEndDate
identifier
instance
stamps
stampsFetched
==(_:_:)
final public class FTMCStampCard : Equatable, Hashable, CustomStringConvertible
A Fintiv Mobile Commerce’s Stamp Card
isExpired
public var isExpired : Bool
Whether the stamp card is expired
description
public var description: String
Human readable description of the Stamp Card
cardType
public var cardType : FTMCStampCardType
The Stamp card type
hashValue
public var hashValue: Int
Hashable protocol comformance
rewards
public let rewards: [FTMCReward]
Array of FTMCRewards available on the Stamp Card
stampStartDate
public let stampStartDate : Date
Start date of the stamp card
redemptionType
public let redemptionType: FTMCStampRedemptionType
The Stamp Card redemption type (QR or barcode)
stampAreaImageURL
public let stampAreaImageURL: String
URL String of the stamp card’s area image
isPublishToMarket
public let isPublishToMarket: Bool
Whether the stamp card is publishable to market
stampCount
public let stampCount: Int
The number of stamps in the stamp card
stampCardId
public let stampCardId: String
Stamp Card Identifier
name
public let name: String
Stamp Card name
backgroundImageURL
public let backgroundImageURL: String
Stamp Card background Image url string
catalogDescription
public let catalogDescription: String
Catalog description
merchant
public let merchant : FTMCMerchant
Merchant of the Stamp Card
stampEndDate
public let stampEndDate: Date
End date of the stamp card
identifier
public var identifier : String
The stamp card Identifier
instance
public var instance : FTMCStampCardInstance? = nil
Stamp card Instance (!= nil is the stamp has been added to the Person)
stamps
public var stamps : [FTMCStamp]
Array of stamps in the card
stampsFetched
public var stampsFetched : Bool
Whether the stamps for the card have been fetched
==(::)
public static func == (lhs: FTMCStampCard, rhs: FTMCStampCard) -> Bool
Equatable protocol comformance
Contents
activeRewards
redeemedRewards
hashValue
isActive
isExpired
description
issueDate
updateDate
expirationDate
totalStamps
currentStamps
stampCardId
cardInstanceId
==(_:_:)
public struct FTMCStampCardInstance : Equatable, Hashable, CustomStringConvertible
A Fintiv Mobile Commerce Stamp card Instance. Represent a stamp card that was added to a person
activeRewards
public var activeRewards : [FTMCRewardInstance]
Array of Rewards Instances that are active (not redeemed already)
redeemedRewards
public var redeemedRewards : [FTMCRewardInstance]
Array of Reward Instance that have been redeemed
hashValue
public var hashValue: Int
Hashable protocol comformance
isActive
public var isActive : Bool
Whether the Stamp Card Instance is active
isExpired
public var isExpired : Bool
Whether the Stamp Card Instance has Expired
description
public var description: String
Human readable description of the Stamp Card Instance
issueDate
public let issueDate : Date
Date the stamp card instance was issued
updateDate
public let updateDate : Date
Date the stamp card instance was updated
expirationDate
public let expirationDate : Date
Stamp card instance expiration date
totalStamps
public var totalStamps : Int
Total stamps in the Stamp Card Instance
currentStamps
public var currentStamps : Int
Current stamps in the Stamp Card Instance
stampCardId
public let stampCardId : String
Identifier of the stamp card the instance was generated from
cardInstanceId
public let cardInstanceId : String
Identifier for the instance
==(::)
public static func == (lhs: FTMCStampCardInstance, rhs: FTMCStampCardInstance) -> Bool
Equatable protocol comformance
Contents
awardStamps
rewardId
stampEventType
stampId
stampState
stampValue
isActive
description
public struct FTMCStamp : CustomStringConvertible
Fintiv Mobile Commerce Stamp
awardStamps
public let awardStamps : Int
Number of award stamps
rewardId
public let rewardId : String
Reward Identifier
stampEventType
public let stampEventType : String
Stamp Event type
stampId
public let stampId : String
Stamp Identifier
stampState
public let stampState : String
Stamp state
stampValue
public let stampValue : String
Stamp value
isActive
public var isActive : Bool
Whether the stamp is active
description
public var description: String
Human readable description of the stamp
Contents
name
threshold
imageURLString
rewardDescription
serviceId
rewardId
walletId
instance
description
public struct FTMCReward : CustomStringConvertible
A Fintiv Mobile Commerce reward
name
public let name: String
Reward’s name
threshold
public let threshold: Int
Threshold, number of stamps required so a reward instance is created for the person
imageURLString
public let imageURLString: String
URL String of the reward’s image
rewardDescription
public let rewardDescription : String
Reward description
serviceId
public let serviceId : String
Service Id of the reward
rewardId
public let rewardId : String
Reward Identifier
walletId
public let walletId: String
Wallet id of the reward
instance
public var instance : FTMCRewardInstance?
Reward’s instance (!= nil once the reward is generated)
description
public var description: String
Human readable description of the Reward
Contents
status
cardInstanceId
rewardInstanceId
rewardedDate
isActive
name
threshold
imageURLString
rewardDescription
serviceId
rewardId
walletId
public struct FTMCRewardInstance
A Fintiv Mobile Commer Reward Instance. Represents a Reward that is available for the Person
status
public let status : String
Reward Instance status
cardInstanceId
public let cardInstanceId : String
Identifier of the card instance the reward instance belongs to
rewardInstanceId
public let rewardInstanceId : String
Reward Instance Identifier
rewardedDate
public let rewardedDate : Date
Date the reward was added to the Person
isActive
public var isActive : Bool
Whether the reward is active
name
public let name: String
Name of the reward
threshold
public let threshold: Int
Threshold, number of stamps needed on the Stamp Card Instance before a reward instance if generated
imageURLString
public let imageURLString: String
URL String of the Image
rewardDescription
public let rewardDescription : String
Reward Instance Description
serviceId
public let serviceId : String
Service Id of the reward
rewardId
public let rewardId : String
Identifier of the reward this instance was created from
walletId
public let walletId : String
Wallet id of the rewardserviceId