MergeHRISClient.Api.Issues (MergeHRISClient v1.0.3) View Source
API calls for all endpoints tagged Issues.
Link to this section Summary
Link to this section Functions
Specs
issues_list(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MergeHRISClient.Model.PaginatedIssueList.t()} | {:error, Tesla.Env.t()}
Gets issues.
Parameters
- connection (MergeHRISClient.Connection): Connection to server
- authorization (String.t): Should include 'Bearer ' followed by your test/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):
- :first_incident_time_after (DateTime.t): If provided, will only return issues whose first incident time was after this datetime.
- :first_incident_time_before (DateTime.t): If provided, will only return issues whose first incident time was before this datetime.
- :include_muted (String.t): If True, will include muted issues
- :integration_name (String.t):
- :last_incident_time_after (DateTime.t): If provided, will only return issues whose first incident time was after this datetime.
- :last_incident_time_before (DateTime.t): If provided, will only return issues whose first incident time was before this datetime.
- :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
Specs
issues_retrieve(Tesla.Env.client(), 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 test/production API Key.
- id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure