Response Structure Reference

id

Value representing the entity id.

Declaration

Swift

public var id: Int


                    
                    
                    redemptionStatus

The reward response redemption status.

Declaration

Swift

public var redemptionStatus: RedemptionStatus


                    
                    
                    memberName

The name of the member who owns the reward response.

Declaration

Swift

public var memberName: String


                    
                    
                    memberId

The id of the member who owns the reward response.

Declaration

Swift

public var memberId: String


                    
                    
                    redemptionAmount

The amount needed for the redemption.

Declaration

Swift

public var redemptionAmount: String


                    
                    
                    metricName

The metric name used for the redemption.

Declaration

Swift

public var metricName: String


                    
                    
                    redemptionUnit

The redemption unit used.

Declaration

Swift

public var redemptionUnit: String


                    
                    
                    metricDisplayName

The metric display name for the redemption.

Declaration

Swift

public var metricDisplayName: String


                    
                    
                    metricAmount

The metric amount needed for the redemption.

Declaration

Swift

public var metricAmount: String

sku

The reward response stock keeping unit.

Declaration

Swift

public var sku: String


                    
                    
                    integrationId

The reward response integration integration id.

Declaration

Swift

public var integrationId: String


                    
                    
                    shippingAddress

The reward response shipping address.

Declaration

Swift

public var shippingAddress: Reward.Response.ShippingAddress?


                    
                    
                    imageUrl

The redemption’s main image url.

Declaration

Swift

public var imageUrl: String


                    
                    
                    thumbImageUrl

The redemption’s thumbnail image url.

Declaration

Swift

public var thumbImageUrl: String


                    
                    
                    useStart

Start date for using the redemption.

Declaration

Swift

public var useStart: String


                    
                    
                    useEnd

End date for using the redemption.

Declaration

Swift

public var useEnd: String


                    
                    
                    createdAt

Date when the redemption was created.

Declaration

Swift

public var createdAt: String


                    
                    
                    updatedAt

Date when the redemption was updated.

Declaration

Swift

public var updatedAt: String


                    
                    
                    reward

Reward object data.

Declaration

Swift

public var reward: Reward?


                    
                    
                    certificate

Certificate object data.

Declaration

Swift

public var certificate: Certificate?


                    
                    
                    coupon

Coupon object data.

Declaration

Swift

public var coupon: Coupon?


                    
                    
                    notes

Notes of the redemption

Declaration

Swift

public var notes: [AnyCodable]


                    
                    
                    init(id:redemptionStatus:memberName:memberId:redemptionAmount:metricName:redemptionUnit:metricDisplayName:metricAmount:sku:integrationId:shippingAddress:imageUrl:thumbImageUrl:useStart:useEnd:createdAt:updatedAt:reward:certificate:coupon:notes:)

Undocumented

Declaration

Swift

public init(id: Int, redemptionStatus: RedemptionStatus, memberName: String, memberId: String, redemptionAmount: String,
            metricName: String, redemptionUnit: String, metricDisplayName: String, metricAmount: String,
            sku: String, integrationId: String, shippingAddress: ShippingAddress?, imageUrl: String,
            thumbImageUrl: String, useStart: String, useEnd: String, createdAt: String, updatedAt: String,
            reward: Reward?, certificate: Certificate?, coupon: Coupon?, notes: [AnyCodable])


                    
                    
                    RedemptionStatus

Enum representing status of the redemption.

Declaration

Swift

public enum RedemptionStatus : String, Codable


                    
                    
                    ShippingAddress

The shipping address of the reward response.

Declaration

Swift

public struct ShippingAddress : Codable, Equatable


                    
                    
                    init(from:)

Declaration

Swift

public init(from decoder: Decoder) throws