Payloads

ClientIdentityProvider

Declared In

SNRClientIdentityProvider.h

Declaration

SwiftObjective-C

enum ClientIdentityProvider: Int {
	synerise,
	oauth,
	facebook,
	apple
}

typedef NS_ENUM(NSUInteger, SNRClientIdentityProvider) {
    SNRClientIdentityProviderSynerise,
    SNRClientIdentityProviderOAuth,
    SNRClientIdentityProviderFacebook,
    SNRClientIdentityProviderApple
}

Functions

Converts from HostApplicationType to String.

SwiftObjective-C

func SNR_ClientIdentityProviderToString(_: ClientIdentityProvider) -> String

NSString * SNR_ClientIdentityProviderToString(SNRClientIdentityProvider type)

---

Converts from String to HostApplicationType.

SwiftObjective-C

func SNR_StringToClientIdentityProvider(_: String) -> ClientIdentityProvider

SNRClientIdentityProvider SNR_StringToClientIdentityProvider(NSString * _Nullable string)

---

---

ClientOAuthAuthenticationContext

Declared In

SNRClientOAuthAuthenticationContext.h

Related To

ClientAgreements

Inherits From

BaseModel

Declaration

SwiftObjective-C

class ClientOAuthAuthenticationContext: BaseModel

@interface SNRClientOAuthAuthenticationContext : SNRBaseModel

Properties

Property	Type	Optional	Default	Description
agreements	ClientAgreements	yes	nil	Object that stores all agreements for a customer
attributes	[AnyHashable: Any]	yes	[]	Additional custom attributes for a customer

Initializers

SwiftObjective-C

init()

- (instancetype)init

---

---

ClientFacebookAuthenticationContext

Declared In

SNRClientOAuthAuthenticationContext.h

Related To

ClientAgreements

Inherits From

BaseModel

Declaration

SwiftObjective-C

class ClientOAuthAuthenticationContext: BaseModel

@interface SNRClientOAuthAuthenticationContext : SNRBaseModel

Properties

Property	Type	Optional	Default	Description
agreements	ClientAgreements	yes	nil	Object that stores all agreements for a customer
attributes	[AnyHashable: Any]	yes	[]	Additional custom attributes for a customer

Initializers

SwiftObjective-C

init()

- (instancetype)init

---

---

ClientAppleSignInAuthenticationContext

Declared In

SNRClientAppleSignInAuthenticationContext.h

Related To

ClientAgreements

Inherits From

BaseModel

Declaration

SwiftObjective-C

class ClientAppleSignInAuthenticationContext: BaseModel

@interface SNRClientAppleSignInAuthenticationContext : SNRBaseModel

Properties

Property	Type	Optional	Default	Description
agreements	ClientAgreements	yes	nil	Object that stores all agreements for a customer
attributes	[AnyHashable: Any]	yes	[]	Additional custom attributes for a customer

Initializers

SwiftObjective-C

init()

- (instancetype)init

---

---

ClientRegisterAccountContext

Declared In

SNRClientRegisterAccountContext.h

Related To

ClientSex
ClientAgreements

Inherits From

BaseModel

Declaration

SwiftObjective-C

class ClientRegisterAccountContext: BaseModel

@interface SNRClientRegisterAccountContext : SNRBaseModel

Properties

Property	Type	Optional	Description
email	String	no	Customer’s email
password	String	no	Customer’s password
firstName	String	yes	Customer’s first name
lastName	String	yes	Customer’s last name
customId	String	yes	Customer’s custom ID
sex	ClientSex	yes	Customer’s sex
phone	String	yes	Customer’s phone
company	Sex	yes	Customer’s company
address	String	yes	Customer’s address
city	String	yes	Customer’s city
province	String	yes	Customer’s province code
zipCode	String	yes	Customer’s ZIP code
countryCode	String	yes	Customer’s country code
agreements	ClientAgreements	yes	Customer’s agreements
attributes	[AnyHashable: Any]	yes	Customer’s attributes

Initializers

SwiftObjective-C

init(email: String, password: String)

- (instancetype)initWithEmail:(nonnull NSString *)email andPassword:(nonnull NSString *)password

---

---

ClientUpdateAccountContext

Declared In

SNRClientUpdateAccountContext.h

Related To

ClientSex
ClientAgreements

Inherits From

BaseModel

Conforms To

NSSecureCoding

Declaration

SwiftObjective-C

class ClientUpdateAccountContext: BaseModel

@interface SNRClientUpdateAccountContext : SNRBaseModel

Properties

Property	Type	Optional	Description
email	String	yes	Customer’s email
phone	String	yes	Customer’s phone
customId	String	yes	Customer’s custom ID
uuid	String	yes	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	yes	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
avatarUrl	String	yes	Customer’s avatar URL
agreements	ClientAgreements	no	Customer’s agreements
attributes	[AnyHashable: Any]	yes	Customer’s attributes

Initializers

SwiftObjective-C

init()

- (instancetype)init

---

---

ClientPasswordResetRequestContext

Declared In

