
### ClientIdentityProvider
**Declared In:**  
Headers/SNRClientIdentityProvider.h
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-172">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-172-0" data-tab-group="tabgrp-172" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-172-1" data-tab-group="tabgrp-172">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-172-0" data-tab-group="tabgrp-172" data-tab-active="true">

```Swift
enum ClientIdentityProvider: Int {
    synerise,
    oauth,
    simpleAuth,
    facebook,
    apple,
    google
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-172-1" data-tab-group="tabgrp-172">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRClientIdentityProvider) {
    SNRClientIdentityProviderSynerise,
    SNRClientIdentityProviderOAuth,
    SNRClientIdentityProviderSimpleAuth,
    SNRClientIdentityProviderFacebook,
    SNRClientIdentityProviderApple,
    SNRClientIdentityProviderGoogle
}
```

</div>
</div>

  
**Functions:**

Converts from **ClientIdentityProvider** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-173">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-173-0" data-tab-group="tabgrp-173" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-173-1" data-tab-group="tabgrp-173">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-173-0" data-tab-group="tabgrp-173" data-tab-active="true">

```Swift
func SNR_ClientIdentityProviderToString(_: ClientIdentityProvider) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-173-1" data-tab-group="tabgrp-173">

```Objective-C
NSString * SNR_ClientIdentityProviderToString(SNRClientIdentityProvider type)
```

</div>
</div>


---

Converts from **String** to **ClientIdentityProvider**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-174">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-174-0" data-tab-group="tabgrp-174" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-174-1" data-tab-group="tabgrp-174">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-174-0" data-tab-group="tabgrp-174" data-tab-active="true">

```Swift
func SNR_StringToClientIdentityProvider(_: String) -> ClientIdentityProvider
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-174-1" data-tab-group="tabgrp-174">

```Objective-C
SNRClientIdentityProvider SNR_StringToClientIdentityProvider(NSString * _Nullable string)
```

</div>
</div>


---
---

### ClientConditionalAuthenticationContext
**Declared In:**  
Headers/SNRClientConditionalAuthContext.h  
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-175">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-175-0" data-tab-group="tabgrp-175" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-175-1" data-tab-group="tabgrp-175">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-175-0" data-tab-group="tabgrp-175" data-tab-active="true">

```Swift
class ClientConditionalAuthContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-175-1" data-tab-group="tabgrp-175">

```Objective-C
@interface SNRClientConditionalAuthContext : SNRBaseModel
```

</div>
</div>

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

<div class="content-tabs code-tabs" data-tab-group="tabgrp-176">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-176-0" data-tab-group="tabgrp-176" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-176-1" data-tab-group="tabgrp-176">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-176-0" data-tab-group="tabgrp-176" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-176-1" data-tab-group="tabgrp-176">

```Objective-C
- (instancetype)init
```

</div>
</div>


---
---

### ClientAuthenticationContext
**Declared In:**  
Headers/SNRClientAuthenticationContext.h  
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-177">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-177-0" data-tab-group="tabgrp-177" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-177-1" data-tab-group="tabgrp-177">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-177-0" data-tab-group="tabgrp-177" data-tab-active="true">

```Swift
class ClientAuthenticationContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-177-1" data-tab-group="tabgrp-177">

```Objective-C
@interface SNRClientAuthenticationContext : SNRBaseModel
```

</div>
</div>

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

<div class="content-tabs code-tabs" data-tab-group="tabgrp-178">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-178-0" data-tab-group="tabgrp-178" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-178-1" data-tab-group="tabgrp-178">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-178-0" data-tab-group="tabgrp-178" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-178-1" data-tab-group="tabgrp-178">

```Objective-C
- (instancetype)init
```

</div>
</div>


---
---

### ClientConditionalAuthResult
**Declared In:**  
Headers/SNRClientConditionalAuthResult.h  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
    
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-179">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-179-0" data-tab-group="tabgrp-179" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-179-1" data-tab-group="tabgrp-179">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-179-0" data-tab-group="tabgrp-179" data-tab-active="true">

