
## ClientIdentityProvider
**Declared In:**  
lib/classes/models/Client/ClientIdentityProvider.js   
  
**Declaration:**  

<pre><code class="language-TypeScript">enum ClientIdentityProvider {
  Facebook = 'FACEBOOK',
  Google = 'GOOGLE',
  Oauth = 'OAUTH',
  Synerise = 'SYNERISE',
  Unknown = 'UNKNOWN',
}</code></pre>


**Functions:**

Converts from `ClientIdentityProvider` to string.

<pre><code class="language-TypeScript">function ClientIdentityProviderToString(clientIdentityProvider: ClientIdentityProvider): string</code></pre>


---

Converts from string to `ClientIdentityProvider`.

<pre><code class="language-TypeScript">function ClientIdentityProviderFromString(string: string): ClientIdentityProvider</code></pre>


---
---
## ClientAuthContext
**Declared In:**  
lib/classes/models/Client/ClientAuthContext.js  
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)   
  
**Declaration:**

<pre><code class="language-TypeScript">interface IClientAuthContext {
  authID?: string;
  agreements?: IClientAgreements;
  attributes?: object;
}</code></pre>

  

<pre><code class="language-TypeScript">class ClientAuthContext extends BaseModel</code></pre>

  
**Properties:**  
Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#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 |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Initializers:**  

<pre><code class="language-TypeScript">constructor(modelObject?: IClientAuthContext)</code></pre>


---
---

## ClientSimpleAuthenticationData
**Declared In:**  
lib/main/modules/ClientModule.js  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**  

<pre><code class="language-TypeScript">class ClientSimpleAuthenticationData extends BaseModel</code></pre>

  
**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](/developers/mobile-sdk/class-reference/react-native/client#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](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | yes | Customer's agreements |
| **attributes** | object | yes | Customer's attributes |

---
---

## ClientSessionEndReason
**Declared In:**  
lib/classes/models/Client/ClientSessionEndReason.js  
  
**Declaration:**  

<pre><code class="language-TypeScript">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'
}</code></pre>

  
**Functions:**

Converts from **ClientSessionEndReason** to **string**.

<pre><code class="language-TypeScript">function ClientSessionEndReasonToString(reason: ClientSessionEndReason): string</code></pre>


---

Converts from **string** to **ClientSessionEndReason**.

<pre><code class="language-TypeScript">function ClientSessionEndReasonFromString(string: string): ClientSessionEndReason</code></pre>


---
---

## ClientSignOutMode
**Declared In:**  
lib/classes/models/Client/ClientSignOutMode.js  
  
**Declaration:**  

<pre><code class="language-TypeScript">enum ClientSignOutMode {
  SignOut = 'SIGN_OUT',
  SignOutWithSessionDestroy = 'SIGN_OUT_WITH_SESSION_DESTROY'
}</code></pre>

  
**Functions:**

Converts from **ClientSignOutMode** to **string**.

<pre><code class="language-TypeScript">function ClientSignOutModeToString(mode: ClientSignOutMode): string</code></pre>


---
---

## ClientAccountInformation
Model representating the customer information.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

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

</div></div></div>

  
**Declared In:**  
lib/classes/models/Client/ClientAccountInformation.js   
  
