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

API calls for all endpoints tagged Issues.

Link to this section Summary

Link to this section Functions

Link to this function

issues_list(connection, authorization, opts \\ [])

View Source

Specs

Gets issues.

Parameters

  • connection (MergeHRISClient.Connection): Connection to server
  • authorization (String.t): Should include 'Bearer ' followed by your production API Key.
  • opts (KeywordList): [optional] Optional parameters
    • :account_token (String.t):
    • :cursor (String.t): The pagination cursor value.
    • :end_date (String.t): If included, will only include issues whose most recent action occurred before this time
    • :end_user_organization_name (String.t):
    • :include_muted (String.t): If True, will include muted issues
    • :integration_name (String.t):
    • :page_size (integer()): Number of results to return per page.
    • :start_date (String.t): If included, will only include issues whose most recent action occurred after this time
    • :status (String.t):

      Returns

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

Link to this function

issues_retrieve(connection, authorization, x_account_token, id, opts \\ [])

View Source

Specs

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

Get a specific issue.

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.
  • id (String.t):
  • opts (KeywordList): [optional] Optional parameters

    Returns

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