```Swift
class ClientConditionalAuthResult: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-179-1" data-tab-group="tabgrp-179">

```Objective-C
@interface SNRClientConditionalAuthResult : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **isSuccess** | Bool | no | Result of authentication operation |
| **token** | String | yes | Token as a raw string |
| **status** | [ClientConditionalAuthStatus](/developers/mobile-sdk/class-reference/ios/client#clientconditionalauthstatus) | no | Status of the authentication |
| **conditions** | [AnyObject] | yes | Authentication conditions |
  

<div class="admonition admonition-important"><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 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

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


---
---

### ClientConditionalAuthStatus
**Declared In:**  
Headers/SNRClientConditionalAuthStatus.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-180">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-180-0" data-tab-group="tabgrp-180" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-180-1" data-tab-group="tabgrp-180">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-180-0" data-tab-group="tabgrp-180" data-tab-active="true">

```Swift
enum ClientConditionalAuthStatus: Int {
    success,
    unauthorized,
    activationRequired,
    registrationRequired,
    approvalRequired,
    termsAcceptanceRequired,
    mfaRequired,
    unknown
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-180-1" data-tab-group="tabgrp-180">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRClientConditionalAuthStatus) {
    SNRClientConditionalAuthStatusSuccess,
    SNRClientConditionalAuthStatusUnauthorized,
    SNRClientConditionalAuthStatusActivationRequired,
    SNRClientConditionalAuthStatusRegistrationRequired,
    SNRClientConditionalAuthStatusApprovalRequired,
    SNRClientConditionalAuthStatusTermsAcceptanceRequired,
    SNRClientConditionalAuthStatusMFARequired,
    SNRClientConditionalAuthStatusUnknown
}
```

</div>
</div>

  
**Functions:**
  
Converts from **ClientConditionalAuthStatus** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-181">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-181-0" data-tab-group="tabgrp-181" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-181-1" data-tab-group="tabgrp-181">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-181-0" data-tab-group="tabgrp-181" data-tab-active="true">

```Swift
func SNR_ClientConditionalAuthStatusToString(_: ClientConditionalAuthStatus) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-181-1" data-tab-group="tabgrp-181">

```Objective-C
NSString * SNR_ClientConditionalAuthStatusToString(SNRClientConditionalAuthStatus status)
```

</div>
</div>


---

Converts from **String** to **ClientConditionalAuthStatus**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-182">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-182-0" data-tab-group="tabgrp-182" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-182-1" data-tab-group="tabgrp-182">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-182-0" data-tab-group="tabgrp-182" data-tab-active="true">

```Swift
func SNR_StringToClientConditionalAuthStatus(_: String) -> ClientConditionalAuthStatus
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-182-1" data-tab-group="tabgrp-182">

```Objective-C
SNRClientConditionalAuthStatus SNR_StringToClientConditionalAuthStatus(NSString * _Nullable string)
```

</div>
</div>


---
---

### ClientSimpleAuthenticationData
**Declared In:**  
Headers/SNRClientSimpleAuthenticationData.h  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-183">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-183-0" data-tab-group="tabgrp-183" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-183-1" data-tab-group="tabgrp-183">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-183-0" data-tab-group="tabgrp-183" data-tab-active="true">

```Swift
class ClientSimpleAuthenticationData: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-183-1" data-tab-group="tabgrp-183">

```Objective-C
@interface SNRClientSimpleAuthenticationData : SNRBaseModel
```

</div>
</div>

  
**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/ios/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/ios/client#clientagreements) | yes | Customer's agreements |
| **attributes** | [AnyHashable: Any] | yes | Customer's attributes |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-184">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-184-0" data-tab-group="tabgrp-184" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-184-1" data-tab-group="tabgrp-184">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-184-0" data-tab-group="tabgrp-184" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-184-1" data-tab-group="tabgrp-184">

```Objective-C
- (instancetype)init
```

</div>
</div>


---
---

### ClientSessionEndReason
**Declared In:**   
Headers/SNRClientSessionEndReason.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-185">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-185-0" data-tab-group="tabgrp-185" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-185-1" data-tab-group="tabgrp-185">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-185-0" data-tab-group="tabgrp-185" data-tab-active="true">

```Swift
enum ClientSessionEndReason: Int {
    userSignOut,
    systemSignOut,
    sessionExpiration,
    securityException,
    clientRejected,
    userAccountDeleted
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-185-1" data-tab-group="tabgrp-185">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRClientSessionEndReason) {
    SNRClientSessionEndReasonUserSignOut,
    SNRClientSessionEndReasonSystemSignOut,
    SNRClientSessionEndReasonSessionExpiration,
    SNRClientSessionEndReasonSessionDestroyed,
    SNRClientSessionEndReasonSecurityException,
    SNRClientSessionEndReasonClientRejected,
    SNRClientSessionEndReasonUserAccountDeleted
}
```

</div>
</div>


---
---

### ClientSignOutMode
**Declared In:**  
Headers/SNRClientSignOutMode.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-186">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-186-0" data-tab-group="tabgrp-186" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-186-1" data-tab-group="tabgrp-186">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-186-0" data-tab-group="tabgrp-186" data-tab-active="true">

```Swift
enum ClientSignOutMode: Int {
    .signOut,
    .signOutWithSessionDestroy
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-186-1" data-tab-group="tabgrp-186">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRClientSignOutMode) {
    SNRClientSignOutModeSignOut,
    SNRClientSignOutModeSignOutWithSessionDestroy
}
```

</div>
</div>


---
---

### ClientAccountInformation
**Declared In:**  
Headers/SNRClientAccountInformation.h  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Conforms To:**  
[NSSecureCoding](https://developer.apple.com/documentation/foundation/nssecurecoding)    
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-187">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-187-0" data-tab-group="tabgrp-187" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-187-1" data-tab-group="tabgrp-187">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-187-0" data-tab-group="tabgrp-187" data-tab-active="true">

```Swift
class ClientAccountInformation: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-187-1" data-tab-group="tabgrp-187">

```Objective-C
@interface SNRClientAccountInformation : SNRBaseModel
```

</div>
</div>

  
**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](/developers/mobile-sdk/class-reference/ios/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** | Bool | no | Customer's anonymous flag |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements) | no | Customer's agreements |
| **attributes** | [AnyHashable: Any] | yes | Customer's attributes |
| **tags** | [String] | yes | Customer's tags |
  

<div class="admonition admonition-important"><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 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

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


---
---

### ClientUpdateAccountBasicInformationContext
**Declared In:**  
Headers/SNRClientUpdateAccountBasicInformationContext.h  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Conforms To:**  
[NSSecureCoding](https://developer.apple.com/documentation/foundation/nssecurecoding)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-188">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-188-0" data-tab-group="tabgrp-188" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-188-1" data-tab-group="tabgrp-188">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-188-0" data-tab-group="tabgrp-188" data-tab-active="true">

```Swift
class ClientUpdateAccountBasicInformationContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-188-1" data-tab-group="tabgrp-188">

```Objective-C
@interface SNRClientUpdateAccountBasicInformationContext : SNRBaseModel
```

</div>
</div>

  
**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/ios/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 |
| **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/ios/client#clientagreements) | no | Customer's agreements |
| **attributes** | [AnyHashable: Any] | yes | Customer's attributes |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-189">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-189-0" data-tab-group="tabgrp-189" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-189-1" data-tab-group="tabgrp-189">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-189-0" data-tab-group="tabgrp-189" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-189-1" data-tab-group="tabgrp-189">

```Objective-C
- (instancetype)init
```

</div>
</div>


---
---

### ClientUpdateAccountContext
**Declared In:**  
Headers/SNRClientUpdateAccountContext.h  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Conforms To:**  
[NSSecureCoding](https://developer.apple.com/documentation/foundation/nssecurecoding)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-190">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-190-0" data-tab-group="tabgrp-190" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-190-1" data-tab-group="tabgrp-190">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-190-0" data-tab-group="tabgrp-190" data-tab-active="true">

```Swift
class ClientUpdateAccountContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-190-1" data-tab-group="tabgrp-190">

```Objective-C
@interface SNRClientUpdateAccountContext : SNRBaseModel
```

</div>
</div>

  
**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/ios/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/ios/client#clientagreements) | no | Customer's agreements |
| **attributes** | [AnyHashable: Any] | yes | Customer's attributes |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-191">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-191-0" data-tab-group="tabgrp-191" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-191-1" data-tab-group="tabgrp-191">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-191-0" data-tab-group="tabgrp-191" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-191-1" data-tab-group="tabgrp-191">

```Objective-C
- (instancetype)init
```

</div>
</div>


---
---

### ClientRegisterAccountContext
**Declared In:**  
Headers/SNRClientRegisterAccountContext.h  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-192">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-192-0" data-tab-group="tabgrp-192" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-192-1" data-tab-group="tabgrp-192">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-192-0" data-tab-group="tabgrp-192" data-tab-active="true">

```Swift
class ClientRegisterAccountContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-192-1" data-tab-group="tabgrp-192">

```Objective-C
@interface SNRClientRegisterAccountContext : SNRBaseModel
```

</div>
</div>

  
**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/ios/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/ios/client#clientagreements) | yes | Customer's agreements |
| **attributes** | [AnyHashable: Any] | yes | Customer's attributes |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-193">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-193-0" data-tab-group="tabgrp-193" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-193-1" data-tab-group="tabgrp-193">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-193-0" data-tab-group="tabgrp-193" data-tab-active="true">

```Swift
init(email: String, password: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-193-1" data-tab-group="tabgrp-193">

```Objective-C
- (instancetype)initWithEmail:(nonnull NSString *)email andPassword:(nonnull NSString *)password
```

</div>
</div>


---
---

### ClientPasswordResetRequestContext
**Declared In:**  
Headers/SNRClientPasswordResetRequestContext.h  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-194">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-194-0" data-tab-group="tabgrp-194" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-194-1" data-tab-group="tabgrp-194">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-194-0" data-tab-group="tabgrp-194" data-tab-active="true">

```Swift
class ClientPasswordResetRequestContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-194-1" data-tab-group="tabgrp-194">

```Objective-C
@interface SNRClientPasswordResetRequestContext : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **email** | Bool | no | Customer's email |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-195">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-195-0" data-tab-group="tabgrp-195" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-195-1" data-tab-group="tabgrp-195">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-195-0" data-tab-group="tabgrp-195" data-tab-active="true">

```Swift
init(email: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-195-1" data-tab-group="tabgrp-195">

```Objective-C
- (instancetype)initWithEmail:(nonnull NSString *)email
```

</div>
</div>


---
---

### ClientPasswordResetConfirmationContext
**Declared In:**  
Headers/SNRClientPasswordResetConfirmationContext.h
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-196">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-196-0" data-tab-group="tabgrp-196" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-196-1" data-tab-group="tabgrp-196">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-196-0" data-tab-group="tabgrp-196" data-tab-active="true">

```Swift
class ClientPasswordResetConfirmationContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-196-1" data-tab-group="tabgrp-196">

```Objective-C
@interface SNRClientPasswordResetConfirmationContext : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **password** | String | no | Customer's password |
| **token** | String | no | Customer's token |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-197">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-197-0" data-tab-group="tabgrp-197" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-197-1" data-tab-group="tabgrp-197">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-197-0" data-tab-group="tabgrp-197" data-tab-active="true">

```Swift
init(password: String, token: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-197-1" data-tab-group="tabgrp-197">

```Objective-C
- (instancetype)initWithPassword:(nonnull NSString *)password andToken:(nonnull NSString *)token
```

</div>
</div>


---
---

### ClientSex
**Declared In:**  
Headers/SNRClientSex.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-198">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-198-0" data-tab-group="tabgrp-198" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-198-1" data-tab-group="tabgrp-198">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-198-0" data-tab-group="tabgrp-198" data-tab-active="true">

```Swift
enum ClientSex: Int {
    notSpecified,
    male,
    female,
    other
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-198-1" data-tab-group="tabgrp-198">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRClientSex) {
    SNRClientSexNotSpecified = 0,
    SNRClientSexMale,
    SNRClientSexFemale,
    SNRClientSexOther,
}
```

</div>
</div>

  
**Functions:**

Converts from **ClientSex** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-199">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-199-0" data-tab-group="tabgrp-199" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-199-1" data-tab-group="tabgrp-199">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-199-0" data-tab-group="tabgrp-199" data-tab-active="true">

```Swift
func SNR_ClientSexToString(_: ClientSex) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-199-1" data-tab-group="tabgrp-199">

```Objective-C
NSString * SNR_ClientSexToString(SNRClientSex type)
```

</div>
</div>


<br>

Converts from **String** to **ClientSex**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-200">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-200-0" data-tab-group="tabgrp-200" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-200-1" data-tab-group="tabgrp-200">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-200-0" data-tab-group="tabgrp-200" data-tab-active="true">

```Swift
func SNR_StringToClientSex(_: String) -> ClientSex
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-200-1" data-tab-group="tabgrp-200">

```Objective-C
SNRClientSex SNR_StringToClientSex(NSString * _Nullable string)
```

</div>
</div>


---
---

### ClientAgreements
**Declared In:**  
Headers/SNRClientAgreements.h  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Conforms To:**  
[NSSecureCoding](https://developer.apple.com/documentation/foundation/nssecurecoding)  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-201">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-201-0" data-tab-group="tabgrp-201" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-201-1" data-tab-group="tabgrp-201">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-201-0" data-tab-group="tabgrp-201" data-tab-active="true">

```Swift
class ClientAgreements: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-201-1" data-tab-group="tabgrp-201">

```Objective-C
@interface SNRClientAgreements : SNRBaseModel
```

</div>
</div>

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

<div class="content-tabs code-tabs" data-tab-group="tabgrp-202">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-202-0" data-tab-group="tabgrp-202" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-202-1" data-tab-group="tabgrp-202">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-202-0" data-tab-group="tabgrp-202" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-202-1" data-tab-group="tabgrp-202">

```Objective-C
- (instancetype)init
```

</div>
</div>


---
---

### ClientEventData
**Declared In:**  
Headers/SNRClientEventData.h  
  
**Related To:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-203">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-203-0" data-tab-group="tabgrp-203" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-203-1" data-tab-group="tabgrp-203">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-203-0" data-tab-group="tabgrp-203" data-tab-active="true">

```Swift
class ClientEventData: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-203-1" data-tab-group="tabgrp-203">

```Objective-C
@interface SNRClientEventData : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **time** | String | no | Event's time |
| **label** | String | no | Event's label |
| **action** | String | no | Event's action |
| **client** | [AnyHashable: Any] | no | Event's customer identification |
| **params** | [AnyHashable: Any] | no | Event's parameters |
  

<div class="admonition admonition-important"><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 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

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

  
**Methods:**

This method retrieves a customer ID.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-204">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-204-0" data-tab-group="tabgrp-204" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-204-1" data-tab-group="tabgrp-204">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-204-0" data-tab-group="tabgrp-204" data-tab-active="true">

```Swift
func getClientID() -> Int
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-204-1" data-tab-group="tabgrp-204">

```Objective-C
- (NSInteger)getClientID
```

</div>
</div>


---

This method retrieves a customer UUID.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-205">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-205-0" data-tab-group="tabgrp-205" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-205-1" data-tab-group="tabgrp-205">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-205-0" data-tab-group="tabgrp-205" data-tab-active="true">

```Swift
func getClientUUIDString() -> String?
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-205-1" data-tab-group="tabgrp-205">

```Objective-C
- (nullable NSString *)getClientUUIDString
```

</div>
</div>


---

This method retrieves a customer email.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-206">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-206-0" data-tab-group="tabgrp-206" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-206-1" data-tab-group="tabgrp-206">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-206-0" data-tab-group="tabgrp-206" data-tab-active="true">

```Swift
func getClientEmail() -> String?
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-206-1" data-tab-group="tabgrp-206">

```Objective-C
- (nullable NSString *)getClientEmail
```

</div>
</div>


---
---

### ClientEventsApiQuery
The object to set parameters easily for fetching client events from API.
  
**Declared In:**  
Headers/SNRClientEventsApiQuery.h  
  
**Inherits From:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-207">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-207-0" data-tab-group="tabgrp-207" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-207-1" data-tab-group="tabgrp-207">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-207-0" data-tab-group="tabgrp-207" data-tab-active="true">

```Swift
class ClientEventsApiQuery: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-207-1" data-tab-group="tabgrp-207">

```Objective-C
@interface SNRClientEventsApiQuery : NSObject
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **actions** | [String] | no  | [] | Specifies event actions for query |
| **timeFrom** | String | yes  | nil | Specifies time from for query |
| **timeTo** | String | yes | nil | Specifies time to for query |
| **limit** | String | no | 100 | Limit of items in the response |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-208">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-208-0" data-tab-group="tabgrp-208" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-208-1" data-tab-group="tabgrp-208">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-208-0" data-tab-group="tabgrp-208" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-208-1" data-tab-group="tabgrp-208">

```Objective-C
- (instancetype)init
```

</div>
</div>


---
---

### TokenPayload
**Declared In:**  
Headers/SNRTokenPayload.h  
  
**Related To:**  
[TokenOrigin](/developers/mobile-sdk/class-reference/ios/client#tokenorigin)
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-209">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-209-0" data-tab-group="tabgrp-209" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-209-1" data-tab-group="tabgrp-209">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-209-0" data-tab-group="tabgrp-209" data-tab-active="true">

```Swift
class TokenPayload: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-209-1" data-tab-group="tabgrp-209">

```Objective-C
@interface SNRTokenPayload : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **tokenString** | String | no | Token as a raw string |
| **expirationDate** | Date | no | Token's expiration time |
| **creationDate** | Date | no | Token's creation time |
| **rlm** | String | no | Token's RLM |
| **origin** | [TokenOrigin](/developers/mobile-sdk/class-reference/ios/client#tokenorigin) | no | Token's origin |
| **uuid** | String | no | Customer's UUID |
| **clientId** | String | no | Customer's ID |
| **customId** | String | yes | Customer's custom ID |
  
**Initializers:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-210">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-210-0" data-tab-group="tabgrp-210" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-210-1" data-tab-group="tabgrp-210">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-210-0" data-tab-group="tabgrp-210" data-tab-active="true">

```Swift
init(tokenString: String, expirationDate: Date, creationDate: Date, rlm: String, origin: TokenOrigin, uuid: String, clientId: String, customId: String?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-210-1" data-tab-group="tabgrp-210">

```Objective-C
- (instancetype)initWithTokenString:(NSString *)tokenString expirationDate:(NSDate *)expirationDate creationDate:(NSDate *)creationDate rlm:(NSString *)rlm origin:(SNRTokenOrigin)origin uuid:(NSString *)uuid clientId:(NSString *)clientId customId:(nullable NSString *)customId;
```

</div>
</div>


---
---

### Token
**Declared In:**  
Headers/SNRToken.h  
  
**Related To:**  
[TokenOrigin](/developers/mobile-sdk/class-reference/ios/client#tokenorigin)
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-211">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-211-0" data-tab-group="tabgrp-211" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-211-1" data-tab-group="tabgrp-211">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-211-0" data-tab-group="tabgrp-211" data-tab-active="true">

```Swift
class Token: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-211-1" data-tab-group="tabgrp-211">

```Objective-C
@interface SNRToken : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **tokenString** | String | no | Token as a raw string |
| **expirationDate** | String | no | Token's expiration time |
| **rlm** | String | no | Token's RLM |
| **origin** | [TokenOrigin](/developers/mobile-sdk/class-reference/ios/client#tokenorigin) | no | Token's origin |
| **clientId** | String | no | Customer's ID |
| **customId** | String | yes | Customer's custom ID |
  
**Methods:**
Checks if the token is near expiration.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-212">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-212-0" data-tab-group="tabgrp-212" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-212-1" data-tab-group="tabgrp-212">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-212-0" data-tab-group="tabgrp-212" data-tab-active="true">

```Swift
func isNearExpiring() -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-212-1" data-tab-group="tabgrp-212">

```Objective-C
- (BOOL)isNearExpiring
```

</div>
</div>


---
---

### TokenOrigin

<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">

The `Oauth` value was renamed in 5.0.0 version to `OAuth`.

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

**Declared In:**  
Headers/SNRTokenOrigin.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-213">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-213-0" data-tab-group="tabgrp-213" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-213-1" data-tab-group="tabgrp-213">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-213-0" data-tab-group="tabgrp-213" data-tab-active="true">

```Swift
enum TokenOrigin: Int {
    unknown,
    synerise,
    simpleAuth,
    facebook,
    OAuth,
    apple
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-213-1" data-tab-group="tabgrp-213">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRTokenOrigin) {
    SNRTokenOriginUnknown,
    SNRTokenOriginSynerise,
    SNRTokenOriginSimpleAuth,
    SNRTokenOriginFacebook,
    SNRTokenOriginOAuth,
    SNRTokenOriginApple
}
```

</div>
</div>

  
**Functions:**
Converts from **TokenOrigin** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-214">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-214-0" data-tab-group="tabgrp-214" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-214-1" data-tab-group="tabgrp-214">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-214-0" data-tab-group="tabgrp-214" data-tab-active="true">

```Swift
func SNR_TokenOriginToString(_: TokenOrigin) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-214-1" data-tab-group="tabgrp-214">

```Objective-C
NSString * SNR_TokenOriginToString(SNRTokenOrigin type)
```

</div>
</div>


---

Converts from **String** to **TokenOrigin**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-215">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-215-0" data-tab-group="tabgrp-215" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-215-1" data-tab-group="tabgrp-215">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-215-0" data-tab-group="tabgrp-215" data-tab-active="true">

```Swift
func SNR_StringToTokenOrigin(_: String) -> TokenOrigin
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-215-1" data-tab-group="tabgrp-215">

```Objective-C
SNRTokenOrigin SNR_StringToTokenOrigin(NSString *string)
```

</div>
</div>


---
---

## 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:**  
Headers/SNRClientOAuthAuthenticationContext.h
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-216">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-216-0" data-tab-group="tabgrp-216" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-216-1" data-tab-group="tabgrp-216">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-216-0" data-tab-group="tabgrp-216" data-tab-active="true">

```Swift
class ClientOAuthAuthenticationContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-216-1" data-tab-group="tabgrp-216">

```Objective-C
@interface SNRClientOAuthAuthenticationContext : SNRBaseModel
```

</div>
</div>

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

<div class="content-tabs code-tabs" data-tab-group="tabgrp-217">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-217-0" data-tab-group="tabgrp-217" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-217-1" data-tab-group="tabgrp-217">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-217-0" data-tab-group="tabgrp-217" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-217-1" data-tab-group="tabgrp-217">

```Objective-C
- (instancetype)init
```

</div>
</div>


---
---

### <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:**  
Headers/SNRClientFacebookAuthenticationContext.h
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-218">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-218-0" data-tab-group="tabgrp-218" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-218-1" data-tab-group="tabgrp-218">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-218-0" data-tab-group="tabgrp-218" data-tab-active="true">

```Swift
class ClientFacebookAuthenticationContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-218-1" data-tab-group="tabgrp-218">

```Objective-C
@interface SNRClientFacebookAuthenticationContext : SNRBaseModel
```

</div>
</div>

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

<div class="content-tabs code-tabs" data-tab-group="tabgrp-219">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-219-0" data-tab-group="tabgrp-219" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-219-1" data-tab-group="tabgrp-219">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-219-0" data-tab-group="tabgrp-219" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-219-1" data-tab-group="tabgrp-219">

```Objective-C
- (instancetype)init
```

</div>
</div>


---
---

### <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:**  
Headers/SNRClientAppleSignInAuthenticationContext.h  
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-220">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-220-0" data-tab-group="tabgrp-220" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-220-1" data-tab-group="tabgrp-220">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-220-0" data-tab-group="tabgrp-220" data-tab-active="true">

```Swift
class ClientAppleSignInAuthenticationContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-220-1" data-tab-group="tabgrp-220">

```Objective-C
@interface SNRClientAppleSignInAuthenticationContext : SNRBaseModel
```

</div>
</div>

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

<div class="content-tabs code-tabs" data-tab-group="tabgrp-221">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-221-0" data-tab-group="tabgrp-221" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-221-1" data-tab-group="tabgrp-221">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-221-0" data-tab-group="tabgrp-221" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-221-1" data-tab-group="tabgrp-221">

```Objective-C
- (instancetype)init
```

</div>
</div>

