Spatio.Api.Inbox (spatio_sdk v0.0.2)

API calls for all endpoints tagged Inbox.

Summary

Functions

get_inbox_counts(connection, opts \\ [])

Per-bucket unread counts.

list_inbox(connection, opts \\ [])

Unified inbox feed across mail, channel mentions, DMs, system notifications.

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

Mark a single inbox item as read.

workspace_get_inbox_counts(connection, org, workspace, opts \\ [])

Parameters

  • connection (Spatio.Connection): Connection to server
  • org (String.t):
  • workspace (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure
workspace_list_inbox(connection, org, workspace, opts \\ [])

Parameters

  • connection (Spatio.Connection): Connection to server
  • org (String.t):
  • workspace (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure
workspace_mark_inbox_item_read(connection, org, workspace, id, opts \\ [])

Parameters

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

Returns

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

Functions

get_inbox_counts(connection, opts \\ [])

@spec get_inbox_counts(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Spatio.Model.InboxCounts.t()}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Per-bucket unread counts.

Parameters

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

Returns

  • {:ok, Spatio.Model.InboxCounts.t} on success
  • {:error, Tesla.Env.t} on failure

list_inbox(connection, opts \\ [])

@spec list_inbox(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Spatio.Model.InboxListResponse.t()}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Unified inbox feed across mail, channel mentions, DMs, system notifications.

Parameters

  • connection (Spatio.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :category (String.t):
    • :unreadOnly (boolean()):
    • :limit (integer()):

Returns

  • {:ok, Spatio.Model.InboxListResponse.t} on success
  • {:error, Tesla.Env.t} on failure

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

@spec mark_inbox_item_read(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Mark a single inbox item as read.

Parameters

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

Returns

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

workspace_get_inbox_counts(connection, org, workspace, opts \\ [])

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

Parameters

  • connection (Spatio.Connection): Connection to server
  • org (String.t):
  • workspace (String.t):
  • opts (keyword): Optional parameters

Returns

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

workspace_list_inbox(connection, org, workspace, opts \\ [])

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

Parameters

  • connection (Spatio.Connection): Connection to server
  • org (String.t):
  • workspace (String.t):
  • opts (keyword): Optional parameters

Returns

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

workspace_mark_inbox_item_read(connection, org, workspace, id, opts \\ [])

@spec workspace_mark_inbox_item_read(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Parameters

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

Returns

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