OpenXchangeClient.Api.Quota (open_xchange_client v0.10.1)

API calls for all endpoints tagged Quota.

Link to this section Summary

Link to this section Functions

Link to this function

get_filestore_usage(connection, session, opts \\ [])

@spec get_filestore_usage(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpenXchangeClient.Model.QuotaResponse.t()} | {:error, Tesla.Env.t()}

Gets the filestore usage data.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

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

Link to this function

get_mail_usage(connection, session, opts \\ [])

@spec get_mail_usage(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpenXchangeClient.Model.QuotaResponse.t()} | {:error, Tesla.Env.t()}

Gets the mail usage data.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

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

Link to this function

get_quota_information(connection, session, opts \\ [])

@spec get_quota_information(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil}
  | {:ok, OpenXchangeClient.Model.QuotasResponse.t()}
  | {:error, Tesla.Env.t()}

Gets quota information.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • opts (KeywordList): [optional] Optional parameters
    • :module (String.t): The module identifier (e.g. "share_links", "filestorage", ...) to get quota information for, required if account is set.
    • :account (String.t): The account identifier within the module to get quota information for.

returns

Returns

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