Payloads
ClientOAuthAuthenticationContext
Declared In
lib/classes/models/Client/ClientOAuthAuthenticationContext.js
Related To
Inherits From
Declaration
interface IClientOAuthAuthenticationContext {
authID?: string;
agreements?: IClientAgreements;
attributes?: object;
}
class ClientOAuthAuthenticationContext extends BaseModel
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| agreements | ClientAgreements |
yes | nil | Object that stores all agreements for a customer |
| attributes | Array<object> |
yes | [] | Additional custom attributes for a customer |
Initializers
constructor()
constructor(modelObject?: IClientOAuthAuthenticationContext)
ClientFacebookAuthenticationContext
Declared In
lib/classes/models/Client/ClientOAuthAuthenticationContext.js
Related To
Inherits From
Declaration
interface IClientOAuthAuthenticationContext {
authID?: string;
agreements?: IClientAgreements;
attributes?: object;
}
class ClientOAuthAuthenticationContext extends BaseModel
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| agreements | ClientAgreements |
yes | nil | Object that stores all agreements for a customer |
| attributes | Array<object> |
yes | [] | Additional custom attributes for a customer |
Initializers
constructor()
constructor(modelObject?: IClientOAuthAuthenticationContext)
ClientAppleSignInAuthenticationContext
Declared In
lib/classes/models/Client/ClientAppleSignInAuthenticationContext.js
Related To
Inherits From
Declaration
interface IClientAppleSignInAuthenticationContext {
authID?: string;
agreements?: IClientAgreements;
attributes?: object;
}
class ClientAppleSignInAuthenticationContext extends BaseModel
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| agreements | ClientAgreements |
yes | nil | Object that stores all agreements for a customer |
| attributes | Array<object> |
yes | [] | Additional custom attributes for a customer |
Initializers
constructor()
constructor(modelObject?: IClientAppleSignInAuthenticationContext)
ClientAccountRegisterContext
Declared In
lib/classes/models/Client/ClientAccountRegisterContext.js
Related To
Inherits From
Declaration
class ClientAccountRegisterContext extends 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 | Array<object> |
yes | Customer’s attributes |
Initializers
constructor(email: string, password: string, modelObject?: IClientAccountRegisterContext)
ClientAccountUpdateContext
Declared In
lib/classes/models/Client/ClientAccountUpdateContext.js
Related To
Inherits From
Declaration
class ClientAccountUpdateContext extends 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 | Array<object> |
yes | Customer’s attributes |
Initializers
constructor(modelObject?: IClientAccountUpdateContext)
ClientIdentityProvider
Declared In
lib/classes/models/Client/ClientIdentityProvider.js
Declaration
enum ClientIdentityProvider {
Facebook = 'FACEBOOK',
Google = 'GOOGLE',
Oauth = 'OAUTH',
Synerise = 'SYNERISE',
Unknown = 'UNKNOWN',
}
Functions
Converts from ClientIdentityProvider to string.
function ClientIdentityProviderToString(clientIdentityProvider: ClientIdentityProvider): string
Converts from string to ClientIdentityProvider.
function ClientIdentityProviderFromString(string: string): ClientIdentityProvider
RecommendationOptions
Declared In
lib/classes/content/RecommendationOptions.js
Declaration
class RecommendationOptions
Properties
| Property | Type | Optional | Description |
|---|---|---|---|
| slug | string |
no | Unique identifier of a specific recommendation |
| productID | string |
no | Product ID attribute |
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()
DocumentsApiQueryType
Declared In
lib/classes/api_queries/DocumentsApiQueryType.js
Declaration
enum DocumentsApiQueryType {
SCHEMA = 'by-schema',
}
DocumentsApiQuery
The object to set parameters easily for fetching documents from API.
Declared In
lib/classes/api_queries/DocumentsApiQuery.js
Related To
Declaration
class DocumentsApiQuery
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
constructor(type: DocumentsApiQueryType, typeValue: string, version: string)
ApiQuerySortingOrder
Declared In
lib/classes/api_queries/BaseApiQuery.js
Declaration
enum ApiQuerySortingOrder {
Ascending = 'asc',
Descending = 'desc',
}