OpenXchangeClient.Api.Capabilities (open_xchange_client v0.10.1)
API calls for all endpoints tagged Capabilities
.
Link to this section Summary
Link to this section Functions
Link to this function
get_all_capabilities(connection, session, opts \\ [])
@spec get_all_capabilities(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.CapabilitiesResponse.t()} | {:error, Tesla.Env.t()}
Gets all capabilities.
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_capability(connection, session, id, opts \\ [])
@spec get_capability(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.CapabilityResponse.t()} | {:error, Tesla.Env.t()}
Gets a capability.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- id (String.t): The identifier of the capability
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure