Responses

BaseModel

Declared In

SNRBaseModel.h

Inherits From

NSObject

Declaration

class BaseModel: NSObject


ClientAccountInformation

Declared In

SNRClientAccountInformation.h

ClientSex
ClientAgreements

Inherits From

BaseModel

Conforms To

NSSecureCoding

Declaration

class ClientAccountInformation: BaseModel

Properties

Property Type Optional Description
clientId Int no Customer’s client ID
email String no Customer’s email
phone String yes Customer’s phone
customId String yes Customer’s custom ID
uuid String no Customer’s UUID
firstName String yes Customer’s first name
lastName String yes Customer’s last name
displayName String yes Customer’s display name
sex ClientSex no Customer’s sex
company String yes Customer’s company
address String yes Customer’s address
city String yes Customer’s city
province String yes Customer’s province
zipCode String yes Customer’s ZIP code
countryCode String yes Customer’s country code
birthDate String yes Customer’s birthdate
lastActivityDate Date no Customer’s last activity date
avatarUrl String yes Customer’s avatar URL
anonymous Bool no Customer’s anonymous flag
agreements ClientAgreements no Customer’s agreements
attributes [AnyHashable: Any] yes Customer’s attributes
tags [String] yes Customer’s tags
Important: All properties are read-only.


ClientSessionEndReason

Declared In

SNRClientSessionEndReason.h

Declaration

enum ClientSessionEndReason: Int {
	userSignOut,
	systemSignOut,
	sessionExpiration,
	securityException
}


ClientSex

Declared In

SNRClientSex.h

Declaration

enum ClientSex: Int {
	notSpecified,
	male,
	female,
	other
}

Functions

Converts from ClientSex to String.

func SNR_ClientSexToString(_: ClientSex) -> String


Converts from String to ClientSex.

func SNR_StringToClientSex(_: String) -> ClientSex



ClientAgreements

Declared In

SNRClientAgreements.h

Inherits From

BaseModel

Conforms To

NSSecureCoding
NSCopying

Declaration

class ClientAgreements: BaseModel

Properties

Property Type Optional Description
email Bool no Email agreement
sms Bool no SMS agreement
push Bool no Push Notifications agreement
bluetooth Bool no Bluetooth agreement
rfid Bool no RFID agreement
wifi Bool no WIFI agreement

Initializers

init()


ClientEventData

Declared In

SNRClientEventData.h

Event

Inherits From

BaseModel

Declaration

class ClientEventData: BaseModel

Properties

Property Type Optional Description
time String no Event’s time
label String no Event’s label
action String no Event’s action
client [AnyHashable: Any] no Event’s customer identification
params [AnyHashable: Any] no Event’s parameters
Important: All properties are read-only.

Methods

Gets customer ID.

func getClientID() -> Int


Gets customer UUID.

func getClientUUIDString() -> String?


Gets customer email.

func getClientEmail() -> String?



Token

Declared In

SNRToken.h

TokenOrigin

Inherits From

BaseModel

Declaration

class Token: BaseModel

Properties

Property Type Optional Description
tokenString String no Token as a raw string
tokenOrigin TokenOrigin no Token’s origin
expirationDate String yes Token’s expiration time
claimsDictionary String yes Token’s claims data

Methods

Checks if the token is near expiration.

func isNearExpiring() -> Bool



TokenOrigin

Declared In

SNRTokenOrigin.h

Declaration

enum TokenOrigin: Int {
	unknown,
	synerise,
	facebook,
	oauth,
	apple
}

Functions

Converts from TokenOrigin to String.

func SNR_TokenOriginToString(_: TokenOrigin) -> String


Converts from String to TokenOrigin.

func SNR_StringToTokenOrigin(_: String) -> TokenOrigin



PromotionResponse

Declared In

SNRPromotionResponse.h

PromotionResponseMetadata Promotion

Inherits From

BaseModel

Declaration

class PromotionResponse: BaseModel

Properties

Property Type Optional Description
metadata PromotionResponseMetadata yes Metadata of the promotion response
items [Promotion] no List of promotion items
Important: All properties are read-only.


PromotionResponseMetadata

Declared In

SNRPromotionResponseMetadata.h

PromotionResponse