**Related To:**
[ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**  

<pre><code class="language-TypeScript">class ClientAccountInformation extends BaseModel</code></pre>

  
**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](/developers/mobile-sdk/class-reference/react-native/client#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](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | no | Customer's agreements |
| **attributes** | Array<object> | yes | Customer's attributes |
| **tags** | Array<string> | yes | Customer's tags |

---
---

## ClientAccountUpdateBasicInformationContext
**Declared In:**  
lib/classes/models/Client/ClientAccountUpdateBasicInformationContext.js  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**

<pre><code class="language-TypeScript">class ClientAccountUpdateBasicInformationContext extends BaseModel</code></pre>

  
**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](/developers/mobile-sdk/class-reference/react-native/client#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](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | no | Customer's agreements |
| **attributes** | object | yes | Customer's attributes |
  
**Initializers:**   

<pre><code class="language-TypeScript">constructor(modelObject?: IClientAccountUpdateBasicInformationContext)</code></pre>


---
---

## ClientAccountUpdateContext
**Declared In:**  
lib/classes/models/Client/ClientAccountUpdateContext.js  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**

<pre><code class="language-TypeScript">class ClientAccountUpdateContext extends BaseModel</code></pre>

  
**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](/developers/mobile-sdk/class-reference/react-native/client#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](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | no | Customer's agreements |
| **attributes** | object | yes | Customer's attributes |
  
**Initializers:**   

<pre><code class="language-TypeScript">constructor(modelObject?: IClientAccountUpdateContext)</code></pre>


---
---

## ClientAccountRegisterContext
**Declared In:**  
lib/classes/models/Client/ClientAccountRegisterContext.js  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**

<pre><code class="language-TypeScript">class ClientAccountRegisterContext extends BaseModel</code></pre>

  
**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](/developers/mobile-sdk/class-reference/react-native/client#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](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | yes | Customer's agreements |
| **attributes** | object | yes | Customer's attributes |
  
**Initializers:**

<pre><code class="language-TypeScript">constructor(email: string, password: string, modelObject?: IClientAccountRegisterContext)</code></pre>


---
---

## ClientSex
**Declared In:**  
lib/classes/models/Client/ClientSex.js  
  
**Declaration:**  

<pre><code class="language-TypeScript">enum ClientSex {
  NotSpecified = 'NOT_SPECIFIED',
  Male = 'MALE',
  Female = 'FEMALE',
  Other = 'OTHER'
}</code></pre>

  
**Functions:**

Converts from **ClientSex** to **string**.

<pre><code class="language-TypeScript">function ClientSexToString(clientSex: ClientSex): string</code></pre>


---

Converts from **string** to **ClientSex**.

<pre><code class="language-TypeScript">function ClientSexFromString(string: string): ClientSex</code></pre>


---
---

## ClientAgreements
**Declared In:**  
lib/classes/models/Client/ClientAgreements.js  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**  

<pre><code class="language-TypeScript">interface IClientAgreements {
  email?: boolean;
  sms?: boolean;
  push?: boolean;
  bluetooth?: boolean;
  rfid?: boolean;
  wifi?: boolean;
}</code></pre>

  

<pre><code class="language-TypeScript">class ClientAgreements extends BaseModel</code></pre>

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

<pre><code class="language-TypeScript">constructor()</code></pre>



<pre><code class="language-TypeScript">constructor(modelObject?: IClientAgreements)</code></pre>


---
---

## Token
**Declared In:**  
lib/classes/models/Token/Token.js  
  
**Related To:**  
[TokenOrigin](/developers/mobile-sdk/class-reference/react-native/client#tokenorigin)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**

<pre><code class="language-TypeScript">class Token extends BaseModel</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **tokenString** | string | no | Token as a raw string |
| **tokenOrigin** | [TokenOrigin](/developers/mobile-sdk/class-reference/react-native/client#tokenorigin) | no | Token's origin |
| **expirationDate** | string | yes | Token's expiration time |

---
---

## TokenOrigin
**Declared In:**  
lib/classes/models/Token/TokenOrigin.js  
  
**Declaration:**

<pre><code class="language-TypeScript">enum TokenOrigin {
  Unknown = 'UNKNOWN',
  Synerise = 'SYNERISE',
  Facebook = 'FACEBOOK',
  Oauth = 'OAUTH',
}</code></pre>

  
**Functions:**

Converts from **TokenOrigin** to **string**.

<pre><code class="language-TypeScript">function TokenOriginToString(tokenOrigin: TokenOrigin): string</code></pre>


---

Converts from **string** to **TokenOrigin**.

<pre><code class="language-TypeScript">function TokenOriginFromString(string: string): TokenOrigin</code></pre>


---
---

## Removed symbols
---

### <del>ClientOAuthAuthenticationContext</del>{#clientoauthauthenticationcontext}
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |
**Declared In:**  
lib/classes/models/Client/ClientOAuthAuthenticationContext.js  
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)    
  
**Declaration:**

<pre><code class="language-TypeScript">interface IClientOAuthAuthenticationContext {
  authID?: string;
  agreements?: IClientAgreements;
  attributes?: object;
}</code></pre>



<pre><code class="language-TypeScript">class ClientOAuthAuthenticationContext extends BaseModel</code></pre>

  
**Properties:**
Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | yes | nil | Object that stores all agreements of a customer |
| **attributes** | object | yes | [] | Additional custom attributes of a customer |

**Initializers:**

<pre><code class="language-TypeScript">constructor()</code></pre>

  

<pre><code class="language-TypeScript">constructor(modelObject?: IClientOAuthAuthenticationContext)</code></pre>


---
---

### <del>ClientFacebookAuthenticationContext</del>{#clientfacebookauthenticationcontext}
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.8 | 3.3.0 | 0.9.7 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |
**Declared In:**  
lib/classes/models/Client/ClientOAuthAuthenticationContext.js  
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)    
  
**Declaration:**

<pre><code class="language-TypeScript">interface IClientOAuthAuthenticationContext {
  authID?: string;
  agreements?: IClientAgreements;
  attributes?: object;
}</code></pre>



<pre><code class="language-TypeScript">class ClientOAuthAuthenticationContext extends BaseModel</code></pre>

  
**Properties:**
Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | yes | nil | Object that stores all agreements of a customer |
| **attributes** | object | yes | [] | Additional custom attributes of a customer |

**Initializers:**

<pre><code class="language-TypeScript">constructor()</code></pre>

  

<pre><code class="language-TypeScript">constructor(modelObject?: IClientOAuthAuthenticationContext)</code></pre>


---
---

### <del>ClientAppleSignInAuthenticationContext</del>{#clientapplesigninauthenticationcontext}
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | n/a | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | n/a | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | n/a | 1.0.0 | n/a |
**Declared In:**  
lib/classes/models/Client/ClientAppleSignInAuthenticationContext.js  
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)    
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)   
  
**Declaration:**

<pre><code class="language-TypeScript">interface IClientAppleSignInAuthenticationContext {
  authID?: string;
  agreements?: IClientAgreements;
  attributes?: object;
}</code></pre>



<pre><code class="language-TypeScript">class ClientAppleSignInAuthenticationContext extends BaseModel</code></pre>

  
**Properties:**  
Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | yes | nil | Object that stores all agreements of a customer |
| **attributes** | object | yes | [] | Additional custom attributes of a customer |
  
**Initializers:**  

<pre><code class="language-TypeScript">constructor()</code></pre>


---


<pre><code class="language-TypeScript">constructor(modelObject?: IClientAppleSignInAuthenticationContext)</code></pre>
