Reward Structure Reference

id

Value representing the entity id.

Declaration

Swift

public var id: Int

sku

Stock keeping unit of the reward.

Declaration

Swift

public var sku: String


                    
                    
                    heading

Heading label of the reward.

Declaration

Swift

public var heading: String


                    
                    
                    subHeading

Subheading label of the reward.

Declaration

Swift

public var subHeading: String


                    
                    
                    body

Body text of the reward.

Declaration

Swift

public var body: String


                    
                    
                    details

Details of the reward.

Declaration

Swift

public var details: String


                    
                    
                    metricDisplayName

Metric name used in the reward.

Declaration

Swift

public var metricDisplayName: String


                    
                    
                    imageUrl

Url of the image attached to the reward.

Declaration

Swift

public var imageUrl: String


                    
                    
                    thumbnailUrl

Url of the thumbnail image attached to the reward.

Declaration

Swift

public var thumbnailUrl: String


                    
                    
                    type

Reward type.

Declaration

Swift

public var type: Reward.RewardType?


                    
                    
                    startDate

Starting date of the reward.

Declaration

Swift

public var startDate: String


                    
                    
                    endDate

Ending date of the reward.

Declaration

Swift

public var endDate: String


                    
                    
                    drawDate

Draw date of the reward.

Declaration

Swift

public var drawDate: String


                    
                    
                    attributes

Attributes of the reward.

Declaration

Swift

public var attributes: [Reward.Attribute]


                    
                    
                    requiredAttributes

Attributes of the reward classes.

Declaration

Swift

public var requiredAttributes: [Reward.Class]


                    
                    
                    combinations

Combinations of the reward.

Declaration

Swift

public var combinations: [Reward.AttributeCombination]


                    
                    
                    selectedCombination

Selected combinations of the reward.

Declaration

Swift

public var selectedCombination: Reward.AttributeCombination?


                    
                    
                    redemptionOptions

Redeem options of the reward.

Declaration

Swift

public var redemptionOptions: [RedemptionOptions]


                    
                    
                    points

Points required by the reward.

Declaration

Swift

public var points: String


                    
                    
                    responseCount

Member response count for reward.

Declaration

Swift

public var responseCount: Int


                    
                    
                    isRespondable

Boolean value if award is respondable.

Declaration

Swift

public var isRespondable: Bool


                    
                    
                    isFavorited

Booolean value if award is favorited.

Declaration

Swift

public var isFavorited: Bool


                    
                    
                    addressRequired

Boolean value if user is required to have an address.

Declaration

Swift

public var addressRequired: Bool


                    
                    
                    isAwarded

Boolean value if award is already awarded.

Declaration

Swift

public var isAwarded: Bool


                    
                    
                    paymentMethod

The payment method of the reward.

Declaration

Swift

public var paymentMethod: String


                    
                    
                    action

The action to be done.

Declaration

Swift

public var action: String


                    
                    
                    responseCurrencyAmount

The currency amount of the response as String.

Declaration

Swift

public var responseCurrencyAmount: String


                    
                    
                    responseCurrencyName

The currency name of the response.

Declaration

Swift

public var responseCurrencyName: String


                    
                    
                    expirationInterval

The expiration interval of the reward.

Declaration

Swift

public var expirationInterval: String


                    
                    
                    expirationPeriod

The expirateion period of the reward.

Declaration

Swift

public var expirationPeriod: String


                    
                    
                    respondableInfo

Reward’s respondable information.

Declaration

Swift

public var respondableInfo: RespondableInfo?


                    
                    
                    embedded

Embededd objects in the reward.

Declaration

Swift

public var embedded: AnyCodable?


                    
                    
                    isAcceptanceRequired

Boolean value whether acceptance is required or not.

Declaration

Swift

public var isAcceptanceRequired: Bool


                    
                    
                    acceptanceText

The string as the acceptance text to display in the view.

Declaration

Swift

public var acceptanceText: String


                    
                    
                    acceptanceUrl

The string value of the url to redirect the acceptance link.

Declaration

Swift

public var acceptanceUrl: String


                    
                    
                    responseMessage

The action to be done.

Declaration

Swift

public var responseMessage: String


                    
                    
                    businessValue

Business value of the reward.

Declaration

Swift

public var businessValue: String


                    
                    
                    maximumMetric

Maximum metric for transfer

Declaration

Swift

public var maximumMetric: String


                    
                    
                    minimumMetric

Minimum metric for transfer

Declaration

Swift

public var minimumMetric: String


                    
                    
                    hasRespondableCombination

Boolean value whether there’s at least 1 respondable combination.

Declaration

Swift

public var hasRespondableCombination: Bool { get }


                    
                    
                    extraJSON

Extra Json added on the offer object

Declaration

Swift

public var extraJSON: [String : AnyCodable]


                    
                    
                    init(id:sku:heading:subHeading:body:details:metricDisplayName:imageUrl:thumbnailUrl:type:startDate:endDate:drawDate:attributes:requiredAttributes:combinations:selectedCombination:redemptionOptions:points:responseCount:isRespondable:isFavorited:addressRequired:isAwarded:paymentMethod:action:responseCurrencyAmount:responseCurrencyName:expirationInterval:expirationPeriod:respondableInfo:embedded:isAcceptanceRequired:acceptanceText:acceptanceUrl:responseMessage:businessValue:maximumMetric:minimumMetric:extraJSON:)

Undocumented

Declaration

Swift

public init(id: Int, sku: String, heading: String, subHeading: String, body: String,
            details: String, metricDisplayName: String, imageUrl: String, thumbnailUrl: String,
            type: RewardType?, startDate: String, endDate: String, drawDate: String, attributes: [Reward.Attribute],
            requiredAttributes: [Reward.Class], combinations: [Reward.AttributeCombination],
            selectedCombination: Reward.AttributeCombination?, redemptionOptions: [RedemptionOptions],
            points: String, responseCount: Int, isRespondable: Bool, isFavorited: Bool, addressRequired: Bool,
            isAwarded: Bool, paymentMethod: String, action: String, responseCurrencyAmount: String,
            responseCurrencyName: String, expirationInterval: String, expirationPeriod: String,
            respondableInfo: RespondableInfo?, embedded: AnyCodable?, isAcceptanceRequired: Bool,
            acceptanceText: String, acceptanceUrl: String, responseMessage: String, businessValue: String,
            maximumMetric: String, minimumMetric: String, extraJSON: [String: AnyCodable])


                    
                    
                    RewardType

Enum representing type of a reward.

Declaration

Swift

public enum RewardType : String, Codable


                    
                    
                    RedemptionOptions

Enum representing redeem options of a reward.

Declaration

Swift

public enum RedemptionOptions : String, Codable


                    
                    
                    Class

Struct representing Reward Class related values.

Declaration

Swift

public struct Class : Codable, Equatable


                    
                    
                    Response

Struct representing Reward Response related values.

Declaration

Swift

public struct Response : Codable, Equatable


                    
                    
                    ResponseInfo

Struct representing reward response info values.

Declaration

Swift

public struct ResponseInfo : Codable, Equatable


                    
                    
                    Category

Struct representing Reward Category related values.

Declaration

Swift

public struct Category : Codable, Equatable


                    
                    
                    Attribute

Struct representing Reward Attribute related values.

Declaration

Swift

public struct Attribute : Codable, Equatable


                    
                    
                    AttributeCombination

Struct representing Reward Attribute Combination related values.

Declaration

Swift

public struct AttributeCombination : Codable, Equatable


                    
                    
                    AttributeOption

Struct representing Reward Attribute Option related values.

Declaration

Swift

public struct AttributeOption : Codable, Equatable


                    
                    
                    init(from:)

Declaration

Swift

public init(from decoder: Decoder) throws