Skip to content

Latest commit

 

History

History
177 lines (126 loc) · 6.22 KB

IssuesApi.md

File metadata and controls

177 lines (126 loc) · 6.22 KB

MergeAccountingClient::IssuesApi

All URIs are relative to https://api.merge.dev/api/accounting/v1

Method HTTP request Description
issues_list GET /issues
issues_retrieve GET /issues/{id}

issues_list

issues_list(opts)

Gets issues.

Examples

require 'time'
require 'merge_accounting_client'
# setup authorization
MergeAccountingClient.configure do |config|
  # Configure API key authorization: tokenAuth
  config.api_key['tokenAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['tokenAuth'] = 'Bearer'
end

api_instance = MergeAccountingClient::IssuesApi.new
opts = {
  account_token: 'account_token_example', # String | 
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
  end_date: 'end_date_example', # String | If included, will only include issues whose most recent action occurred before this time
  end_user_organization_name: 'end_user_organization_name_example', # String | 
  first_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
  first_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
  include_muted: 'include_muted_example', # String | If True, will include muted issues
  integration_name: 'integration_name_example', # String | 
  last_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose last incident time was after this datetime.
  last_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose last incident time was before this datetime.
  page_size: 56, # Integer | Number of results to return per page.
  start_date: 'start_date_example', # String | If included, will only include issues whose most recent action occurred after this time
  status: 'ONGOING' # String | Status of the issue. Options: ('ONGOING', 'RESOLVED')  * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED
}

begin
  
  result = api_instance.issues_list(opts)
  p result
rescue MergeAccountingClient::ApiError => e
  puts "Error when calling IssuesApi->issues_list: #{e}"
end

Using the issues_list_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> issues_list_with_http_info(opts)

begin
  
  data, status_code, headers = api_instance.issues_list_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaginatedIssueList>
rescue MergeAccountingClient::ApiError => e
  puts "Error when calling IssuesApi->issues_list_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
account_token String [optional]
cursor String The pagination cursor value. [optional]
end_date String If included, will only include issues whose most recent action occurred before this time [optional]
end_user_organization_name String [optional]
first_incident_time_after Time If provided, will only return issues whose first incident time was after this datetime. [optional]
first_incident_time_before Time If provided, will only return issues whose first incident time was before this datetime. [optional]
include_muted String If True, will include muted issues [optional]
integration_name String [optional]
last_incident_time_after Time If provided, will only return issues whose last incident time was after this datetime. [optional]
last_incident_time_before Time If provided, will only return issues whose last incident time was before this datetime. [optional]
page_size Integer Number of results to return per page. [optional]
start_date String If included, will only include issues whose most recent action occurred after this time [optional]
status String Status of the issue. Options: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED [optional]

Return type

PaginatedIssueList

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

issues_retrieve

issues_retrieve(id)

Get a specific issue.

Examples

require 'time'
require 'merge_accounting_client'
# setup authorization
MergeAccountingClient.configure do |config|
  # Configure API key authorization: tokenAuth
  config.api_key['tokenAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['tokenAuth'] = 'Bearer'
end

api_instance = MergeAccountingClient::IssuesApi.new
id = TODO # String | 

begin
  
  result = api_instance.issues_retrieve(id)
  p result
rescue MergeAccountingClient::ApiError => e
  puts "Error when calling IssuesApi->issues_retrieve: #{e}"
end

Using the issues_retrieve_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> issues_retrieve_with_http_info(id)

begin
  
  data, status_code, headers = api_instance.issues_retrieve_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Issue>
rescue MergeAccountingClient::ApiError => e
  puts "Error when calling IssuesApi->issues_retrieve_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String

Return type

Issue

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json