merge_ticketing_client 1.0.1 → 1.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (139) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -6
  3. data/docs/Account.md +11 -10
  4. data/docs/AccountIntegration.md +1 -1
  5. data/docs/Attachment.md +15 -14
  6. data/docs/AttachmentRequest.md +11 -12
  7. data/docs/Collection.md +33 -0
  8. data/docs/CollectionTypeEnum.md +15 -0
  9. data/docs/CollectionsApi.md +193 -0
  10. data/docs/Comment.md +16 -15
  11. data/docs/CommentRequest.md +12 -13
  12. data/docs/ConditionSchema.md +30 -0
  13. data/docs/ConditionTypeEnum.md +15 -0
  14. data/docs/Contact.md +14 -13
  15. data/docs/DataPassthroughRequest.md +10 -11
  16. data/docs/EndUserDetailsRequest.md +2 -2
  17. data/docs/FieldFormatEnum.md +15 -0
  18. data/docs/FieldTypeEnum.md +15 -0
  19. data/docs/Issue.md +18 -17
  20. data/docs/LinkToken.md +1 -1
  21. data/docs/LinkedAccountCondition.md +27 -0
  22. data/docs/LinkedAccountConditionRequest.md +21 -0
  23. data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
  24. data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
  25. data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
  26. data/docs/MetaResponse.md +6 -7
  27. data/docs/OperatorSchema.md +20 -0
  28. data/docs/PaginatedCollectionList.md +22 -0
  29. data/docs/PaginatedConditionSchemaList.md +22 -0
  30. data/docs/PaginatedRemoteFieldClassList.md +22 -0
  31. data/docs/PatchedTicketRequest.md +25 -22
  32. data/docs/Project.md +11 -10
  33. data/docs/ProjectsApi.md +10 -8
  34. data/docs/RemoteData.md +4 -5
  35. data/docs/RemoteField.md +19 -0
  36. data/docs/RemoteFieldClass.md +38 -0
  37. data/docs/RemoteFieldClassItemSchema.md +22 -0
  38. data/docs/RemoteResponse.md +9 -10
  39. data/docs/SelectiveSyncApi.md +233 -0
  40. data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
  41. data/docs/SyncStatus.md +5 -3
  42. data/docs/Tag.md +9 -8
  43. data/docs/Team.md +11 -10
  44. data/docs/Ticket.md +32 -25
  45. data/docs/TicketRequest.md +26 -25
  46. data/docs/TicketsApi.md +141 -13
  47. data/docs/User.md +14 -13
  48. data/docs/UsersApi.md +2 -0
  49. data/lib/merge_ticketing_client/api/collections_api.rb +234 -0
  50. data/lib/merge_ticketing_client/api/linked_accounts_api.rb +1 -1
  51. data/lib/merge_ticketing_client/api/projects_api.rb +14 -11
  52. data/lib/merge_ticketing_client/api/selective_sync_api.rb +225 -0
  53. data/lib/merge_ticketing_client/api/tickets_api.rb +177 -19
  54. data/lib/merge_ticketing_client/api/users_api.rb +3 -0
  55. data/lib/merge_ticketing_client/models/account.rb +16 -4
  56. data/lib/merge_ticketing_client/models/account_details_and_actions_status_enum.rb +1 -1
  57. data/lib/merge_ticketing_client/models/account_integration.rb +1 -1
  58. data/lib/merge_ticketing_client/models/attachment.rb +18 -4
  59. data/lib/merge_ticketing_client/models/attachment_request.rb +24 -20
  60. data/lib/merge_ticketing_client/models/categories_enum.rb +3 -2
  61. data/lib/merge_ticketing_client/models/category_enum.rb +3 -2
  62. data/lib/merge_ticketing_client/models/collection.rb +308 -0
  63. data/lib/merge_ticketing_client/models/collection_type_enum.rb +45 -0
  64. data/lib/merge_ticketing_client/models/comment.rb +19 -4
  65. data/lib/merge_ticketing_client/models/comment_request.rb +25 -20
  66. data/lib/merge_ticketing_client/models/condition_schema.rb +297 -0
  67. data/lib/merge_ticketing_client/models/condition_type_enum.rb +50 -0
  68. data/lib/merge_ticketing_client/models/contact.rb +16 -4
  69. data/lib/merge_ticketing_client/models/data_passthrough_request.rb +1 -0
  70. data/lib/merge_ticketing_client/models/encoding_enum.rb +1 -1
  71. data/lib/merge_ticketing_client/models/end_user_details_request.rb +2 -2
  72. data/lib/merge_ticketing_client/models/field_format_enum.rb +49 -0
  73. data/lib/merge_ticketing_client/models/field_type_enum.rb +49 -0
  74. data/lib/merge_ticketing_client/models/issue.rb +15 -4
  75. data/lib/merge_ticketing_client/models/link_token.rb +0 -5
  76. data/lib/merge_ticketing_client/models/linked_account_condition.rb +282 -0
  77. data/lib/merge_ticketing_client/models/linked_account_condition_request.rb +269 -0
  78. data/lib/merge_ticketing_client/models/linked_account_selective_sync_configuration.rb +221 -0
  79. data/lib/merge_ticketing_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
  80. data/lib/merge_ticketing_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
  81. data/lib/merge_ticketing_client/models/method_enum.rb +1 -1
  82. data/lib/merge_ticketing_client/models/operator_schema.rb +229 -0
  83. data/lib/merge_ticketing_client/models/paginated_collection_list.rb +240 -0
  84. data/lib/merge_ticketing_client/models/paginated_condition_schema_list.rb +240 -0
  85. data/lib/merge_ticketing_client/models/paginated_remote_field_class_list.rb +240 -0
  86. data/lib/merge_ticketing_client/models/patched_ticket_request.rb +57 -29
  87. data/lib/merge_ticketing_client/models/priority_enum.rb +1 -1
  88. data/lib/merge_ticketing_client/models/project.rb +16 -4
  89. data/lib/merge_ticketing_client/models/remote_data.rb +9 -7
  90. data/lib/merge_ticketing_client/models/remote_field.rb +231 -0
  91. data/lib/merge_ticketing_client/models/remote_field_class.rb +318 -0
  92. data/lib/merge_ticketing_client/models/remote_field_class_item_schema.rb +241 -0
  93. data/lib/merge_ticketing_client/models/request_format_enum.rb +1 -1
  94. data/lib/merge_ticketing_client/models/response_type_enum.rb +1 -1
  95. data/lib/merge_ticketing_client/models/selective_sync_configurations_usage_enum.rb +45 -0
  96. data/lib/merge_ticketing_client/models/sync_status.rb +13 -4
  97. data/lib/merge_ticketing_client/models/sync_status_status_enum.rb +1 -1
  98. data/lib/merge_ticketing_client/models/tag.rb +16 -4
  99. data/lib/merge_ticketing_client/models/team.rb +16 -4
  100. data/lib/merge_ticketing_client/models/ticket.rb +56 -7
  101. data/lib/merge_ticketing_client/models/ticket_request.rb +57 -40
  102. data/lib/merge_ticketing_client/models/ticket_status_enum.rb +1 -1
  103. data/lib/merge_ticketing_client/models/user.rb +16 -4
  104. data/lib/merge_ticketing_client/version.rb +1 -1
  105. data/lib/merge_ticketing_client.rb +21 -0
  106. data/spec/api/collections_api_spec.rb +76 -0
  107. data/spec/api/projects_api_spec.rb +3 -2
  108. data/spec/api/selective_sync_api_spec.rb +72 -0
  109. data/spec/api/tickets_api_spec.rb +24 -4
  110. data/spec/api/users_api_spec.rb +1 -0
  111. data/spec/models/account_spec.rb +6 -0
  112. data/spec/models/attachment_request_spec.rb +12 -0
  113. data/spec/models/attachment_spec.rb +6 -0
  114. data/spec/models/collection_spec.rb +82 -0
  115. data/spec/models/collection_type_enum_spec.rb +28 -0
  116. data/spec/models/comment_request_spec.rb +12 -0
  117. data/spec/models/comment_spec.rb +6 -0
  118. data/spec/models/condition_schema_spec.rb +70 -0
  119. data/spec/models/condition_type_enum_spec.rb +28 -0
  120. data/spec/models/contact_spec.rb +6 -0
  121. data/spec/models/issue_spec.rb +6 -0
  122. data/spec/models/linked_account_condition_request_spec.rb +46 -0
  123. data/spec/models/linked_account_condition_spec.rb +64 -0
  124. data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
  125. data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
  126. data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
  127. data/spec/models/operator_schema_spec.rb +40 -0
  128. data/spec/models/paginated_collection_list_spec.rb +46 -0
  129. data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
  130. data/spec/models/patched_ticket_request_spec.rb +24 -0
  131. data/spec/models/project_spec.rb +6 -0
  132. data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
  133. data/spec/models/sync_status_spec.rb +6 -0
  134. data/spec/models/tag_spec.rb +6 -0
  135. data/spec/models/team_spec.rb +6 -0
  136. data/spec/models/ticket_request_spec.rb +24 -0
  137. data/spec/models/ticket_spec.rb +18 -0
  138. data/spec/models/user_spec.rb +6 -0
  139. metadata +144 -72
