MergeHRISClient.Api.AvailableActions (MergeHRISClient v1.0.2) View Source

API calls for all endpoints tagged AvailableActions.

Link to this section Summary

Functions

Returns a list of models and actions available for an account.

Link to this section Functions

Link to this function

available_actions_retrieve(connection, authorization, x_account_token, opts \\ [])

View Source

Specs

available_actions_retrieve(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, MergeHRISClient.Model.AvailableActions.t()} | {:error, Tesla.Env.t()}

Returns a list of models and actions available for an account.

Parameters

  • connection (MergeHRISClient.Connection): Connection to server
  • authorization (String.t): Should include 'Bearer ' followed by your production API Key.
  • x_account_token (String.t): Token identifying the end user.
  • opts (KeywordList): [optional] Optional parameters

    Returns

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