Payloads

ClientIdentityProvider

Declared In

SNRClientIdentityProvider.h

Declaration

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

Functions

Converts from HostApplicationType to String.

func SNR_ClientIdentityProviderToString(_: ClientIdentityProvider) -> String


Converts from String to HostApplicationType.

func SNR_StringToClientIdentityProvider(_: String) -> ClientIdentityProvider



ClientOAuthAuthenticationContext

Declared In

SNRClientOAuthAuthenticationContext.h

ClientAgreements

Inherits From

BaseModel

Declaration

class ClientOAuthAuthenticationContext: BaseModel

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

init()


ClientFacebookAuthenticationContext

Declared In

SNRClientOAuthAuthenticationContext.h

ClientAgreements

Inherits From

BaseModel

Declaration

class ClientOAuthAuthenticationContext: BaseModel

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

init()


ClientAppleSignInAuthenticationContext

Declared In

SNRClientAppleSignInAuthenticationContext.h

ClientAgreements

Inherits From

BaseModel

Declaration

class ClientAppleSignInAuthenticationContext: BaseModel

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

init()


ClientRegisterAccountContext

Declared In

SNRClientRegisterAccountContext.h

ClientSex
ClientAgreements

Inherits From

BaseModel

Declaration

class ClientRegisterAccountContext: BaseModel

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

init(email: String, password: String)


ClientUpdateAccountContext

Declared In

SNRClientUpdateAccountContext.h

ClientSex
ClientAgreements

Inherits From

BaseModel

Conforms To

NSSecureCoding

Declaration

class ClientUpdateAccountContext: BaseModel

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

init()


ClientPasswordResetRequestContext

Declared In

SNRClientPasswordResetRequestContext.h

Inherits From

BaseModel

Declaration

class ClientPasswordResetRequestContext: BaseModel

Properties

Property Type Optional Description
email Bool no Customer’s email

Initializers

init(email: String)


ClientPasswordResetConfirmationContext

Declared In

SNRClientPasswordResetConfirmationContext.h

Inherits From

BaseModel

Declaration

class ClientPasswordResetConfirmationContext: BaseModel

Properties

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

Initializers

init(password: String, token: String)


PromotionsApiQuery

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

Declared In

SNRPromotionsApiQuery.h

PromotionResponse
Promotion

Inherits From

NSObject

Declaration

class PromotionsApiQuery: 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:

Initializers

init()


DocumentsApiQueryType

Declared In

SNRDocumentsApiQueryType.h

Declaration

enum DocumentsApiQueryType: Int {
	bySchema
}


DocumentsApiQuery

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

Declared In

SNRDocumentsApiQuery.h

DocumentsApiQueryType

Inherits From

NSObject

Declaration

class DocumentsApiQuery: 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

init(type: DocumentsApiQueryType, value: String)


ClientEventsApiQuery

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

Declared In

SNRClientEventsApiQuery.h

Inherits From

NSObject

Declaration

class ClientEventsApiQuery: 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

init()


ApiQuerySortingOrder

Declared In

SNRApiQuerySortingOrder.h

Declaration

enum ApiQuerySortingOrder: Int {
	ascending,
	descending
}

Functions

Converts from ApiQuerySortingOrder to String.

func SNR_ApiQuerySortingOrderToString(_: ApiQuerySortingOrder) -> String


Converts from String to ApiQuerySortingOrder.

func SNR_StringToApiQuerySortingOrder(_: String) -> ApiQuerySortingOrder

Note:

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

  • SNR_API_QUERY_SORTING_ASC
  • SNR_API_QUERY_SORTING_DESC
😕

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.