README.md

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.

Key / Legend

⚠ - Missing more documentation

- Read full markdown documentation

SDK Documentation

• Enums

  • HTTP_METHOD
  • LOGIN_STATUS
  • CREDENTIAL_TYPE
  • CREDENTIAL_STATUS
  • DEVICE_TOKEN_ACTION
  • WEBSOCKET_STATUS

• Interfaces

  • CLIENT_EVENTS

• Classes

  • Client -

    • constructor()

    • Public Methods (A-Z)

      • api_call()
      • authenticate_stream()
      • connect_streaming_api()
      • create_session()
      • end_session()
      • generate_device_token()
      • get_device_token()
      • get_phone_number()
      • get_request_headers()
      • get_session()
      • interactive_login_prompt()
      • reset_device_token()
      • send_pop_view_count()
      • set_event()
      • set_language()
      • set_phone_number()
      • sleep()
      • submit_phone_number()
      • submit_verification_code()

    • Private Methods (A-Z)

      • send_device_token()
      • stream_send()
      • submit_credential()
      • trigger_event()

  • ApiResponseBase -

    • constructor()

    • Public Methods (A-Z)

      • set_attributes()

  • Session -

    • constructor()

    • Public Methods (A-Z)

      • set_phone_number()
      • set_verify_code()

  • Config -

    • constructor()

API Documentation

• HTTPS Web API

  • /api/configs - configs.md
  • /api/sessions - sessions.md
  • /api/apple_device_tokens - apple_device_tokens.md
  • /api/users - users.md
  • /api/groups - groups.md ⚠️

• Websocket Streaming API

  • Stream Authentication
  • Pop View Counts Event