OpenXchangeClient.Api.Jump (open_xchange_client v0.10.1)

API calls for all endpoints tagged Jump.

Link to this section Summary

Link to this section Functions

Link to this function

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

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

Acquires an identity token.

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
    • :system (String.t): The identifier for the external service/system, like "com.openexchange.jump.endpoint.mysystem".

returns

Returns

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