merge_ticketing_client 1.0.0

data/docs/TagsApi.md

@@ -0,0 +1,177 @@
+# MergeTicketingClient::TagsApi
+
+All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**tags_list**](TagsApi.md#tags_list) | **GET** /tags |  |
+| [**tags_retrieve**](TagsApi.md#tags_retrieve) | **GET** /tags/{id} |  |
+
+
+## tags_list
+
+> <PaginatedTagList> tags_list(x_account_token, opts)
+
+
+
+Returns a list of `Tag` objects.
+
+### 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::TagsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
+  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
+  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
+  page_size: 56, # Integer | Number of results to return per page.
+  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+}
+
+begin
+  
+  result = api_instance.tags_list(x_account_token, opts)
+  p result
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling TagsApi->tags_list: #{e}"
+end
+```
+
+#### Using the tags_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedTagList>, Integer, Hash)> tags_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.tags_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedTagList>
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling TagsApi->tags_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
+| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
+| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+
+### Return type
+
+[**PaginatedTagList**](PaginatedTagList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## tags_retrieve
+
+> <Tag> tags_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `Tag` object with the given `id`.
+
+### 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::TagsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+}
+
+begin
+  
+  result = api_instance.tags_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling TagsApi->tags_retrieve: #{e}"
+end
+```
+
+#### Using the tags_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Tag>, Integer, Hash)> tags_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.tags_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Tag>
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling TagsApi->tags_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**Tag**](Tag.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Team.md

@@ -0,0 +1,28 @@
+# MergeTicketingClient::Team
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **name** | **String** | The team's name. | [optional] |
+| **description** | **String** | The team's description. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::Team.new(
+  id: 17a54124-287f-494d-965e-3c5b330c9a68,
+  remote_id: 19202938,
+  name: Platform,
+  description: Platform and Integrations Team,
+  remote_data: null,
+  remote_was_deleted: null
+)
+```
+

data/docs/TeamsApi.md

@@ -0,0 +1,177 @@
+# MergeTicketingClient::TeamsApi
+
+All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**teams_list**](TeamsApi.md#teams_list) | **GET** /teams |  |
+| [**teams_retrieve**](TeamsApi.md#teams_retrieve) | **GET** /teams/{id} |  |
+
+
+## teams_list
+
+> <PaginatedTeamList> teams_list(x_account_token, opts)
+
+
+
+Returns a list of `Team` objects.
+
+### 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::TeamsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
+  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
+  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
+  page_size: 56, # Integer | Number of results to return per page.
+  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+}
+
+begin
+  
+  result = api_instance.teams_list(x_account_token, opts)
+  p result
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling TeamsApi->teams_list: #{e}"
+end
+```
+
+#### Using the teams_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedTeamList>, Integer, Hash)> teams_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.teams_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedTeamList>
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling TeamsApi->teams_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
+| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
+| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+
+### Return type
+
+[**PaginatedTeamList**](PaginatedTeamList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## teams_retrieve
+
+> <Team> teams_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `Team` object with the given `id`.
+
+### 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::TeamsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+}
+
+begin
+  
+  result = api_instance.teams_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling TeamsApi->teams_retrieve: #{e}"
+end
+```
+
+#### Using the teams_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Team>, Integer, Hash)> teams_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.teams_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Team>
+rescue MergeTicketingClient::ApiError => e
+  puts "Error when calling TeamsApi->teams_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**Team**](Team.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Ticket.md

@@ -0,0 +1,52 @@
+# MergeTicketingClient::Ticket
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **name** | **String** | The ticket's name. | [optional] |
+| **assignees** | **Array<String>** |  | [optional] |
+| **due_date** | **Time** | The ticket's due date. | [optional] |
+| **status** | [**TicketStatusEnum**](TicketStatusEnum.md) | The current status of the ticket. | [optional] |
+| **description** | **String** | The ticket's description. | [optional] |
+| **project** | **String** |  | [optional] |
+| **ticket_type** | **String** | The ticket's type. | [optional] |
+| **account** | **String** |  | [optional] |
+| **contact** | **String** |  | [optional] |
+| **parent_ticket** | **String** |  | [optional] |
+| **attachments** | **Array<String>** |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **remote_created_at** | **Time** | When the third party's ticket was created. | [optional] |
+| **remote_updated_at** | **Time** | When the third party's ticket was updated. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+| **remote_was_deleted** | **Boolean** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::Ticket.new(
+  id: 0958cbc6-6040-430a-848e-aafacbadf4ae,
+  remote_id: 19202938,
+  name: Please add more integrations,
+  assignees: ["17a54124-287f-494d-965e-3c5b330c9a68"],
+  due_date: 2022-10-11T00:00Z,
+  status: OPEN,
+  description: Can you please add more integrations? It'll make syncing data much easier!,
+  project: fb8c55b6-1cb8-4b4c-9fb6-17924231619d,
+  ticket_type: incident,
+  account: 0958cbc6-6040-430a-848e-aafacbadf4ae,
+  contact: 65c345ba-6870-4974-87ba-dd31509c367a,
+  parent_ticket: 75b33d04-30d2-4f3e-be45-27838bc94342,
+  attachments: ["42747df1-95e7-46e2-93cc-66f1191edca5","92f972d0-2526-434b-9409-4c3b468e08f0"],
+  tags: ["enterprise","other-tag"],
+  remote_created_at: 2021-11-10T00:00Z,
+  remote_updated_at: 2021-12-09T00:00Z,
+  remote_data: null,
+  remote_was_deleted: null
+)
+```
+

data/docs/TicketEndpointRequest.md

@@ -0,0 +1,18 @@
+# MergeTicketingClient::TicketEndpointRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**TicketRequest**](TicketRequest.md) |  |  |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::TicketEndpointRequest.new(
+  model: null
+)
+```
+

data/docs/TicketRequest.md

@@ -0,0 +1,46 @@
+# MergeTicketingClient::TicketRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **name** | **String** | The ticket's name. | [optional] |
+| **assignees** | **Array<String>** |  | [optional] |
+| **due_date** | **Time** | The ticket's due date. | [optional] |
+| **status** | [**TicketStatusEnum**](TicketStatusEnum.md) | The current status of the ticket. | [optional] |
+| **description** | **String** | The ticket's description. | [optional] |
+| **project** | **String** |  | [optional] |
+| **ticket_type** | **String** | The ticket's type. | [optional] |
+| **account** | **String** |  | [optional] |
+| **contact** | **String** |  | [optional] |
+| **parent_ticket** | **String** |  | [optional] |
+| **attachments** | **Array<String>** |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **remote_created_at** | **Time** | When the third party's ticket was created. | [optional] |
+| **remote_updated_at** | **Time** | When the third party's ticket was updated. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::TicketRequest.new(
+  remote_id: 19202938,
+  name: Please add more integrations,
+  assignees: ["17a54124-287f-494d-965e-3c5b330c9a68"],
+  due_date: 2022-10-11T00:00Z,
+  status: OPEN,
+  description: Can you please add more integrations? It'll make syncing data much easier!,
+  project: fb8c55b6-1cb8-4b4c-9fb6-17924231619d,
+  ticket_type: incident,
+  account: 0958cbc6-6040-430a-848e-aafacbadf4ae,
+  contact: 65c345ba-6870-4974-87ba-dd31509c367a,
+  parent_ticket: 75b33d04-30d2-4f3e-be45-27838bc94342,
+  attachments: ["42747df1-95e7-46e2-93cc-66f1191edca5","92f972d0-2526-434b-9409-4c3b468e08f0"],
+  tags: ["enterprise","other-tag"],
+  remote_created_at: 2021-11-10T00:00Z,
+  remote_updated_at: 2021-12-09T00:00Z
+)
+```
+

data/docs/TicketResponse.md

@@ -0,0 +1,24 @@
+# MergeTicketingClient::TicketResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**Ticket**](Ticket.md) |  |  |
+| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) |  |  |
+| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) |  |  |
+| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::TicketResponse.new(
+  model: null,
+  warnings: null,
+  errors: null,
+  logs: null
+)
+```
+

data/docs/TicketStatusEnum.md

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

data/docs/TicketingAttachmentEndpointRequest.md

@@ -0,0 +1,18 @@
+# MergeTicketingClient::TicketingAttachmentEndpointRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**AttachmentRequest**](AttachmentRequest.md) |  |  |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::TicketingAttachmentEndpointRequest.new(
+  model: null
+)
+```
+

data/docs/TicketingAttachmentResponse.md

@@ -0,0 +1,24 @@
+# MergeTicketingClient::TicketingAttachmentResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**Attachment**](Attachment.md) |  |  |
+| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) |  |  |
+| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) |  |  |
+| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ticketing_client'
+
+instance = MergeTicketingClient::TicketingAttachmentResponse.new(
+  model: null,
+  warnings: null,
+  errors: null,
+  logs: null
+)
+```
+