Client

ClientIdentityProvider

Declared In:
lib/enums/client/identity_provider.dart

Declaration:

enum IdentityProvider {
  synerise('SYNERISE'),
  facebook('FACEBOOK'),
  google('GOOGLE'),
  oauth('OAUTH'),
  apple('APPLE'),
  unknown('UNKNOWN');
  }

ClientAuthContext

Declared In:
lib/model/client/client_auth_context.dart

Related To:
ClientAgreements

Declaration: 

class ClientAuthContext

Properties:

Property Type Optional Default Description
authId String yes null Optional identifier of authorization
agreements ClientAgreements yes null Object that stores all agreements of a customer
attributes HashMap<String, Object> yes null Additional custom attributes of a customer
Note: authId parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

Initializers: 

ClientAuthContext({this.authId, this.agreements, this.attributes})

Example: 

ClientAuthContext clientAuthContext = ClientAuthContext(
authId: 'AUTH_ID', 
agreements: agreements, 
attributes: attributes
);

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/model/client/client_account_information.dart

Related To:
ClientSex
ClientAgreements

Declaration:

class ClientAccountInformation

Properties:

Property Type Optional Description
clientId int 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 bool no Customer’s anonymous flag
agreements ClientAgreements no Customer’s agreements
attributes HashMap<String, Object> yes Customer’s attributes
tags List yes Customer’s tags

ClientAccountUpdateContext

Declared In:
lib/model/client/client_account_update_context.dart

Related To:
ClientSex
ClientAgreements

Declaration: 

class ClientAccountUpdateContext

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 HashMap<String, Object> yes Customer’s attributes

Initializers: 

ClientAccountUpdateContext({
  this.email,
  this.password,
  this.firstName,
  this.lastName,
  this.sex,
  this.phone,
  this.company,
  this.address,
  this.city,
  this.zipcode,
  this.countrycode,
  this.province,
  this.uuid,
  this.customId,
  this.agreements,
  this.attributes
});

Example:

ClientAccountUpdateContext clientAccountUpdateContext = ClientAccountUpdateContext(
  email: email,
  password: password,
  firstName: firstName,
  lastName: lastName,
  sex: sex,
  phone: phone,
  company: company,
  address: address,
  city: city,
  zipcode: zipcode,
  countrycode: countrycode,
  province: province);

ClientAccountRegisterContext

Declared In:
lib/model/client/client_account_register_context.dart

Related To:
ClientSex
ClientAgreements

Declaration: 

class ClientAccountRegisterContext

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 HashMap<String, Object> yes Customer’s attributes

Initializers:

ClientAccountRegisterContext({
  required this.email,
  required this.password,
  this.firstName,
  this.lastName,
  this.sex,
  this.phone,
  this.company,
  this.address,
  this.city,
  this.zipcode,
  this.countrycode,
  this.province,
  this.uuid,
  this.customId,
  this.agreements,
  this.attributes
})

Example: 

ClientAccountRegisterContext clientAccountRegisterContext = ClientAccountRegisterContext(email: "EMAIL", password: "PASSWORD");

ClientSimpleAuthenticationData

Declared In:
lib/model/client/client_simple_authentication_data.dart

Related To:
ClientSex
ClientAgreements

Declaration:

class ClientSimpleAuthenticationData

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 Map<String, Object> yes Customer’s attributes

Initializers: 

ClientAccountUpdateContext({
  this.email,
  this.password,
  this.firstName,
  this.lastName,
  this.sex,
  this.phone,
  this.company,
  this.address,
  this.city,
  this.zipcode,
  this.countrycode,
  this.province,
  this.uuid,
  this.customId,
  this.agreements,
  this.attributes
});

ClientSex

Declared In:
lib/enums/client/client_sex.dart

Declaration:

enum ClientSex {
  notSpecified('NOT_SPECIFIED'),
  male('MALE'),
  female('FEMALE'),
  other('OTHER');
}

ClientAgreements

Declared In:
lib/model/client/client_agreements.dart

Declaration: 

class ClientAgreements

Properties:

Property Type Optional Description
email bool no Email agreement
sms bool no SMS agreement
push bool no Push notifications agreement
bluetooth bool no Bluetooth agreement
rfid bool no RFID agreement
wifi bool no WIFI agreement

Initializers: 

ClientAgreements({this.email, this.sms, this.push, this.bluetooth, this.rfid, this.wifi})

Token

Declared In:
lib/model/client/token.dart

Related To:
TokenOrigin

Declaration:

class Token

Properties:

Property Type Optional Description
tokenString String no Token as a raw string
origin TokenOrigin no Token’s origin
expirationDate DateTime no Token’s expiration time

TokenOrigin

Declared In:
lib/enums/client/token_origin.dart

Declaration:

enum TokenOrigin {
  synerise('SYNERISE'),
  facebook('FACEBOOK'),
  google('GOOGLE'),
  oauth('OAUTH'),
  apple('APPLE'),
  simpleAuth('SIMPLE_AUTH'),
  anonymous('ANONYMOUS'),
  unknown('UNKNOWN');
}

ClientConditionalAuthenticationContext

Declared In:
lib/model/client/client_conditional_auth_context.dart

Related To:
ClientAgreements

Declaration: 

class ClientCondtitionalAuthContext {

Properties:

Property Type Optional Description
agreements ClientAgreements yes Object that stores all agreements of a customer
attributes Map<String, Object> yes Additional custom attributes of a customer

Initializers: 

ClientCondtitionalAuthContext({this.agreements, this.attributes});

ClientAuthenticationContext

Declared In:
lib/model/client/client_auth_context.dart

Related To:
ClientAgreements

Declaration: 

class ClientAuthContext

Properties:

Property Type Optional Description
agreements ClientAgreements yes Object that stores all agreements of a customer
attributes Map<String, Object> yes Additional custom attributes of a customer
authId String yes Unique authID

Initializers: 

ClientAuthContext({this.authId, this.agreements, this.attributes});

ClientConditionalAuthResult

Declared In:
lib/model/client/client_conditional_auth_result.dart

Declaration: 

class ClientConditionalAuthResult

Properties:

Property Type Optional Description
status ClientConditionalAuthStatus no Status of the authentication
conditions List yes Authentication conditions
Important: All properties are read-only.

ClientConditionalAuthStatus

Declared In:
lib/enums/client/client_conditional_auth_status.dart

Declaration: 

enum ClientConditionalAuthStatus {
  success('SUCCESS'),
  unauthorized('UNAUTHORIZED'),
  activationRequired('ACTIVATION_REQUIRED'),
  registrationRequired('REGISTRATION_REQUIRED'),
  approvalRequired('APPROVAL_REQUIRED'),
  termsAcceptanceRequired('TERMS_ACCEPTANCE_REQUIRED'),
  mfaRequired('MFA_REQUIRED');
  }

Functions:

Converts from ClientConditionalAuthStatus to String. 

String getClientConditionalAuthStatusAsString() {

Converts from String to ClientConditionalAuthStatus. 

static ClientConditionalAuthStatus? getClientConditionalAuthStatusFromString(String string) {

ClientSignOutMode

Declared In:
lib/enums/client/client_sign_out_mode.dart

Declaration: 

enum ClientSignOutMode {
  signOut('SIGN_OUT'),
  signOutWithSessionDestroy('SIGN_OUT_WITH_SESSION_DESTROY');

Functions:

Converts from ClientSignOutMode to String. 

String clientSignOutModeAsString() {

Converts from String to ClientSignOutMode. 

static ClientSignOutMode? getClientSignOutModeFromString(String string) {

😕

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