Inherits From

BaseModel

Declaration

class PromotionResponseMetadata: BaseModel

Properties

Property Type Optional Description
totalCount Int no Total count of promotions
totalPages Int no Total count of pages
page Int no Current page
limit Int no Limit of promotions per page
code Int no HTTP code of the response
Important: All properties are read-only.


Promotion

Declared In

SNRPromotion.h

PromotionResponse
PromotionStatus
PromotionType PromotionDiscountType

Inherits From

BaseModel

Declaration

class Promotion: BaseModel

Properties

Property Type Optional Description
uuid String no Promotion’s UUID
code String no Promotion’s code
status PromotionStatus yes Promotion’s status
type PromotionType yes Promotion’s type
redeemLimitPerClient NSNumber yes Redemption limit per client
redeemQuantityPerActivation NSNumber yes Redemption quantity per activation
currentRedeemedQuantity NSNumber no Current redemption quantity
currentRedeemLimit NSNumber yes Current redemption limit
activationCounter NSNumber no Promotion’s activation counter
discountType PromotionDiscountType yes Discount value
discountValue NSNumber no Discount type
requireRedeemedPoints NSNumber yes Required redeemed points
priority NSNumber yes Promotion’s priority
price NSNumber no Item price
name String yes Promotion’s name
headline String yes Promotion’s headline
descriptionText String yes Promotion’s description
images [[AnyHashable: Any]] yes List of promotion images
startAt Date yes Start of a promotion
expireAt Date yes Expiration time of the promotion
lastingAt Date yes How long the promotion lasts
params [AnyHashable: Any] yes Promotion’s custom parameters
catalogIndexItems [String] yes List of item indexes
Important: All properties are read-only.


PromotionStatus

Declared In

SNRPromotionStatus.h

Promotion

Declaration

enum PromotionStatus: Int {
	none,
	active,
	assigned,
	redeemed
}

Functions

Converts from PromotionStatus to String.

func SNR_PromotionStatusToString(_: PromotionStatus) -> String


Converts from String to PromotionStatus.

func SNR_StringToPromotionStatus(_: String) -> PromotionStatus

Note

The following string constants can be used in PromotionsApiQuery object:

  • SNR_PROMOTION_STATUS_NONE
  • SNR_PROMOTION_STATUS_ACTIVE
  • SNR_PROMOTION_STATUS_ASSIGNED
  • SNR_PROMOTION_STATUS_REDEEMED


PromotionType

Declared In

SNRPromotionType.h

Promotion

Declaration

enum PromotionType: Int {
	unknown,
	membersOnly,
	custom,
	general
}

Functions

Converts from PromotionType to String.

func SNR_PromotionTypeToString(_: PromotionType) -> String


Converts from String to PromotionType.

func SNR_StringToPromotionType(_: String) -> PromotionType

Note

The following string constants can be used in PromotionsApiQuery object:

  • SNR_PROMOTION_TYPE_UNKNOWN
  • SNR_PROMOTION_TYPE_MEMBERS_ONLY
  • SNR_PROMOTION_TYPE_CUSTOM
  • SNR_PROMOTION_TYPE_GENERAL


PromotionDiscountType

Declared In

SNRPromotionDiscountType.h

Promotion

Declaration

enum PromotionDiscountType: Int {
	none,
	percent,
	amount,
	2For1,
	points,
	multibuy
}

Functions

Converts from PromotionDiscountType to String.

func SNR_PromotionDiscountTypeToString(_: PromotionDiscountType) -> String


Converts from String to PromotionDiscountType.

func SNR_StringToPromotionDiscountType(_: String) -> PromotionDiscountType



AssignVoucherResponse

Declared In

SNRAssignVoucherResponse.h

AssignVoucherData

Inherits From

BaseModel

Declaration

class AssignVoucherResponse: BaseModel

Properties

Property Type Optional Description
message String no Message from Voucher assignment response
assignVoucherData AssignVoucherData yes List of voucher data items
Important: All properties are read-only.


AssignVoucherData

Declared In

SNRAssignVoucherData.h

AssignVoucherResponse

Inherits From

BaseModel

Declaration

class AssignVoucherData: BaseModel

Properties

Property Type Optional Description
code String no Voucher’s code
expireIn Date yes Voucher’s expiration date
redeemAt Date yes Voucher’s redeem date
assignedAt Date yes Voucher’s assignment date
createdAt Date no Voucher’s creation date
updatedAt Date no Voucher’s update date
Important: All properties are read-only.


VoucherCodesResponse

Declared In

SNRVoucherCodesResponse.h

SNRVoucherCodesData

Inherits From

BaseModel

Declaration

class VoucherCodesResponse: BaseModel

Properties

Property Type Optional Description
items [VoucherCodesData] no List of voucher items
Important: All properties are read-only.


VoucherCodesData

Declared In

SNRVoucherCodesData.h

Inherits From

BaseModel

Declaration

class VoucherCodesData: BaseModel

Properties

Property Type Optional Description
code String no Voucher’s code
status VoucherStatus no Voucher’s status
clientId String no Voucher’s client ID
clientUuid String no Voucher’s client UUID
poolUuid String no Voucher’s pool ID
expireIn Date no Voucher’s expiration date
redeemAt Date no Voucher’s redemption date
assignedAt Date no Voucher’s assignment date
createdAt Date no Voucher’s creation date
updatedAt Date no Voucher’s update date
Important: All properties are read-only.


VoucherStatus

Declared In

SNRVoucherStatus.h

Declaration

enum VoucherStatus: Int {
	unassigned,
	assigned,
	redeemed,
	canceled
}

Functions

Converts from VoucherStatus to String.

func SNR_VoucherStatusToString(_: VoucherStatus) -> String


Converts from String to VoucherStatus.

func SNR_StringToVoucherStatus(_: String) -> VoucherStatus



RecommendationResponse

Declared In

SNRRecommendationResponse.h

Recommendation

Inherits From

BaseModel

Declaration

class RecommendationResponse: BaseModel

Properties

Property Type Optional Description
name String no Recommendations name
campaignHash String no Campaign Hash
campaignID String no Campaign ID
items [Recommendation] no List of recommendation items
Important: All properties are read-only.


Recommendation

Declared In

SNRRecommendation.h

RecommendationResponse

Inherits From

BaseModel

Declaration

class Recommendation: BaseModel

Properties

Property Type Optional Description
gtin String no Product’s GTIN
productRetailerPartNo String no Product’s ID
title String no Recommendation title
brand String no Product’s brand
category String no Product’s category
descriptionText String no Product’s description
gender String no Product’s gender parameter
color String no Product’s color
sizes [NSNumber] no List of sizes
priceValue String no Price value
effectivePriceValue String no Effective price
salePriceValue String no Sale price value
priceCurrency String no Price currency
link String no Product’s link
imageLink String no Product’s image link
additionalImageLinks [String] no List of additional image links
customAttributes [AnyHashable: Any] no Product’s custom recommendation attributes
Important: All properties are read-only.


RecommendationOptions

Declared In

SNRRecommendationOptions.h

Inherits From

BaseModel

Declaration

class RecommendationOptions: BaseModel

Properties

Property Type Optional Description
slug String no Unique identifier of a specific recommendation
productID String no Product ID attribute


ScreenViewResponse

Declared In

SNRScreenViewResponse.h

SNRScreenViewAudience

Inherits From

BaseModel

Declaration

class ScreenViewResponse: BaseModel

Properties

Property Type Optional Description
audience ScreenViewAudience no Audience of a screen view
identifier String no Screen View’s ID
hashString String no Screen View’s hash
path String no Screen View’s path
name String no Screen View’s name
priority NSNumber no Screen View’s priority
descriptionText String yes Screen View’s description
data AnyObject no Screen View’s data
version String no Version of a screen view
parentVersion String yes Parent version of a screen view
createdAt Date no Screen View’s creation date
updatedAt Date no Screen View’s update date
deletedAt Date yes Screen View’s deletion date
Important: All properties are read-only.


ScreenViewAudience

Declared In

SNRScreenViewAudience.h

SNRScreenViewResponse

Inherits From

BaseModel

Declaration

class ScreenViewAudience: BaseModel

Properties

Property Type Optional Description
IDs [String] yes Audience’s identifiers
query String yes Audience’s query
Important: All properties are read-only.
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.