Spatio.Api.Notifications (spatio_sdk v0.0.2)

API calls for all endpoints tagged Notifications.

Summary

Functions

get_notification_preferences(connection, opts \\ [])

Read the caller's notification preferences.

update_notification_preferences(connection, request_body, opts \\ [])

Update notification preferences.

Functions

get_notification_preferences(connection, opts \\ [])

@spec get_notification_preferences(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Read the caller's notification preferences.

Parameters

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

Returns

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

update_notification_preferences(connection, request_body, opts \\ [])

@spec update_notification_preferences(
  Tesla.Env.client(),
  %{optional(String.t()) => any()},
  keyword()
) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Update notification preferences.

Parameters

connection (Spatio.Connection): Connection to server
request_body (%{optional(String.t) => any()}):
opts (keyword): Optional parameters

Returns

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