Client
ClientIdentityProvider
Declared In:
Headers/SNRClientIdentityProvider.h
Declaration:
enum ClientIdentityProvider: Int {
synerise,
oauth,
simpleAuth,
facebook,
apple,
google
}
Functions:
Converts from ClientIdentityProvider to String.
func SNR_ClientIdentityProviderToString(_: ClientIdentityProvider) -> String
Converts from String to ClientIdentityProvider.
func SNR_StringToClientIdentityProvider(_: String) -> ClientIdentityProvider
ClientConditionalAuthenticationContext
Declared In:
Headers/SNRClientConditionalAuthContext.h
Related To:
ClientAgreements
Inherits From:
BaseModel
Declaration:
class ClientConditionalAuthContext: BaseModel
Properties:
Property | Type | Optional | Default | Description |
---|---|---|---|---|
agreements | ClientAgreements | yes | nil | Object that stores all agreements of a customer |
attributes | [AnyHashable: Any] | yes | [] | Additional custom attributes of a customer |
Initializers:
init()
ClientAuthenticationContext
Declared In:
Headers/SNRClientAuthenticationContext.h
Related To:
ClientAgreements
Inherits From:
BaseModel
Declaration:
class ClientAuthenticationContext: BaseModel
Properties:
Property | Type | Optional | Default | Description |
---|---|---|---|---|
agreements | ClientAgreements | yes | nil | Object that stores all agreements of a customer |
attributes | [AnyHashable: Any] | yes | [] | Additional custom attributes of a customer |
Initializers:
init()
ClientOAuthAuthenticationContext
Declared In:
Headers/SNRClientOAuthAuthenticationContext.h
Related To:
ClientAgreements
Inherits From:
BaseModel
Declaration:
class ClientOAuthAuthenticationContext: BaseModel
Properties:
Property | Type | Optional | Default | Description |
---|---|---|---|---|
agreements | ClientAgreements | yes | nil | Object that stores all agreements of a customer |
attributes | [AnyHashable: Any] | yes | [] | Additional custom attributes of a customer |
Initializers:
init()
ClientFacebookAuthenticationContext
Declared In:
Headers/SNRClientOAuthAuthenticationContext.h
Related To:
ClientAgreements
Inherits From:
BaseModel
Declaration:
class ClientOAuthAuthenticationContext: BaseModel
Properties:
Property | Type | Optional | Default | Description |
---|---|---|---|---|
agreements | ClientAgreements | yes | nil | Object that stores all agreements of a customer |
attributes | [AnyHashable: Any] | yes | [] | Additional custom attributes of a customer |
Initializers:
init()
ClientAppleSignInAuthenticationContext
Declared In:
Headers/SNRClientAppleSignInAuthenticationContext.h
Related To:
ClientAgreements
Inherits From:
BaseModel
Declaration:
class ClientAppleSignInAuthenticationContext: BaseModel
Properties:
Property | Type | Optional | Default | Description |
---|---|---|---|---|
agreements | ClientAgreements | yes | nil | Object that stores all agreements of a customer |
attributes | [AnyHashable: Any] | yes | [] | Additional custom attributes of a customer |
Initializers:
init()
ClientConditionalAuthResult
Declared In:
Headers/SNRClientConditionalAuthResult.h
Inherits From:
BaseModel
Declaration:
class ClientConditionalAuthResult: BaseModel
Properties:
Property | Type | Optional | Description |
---|---|---|---|
isSuccess | Bool | no | Result of authentication operation |
token | String | yes | Token as a raw string |
status | ClientConditionalAuthStatus | no | Status of the authentication |
conditions | [AnyObject] | yes | Authentication conditions |
ClientConditionalAuthStatus
Declared In:
Headers/SNRClientConditionalAuthStatus.h
Declaration:
enum ClientConditionalAuthStatus: Int {
success,
unauthorized,
activationRequired,
registrationRequired,
approvalRequired,
termsAcceptanceRequired,
mfaRequired,
unknown
}
Functions:
Converts from ClientConditionalAuthStatus to String.
func SNR_ClientConditionalAuthStatusToString(_: ClientConditionalAuthStatus) -> String
Converts from String to ClientConditionalAuthStatus.
func SNR_StringToClientConditionalAuthStatus(_: String) -> ClientConditionalAuthStatus
ClientSimpleAuthenticationData
Declared In:
Headers/SNRClientSimpleAuthenticationData.h
Related To:
ClientSex
ClientAgreements
Inherits From:
BaseModel
Declaration:
class ClientSimpleAuthenticationData: BaseModel
Properties:
Property | Type | Optional | Description |
---|---|---|---|
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 | [AnyHashable: Any] | yes | Customer’s attributes |
Initializers:
init()
ClientSessionEndReason
Declared In:
Headers/SNRClientSessionEndReason.h
Declaration:
enum ClientSessionEndReason: Int {
userSignOut,
systemSignOut,
sessionExpiration,
securityException,
clientRejected,
userAccountDeleted
}
ClientSignOutMode
Declared In:
Headers/SNRClientSignOutMode.h
Declaration:
enum ClientSignOutMode: Int {
.signOut,
.signOutWithSessionDestroy
}
ClientAccountInformation
Declared In:
Headers/SNRClientAccountInformation.h
Related To:
ClientSex
ClientAgreements
Inherits From:
BaseModel
Conforms To:
NSSecureCoding
Declaration:
class ClientAccountInformation: BaseModel
Properties:
Property | Type | Optional | Description |
---|---|---|---|
clientId | Int | no | Customer’s ID |
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 | [AnyHashable: Any] | yes | Customer’s attributes |
tags | [String] | yes | Customer’s tags |
ClientUpdateAccountBasicInformationContext
Declared In:
Headers/SNRClientUpdateAccountBasicInformationContext.h
Related To:
ClientSex
ClientAgreements
Inherits From:
BaseModel
Conforms To:
NSSecureCoding
Declaration:
class ClientUpdateAccountBasicInformationContext: BaseModel
Properties:
Property | Type | Optional | Description |
---|---|---|---|
firstName | String | yes | Customer’s first name |
lastName | String | yes | Customer’s last name |
displayName | String | yes | Customer’s display name |
sex | ClientSex | yes | Customer’s sex |
phone | String | yes | Customer’s phone |
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 | [AnyHashable: Any] | yes | Customer’s attributes |
Initializers:
init()
ClientUpdateAccountContext
Declared In:
Headers/SNRClientUpdateAccountContext.h
Related To:
ClientSex
ClientAgreements
Inherits From:
BaseModel
Conforms To:
NSSecureCoding
Declaration:
class ClientUpdateAccountContext: BaseModel
Properties:
Property | Type | Optional | Description |
---|---|---|---|
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 | [AnyHashable: Any] | yes | Customer’s attributes |
Initializers:
init()
ClientRegisterAccountContext
Declared In:
Headers/SNRClientRegisterAccountContext.h
Related To:
ClientSex
ClientAgreements
Inherits From:
BaseModel
Declaration:
class ClientRegisterAccountContext: BaseModel
Properties:
Property | Type | Optional | Description |
---|---|---|---|
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 | [AnyHashable: Any] | yes | Customer’s attributes |
Initializers:
init(email: String, password: String)
ClientPasswordResetRequestContext
Declared In:
Headers/SNRClientPasswordResetRequestContext.h
Inherits From:
BaseModel
Declaration:
class ClientPasswordResetRequestContext: BaseModel
Properties:
Property | Type | Optional | Description |
---|---|---|---|
Bool | no | Customer’s email |
Initializers:
init(email: String)
ClientPasswordResetConfirmationContext
Declared In:
Headers/SNRClientPasswordResetConfirmationContext.h
Inherits From:
BaseModel
Declaration:
class ClientPasswordResetConfirmationContext: BaseModel
Properties:
Property | Type | Optional | Description |
---|---|---|---|
password | String | no | Customer’s password |
token | String | no | Customer’s token |
Initializers:
init(password: String, token: String)
ClientSex
Declared In:
Headers/SNRClientSex.h
Declaration:
enum ClientSex: Int {
notSpecified,
male,
female,
other
}
Functions:
Converts from ClientSex to String.
func SNR_ClientSexToString(_: ClientSex) -> String
Converts from String to ClientSex.
func SNR_StringToClientSex(_: String) -> ClientSex
ClientAgreements
Declared In:
Headers/SNRClientAgreements.h
Inherits From:
BaseModel
Conforms To:
NSSecureCoding
NSCopying
Declaration:
class ClientAgreements: BaseModel
Properties:
Property | Type | Optional | Description |
---|---|---|---|
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:
init()
ClientEventData
Declared In:
Headers/SNRClientEventData.h
Related To:
Event
Inherits From:
BaseModel
Declaration:
class ClientEventData: BaseModel
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 |
Methods:
This method retrieves a customer ID.
func getClientID() -> Int
This method retrieves a customer UUID.
func getClientUUIDString() -> String?
This method retrieves a customer email.
func getClientEmail() -> String?
ClientEventsApiQuery
The object to set parameters easily for fetching client events from API.
Declared In:
Headers/SNRClientEventsApiQuery.h
Inherits From:
NSObject
Declaration:
class ClientEventsApiQuery: NSObject
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:
init()
TokenPayload
Declared In:
Headers/SNRTokenPayload.h
Related To:
TokenOrigin
Inherits From:
BaseModel
Declaration:
class TokenPayload: BaseModel
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 | no | Token’s origin |
uuid | String | no | Customer’s UUID |
clientId | String | no | Customer’s ID |
customId | String | yes | Customer’s custom ID |
Initializers:
init(tokenString: String, expirationDate: Date, creationDate: Date, rlm: String, origin: TokenOrigin, uuid: String, clientId: String, customId: String?)
Token
Declared In:
Headers/SNRToken.h
Related To:
TokenOrigin
Inherits From:
BaseModel
Declaration:
class Token: BaseModel
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 | 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.
func isNearExpiring() -> Bool
TokenOrigin
Declared In:
Headers/SNRTokenOrigin.h
Declaration:
enum TokenOrigin: Int {
unknown,
synerise,
simpleAuth,
facebook,
oauth,
apple
}
Functions: Converts from TokenOrigin to String.
func SNR_TokenOriginToString(_: TokenOrigin) -> String
Converts from String to TokenOrigin.
func SNR_StringToTokenOrigin(_: String) -> TokenOrigin