merge_ticketing_client 1.0.0

data/docs/DataPassthroughRequest.md

@@ -0,0 +1,32 @@
+# MergeTicketingClient::DataPassthroughRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **method** | [**MethodEnum**](MethodEnum.md) |  |  |
+| **path** | **String** |  |  |
+| **base_url_override** | **String** |  | [optional] |
+| **data** | **String** |  | [optional] |
+| **multipart_form_data** | [**Array<MultipartFormFieldRequest>**](MultipartFormFieldRequest.md) | Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`. | [optional] |
+| **headers** | [**Hash<String, AnyType>**](AnyType.md) | The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. | [optional] |
+| **request_format** | [**RequestFormatEnum**](RequestFormatEnum.md) |  | [optional] |
+| **normalize_response** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::DataPassthroughRequest.new(
+  method: POST,
+  path: /scooters,
+  base_url_override: null,
+  data: {"company": "Lime", "model": "Gen 2.5"},
+  multipart_form_data: null,
+  headers: {"EXTRA-HEADER":"value"},
+  request_format: JSON,
+  normalize_response: null
+)
+```
+

data/docs/DebugModeLog.md

@@ -0,0 +1,22 @@
+# MergeTicketingClient::DebugModeLog
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **log_id** | **String** |  |  |
+| **dashboard_view** | **String** |  |  |
+| **log_summary** | [**DebugModelLogSummary**](DebugModelLogSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::DebugModeLog.new(
+  log_id: 99433219-8017-4acd-bb3c-ceb23d663832,
+  dashboard_view: https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832,
+  log_summary: null
+)
+```
+

data/docs/DebugModelLogSummary.md

@@ -0,0 +1,22 @@
+# MergeTicketingClient::DebugModelLogSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** |  |  |
+| **method** | **String** |  |  |
+| **status_code** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::DebugModelLogSummary.new(
+  url: https://harvest.greenhouse.io/v1/candidates/,
+  method: POST,
+  status_code: 200
+)
+```
+

data/docs/DeleteAccountApi.md

@@ -0,0 +1,78 @@
+# MergeTicketingClient::DeleteAccountApi
+
+All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_account_create**](DeleteAccountApi.md#delete_account_create) | **POST** /delete-account |  |
+
+
+## delete_account_create
+
+> delete_account_create(x_account_token)
+
+
+
+Delete a linked account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_ticketing_client'
+# setup authorization
+MergeTicketingClient.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 = MergeTicketingClient::DeleteAccountApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  api_instance.delete_account_create(x_account_token)
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling DeleteAccountApi->delete_account_create: #{e}"
+end
+```
+
+#### Using the delete_account_create_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_account_create_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.delete_account_create_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling DeleteAccountApi->delete_account_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/EncodingEnum.md

@@ -0,0 +1,15 @@
+# MergeTicketingClient::EncodingEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::EncodingEnum.new()
+```
+

data/docs/EndUserDetailsRequest.md

@@ -0,0 +1,30 @@
+# MergeTicketingClient::EndUserDetailsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **end_user_email_address** | **String** | Your end user's email address. |  |
+| **end_user_organization_name** | **String** | Your end user's organization. |  |
+| **end_user_origin_id** | **String** | Unique ID for your end user. |  |
+| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | The integration categories to show in Merge Link. |  |
+| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://www.merge.dev/docs/basics/integration-metadata/. | [optional] |
+| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. | [optional][default to 30] |
+| **should_create_magic_link_url** | **Boolean** | Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/product/integrations,-fast.-say-hello-to-magic-link/. | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::EndUserDetailsRequest.new(
+  end_user_email_address: null,
+  end_user_organization_name: null,
+  end_user_origin_id: null,
+  categories: null,
+  integration: null,
+  link_expiry_mins: null,
+  should_create_magic_link_url: null
+)
+```
+

data/docs/ErrorValidationProblem.md

@@ -0,0 +1,24 @@
+# MergeTicketingClient::ErrorValidationProblem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source** | [**ValidationProblemSource**](ValidationProblemSource.md) |  | [optional] |
+| **title** | **String** |  |  |
+| **detail** | **String** |  |  |
+| **problem_type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::ErrorValidationProblem.new(
+  source: null,
+  title: Missing Required Field,
+  detail: custom_fields is a required field on model.,
+  problem_type: MISSING_REQUIRED_FIELD
+)
+```
+

data/docs/ForceResyncApi.md

@@ -0,0 +1,79 @@
+# MergeTicketingClient::ForceResyncApi
+
+All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**sync_status_resync_create**](ForceResyncApi.md#sync_status_resync_create) | **POST** /sync-status/resync |  |
+
+
+## sync_status_resync_create
+
+> <Array<SyncStatus>> sync_status_resync_create(x_account_token)
+
+
+
+Force re-sync of all models. This is only available for organizations on Merge's Grow and Expand plans.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_ticketing_client'
+# setup authorization
+MergeTicketingClient.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 = MergeTicketingClient::ForceResyncApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.sync_status_resync_create(x_account_token)
+  p result
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling ForceResyncApi->sync_status_resync_create: #{e}"
+end
+```
+
+#### Using the sync_status_resync_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<SyncStatus>>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.sync_status_resync_create_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<SyncStatus>>
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling ForceResyncApi->sync_status_resync_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+[**Array&lt;SyncStatus&gt;**](SyncStatus.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/GenerateKeyApi.md

@@ -0,0 +1,79 @@
+# MergeTicketingClient::GenerateKeyApi
+
+All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**generate_key_create**](GenerateKeyApi.md#generate_key_create) | **POST** /generate-key |  |
+
+
+## generate_key_create
+
+> <RemoteKey> generate_key_create(generate_remote_key_request)
+
+
+
+Create a remote key.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_ticketing_client'
+# setup authorization
+MergeTicketingClient.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 = MergeTicketingClient::GenerateKeyApi.new
+generate_remote_key_request = MergeTicketingClient::GenerateRemoteKeyRequest.new({name: 'Remote Deployment Key 1'}) # GenerateRemoteKeyRequest | 
+
+begin
+  
+  result = api_instance.generate_key_create(generate_remote_key_request)
+  p result
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling GenerateKeyApi->generate_key_create: #{e}"
+end
+```
+
+#### Using the generate_key_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RemoteKey>, Integer, Hash)> generate_key_create_with_http_info(generate_remote_key_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.generate_key_create_with_http_info(generate_remote_key_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RemoteKey>
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling GenerateKeyApi->generate_key_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **generate_remote_key_request** | [**GenerateRemoteKeyRequest**](GenerateRemoteKeyRequest.md) |  |  |
+
+### Return type
+
+[**RemoteKey**](RemoteKey.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/GenerateRemoteKeyRequest.md

@@ -0,0 +1,18 @@
+# MergeTicketingClient::GenerateRemoteKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::GenerateRemoteKeyRequest.new(
+  name: Remote Deployment Key 1
+)
+```
+

data/docs/Issue.md

@@ -0,0 +1,30 @@
+# MergeTicketingClient::Issue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **status** | [**IssueStatusEnum**](IssueStatusEnum.md) |  | [optional] |
+| **error_description** | **String** |  |  |
+| **end_user** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional][readonly] |
+| **first_incident_time** | **Time** |  | [optional] |
+| **last_incident_time** | **Time** |  | [optional] |
+| **is_muted** | **Boolean** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::Issue.new(
+  id: null,
+  status: null,
+  error_description: null,
+  end_user: null,
+  first_incident_time: null,
+  last_incident_time: null,
+  is_muted: null
+)
+```
+

data/docs/IssueStatusEnum.md

@@ -0,0 +1,15 @@
+# MergeTicketingClient::IssueStatusEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::IssueStatusEnum.new()
+```
+

data/docs/IssuesApi.md

@@ -0,0 +1,177 @@
+# MergeTicketingClient::IssuesApi
+
+All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**issues_list**](IssuesApi.md#issues_list) | **GET** /issues |  |
+| [**issues_retrieve**](IssuesApi.md#issues_retrieve) | **GET** /issues/{id} |  |
+
+
+## issues_list
+
+> <PaginatedIssueList> issues_list(opts)
+
+
+
+Gets issues.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_ticketing_client'
+# setup authorization
+MergeTicketingClient.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 = MergeTicketingClient::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 first 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 first 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 | 
+}
+
+begin
+  
+  result = api_instance.issues_list(opts)
+  p result
+rescue MergeTicketingClient::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(<PaginatedIssueList>, Integer, Hash)> issues_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.issues_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedIssueList>
+rescue MergeTicketingClient::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 first incident time was after this datetime. | [optional] |
+| **last_incident_time_before** | **Time** | If provided, will only return issues whose first 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** |  | [optional] |
+
+### Return type
+
+[**PaginatedIssueList**](PaginatedIssueList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## issues_retrieve
+
+> <Issue> issues_retrieve(id)
+
+
+
+Get a specific issue.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_ticketing_client'
+# setup authorization
+MergeTicketingClient.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 = MergeTicketingClient::IssuesApi.new
+id = TODO # String | 
+
+begin
+  
+  result = api_instance.issues_retrieve(id)
+  p result
+rescue MergeTicketingClient::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(<Issue>, Integer, Hash)> issues_retrieve_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.issues_retrieve_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Issue>
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling IssuesApi->issues_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | [**String**](.md) |  |  |
+
+### Return type
+
+[**Issue**](Issue.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/LinkToken.md

@@ -0,0 +1,22 @@
+# MergeTicketingClient::LinkToken
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **link_token** | **String** |  |  |
+| **integration_name** | **String** |  |  |
+| **magic_link_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::LinkToken.new(
+  link_token: necdP7FtdASl1fQwm62be2_dM4wBG8_GactqoUV0,
+  integration_name: Lever,
+  magic_link_url: https://link.merge.dev/asdfjkl12345jsndfgi2i83n
+)
+```
+