View Source PlacetelAPI.Api.Subscriptions (placetel_api v2.0.1)

API calls for all endpoints tagged Subscriptions.

Link to this section Summary

Functions

List subscriptions Fetch a list of all registered subscriptions

Link to this section Functions

Link to this function

delete_subscriptions_id(connection, id, opts \\ [])

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

Delete a subscription

parameters

Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • id (String.t):
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_subscriptions(connection, opts \\ [])

View Source
@spec get_subscriptions(
  Tesla.Env.client(),
  keyword()
) :: {:ok, [PlacetelAPI.Model.Subscription.t()]} | {:error, Tesla.Env.t()}

List subscriptions Fetch a list of all registered subscriptions

parameters

Parameters

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

returns

Returns

  • {:ok, [%Subscription{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

put_subscriptions(connection, subscriptions, opts \\ [])

View Source
@spec put_subscriptions(
  Tesla.Env.client(),
  PlacetelAPI.Model.PutSubscriptions.t(),
  keyword()
) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Add a subscription

parameters

Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • subscriptions (PutSubscriptions):
  • opts (keyword): Optional parameters

returns

Returns

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