SNRClientPasswordResetRequestContext.h

Inherits From

BaseModel

Declaration

SwiftObjective-C

class ClientPasswordResetRequestContext: BaseModel

@interface SNRClientPasswordResetRequestContext : SNRBaseModel

Properties

Property	Type	Optional	Description
email	Bool	no	Customer’s email

Initializers

SwiftObjective-C

init(email: String)

- (instancetype)initWithEmail:(nonnull NSString *)email

---

---

ClientPasswordResetConfirmationContext

Declared In

SNRClientPasswordResetConfirmationContext.h

Inherits From

BaseModel

Declaration

SwiftObjective-C

class ClientPasswordResetConfirmationContext: BaseModel

@interface SNRClientPasswordResetConfirmationContext : SNRBaseModel

Properties

Property	Type	Optional	Description
password	String	no	Customer’s password
token	String	no	Customer’s token

Initializers

SwiftObjective-C

init(password: String, token: String)

- (instancetype)initWithPassword:(nonnull NSString *)password andToken:(nonnull NSString *)token

---

---

PromotionsApiQuery

The object to set parameters easily for fetching promotions from API.

Declared In

SNRPromotionsApiQuery.h

Related To

PromotionResponse
Promotion

Inherits From

NSObject

Declaration

SwiftObjective-C

class PromotionsApiQuery: NSObject

@interface SNRPromotionsApiQuery : NSObject

Properties

Property	Type	Optional	Default	Description
statuses	[SNRPromotionStatusString]	no	[]	List of promotion statuses for query
types	[SNRPromotionTypeString]	no	[]	List of promotion types for query
sorting	[[SNRPromotionSortingKey: SNRApiQuerySortingOrderString]]	yes	[]	Specifies sorting rules for items in the response
limit	Int	no	100	Limit of items per page in the response
page	Int	no	1	Page number
includeMeta	Bool	no	false	Specifies if meta data should be included in the response

Note:

• Check the list of promotion sorting keys available in Loyalty - Promotion sorting options section.
• See ApiQuerySortingOrderString to check ordering options.

Initializers

SwiftObjective-C

init()

- (instancetype)init

---

---

DocumentsApiQueryType

Declared In

SNRDocumentsApiQueryType.h

Declaration

SwiftObjective-C

enum DocumentsApiQueryType: Int {
	bySchema
}

typedef NS_ENUM(NSInteger, SNRDocumentsApiQueryType) {
    SNRDocumentsApiQueryTypeBySchema
}

---

---

DocumentsApiQuery

The object to set parameters easily for fetching documents from API.

Declared In

SNRDocumentsApiQuery.h

Related To

DocumentsApiQueryType

Inherits From

NSObject

Declaration

SwiftObjective-C

class DocumentsApiQuery: NSObject

@interface SNRDocumentsApiQuery : NSObject

Properties

Property	Type	Optional	Default	Description
type	DocumentsApiQueryType	no	.bySchema	Query type
typeValue	String	no	nil	Value for query type
version	String	yes	nil	Specifies document version

Initializers

SwiftObjective-C

init(type: DocumentsApiQueryType, value: String)

- (instancetype)initWithType:(SNRDocumentsApiQueryType)type typeValue:(nonnull NSString *)typeValue

---

---

ClientEventsApiQuery

The object to set parameters easily for fetching client events from API.

Declared In

SNRClientEventsApiQuery.h

Inherits From

NSObject

Declaration

SwiftObjective-C

class ClientEventsApiQuery: NSObject

@interface SNRClientEventsApiQuery : NSObject

Properties

Property	Type	Optional	Default	Description
actions	[String]	no	[]	Specifies event actions for query
timeFrom	String	yes	nil	Specifies time from for query
timeTo	String	yes	nil	Specifies time to for query
limit	String	no	100	Limit of items in the response

Initializers

SwiftObjective-C

init()

- (instancetype)init

---

---

ApiQuerySortingOrder

Declared In

SNRApiQuerySortingOrder.h

Declaration

SwiftObjective-C

enum ApiQuerySortingOrder: Int {
	ascending,
	descending
}

typedef NS_ENUM(NSUInteger, SNRApiQuerySortingOrder) {
    SNRApiQuerySortingOrderAscending,
    SNRApiQuerySortingOrderDescending
}

Functions

Converts from ApiQuerySortingOrder to String.

SwiftObjective-C

func SNR_ApiQuerySortingOrderToString(_: ApiQuerySortingOrder) -> String

NSString * SNR_ApiQuerySortingOrderToString(SNRApiQuerySortingOrder type)

---

Converts from String to ApiQuerySortingOrder.

SwiftObjective-C

func SNR_StringToApiQuerySortingOrder(_: String) -> ApiQuerySortingOrder

SNRApiQuerySortingOrder SNR_StringToApiQuerySortingOrder(NSString * _Nullable string)

Note:

The following string constants can be used in API Query objects:

• SNR_API_QUERY_SORTING_ASC
• SNR_API_QUERY_SORTING_DESC

---