AgentPushKit.Api.Devices (agent_push_kit v0.1.0)

API calls for all endpoints tagged Devices.

Summary

Functions

get_web_push_configuration(connection, opts \\ [])

Get browser push availability and its public VAPID key

register_device(connection, register_device_input, opts \\ [])

register_web_push_subscription(connection, register_web_push_subscription_input, opts \\ [])

remove_device(connection, installation_id, opts \\ [])

Disable push delivery to one installation

remove_web_push_subscription(connection, subscription_id, opts \\ [])

Disable a browser push subscription

Functions

get_web_push_configuration(connection, opts \\ [])

@spec get_web_push_configuration(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.WebPushConfiguration.t()}
  | {:error, Tesla.Env.t()}

Get browser push availability and its public VAPID key

Parameters

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

Returns

{:ok, AgentPushKit.Model.WebPushConfiguration.t} on success
{:error, Tesla.Env.t} on failure

register_device(connection, register_device_input, opts \\ [])

@spec register_device(
  Tesla.Env.client(),
  AgentPushKit.Model.RegisterDeviceInput.t(),
  keyword()
) ::
  {:ok, AgentPushKit.Model.Device.t()}
  | {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (AgentPushKit.Connection): Connection to server
register_device_input (RegisterDeviceInput):
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.Device.t} on success
{:error, Tesla.Env.t} on failure

register_web_push_subscription(connection, register_web_push_subscription_input, opts \\ [])

@spec register_web_push_subscription(
  Tesla.Env.client(),
  AgentPushKit.Model.RegisterWebPushSubscriptionInput.t(),
  keyword()
) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.WebPushSubscription.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (AgentPushKit.Connection): Connection to server
register_web_push_subscription_input (RegisterWebPushSubscriptionInput):
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.WebPushSubscription.t} on success
{:error, Tesla.Env.t} on failure

remove_device(connection, installation_id, opts \\ [])

@spec remove_device(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.DisabledResponse.t()}
  | {:error, Tesla.Env.t()}

Disable push delivery to one installation

Parameters

connection (AgentPushKit.Connection): Connection to server
installation_id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.DisabledResponse.t} on success
{:error, Tesla.Env.t} on failure

remove_web_push_subscription(connection, subscription_id, opts \\ [])

@spec remove_web_push_subscription(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.DisabledResponse.t()}
  | {:error, Tesla.Env.t()}

Disable a browser push subscription

Parameters

connection (AgentPushKit.Connection): Connection to server
subscription_id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.DisabledResponse.t} on success
{:error, Tesla.Env.t} on failure