OpenXchangeClient.Api.JSlob (open_xchange_client v0.10.0)

API calls for all endpoints tagged JSlob.

Link to this section Summary

Functions

Stores or deletes a JSlob. To delete a JSON configuration just send an empty request body for the specified id.

Link to this section Functions

Link to this function

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

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

Gets all JSlobs.

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
    • :service_id (String.t): The identifier for the JSlob service, default is "com.openexchange.jslob.config".

returns

Returns

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

Link to this function

get_j_slob_list(connection, session, body, opts \\ [])

@spec get_j_slob_list(Tesla.Env.client(), String.t(), [String.t()], keyword()) ::
  {:ok, OpenXchangeClient.Model.JSlobsResponse.t()} | {:error, Tesla.Env.t()}

Gets a list of JSlobs.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • body ([String.t]): A JSON array with the identifiers of the requested JSlobs.
  • opts (KeywordList): [optional] Optional parameters
    • :service_id (String.t): The identifier for the JSlob service, default is "com.openexchange.jslob.config".

returns

Returns

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

Link to this function

set_j_slob(connection, session, body, opts \\ [])

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

Stores or deletes a JSlob. To delete a JSON configuration just send an empty request body for the specified id.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • body (map()): A JSON object containing the JSON configuration to store. To delete the JSlob just send an empty body.
  • opts (KeywordList): [optional] Optional parameters
    • :id (String.t): The JSlob indentifier.
    • :service_id (String.t): The identifier for the JSlob service, default is "com.openexchange.jslob.config".

returns

Returns

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

Link to this function

update_j_slob(connection, session, body, opts \\ [])

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

Updates a JSlob.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • body (map()): The JSON object containing the updated JSON configuration to store. Fields that are not included are thus not affected and survive the change. Use /jslob?action=set to delete fields or entire JSlob.
  • opts (KeywordList): [optional] Optional parameters
    • :id (String.t): The JSlob indentifier.
    • :service_id (String.t): The identifier for the JSlob service, default is "com.openexchange.jslob.config".

returns

Returns

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