HookSniffAPI.Api.Notifications (HookSniff v0.3.0)

API calls for all endpoints tagged Notifications.

Summary

Functions

notifications_get(connection, opts \\ [])

List notifications

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

Delete notification

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

Mark notification as read

notifications_read_all_put(connection, opts \\ [])

Mark all notifications as read

notifications_unread_count_get(connection, opts \\ [])

Get unread notification count

Functions

notifications_get(connection, opts \\ [])

@spec notifications_get(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.NotificationListResponse.t()}
  | {:error, Tesla.Env.t()}

List notifications

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :page (integer()):
- :per_page (integer()):

Returns

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

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

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

Delete notification

Parameters

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

Returns

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

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

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

Mark notification as read

Parameters

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

Returns

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

notifications_read_all_put(connection, opts \\ [])

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

Mark all notifications as read

Parameters

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

Returns

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

notifications_unread_count_get(connection, opts \\ [])

@spec notifications_unread_count_get(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.NotificationsUnreadCountGet200Response.t()}
  | {:error, Tesla.Env.t()}

Get unread notification count

Parameters

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

Returns

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