View Source PlacetelAPI.Api.Subscriptions (placetel_api v2.0.1)
API calls for all endpoints tagged Subscriptions
.
Link to this section Summary
Functions
Delete a subscription
List subscriptions Fetch a list of all registered subscriptions
Add a subscription
Link to this section Functions
@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 serverid
(String.t):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
@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 serveropts
(keyword): Optional parameters
returns
Returns
{:ok, [%Subscription{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@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 serversubscriptions
(PutSubscriptions):opts
(keyword): Optional parameters
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure