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:
ClientAgreements

Inherits From:
BaseModel

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 [] Optional identifier of authorization
Note: authID parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

Initializers:

constructor(modelObject?: IClientAuthContext)



ClientOAuthAuthenticationContext

Declared In:
lib/classes/models/Client/ClientOAuthAuthenticationContext.js

Related To:
ClientAgreements

Inherits From:
BaseModel

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 object yes [] Additional custom attributes of a customer

Initializers:

constructor()

constructor(modelObject?: IClientOAuthAuthenticationContext)


ClientSimpleAuthenticationData

Declared In:
lib/main/modules/ClientModule.js

Related To:
ClientSex
ClientAgreements

Inherits From:
BaseModel

Declaration:

class ClientSimpleAuthenticationData extends 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 yes Customer’s agreements
attributes object yes Customer’s attributes


ClientFacebookAuthenticationContext

Declared In:
lib/classes/models/Client/ClientOAuthAuthenticationContext.js

Related To:
ClientAgreements

Inherits From:
BaseModel

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 object yes [] Additional custom attributes of a customer

Initializers:

constructor()

constructor(modelObject?: IClientOAuthAuthenticationContext)


ClientAppleSignInAuthenticationContext

Declared In:
lib/classes/models/Client/ClientAppleSignInAuthenticationContext.js

Related To:
ClientAgreements

Inherits From:
BaseModel

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 object yes [] Additional custom attributes of a customer

Initializers:

constructor()


constructor(modelObject?: IClientAppleSignInAuthenticationContext)


ClientSessionEndReason

Declared In:
lib/classes/models/Client/ClientSessionEndReason.js

Declaration:

enum ClientSessionEndReason {
  NotSpecified = 'NOT_SPECIFIED',
  SessionExpiration = 'SESSION_EXPIRATION',
  SecurityException = 'SECURITY_EXCEPTION',
  UserSignOut = 'USER_SIGN_OUT',
  SystemSignOut = 'SYSTEM_SIGN_OUT',
  SessionDestroyed = 'SESSION_DESTROYED',
  ClientRejected = 'CLIENT_REJECTED',
  UserAccountDeleted = 'USER_ACCOUNT_DELETED'
}

Functions:

Converts from ClientSessionEndReason to string.

function ClientSessionEndReasonToString(reason: ClientSessionEndReason): string


Converts from string to ClientSessionEndReason.

function ClientSessionEndReasonFromString(string: string): ClientSessionEndReason



ClientSignOutMode

Declared In:
lib/classes/models/Client/ClientSignOutMode.js

Declaration:

enum ClientSignOutMode {
  SignOut = 'SIGN_OUT',
  SignOutWithSessionDestroy = 'SIGN_OUT_WITH_SESSION_DESTROY'
}

Functions:

Converts from ClientSignOutMode to string.

function ClientSignOutModeToString(mode: ClientSignOutMode): string



ClientAccountInformation

Model representating the customer information.

WARNING: This is a read-only class and it is not meant to be instantiated directly.

Declared In:
lib/classes/models/Client/ClientAccountInformation.js

Related To: ClientSex
ClientAgreements

Inherits From:
BaseModel

Declaration:

class ClientAccountInformation extends BaseModel

Properties:

Property Type Optional Description
clientId number no Customer’s ID
email 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 yes Customer’s attributes
tags Array yes Customer’s tags


ClientAccountUpdateBasicInformationContext

Declared In:
lib/classes/models/Client/ClientAccountUpdateBasicInformationContext.js

Related To:
ClientSex
ClientAgreements

Inherits From:
BaseModel

Declaration:

class ClientAccountUpdateBasicInformationContext extends BaseModel

Properties:

Property Type Optional Description
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
phone string yes Customer’s phone number
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 object yes Customer’s attributes

Initializers:

constructor(modelObject?: IClientAccountUpdateBasicInformationContext)



ClientAccountUpdateContext

Declared In:
lib/classes/models/Client/ClientAccountUpdateContext.js

Related To:
ClientSex
ClientAgreements

Inherits From:
BaseModel

Declaration:

class ClientAccountUpdateContext extends BaseModel

Properties:

Property Type Optional Description
email string yes Customer’s email
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
phone string yes Customer’s phone number
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 object yes Customer’s attributes

Initializers:

constructor(modelObject?: IClientAccountUpdateContext)



ClientAccountRegisterContext

Declared In:
lib/classes/models/Client/ClientAccountRegisterContext.js

Related To:
ClientSex
ClientAgreements

Inherits From:
BaseModel

Declaration:

class ClientAccountRegisterContext extends 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 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 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:
BaseModel

Declaration:

interface IClientAgreements {
  email?: boolean;
  sms?: boolean;
  push?: boolean;
  bluetooth?: boolean;
  rfid?: boolean;
  wifi?: boolean;
}

class ClientAgreements extends BaseModel

Properties:

Property Type Optional Description
email 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:
TokenOrigin

Inherits From:
BaseModel

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

😕

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.

Close modal icon Placeholder alt for modal to satisfy link checker