data/docs/ProjectsApi.md CHANGED
@@ -6,7 +6,7 @@ All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**projects_list**](ProjectsApi.md#projects_list) | **GET** /projects | |
8
8
  | [**projects_retrieve**](ProjectsApi.md#projects_retrieve) | **GET** /projects/{id} | |
9
- | [**projects_users_list**](ProjectsApi.md#projects_users_list) | **GET** /projects/{id}/users | |
9
+ | [**projects_users_list**](ProjectsApi.md#projects_users_list) | **GET** /projects/{parent_id}/users | |
10
10
 
11
11
 
12
12
  ## projects_list
@@ -179,11 +179,11 @@ end
179
179
 
180
180
  ## projects_users_list
181
181
 
182
- > <PaginatedUserList> projects_users_list(x_account_token, id, opts)
182
+ > <PaginatedUserList> projects_users_list(x_account_token, parent_id, opts)
183
183
 
184
184
 
185
185
 
186
- Returns a `User` object with the given `id`.
186
+ Returns a list of `User` objects.
187
187
 
188
188
  ### Examples
189
189
 
@@ -200,17 +200,18 @@ end
200
200
 
201
201
  api_instance = MergeTicketingClient::ProjectsApi.new
202
202
  x_account_token = 'x_account_token_example' # String | Token identifying the end user.
203
- id = TODO # String |
203
+ parent_id = TODO # String |
204
204
  opts = {
205
205
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
206
206
  expand: 'teams', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
207
+ include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
207
208
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
208
209
  page_size: 56 # Integer | Number of results to return per page.
209
210
  }
210
211
 
211
212
  begin
212
213
 
213
- result = api_instance.projects_users_list(x_account_token, id, opts)
214
+ result = api_instance.projects_users_list(x_account_token, parent_id, opts)
214
215
  p result
215
216
  rescue MergeTicketingClient::ApiError => e
216
217
  puts "Error when calling ProjectsApi->projects_users_list: #{e}"
@@ -221,12 +222,12 @@ end
221
222
 
222
223
  This returns an Array which contains the response data, status code and headers.
223
224
 
224
- > <Array(<PaginatedUserList>, Integer, Hash)> projects_users_list_with_http_info(x_account_token, id, opts)
225
+ > <Array(<PaginatedUserList>, Integer, Hash)> projects_users_list_with_http_info(x_account_token, parent_id, opts)
225
226
 
226
227
  ```ruby
227
228
  begin
228
229
 
229
- data, status_code, headers = api_instance.projects_users_list_with_http_info(x_account_token, id, opts)
230
+ data, status_code, headers = api_instance.projects_users_list_with_http_info(x_account_token, parent_id, opts)
230
231
  p status_code # => 2xx
231
232
  p headers # => { ... }
232
233
  p data # => <PaginatedUserList>
@@ -240,9 +241,10 @@ end
240
241
  | Name | Type | Description | Notes |
241
242
  | ---- | ---- | ----------- | ----- |
242
243
  | **x_account_token** | **String** | Token identifying the end user. | |
243
- | **id** | [**String**](.md) | | |
244
+ | **parent_id** | [**String**](.md) | | |
244
245
  | **cursor** | **String** | The pagination cursor value. | [optional] |
245
246
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
247
+ | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
246
248
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
247
249
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
248
250
 
data/docs/RemoteData.md CHANGED
@@ -2,10 +2,10 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **path** | **String** | | |
8
- | **data** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
5
+ | Name | Type | Description | Notes |
6
+ | -------- | ------------------------------------------- | ----------- | ---------- |
7
+ | **path** | **String** | | |
8
+ | **data** | [**Hash&lt;String, Object&gt;**](Object.md) | | [optional] |
9
9
 
10
10
  ## Example
11
11
 
@@ -17,4 +17,3 @@ instance = MergeTicketingClient::RemoteData.new(
17
17
  data: null
18
18
  )
19
19
  ```
20
-
@@ -0,0 +1,19 @@
1
+ # MergeTicketingClient::RemoteField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---------------------- | ------------------------------------------- | ----------- | ---------- |
7
+ | **value** | [**Hash&lt;String, Object&gt;**](Object.md) | | [optional] |
8
+ | **remote_field_class** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'merge_ticketing_client'
14
+
15
+ instance = MergeTicketingClient::RemoteField.new(
16
+ value: null,
17
+ remote_field_class: null
18
+ )
19
+ ```
@@ -0,0 +1,38 @@
1
+ # MergeTicketingClient::RemoteFieldClass
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **display_name** | **String** | | [optional] |
8
+ | **remote_key_name** | **String** | | [optional] |
9
+ | **description** | **String** | | [optional] |
10
+ | **is_required** | **Boolean** | | [optional] |
11
+ | **field_type** | [**FieldTypeEnum**](FieldTypeEnum.md) | | [optional][readonly] |
12
+ | **field_format** | [**FieldFormatEnum**](FieldFormatEnum.md) | | [optional][readonly] |
13
+ | **field_choices** | **Array&lt;String&gt;** | | [optional][readonly] |
14
+ | **item_schema** | [**RemoteFieldClassItemSchema**](RemoteFieldClassItemSchema.md) | | [optional] |
15
+ | **is_custom** | **Boolean** | | [optional] |
16
+ | **id** | **String** | | [optional][readonly] |
17
+ | **remote_fields** | [**Array&lt;RemoteField&gt;**](RemoteField.md) | | [optional][readonly] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'merge_ticketing_client'
23
+
24
+ instance = MergeTicketingClient::RemoteFieldClass.new(
25
+ display_name: null,
26
+ remote_key_name: null,
27
+ description: null,
28
+ is_required: null,
29
+ field_type: null,
30
+ field_format: null,
31
+ field_choices: null,
32
+ item_schema: null,
33
+ is_custom: null,
34
+ id: null,
35
+ remote_fields: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,22 @@
1
+ # MergeTicketingClient::RemoteFieldClassItemSchema
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **item_type** | **String** | | [optional] |
8
+ | **item_format** | **String** | | [optional] |
9
+ | **item_choices** | **Array&lt;String&gt;** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_ticketing_client'
15
+
16
+ instance = MergeTicketingClient::RemoteFieldClassItemSchema.new(
17
+ item_type: null,
18
+ item_format: null,
19
+ item_choices: null
20
+ )
21
+ ```
22
+
@@ -2,15 +2,15 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **method** | **String** | | |
8
- | **path** | **String** | | |
9
- | **status** | **Integer** | | |
10
- | **response** | [**AnyType**](.md) | | |
11
- | **response_headers** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
12
- | **response_type** | [**ResponseTypeEnum**](ResponseTypeEnum.md) | | [optional] |
13
- | **headers** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
5
+ | Name | Type | Description | Notes |
6
+ | -------------------- | ------------------------------------------- | ----------- | ---------- |
7
+ | **method** | **String** | | |
8
+ | **path** | **String** | | |
9
+ | **status** | **Integer** | | |
10
+ | **response** | [**Object**](.md) | | |
11
+ | **response_headers** | [**Hash&lt;String, Object&gt;**](Object.md) | | [optional] |
12
+ | **response_type** | [**ResponseTypeEnum**](ResponseTypeEnum.md) | | [optional] |
13
+ | **headers** | [**Hash&lt;String, Object&gt;**](Object.md) | | [optional] |
14
14
 
15
15
  ## Example
16
16
 
@@ -27,4 +27,3 @@ instance = MergeTicketingClient::RemoteResponse.new(
27
27
  headers: {&quot;EXTRA-HEADER&quot;:&quot;value&quot;,&quot;Authorization&quot;:&quot;&lt;redacted&gt;&quot;}
28
28
  )
29
29
  ```
30
-
@@ -0,0 +1,233 @@
1
+ # MergeTicketingClient::SelectiveSyncApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**selective_sync_configurations_list**](SelectiveSyncApi.md#selective_sync_configurations_list) | **GET** /selective-sync/configurations | |
8
+ | [**selective_sync_configurations_update**](SelectiveSyncApi.md#selective_sync_configurations_update) | **PUT** /selective-sync/configurations | |
9
+ | [**selective_sync_meta_list**](SelectiveSyncApi.md#selective_sync_meta_list) | **GET** /selective-sync/meta | |
10
+
11
+
12
+ ## selective_sync_configurations_list
13
+
14
+ > <Array<LinkedAccountSelectiveSyncConfiguration>> selective_sync_configurations_list(x_account_token)
15
+
16
+
17
+
18
+ Get a linked account's selective syncs.
19
+
20
+ ### Examples
21
+
22
+ ```ruby
23
+ require 'time'
24
+ require 'merge_ticketing_client'
25
+ # setup authorization
26
+ MergeTicketingClient.configure do |config|
27
+ # Configure API key authorization: tokenAuth
28
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
29
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
31
+ end
32
+
33
+ api_instance = MergeTicketingClient::SelectiveSyncApi.new
34
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
35
+
36
+ begin
37
+
38
+ result = api_instance.selective_sync_configurations_list(x_account_token)
39
+ p result
40
+ rescue MergeTicketingClient::ApiError => e
41
+ puts "Error when calling SelectiveSyncApi->selective_sync_configurations_list: #{e}"
42
+ end
43
+ ```
44
+
45
+ #### Using the selective_sync_configurations_list_with_http_info variant
46
+
47
+ This returns an Array which contains the response data, status code and headers.
48
+
49
+ > <Array(<Array<LinkedAccountSelectiveSyncConfiguration>>, Integer, Hash)> selective_sync_configurations_list_with_http_info(x_account_token)
50
+
51
+ ```ruby
52
+ begin
53
+
54
+ data, status_code, headers = api_instance.selective_sync_configurations_list_with_http_info(x_account_token)
55
+ p status_code # => 2xx
56
+ p headers # => { ... }
57
+ p data # => <Array<LinkedAccountSelectiveSyncConfiguration>>
58
+ rescue MergeTicketingClient::ApiError => e
59
+ puts "Error when calling SelectiveSyncApi->selective_sync_configurations_list_with_http_info: #{e}"
60
+ end
61
+ ```
62
+
63
+ ### Parameters
64
+
65
+ | Name | Type | Description | Notes |
66
+ | ---- | ---- | ----------- | ----- |
67
+ | **x_account_token** | **String** | Token identifying the end user. | |
68
+
69
+ ### Return type
70
+
71
+ [**Array&lt;LinkedAccountSelectiveSyncConfiguration&gt;**](LinkedAccountSelectiveSyncConfiguration.md)
72
+
73
+ ### Authorization
74
+
75
+ [tokenAuth](../README.md#tokenAuth)
76
+
77
+ ### HTTP request headers
78
+
79
+ - **Content-Type**: Not defined
80
+ - **Accept**: application/json
81
+
82
+
83
+ ## selective_sync_configurations_update
84
+
85
+ > <Array<LinkedAccountSelectiveSyncConfiguration>> selective_sync_configurations_update(x_account_token, linked_account_selective_sync_configuration_list_request)
86
+
87
+
88
+
89
+ Replace a linked account's selective syncs.
90
+
91
+ ### Examples
92
+
93
+ ```ruby
94
+ require 'time'
95
+ require 'merge_ticketing_client'
96
+ # setup authorization
97
+ MergeTicketingClient.configure do |config|
98
+ # Configure API key authorization: tokenAuth
99
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
100
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
101
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
102
+ end
103
+
104
+ api_instance = MergeTicketingClient::SelectiveSyncApi.new
105
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
106
+ linked_account_selective_sync_configuration_list_request = MergeTicketingClient::LinkedAccountSelectiveSyncConfigurationListRequest.new({sync_configurations: [MergeTicketingClient::LinkedAccountSelectiveSyncConfigurationRequest.new({linked_account_conditions: [MergeTicketingClient::LinkedAccountConditionRequest.new({condition_schema_id: 'condition_schema_id_example', operator: 'operator_example', value: TODO})]})]}) # LinkedAccountSelectiveSyncConfigurationListRequest |
107
+
108
+ begin
109
+
110
+ result = api_instance.selective_sync_configurations_update(x_account_token, linked_account_selective_sync_configuration_list_request)
111
+ p result
112
+ rescue MergeTicketingClient::ApiError => e
113
+ puts "Error when calling SelectiveSyncApi->selective_sync_configurations_update: #{e}"
114
+ end
115
+ ```
116
+
117
+ #### Using the selective_sync_configurations_update_with_http_info variant
118
+
119
+ This returns an Array which contains the response data, status code and headers.
120
+
121
+ > <Array(<Array<LinkedAccountSelectiveSyncConfiguration>>, Integer, Hash)> selective_sync_configurations_update_with_http_info(x_account_token, linked_account_selective_sync_configuration_list_request)
122
+
123
+ ```ruby
124
+ begin
125
+
126
+ data, status_code, headers = api_instance.selective_sync_configurations_update_with_http_info(x_account_token, linked_account_selective_sync_configuration_list_request)
127
+ p status_code # => 2xx
128
+ p headers # => { ... }
129
+ p data # => <Array<LinkedAccountSelectiveSyncConfiguration>>
130
+ rescue MergeTicketingClient::ApiError => e
131
+ puts "Error when calling SelectiveSyncApi->selective_sync_configurations_update_with_http_info: #{e}"
132
+ end
133
+ ```
134
+
135
+ ### Parameters
136
+
137
+ | Name | Type | Description | Notes |
138
+ | ---- | ---- | ----------- | ----- |
139
+ | **x_account_token** | **String** | Token identifying the end user. | |
140
+ | **linked_account_selective_sync_configuration_list_request** | [**LinkedAccountSelectiveSyncConfigurationListRequest**](LinkedAccountSelectiveSyncConfigurationListRequest.md) | | |
141
+
142
+ ### Return type
143
+
144
+ [**Array&lt;LinkedAccountSelectiveSyncConfiguration&gt;**](LinkedAccountSelectiveSyncConfiguration.md)
145
+
146
+ ### Authorization
147
+
148
+ [tokenAuth](../README.md#tokenAuth)
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: application/json
153
+ - **Accept**: application/json
154
+
155
+
156
+ ## selective_sync_meta_list
157
+
158
+ > <PaginatedConditionSchemaList> selective_sync_meta_list(x_account_token, opts)
159
+
160
+
161
+
162
+ Get metadata for the conditions available to a linked account.
163
+
164
+ ### Examples
165
+
166
+ ```ruby
167
+ require 'time'
168
+ require 'merge_ticketing_client'
169
+ # setup authorization
170
+ MergeTicketingClient.configure do |config|
171
+ # Configure API key authorization: tokenAuth
172
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
173
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
174
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
175
+ end
176
+
177
+ api_instance = MergeTicketingClient::SelectiveSyncApi.new
178
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
179
+ opts = {
180
+ common_model: 'common_model_example', # String |
181
+ cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
182
+ page_size: 56 # Integer | Number of results to return per page.
183
+ }
184
+
185
+ begin
186
+
187
+ result = api_instance.selective_sync_meta_list(x_account_token, opts)
188
+ p result
189
+ rescue MergeTicketingClient::ApiError => e
190
+ puts "Error when calling SelectiveSyncApi->selective_sync_meta_list: #{e}"
191
+ end
192
+ ```
193
+
194
+ #### Using the selective_sync_meta_list_with_http_info variant
195
+
196
+ This returns an Array which contains the response data, status code and headers.
197
+
198
+ > <Array(<PaginatedConditionSchemaList>, Integer, Hash)> selective_sync_meta_list_with_http_info(x_account_token, opts)
199
+
200
+ ```ruby
201
+ begin
202
+
203
+ data, status_code, headers = api_instance.selective_sync_meta_list_with_http_info(x_account_token, opts)
204
+ p status_code # => 2xx
205
+ p headers # => { ... }
206
+ p data # => <PaginatedConditionSchemaList>
207
+ rescue MergeTicketingClient::ApiError => e
208
+ puts "Error when calling SelectiveSyncApi->selective_sync_meta_list_with_http_info: #{e}"
209
+ end
210
+ ```
211
+
212
+ ### Parameters
213
+
214
+ | Name | Type | Description | Notes |
215
+ | ---- | ---- | ----------- | ----- |
216
+ | **x_account_token** | **String** | Token identifying the end user. | |
217
+ | **common_model** | **String** | | [optional] |
218
+ | **cursor** | **String** | The pagination cursor value. | [optional] |
219
+ | **page_size** | **Integer** | Number of results to return per page. | [optional] |
220
+
221
+ ### Return type
222
+
223
+ [**PaginatedConditionSchemaList**](PaginatedConditionSchemaList.md)
224
+
225
+ ### Authorization
226
+
227
+ [tokenAuth](../README.md#tokenAuth)
228
+
229
+ ### HTTP request headers
230
+
231
+ - **Content-Type**: Not defined
232
+ - **Accept**: application/json
233
+
@@ -0,0 +1,15 @@
1
+ # MergeTicketingClient::SelectiveSyncConfigurationsUsageEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'merge_ticketing_client'
12
+
13
+ instance = MergeTicketingClient::SelectiveSyncConfigurationsUsageEnum.new()
14
+ ```
15
+
data/docs/SyncStatus.md CHANGED
@@ -10,6 +10,7 @@
10
10
  | **next_sync_start** | **Time** | | [optional] |
11
11
  | **status** | [**SyncStatusStatusEnum**](SyncStatusStatusEnum.md) | | |
12
12
  | **is_initial_sync** | **Boolean** | | |
13
+ | **selective_sync_configurations_usage** | [**SelectiveSyncConfigurationsUsageEnum**](SelectiveSyncConfigurationsUsageEnum.md) | | [optional] |
13
14
 
14
15
  ## Example
15
16
 
@@ -17,12 +18,13 @@
17
18
  require 'merge_ticketing_client'
18
19
 
19
20
  instance = MergeTicketingClient::SyncStatus.new(
20
- model_name: Candidate,
21
- model_id: ats.Candidate,
21
+ model_name: Ticket,
22
+ model_id: ticketing.Ticket,
22
23
  last_sync_start: 2021-03-30T19:44:18.695973Z,
23
24
  next_sync_start: 2021-03-30T20:44:18.662942Z,
24
25
  status: SYNCING,
25
- is_initial_sync: true
26
+ is_initial_sync: true,
27
+ selective_sync_configurations_usage: IN_NEXT_SYNC
26
28
  )
27
29
  ```
28
30
 
data/docs/Tag.md CHANGED
@@ -2,12 +2,13 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
8
- | **name** | **String** | The tag&#39;s name. | [optional] |
9
- | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
10
- | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
5
+ | Name | Type | Description | Notes |
6
+ | ---------------------- | -------------------------------------------- | ------------------------------------------------------------------------------ | -------------------- |
7
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
8
+ | **name** | **String** | The tag&#39;s name. | [optional] |
9
+ | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
10
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
11
+ | **field_mappings** | [**Hash&lt;String, Object&gt;**](Object.md) | | [optional][readonly] |
11
12
 
12
13
  ## Example
13
14
 
@@ -18,7 +19,7 @@ instance = MergeTicketingClient::Tag.new(
18
19
  remote_id: 19202938,
19
20
  name: Ticketing API,
20
21
  remote_data: null,
21
- remote_was_deleted: null
22
+ remote_was_deleted: null,
23
+ field_mappings: {&quot;organization_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;},&quot;linked_account_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;}}
22
24
  )
23
25
  ```
24
-
data/docs/Team.md CHANGED
@@ -2,14 +2,15 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | [optional][readonly] |
8
- | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
- | **name** | **String** | The team&#39;s name. | [optional] |
10
- | **description** | **String** | The team&#39;s description. | [optional] |
11
- | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
12
- | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
5
+ | Name | Type | Description | Notes |
6
+ | ---------------------- | -------------------------------------------- | ------------------------------------------------------------------------------ | -------------------- |
7
+ | **id** | **String** | | [optional][readonly] |
8
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
+ | **name** | **String** | The team&#39;s name. | [optional] |
10
+ | **description** | **String** | The team&#39;s description. | [optional] |
11
+ | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
12
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
13
+ | **field_mappings** | [**Hash&lt;String, Object&gt;**](Object.md) | | [optional][readonly] |
13
14
 
14
15
  ## Example
15
16
 
@@ -22,7 +23,7 @@ instance = MergeTicketingClient::Team.new(
22
23
  name: Platform,
23
24
  description: Platform and Integrations Team,
24
25
  remote_data: null,
25
- remote_was_deleted: null
26
+ remote_was_deleted: null,
27
+ field_mappings: {&quot;organization_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;},&quot;linked_account_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;}}
26
28
  )
27
29
  ```
28
-
data/docs/Ticket.md CHANGED
@@ -2,29 +2,33 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | [optional][readonly] |
8
- | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
- | **name** | **String** | The ticket&#39;s name. | [optional] |
10
- | **assignees** | **Array&lt;String&gt;** | | [optional] |
11
- | **due_date** | **Time** | The ticket&#39;s due date. | [optional] |
12
- | **status** | [**TicketStatusEnum**](TicketStatusEnum.md) | The current status of the ticket. | [optional] |
13
- | **description** | **String** | The ticket&#39;s description. | [optional] |
14
- | **project** | **String** | | [optional] |
15
- | **ticket_type** | **String** | The ticket&#39;s type. | [optional] |
16
- | **account** | **String** | | [optional] |
17
- | **contact** | **String** | | [optional] |
18
- | **parent_ticket** | **String** | | [optional] |
19
- | **attachments** | **Array&lt;String&gt;** | | [optional] |
20
- | **tags** | **Array&lt;String&gt;** | | [optional] |
21
- | **remote_created_at** | **Time** | When the third party&#39;s ticket was created. | [optional] |
22
- | **remote_updated_at** | **Time** | When the third party&#39;s ticket was updated. | [optional] |
23
- | **completed_at** | **Time** | When the ticket was completed. | [optional] |
24
- | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
25
- | **remote_was_deleted** | **Boolean** | | [optional][readonly] |
26
- | **ticket_url** | **String** | The 3rd party url of the Ticket. | [optional] |
27
- | **priority** | [**PriorityEnum**](PriorityEnum.md) | The priority or urgency of the Ticket. Possible values include: URGENT, HIGH, NORMAL, LOW - in cases where there is no clear mapping - the original value passed through. | [optional] |
5
+ | Name | Type | Description | Notes |
6
+ | ---------------------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -------------------- |
7
+ | **id** | **String** | | [optional][readonly] |
8
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
+ | **name** | **String** | The ticket&#39;s name. | [optional] |
10
+ | **assignees** | **Array&lt;String&gt;** | | [optional] |
11
+ | **creator** | **String** | The user who created this ticket. | [optional] |
12
+ | **due_date** | **Time** | The ticket&#39;s due date. | [optional] |
13
+ | **status** | [**TicketStatusEnum**](TicketStatusEnum.md) | The current status of the ticket. | [optional] |
14
+ | **description** | **String** | The ticket’s description. HTML version of description is mapped if supported by the third-party platform. | [optional] |
15
+ | **project** | **String** | The project the ticket belongs to. | [optional] |
16
+ | **collections** | **Array&lt;String&gt;** | | [optional] |
17
+ | **ticket_type** | **String** | The ticket&#39;s type. | [optional] |
18
+ | **account** | **String** | The account associated with the ticket. | [optional] |
19
+ | **contact** | **String** | The contact associated with the ticket. | [optional] |
20
+ | **parent_ticket** | **String** | The ticket&#39;s parent ticket. | [optional] |
21
+ | **attachments** | **Array&lt;String&gt;** | | [optional] |
22
+ | **tags** | **Array&lt;String&gt;** | | [optional] |
23
+ | **remote_created_at** | **Time** | When the third party&#39;s ticket was created. | [optional] |
24
+ | **remote_updated_at** | **Time** | When the third party&#39;s ticket was updated. | [optional] |
25
+ | **completed_at** | **Time** | When the ticket was completed. | [optional] |
26
+ | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
27
+ | **remote_was_deleted** | **Boolean** | | [optional][readonly] |
28
+ | **ticket_url** | **String** | The 3rd party url of the Ticket. | [optional] |
29
+ | **priority** | [**PriorityEnum**](PriorityEnum.md) | The priority or urgency of the Ticket. | [optional] |
30
+ | **field_mappings** | [**Hash&lt;String, Object&gt;**](Object.md) | | [optional][readonly] |
31
+ | **remote_fields** | [**Array&lt;RemoteField&gt;**](RemoteField.md) | | [optional][readonly] |
28
32
 
29
33
  ## Example
30
34
 
@@ -36,10 +40,12 @@ instance = MergeTicketingClient::Ticket.new(
36
40
  remote_id: 19202938,
37
41
  name: Please add more integrations,
38
42
  assignees: [&quot;17a54124-287f-494d-965e-3c5b330c9a68&quot;],
43
+ creator: null,
39
44
  due_date: 2022-10-11T00:00Z,
40
45
  status: OPEN,
41
46
  description: Can you please add more integrations? It&#39;ll make syncing data much easier!,
42
47
  project: fb8c55b6-1cb8-4b4c-9fb6-17924231619d,
48
+ collections: [&quot;fb8c55b6-1cb8-4b4c-9fb6-17924231619d&quot;],
43
49
  ticket_type: incident,
44
50
  account: 0958cbc6-6040-430a-848e-aafacbadf4ae,
45
51
  contact: 65c345ba-6870-4974-87ba-dd31509c367a,
@@ -52,7 +58,8 @@ instance = MergeTicketingClient::Ticket.new(
52
58
  remote_data: null,
53
59
  remote_was_deleted: null,
54
60
  ticket_url: https://thirdpartysoftware.com/project/3/issue/1,
55
- priority: HIGH
61
+ priority: HIGH,
62
+ field_mappings: {&quot;organization_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;},&quot;linked_account_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;}},
63
+ remote_fields: null
56
64
  )
57
65
  ```
58
-