Spatio.Api.Folders (spatio_sdk v0.0.2)

API calls for all endpoints tagged Folders.

Summary

Functions

create_email_folder(connection, create_email_folder_request, opts \\ [])

Create an email folder.

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

Delete an email folder.

list_email_folders(connection, opts \\ [])

List the caller's email folders.

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

List emails inside a folder.

move_emails_to_folder(connection, id, move_emails_request, opts \\ [])

Move emails into a folder.

update_email_folder(connection, id, update_email_folder_request, opts \\ [])

Update an email folder.

Functions

create_email_folder(connection, create_email_folder_request, opts \\ [])

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

Create an email folder.

Parameters

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

Returns

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

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

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

Delete an email folder.

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

list_email_folders(connection, opts \\ [])

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

List the caller's email folders.

Parameters

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

Returns

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

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

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

List emails inside a folder.

Parameters

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

Returns

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

move_emails_to_folder(connection, id, move_emails_request, opts \\ [])

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

Move emails into a folder.

Parameters

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

Returns

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

update_email_folder(connection, id, update_email_folder_request, opts \\ [])

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

Update an email folder.

Parameters

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

Returns

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