Skip to content

Latest commit

 

History

History
106 lines (67 loc) · 1.94 KB

endpoints.md

File metadata and controls

106 lines (67 loc) · 1.94 KB
Raw

Endpoints

endpoints_controller = client.endpoints

Class Name

EndpointsController

Methods

Get Pin

def get_pin(self)

Response Type

CodeResponse

Example Usage

result = endpoints_controller.get_pin()

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException

Get Pin Status

def get_pin_status(self,
                  user_code)

Parameters

Parameter Type Tags Description
user_code string Template, Required -

Response Type

CodeStatusResponse

Example Usage

user_code = 'userCode0'

result = endpoints_controller.get_pin_status(user_code)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException

Get User Settings

def get_user_settings(self,
                     user_id)

Parameters

Parameter Type Tags Description
user_id uuid|string Template, Required -

Response Type

UserSettings

Example Usage

user_id = '000013ec-0000-0000-0000-000000000000'

result = endpoints_controller.get_user_settings(user_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException