# SDK / API Documentation Please feel free to make contributions to the documentation by submitting a pull request with your contribution. ### [Click here to jump to API documentation.](#API-Documentation) ### Key / Legend ⚠ - Missing more documentation  - Read full markdown documentation ## SDK Documentation - ### Enums - [HTTP_METHOD](sdk-docs/enums/HTTP_METHOD.md) - [LOGIN_STATUS](sdk-docs/enums/LOGIN_STATUS.md) - [CREDENTIAL_TYPE](sdk-docs/enums/CREDENTIAL_TYPE.md) - [CREDENTIAL_STATUS](sdk-docs/enums/CREDENTIAL_STATUS.md) - [DEVICE_TOKEN_ACTION](sdk-docs/enums/DEVICE_TOKEN_ACTION.md) - [WEBSOCKET_STATUS](sdk-docs/enums/WEBSOCKET_STATUS.md) - ### Interfaces - [CLIENT_EVENTS](sdk-docs/interfaces/CLIENT_EVENTS.md) - ### Classes - ### Client - [](sdk-docs/classes/Client.md) - [constructor()](sdk-docs/classes/Client.md#constructor) - #### Public Methods (A-Z) - [api_call()](sdk-docs/classes/Client.md#api_call) - [authenticate_stream()](sdk-docs/classes/Client.md#authenticate_stream) - [connect_streaming_api()](sdk-docs/classes/Client.md#connect_streaming_api) - [create_session()](sdk-docs/classes/Client.md#create_session) - [end_session()](sdk-docs/classes/Client.md#end_session) - [generate_device_token()](sdk-docs/classes/Client.md#generate_device_token) - [get_device_token()](sdk-docs/classes/Client.md#get_device_token) - [get_phone_number()](sdk-docs/classes/Client.md#get_phone_number) - [get_request_headers()](sdk-docs/classes/Client.md#get_request_headers) - [get_session()](sdk-docs/classes/Client.md#get_session) - [interactive_login_prompt()](sdk-docs/classes/Client.md#interactive_login_prompt) - [reset_device_token()](sdk-docs/classes/Client.md#reset_device_token) - [send_pop_view_count()](sdk-docs/classes/Client.md#send_pop_view_count) - [set_event()](sdk-docs/classes/Client.md#set_event) - [set_language()](sdk-docs/classes/Client.md#set_language) - [set_phone_number()](sdk-docs/classes/Client.md#set_phone_number) - [sleep()](sdk-docs/classes/Client.md#sleep) - [submit_phone_number()](sdk-docs/classes/Client.md#submit_phone_number) - [submit_verification_code()](sdk-docs/classes/Client.md#submit_verification_code) - #### Private Methods (A-Z) - [send_device_token()](sdk-docs/classes/Client.md#send_device_token) - [stream_send()](sdk-docs/classes/Client.md#stream_send) - [submit_credential()](sdk-docs/classes/Client.md#submit_credential) - [trigger_event()](sdk-docs/classes/Client.md#trigger_event) - ### ApiResponseBase - [](sdk-docs/classes/ApiResponseBase.md) - [constructor()](sdk-docs/classes/ApiResponseBase.md#constructor) - #### Public Methods (A-Z) - [set_attributes()](sdk-docs/classes/ApiResponseBase.md#set_attributes) - ### Session - [](sdk-docs/classes/Session.md) - [constructor()](sdk-docs/classes/Session.md#constructor) - #### Public Methods (A-Z) - [set_phone_number()](sdk-docs/classes/Session.md#set_phone_number) - [set_verify_code()](sdk-docs/classes/Session.md#set_verify_code) - ### Config - [](sdk-docs/classes/Config.md) - [constructor()](sdk-docs/classes/Config.md#constructor) ## API Documentation - ### HTTPS Web API - `/api/configs` - [configs.md](api-docs/configs.md) - `/api/sessions` - [sessions.md](api-docs/sessions.md) - `/api/apple_device_tokens` - [apple_device_tokens.md](api-docs/apple_device_tokens.md) - `/api/users` - [users.md](api-docs/users.md) - `/api/groups` - [groups.md](api-docs/groups.md) ⚠️ - ### Websocket Streaming API - [Stream Authentication](api-docs/websocket-stream.md#stream-authentication) - [Pop View Counts Event](api-docs/websocket-stream.md#pop-view-counts-event)