Payloads
ClientIdentityProvider
Declared In
SNRClientIdentityProvider.h
Declaration
enum ClientIdentityProvider: Int {
synerise,
oauth,
facebook,
apple,
google
}
Functions
Converts from ClientIdentityProvider to String.
func SNR_ClientIdentityProviderToString(_: ClientIdentityProvider) -> String
Converts from String to ClientIdentityProvider.
func SNR_StringToClientIdentityProvider(_: String) -> ClientIdentityProvider
ClientSignOutMode
Declared In
SNRClientSignOutMode.h
Declaration
enum ClientSignOutMode: Int {
.signOut,
.signOutWithSessionDestroy
}
ClientConditionalAuthenticationContext
Declared In
SNRClientConditionalAuthContext.h
Related To
Inherits From
Declaration
class ClientConditionalAuthContext: BaseModel
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| agreements | ClientAgreements |
yes | nil | Object that stores all agreements of a customer |
| attributes | [AnyHashable: Any] |
yes | [] | Additional custom attributes of a customer |
Initializers
init()
ClientAuthenticationContext
Declared In
SNRClientAuthenticationContext.h
Related To
Inherits From
Declaration
class ClientAuthenticationContext: BaseModel
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| agreements | ClientAgreements |
yes | nil | Object that stores all agreements of a customer |
| attributes | [AnyHashable: Any] |
yes | [] | Additional custom attributes of a customer |
Initializers
init()
ClientOAuthAuthenticationContext
Declared In
SNRClientOAuthAuthenticationContext.h
Related To
Inherits From
Declaration
class ClientOAuthAuthenticationContext: BaseModel
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| agreements | ClientAgreements |
yes | nil | Object that stores all agreements of a customer |
| attributes | [AnyHashable: Any] |
yes | [] | Additional custom attributes of a customer |
Initializers
init()
ClientFacebookAuthenticationContext
Declared In
SNRClientOAuthAuthenticationContext.h
Related To
Inherits From
Declaration
class ClientOAuthAuthenticationContext: BaseModel
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| agreements | ClientAgreements |
yes | nil | Object that stores all agreements of a customer |
| attributes | [AnyHashable: Any] |
yes | [] | Additional custom attributes of a customer |
Initializers
init()
ClientAppleSignInAuthenticationContext
Declared In
SNRClientAppleSignInAuthenticationContext.h
Related To
Inherits From
Declaration
class ClientAppleSignInAuthenticationContext: BaseModel
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| agreements | ClientAgreements |
yes | nil | Object that stores all agreements of a customer |
| attributes | [AnyHashable: Any] |
yes | [] | Additional custom attributes of a customer |
Initializers
init()
ClientRegisterAccountContext
Declared In
SNRClientRegisterAccountContext.h
Related To
Inherits From
Declaration
class ClientRegisterAccountContext: BaseModel
Properties
| Property | Type | Optional | Description |
|---|---|---|---|
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 | String |
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
Related To
Inherits From
Conforms To
Declaration
class ClientUpdateAccountContext: BaseModel
Properties
| Property | Type | Optional | Description |
|---|---|---|---|
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
Declaration
class ClientPasswordResetRequestContext: BaseModel
Properties
| Property | Type | Optional | Description |
|---|---|---|---|
Bool |
no | Customer’s email |
Initializers
init(email: String)
ClientPasswordResetConfirmationContext
Declared In
SNRClientPasswordResetConfirmationContext.h
Inherits From
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
Related To
Inherits From
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:
- Check the list of promotion sorting keys available in Loyalty - Promotion sorting options section.
- See
ApiQuerySortingOrderStringto check ordering options.
Initializers
init()
PromotionIdentifier
Declared In
SNRPromotionIdentifier.h
Inherits From
Declaration
class PromotionIdentifier: BaseModel
Initializers
init(uuid: String)
init(code: String)
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
Related To
Inherits From
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
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_ASCSNR_API_QUERY_SORTING_DESC
RecommendationFiltersJoinerRule
Declared In
SNRRecommendationOptions.h
Declaration
enum RecommendationFiltersJoinerRule: Int {
and,
or,
replace
}
Functions
Converts from RecommendationFiltersJoinerRule to String.
func SNR_RecommendationFiltersJoinerRuleToString(_: RecommendationFiltersJoinerRule) -> String
RecommendationOptions
Declared In
SNRRecommendationOptions.h
Related To
RecommendationFiltersJoinerRule
Declaration
class RecommendationOptions
Properties
| Property | Type | Optional | Description |
|---|---|---|---|
| slug | String |
no | Unique identifier of a specific recommendation |
| productID | String |
no | Product identifier |
| productIDs | [String] |
no | List of product identifiers |
| itemsExcluded | [String] |
no | Items that will be excluded from the generated recommendations |
| additionalFilters | String |
no | Additional filters. These are merged with the campaign’s own filters according to the logic in filtersJoiner |
| filtersJoiner | RecommendationFiltersJoinerRule |
no | Defines the logic of merging additionalFilters with the campaign’s existing filters |
| additionalElasticFilters | String |
no | Additional elastic filters. These are merged with the campaign’s own elastic filters according to the logic in elasticFiltersJoiner |
| elasticFiltersJoiner | RecommendationFiltersJoinerRule |
no | Defines the logic of merging additionalElasticFilters with the campaign’s existing elastic filters |
| displayAttribute | [String] |
no | An array of item attributes which value will be returned in a recommendation response |
| includeContextItems | Bool |
no | When true, the recommendation response will include context item metadata |
