OpenXchangeClient.Api.Advertisement (open_xchange_client v0.10.0)

API calls for all endpoints tagged Advertisement.

Link to this section Summary

Functions

Retrieves the advertisement configuration

Link to this section Functions

Link to this function

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

@spec get_advertisement_config(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, String.t()} | {:error, Tesla.Env.t()}

Retrieves the advertisement configuration

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