HookSniffAPI.Api.Devices (HookSniff v0.3.0)

API calls for all endpoints tagged Devices.

Summary

Functions

devices_get(connection, opts \\ [])

List registered devices

devices_post(connection, register_device_request, opts \\ [])

devices_token_delete(connection, token, opts \\ [])

Remove device token

Functions

devices_get(connection, opts \\ [])

@spec devices_get(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [HookSniffAPI.Model.DeviceTokenResponse.t()]} | {:error, Tesla.Env.t()}

List registered devices

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, [%DeviceTokenResponse{}, ...]} on success
{:error, Tesla.Env.t} on failure

devices_post(connection, register_device_request, opts \\ [])

@spec devices_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.RegisterDeviceRequest.t(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.DeviceTokenResponse.t()} | {:error, Tesla.Env.t()}

Parameters

connection (HookSniffAPI.Connection): Connection to server
register_device_request (RegisterDeviceRequest):
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.DeviceTokenResponse.t} on success
{:error, Tesla.Env.t} on failure

devices_token_delete(connection, token, opts \\ [])

@spec devices_token_delete(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Remove device token

Parameters

connection (HookSniffAPI.Connection): Connection to server
token (String.t):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure