Client
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
ClientAuthContext
Declared In
lib/classes/models/Client/ClientAuthContext.js
Related To
Inherits From
Declaration
interface IClientAuthContext {
authID?: string;
agreements?: IClientAgreements;
attributes?: object;
}
class ClientAuthContext extends BaseModel
Properties
Property | Type | Optional | Default | Description |
---|---|---|---|---|
agreements | ClientAgreements |
yes | nil | Object that stores all agreements of a customer |
attributes | object |
yes | [] | Additional custom attributes of a customer |
authID | string |
yes | [] | User’s unique identifier, needed to decrease the number of generated UUIDs |
Initializers
constructor(modelObject?: IClientAuthContext)
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 of a customer |
attributes | Array<object> |
yes | [] | Additional custom attributes of 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 of a customer |
attributes | Array<object> |
yes | [] | Additional custom attributes of 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 of a customer |
attributes | Array<object> |
yes | [] | Additional custom attributes of a customer |
Initializers
constructor()
constructor(modelObject?: IClientAppleSignInAuthenticationContext)
ClientAccountInformation
Model representating the customer information.
Declared In
lib/classes/models/Client/ClientAccountInformation.js
Related To
Inherits From
Declaration
class ClientAccountInformation extends BaseModel
Properties
Property | Type | Optional | Description |
---|---|---|---|
clientId | number |
no | Customer’s ID |
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 | boolean |
no | Customer’s anonymous flag |
agreements | ClientAgreements |
no | Customer’s agreements |
attributes | Array<object> |
yes | Customer’s attributes |
tags | Array<string> |
yes | Customer’s tags |
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)
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)
ClientSex
Declared In
lib/classes/models/Client/ClientSex.js
Declaration
enum ClientSex {
NotSpecified = 'NOT_SPECIFIED',
Male = 'MALE',
Female = 'FEMALE',
Other = 'OTHER',
}
Functions
Converts from ClientSex
to string
.
function ClientSexToString(clientSex: ClientSex): string
Converts from string
to ClientSex
.
function ClientSexFromString(string: string): ClientSex
ClientAgreements
Declared In
lib/classes/models/Client/ClientAgreements.js
Inherits From
Declaration
interface IClientAgreements {
email?: boolean;
sms?: boolean;
push?: boolean;
bluetooth?: boolean;
rfid?: boolean;
wifi?: boolean;
}
class ClientAgreements extends BaseModel
Properties
Property | Type | Optional | Description |
---|---|---|---|
boolean |
no | Email agreement | |
sms | boolean |
no | SMS agreement |
push | boolean |
no | Push Notifications agreement |
bluetooth | boolean |
no | Bluetooth agreement |
rfid | boolean |
no | RFID agreement |
wifi | boolean |
no | WIFI agreement |
Initializers
constructor()
constructor(modelObject?: IClientAgreements)
Token
Declared In
lib/classes/models/Token/Token.js
Related To
Inherits From
Declaration
class Token extends 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 |
TokenOrigin
Declared In
lib/classes/models/Token/TokenOrigin.js
Declaration
enum TokenOrigin {
Unknown = 'UNKNOWN',
Synerise = 'SYNERISE',
Facebook = 'FACEBOOK',
Oauth = 'OAUTH',
}
Functions
Converts from TokenOrigin
to string
.
function TokenOriginToString(tokenOrigin: TokenOrigin): string
Converts from string
to TokenOrigin
.
function TokenOriginFromString(string: string): TokenOrigin