Client

ClientIdentityProvider

Declared In

lib/enums/client/identity_provider.dart

Declaration

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

Functions

Converts from String to ClientIdentityProvider.

Future<String> getIdentityProviderByString(String String)


ClientAuthContext

Declared In

lib/model/client/client_auth_context.dart

ClientAttributes
ClientAgreements

Declaration

class ClientAuthContext {
  String? authId;
  ClientAgreements? agreements;
  ClientAttributes? attributes;

Properties

Property Type Optional Default Description
agreements ClientAgreements yes [] Object that stores all agreements of a customer
authId String yes [] Additional custom attributes of a customer
attributes ClientAttributes yes [] Userโ€™s unique identifier, needed to decrease the int of generated UUIDs

Initializers

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

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 Boolean no Customer’s anonymous flag
agreements ClientAgreements no Customer’s agreements
attributes Object yes Customer’s attributes
tags List<String> yes Customer’s tags


ClientAccountUpdateContext

Declared In

lib/model/client/client_account_update_context.dart

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 no Customer’s agreements
attributes Object yes Customer’s attributes

Initializers

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

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

Initializers

ClientAccountRegisterContext clientAccountRegisterContext = ClientAccountRegisterContext(
        email: email,
        password: password);


ClientSex

Declared In

lib/enums/client/client_sex.dart

Declaration

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

Functions

Converts from String to ClientSex.

ClientSex clientSex = getClientSexFromString(Strin string)



ClientAgreements

Declared In

lib/model/client/client_agreements.dart

Declaration

class ClientAgreements {
  bool? email;
  bool? sms;
  bool? push;
  bool? bluetooth;
  bool? rfid;
  bool? wifi;
  }

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 agreements = ClientAgreements(push: false, rfid: false, wifi: false);


ClientAttributes

Declared In

lib/model/client/client_attributes.dart



Token

Declared In

lib/model/client/token.dart

TokenOrigin

Declaration

class Token

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/enums/client/token_origin.dart

Declaration

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

Functions

Converts from String to TokenOrigin.

TokenOrigin tokenOrigin = TokenOrigin.fromString(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