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.
- checksums.yaml +4 -4
- data/README.md +31 -6
- data/docs/Account.md +11 -10
- data/docs/AccountIntegration.md +1 -1
- data/docs/Attachment.md +15 -14
- data/docs/AttachmentRequest.md +11 -12
- data/docs/Collection.md +33 -0
- data/docs/CollectionTypeEnum.md +15 -0
- data/docs/CollectionsApi.md +193 -0
- data/docs/Comment.md +16 -15
- data/docs/CommentRequest.md +12 -13
- data/docs/ConditionSchema.md +30 -0
- data/docs/ConditionTypeEnum.md +15 -0
- data/docs/Contact.md +14 -13
- data/docs/DataPassthroughRequest.md +10 -11
- data/docs/EndUserDetailsRequest.md +2 -2
- data/docs/FieldFormatEnum.md +15 -0
- data/docs/FieldTypeEnum.md +15 -0
- data/docs/Issue.md +18 -17
- data/docs/LinkToken.md +1 -1
- data/docs/LinkedAccountCondition.md +27 -0
- data/docs/LinkedAccountConditionRequest.md +21 -0
- data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
- data/docs/MetaResponse.md +6 -7
- data/docs/OperatorSchema.md +20 -0
- data/docs/PaginatedCollectionList.md +22 -0
- data/docs/PaginatedConditionSchemaList.md +22 -0
- data/docs/PaginatedRemoteFieldClassList.md +22 -0
- data/docs/PatchedTicketRequest.md +25 -22
- data/docs/Project.md +11 -10
- data/docs/ProjectsApi.md +10 -8
- data/docs/RemoteData.md +4 -5
- data/docs/RemoteField.md +19 -0
- data/docs/RemoteFieldClass.md +38 -0
- data/docs/RemoteFieldClassItemSchema.md +22 -0
- data/docs/RemoteResponse.md +9 -10
- data/docs/SelectiveSyncApi.md +233 -0
- data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
- data/docs/SyncStatus.md +5 -3
- data/docs/Tag.md +9 -8
- data/docs/Team.md +11 -10
- data/docs/Ticket.md +32 -25
- data/docs/TicketRequest.md +26 -25
- data/docs/TicketsApi.md +141 -13
- data/docs/User.md +14 -13
- data/docs/UsersApi.md +2 -0
- data/lib/merge_ticketing_client/api/collections_api.rb +234 -0
- data/lib/merge_ticketing_client/api/linked_accounts_api.rb +1 -1
- data/lib/merge_ticketing_client/api/projects_api.rb +14 -11
- data/lib/merge_ticketing_client/api/selective_sync_api.rb +225 -0
- data/lib/merge_ticketing_client/api/tickets_api.rb +177 -19
- data/lib/merge_ticketing_client/api/users_api.rb +3 -0
- data/lib/merge_ticketing_client/models/account.rb +16 -4
- data/lib/merge_ticketing_client/models/account_details_and_actions_status_enum.rb +1 -1
- data/lib/merge_ticketing_client/models/account_integration.rb +1 -1
- data/lib/merge_ticketing_client/models/attachment.rb +18 -4
- data/lib/merge_ticketing_client/models/attachment_request.rb +24 -20
- data/lib/merge_ticketing_client/models/categories_enum.rb +3 -2
- data/lib/merge_ticketing_client/models/category_enum.rb +3 -2
- data/lib/merge_ticketing_client/models/collection.rb +308 -0
- data/lib/merge_ticketing_client/models/collection_type_enum.rb +45 -0
- data/lib/merge_ticketing_client/models/comment.rb +19 -4
- data/lib/merge_ticketing_client/models/comment_request.rb +25 -20
- data/lib/merge_ticketing_client/models/condition_schema.rb +297 -0
- data/lib/merge_ticketing_client/models/condition_type_enum.rb +50 -0
- data/lib/merge_ticketing_client/models/contact.rb +16 -4
- data/lib/merge_ticketing_client/models/data_passthrough_request.rb +1 -0
- data/lib/merge_ticketing_client/models/encoding_enum.rb +1 -1
- data/lib/merge_ticketing_client/models/end_user_details_request.rb +2 -2
- data/lib/merge_ticketing_client/models/field_format_enum.rb +49 -0
- data/lib/merge_ticketing_client/models/field_type_enum.rb +49 -0
- data/lib/merge_ticketing_client/models/issue.rb +15 -4
- data/lib/merge_ticketing_client/models/link_token.rb +0 -5
- data/lib/merge_ticketing_client/models/linked_account_condition.rb +282 -0
- data/lib/merge_ticketing_client/models/linked_account_condition_request.rb +269 -0
- data/lib/merge_ticketing_client/models/linked_account_selective_sync_configuration.rb +221 -0
- data/lib/merge_ticketing_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
- data/lib/merge_ticketing_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
- data/lib/merge_ticketing_client/models/method_enum.rb +1 -1
- data/lib/merge_ticketing_client/models/operator_schema.rb +229 -0
- data/lib/merge_ticketing_client/models/paginated_collection_list.rb +240 -0
- data/lib/merge_ticketing_client/models/paginated_condition_schema_list.rb +240 -0
- data/lib/merge_ticketing_client/models/paginated_remote_field_class_list.rb +240 -0
- data/lib/merge_ticketing_client/models/patched_ticket_request.rb +57 -29
- data/lib/merge_ticketing_client/models/priority_enum.rb +1 -1
- data/lib/merge_ticketing_client/models/project.rb +16 -4
- data/lib/merge_ticketing_client/models/remote_data.rb +9 -7
- data/lib/merge_ticketing_client/models/remote_field.rb +231 -0
- data/lib/merge_ticketing_client/models/remote_field_class.rb +318 -0
- data/lib/merge_ticketing_client/models/remote_field_class_item_schema.rb +241 -0
- data/lib/merge_ticketing_client/models/request_format_enum.rb +1 -1
- data/lib/merge_ticketing_client/models/response_type_enum.rb +1 -1
- data/lib/merge_ticketing_client/models/selective_sync_configurations_usage_enum.rb +45 -0
- data/lib/merge_ticketing_client/models/sync_status.rb +13 -4
- data/lib/merge_ticketing_client/models/sync_status_status_enum.rb +1 -1
- data/lib/merge_ticketing_client/models/tag.rb +16 -4
- data/lib/merge_ticketing_client/models/team.rb +16 -4
- data/lib/merge_ticketing_client/models/ticket.rb +56 -7
- data/lib/merge_ticketing_client/models/ticket_request.rb +57 -40
- data/lib/merge_ticketing_client/models/ticket_status_enum.rb +1 -1
- data/lib/merge_ticketing_client/models/user.rb +16 -4
- data/lib/merge_ticketing_client/version.rb +1 -1
- data/lib/merge_ticketing_client.rb +21 -0
- data/spec/api/collections_api_spec.rb +76 -0
- data/spec/api/projects_api_spec.rb +3 -2
- data/spec/api/selective_sync_api_spec.rb +72 -0
- data/spec/api/tickets_api_spec.rb +24 -4
- data/spec/api/users_api_spec.rb +1 -0
- data/spec/models/account_spec.rb +6 -0
- data/spec/models/attachment_request_spec.rb +12 -0
- data/spec/models/attachment_spec.rb +6 -0
- data/spec/models/collection_spec.rb +82 -0
- data/spec/models/collection_type_enum_spec.rb +28 -0
- data/spec/models/comment_request_spec.rb +12 -0
- data/spec/models/comment_spec.rb +6 -0
- data/spec/models/condition_schema_spec.rb +70 -0
- data/spec/models/condition_type_enum_spec.rb +28 -0
- data/spec/models/contact_spec.rb +6 -0
- data/spec/models/issue_spec.rb +6 -0
- data/spec/models/linked_account_condition_request_spec.rb +46 -0
- data/spec/models/linked_account_condition_spec.rb +64 -0
- data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
- data/spec/models/operator_schema_spec.rb +40 -0
- data/spec/models/paginated_collection_list_spec.rb +46 -0
- data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
- data/spec/models/patched_ticket_request_spec.rb +24 -0
- data/spec/models/project_spec.rb +6 -0
- data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
- data/spec/models/sync_status_spec.rb +6 -0
- data/spec/models/tag_spec.rb +6 -0
- data/spec/models/team_spec.rb +6 -0
- data/spec/models/ticket_request_spec.rb +24 -0
- data/spec/models/ticket_spec.rb +18 -0
- data/spec/models/user_spec.rb +6 -0
- metadata +144 -72
data/docs/TicketRequest.md
CHANGED
@@ -2,26 +2,27 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **
|
8
|
-
| **
|
9
|
-
| **
|
10
|
-
| **due_date**
|
11
|
-
| **status**
|
12
|
-
| **description**
|
13
|
-
| **project**
|
14
|
-
| **
|
15
|
-
| **
|
16
|
-
| **
|
17
|
-
| **
|
18
|
-
| **
|
19
|
-
| **
|
20
|
-
| **
|
21
|
-
| **
|
22
|
-
| **
|
23
|
-
| **
|
24
|
-
| **
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ------------------------- | ------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ---------- |
|
7
|
+
| **name** | **String** | The ticket's name. | [optional] |
|
8
|
+
| **assignees** | **Array<String>** | | [optional] |
|
9
|
+
| **creator** | **String** | The user who created this ticket. | [optional] |
|
10
|
+
| **due_date** | **Time** | The ticket's due date. | [optional] |
|
11
|
+
| **status** | [**TicketStatusEnum**](TicketStatusEnum.md) | The current status of the ticket. | [optional] |
|
12
|
+
| **description** | **String** | The ticket’s description. HTML version of description is mapped if supported by the third-party platform. | [optional] |
|
13
|
+
| **project** | **String** | The project the ticket belongs to. | [optional] |
|
14
|
+
| **collections** | **Array<String>** | | [optional] |
|
15
|
+
| **ticket_type** | **String** | The ticket's type. | [optional] |
|
16
|
+
| **account** | **String** | The account associated with the ticket. | [optional] |
|
17
|
+
| **contact** | **String** | The contact associated with the ticket. | [optional] |
|
18
|
+
| **parent_ticket** | **String** | The ticket's parent ticket. | [optional] |
|
19
|
+
| **attachments** | **Array<String>** | | [optional] |
|
20
|
+
| **tags** | **Array<String>** | | [optional] |
|
21
|
+
| **completed_at** | **Time** | When the ticket was completed. | [optional] |
|
22
|
+
| **ticket_url** | **String** | The 3rd party url of the Ticket. | [optional] |
|
23
|
+
| **priority** | [**PriorityEnum**](PriorityEnum.md) | The priority or urgency of the Ticket. | [optional] |
|
24
|
+
| **integration_params** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
25
|
+
| **linked_account_params** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
25
26
|
|
26
27
|
## Example
|
27
28
|
|
@@ -29,24 +30,24 @@
|
|
29
30
|
require 'merge_ticketing_client'
|
30
31
|
|
31
32
|
instance = MergeTicketingClient::TicketRequest.new(
|
32
|
-
remote_id: 19202938,
|
33
33
|
name: Please add more integrations,
|
34
34
|
assignees: ["17a54124-287f-494d-965e-3c5b330c9a68"],
|
35
|
+
creator: null,
|
35
36
|
due_date: 2022-10-11T00:00Z,
|
36
37
|
status: OPEN,
|
37
38
|
description: Can you please add more integrations? It'll make syncing data much easier!,
|
38
39
|
project: fb8c55b6-1cb8-4b4c-9fb6-17924231619d,
|
40
|
+
collections: ["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],
|
39
41
|
ticket_type: incident,
|
40
42
|
account: 0958cbc6-6040-430a-848e-aafacbadf4ae,
|
41
43
|
contact: 65c345ba-6870-4974-87ba-dd31509c367a,
|
42
44
|
parent_ticket: 75b33d04-30d2-4f3e-be45-27838bc94342,
|
43
45
|
attachments: ["42747df1-95e7-46e2-93cc-66f1191edca5","92f972d0-2526-434b-9409-4c3b468e08f0"],
|
44
46
|
tags: ["enterprise","other-tag"],
|
45
|
-
remote_created_at: 2021-11-10T00:00Z,
|
46
|
-
remote_updated_at: 2021-12-09T00:00Z,
|
47
47
|
completed_at: 2021-12-09T00:00Z,
|
48
48
|
ticket_url: https://thirdpartysoftware.com/project/3/issue/1,
|
49
|
-
priority: HIGH
|
49
|
+
priority: HIGH,
|
50
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
51
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
50
52
|
)
|
51
53
|
```
|
52
|
-
|
data/docs/TicketsApi.md
CHANGED
@@ -4,22 +4,23 @@ All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**tickets_collaborators_list**](TicketsApi.md#tickets_collaborators_list) | **GET** /tickets/{
|
7
|
+
| [**tickets_collaborators_list**](TicketsApi.md#tickets_collaborators_list) | **GET** /tickets/{parent_id}/collaborators | |
|
8
8
|
| [**tickets_create**](TicketsApi.md#tickets_create) | **POST** /tickets | |
|
9
9
|
| [**tickets_list**](TicketsApi.md#tickets_list) | **GET** /tickets | |
|
10
10
|
| [**tickets_meta_patch_retrieve**](TicketsApi.md#tickets_meta_patch_retrieve) | **GET** /tickets/meta/patch/{id} | |
|
11
11
|
| [**tickets_meta_post_retrieve**](TicketsApi.md#tickets_meta_post_retrieve) | **GET** /tickets/meta/post | |
|
12
12
|
| [**tickets_partial_update**](TicketsApi.md#tickets_partial_update) | **PATCH** /tickets/{id} | |
|
13
|
+
| [**tickets_remote_field_classes_list**](TicketsApi.md#tickets_remote_field_classes_list) | **GET** /tickets/remote-field-classes | |
|
13
14
|
| [**tickets_retrieve**](TicketsApi.md#tickets_retrieve) | **GET** /tickets/{id} | |
|
14
15
|
|
15
16
|
|
16
17
|
## tickets_collaborators_list
|
17
18
|
|
18
|
-
> <PaginatedUserList> tickets_collaborators_list(x_account_token,
|
19
|
+
> <PaginatedUserList> tickets_collaborators_list(x_account_token, parent_id, opts)
|
19
20
|
|
20
21
|
|
21
22
|
|
22
|
-
Returns a `User`
|
23
|
+
Returns a list of `User` objects.
|
23
24
|
|
24
25
|
### Examples
|
25
26
|
|
@@ -36,17 +37,18 @@ end
|
|
36
37
|
|
37
38
|
api_instance = MergeTicketingClient::TicketsApi.new
|
38
39
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
39
|
-
|
40
|
+
parent_id = TODO # String |
|
40
41
|
opts = {
|
41
42
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
42
43
|
expand: 'teams', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
44
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
43
45
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
44
46
|
page_size: 56 # Integer | Number of results to return per page.
|
45
47
|
}
|
46
48
|
|
47
49
|
begin
|
48
50
|
|
49
|
-
result = api_instance.tickets_collaborators_list(x_account_token,
|
51
|
+
result = api_instance.tickets_collaborators_list(x_account_token, parent_id, opts)
|
50
52
|
p result
|
51
53
|
rescue MergeTicketingClient::ApiError => e
|
52
54
|
puts "Error when calling TicketsApi->tickets_collaborators_list: #{e}"
|
@@ -57,12 +59,12 @@ end
|
|
57
59
|
|
58
60
|
This returns an Array which contains the response data, status code and headers.
|
59
61
|
|
60
|
-
> <Array(<PaginatedUserList>, Integer, Hash)> tickets_collaborators_list_with_http_info(x_account_token,
|
62
|
+
> <Array(<PaginatedUserList>, Integer, Hash)> tickets_collaborators_list_with_http_info(x_account_token, parent_id, opts)
|
61
63
|
|
62
64
|
```ruby
|
63
65
|
begin
|
64
66
|
|
65
|
-
data, status_code, headers = api_instance.tickets_collaborators_list_with_http_info(x_account_token,
|
67
|
+
data, status_code, headers = api_instance.tickets_collaborators_list_with_http_info(x_account_token, parent_id, opts)
|
66
68
|
p status_code # => 2xx
|
67
69
|
p headers # => { ... }
|
68
70
|
p data # => <PaginatedUserList>
|
@@ -76,9 +78,10 @@ end
|
|
76
78
|
| Name | Type | Description | Notes |
|
77
79
|
| ---- | ---- | ----------- | ----- |
|
78
80
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
79
|
-
| **
|
81
|
+
| **parent_id** | [**String**](.md) | | |
|
80
82
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
81
83
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
84
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
82
85
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
83
86
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
84
87
|
|
@@ -200,18 +203,36 @@ api_instance = MergeTicketingClient::TicketsApi.new
|
|
200
203
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
201
204
|
opts = {
|
202
205
|
account_id: 'account_id_example', # String | If provided, will only return tickets for this account.
|
206
|
+
assignee_ids: 'assignee_ids_example', # String | If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas.
|
207
|
+
collection_ids: 'collection_ids_example', # String | If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas.
|
208
|
+
completed_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return tickets completed after this datetime.
|
209
|
+
completed_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return tickets completed before this datetime.
|
210
|
+
contact_id: 'contact_id_example', # String | If provided, will only return tickets for this contact.
|
203
211
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
204
212
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
205
213
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
214
|
+
due_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return tickets due after this datetime.
|
215
|
+
due_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return tickets due before this datetime.
|
206
216
|
expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
207
217
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
208
218
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
219
|
+
include_remote_fields: true, # Boolean | Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
|
209
220
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
210
221
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
211
222
|
page_size: 56, # Integer | Number of results to return per page.
|
223
|
+
parent_ticket_id: 'parent_ticket_id_example', # String | If provided, will only return sub tickets of the parent_ticket_id.
|
224
|
+
priority: 'HIGH', # String | If provided, will only return tickets of this priority.
|
212
225
|
project_id: 'project_id_example', # String | If provided, will only return tickets for this project.
|
213
|
-
|
214
|
-
|
226
|
+
remote_created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return tickets created in the third party platform after this datetime.
|
227
|
+
remote_created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return tickets created in the third party platform before this datetime.
|
228
|
+
remote_fields: 'priority', # String | Deprecated. Use show_enum_origins.
|
229
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
230
|
+
remote_updated_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return tickets updated in the third party platform after this datetime.
|
231
|
+
remote_updated_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return tickets updated in the third party platform before this datetime.
|
232
|
+
show_enum_origins: 'priority', # String | Which fields should be returned in non-normalized form.
|
233
|
+
status: 'CLOSED', # String | If provided, will only return tickets of this status.
|
234
|
+
tags: 'tags_example', # String | If provided, will only return tickets matching the tags; multiple tags can be separated by commas.
|
235
|
+
ticket_type: 'ticket_type_example' # String | If provided, will only return tickets of this type.
|
215
236
|
}
|
216
237
|
|
217
238
|
begin
|
@@ -247,18 +268,36 @@ end
|
|
247
268
|
| ---- | ---- | ----------- | ----- |
|
248
269
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
249
270
|
| **account_id** | **String** | If provided, will only return tickets for this account. | [optional] |
|
271
|
+
| **assignee_ids** | **String** | If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas. | [optional] |
|
272
|
+
| **collection_ids** | **String** | If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas. | [optional] |
|
273
|
+
| **completed_after** | **Time** | If provided, will only return tickets completed after this datetime. | [optional] |
|
274
|
+
| **completed_before** | **Time** | If provided, will only return tickets completed before this datetime. | [optional] |
|
275
|
+
| **contact_id** | **String** | If provided, will only return tickets for this contact. | [optional] |
|
250
276
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
251
277
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
252
278
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
279
|
+
| **due_after** | **Time** | If provided, will only return tickets due after this datetime. | [optional] |
|
280
|
+
| **due_before** | **Time** | If provided, will only return tickets due before this datetime. | [optional] |
|
253
281
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
254
282
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
255
283
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
284
|
+
| **include_remote_fields** | **Boolean** | Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. | [optional] |
|
256
285
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
257
286
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
258
287
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
288
|
+
| **parent_ticket_id** | **String** | If provided, will only return sub tickets of the parent_ticket_id. | [optional] |
|
289
|
+
| **priority** | **String** | If provided, will only return tickets of this priority. | [optional] |
|
259
290
|
| **project_id** | **String** | If provided, will only return tickets for this project. | [optional] |
|
260
|
-
| **
|
291
|
+
| **remote_created_after** | **Time** | If provided, will only return tickets created in the third party platform after this datetime. | [optional] |
|
292
|
+
| **remote_created_before** | **Time** | If provided, will only return tickets created in the third party platform before this datetime. | [optional] |
|
293
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
261
294
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
295
|
+
| **remote_updated_after** | **Time** | If provided, will only return tickets updated in the third party platform after this datetime. | [optional] |
|
296
|
+
| **remote_updated_before** | **Time** | If provided, will only return tickets updated in the third party platform before this datetime. | [optional] |
|
297
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
298
|
+
| **status** | **String** | If provided, will only return tickets of this status. | [optional] |
|
299
|
+
| **tags** | **String** | If provided, will only return tickets matching the tags; multiple tags can be separated by commas. | [optional] |
|
300
|
+
| **ticket_type** | **String** | If provided, will only return tickets of this type. | [optional] |
|
262
301
|
|
263
302
|
### Return type
|
264
303
|
|
@@ -424,6 +463,8 @@ end
|
|
424
463
|
|
425
464
|
|
426
465
|
|
466
|
+
Updates a `Ticket` object with the given `id`.
|
467
|
+
|
427
468
|
### Examples
|
428
469
|
|
429
470
|
```ruby
|
@@ -497,6 +538,89 @@ end
|
|
497
538
|
- **Accept**: application/json
|
498
539
|
|
499
540
|
|
541
|
+
## tickets_remote_field_classes_list
|
542
|
+
|
543
|
+
> <PaginatedRemoteFieldClassList> tickets_remote_field_classes_list(x_account_token, opts)
|
544
|
+
|
545
|
+
|
546
|
+
|
547
|
+
Returns a list of `RemoteFieldClass` objects.
|
548
|
+
|
549
|
+
### Examples
|
550
|
+
|
551
|
+
```ruby
|
552
|
+
require 'time'
|
553
|
+
require 'merge_ticketing_client'
|
554
|
+
# setup authorization
|
555
|
+
MergeTicketingClient.configure do |config|
|
556
|
+
# Configure API key authorization: tokenAuth
|
557
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
558
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
559
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
560
|
+
end
|
561
|
+
|
562
|
+
api_instance = MergeTicketingClient::TicketsApi.new
|
563
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
564
|
+
opts = {
|
565
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
566
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
567
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
568
|
+
include_remote_fields: true, # Boolean | Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
|
569
|
+
page_size: 56 # Integer | Number of results to return per page.
|
570
|
+
}
|
571
|
+
|
572
|
+
begin
|
573
|
+
|
574
|
+
result = api_instance.tickets_remote_field_classes_list(x_account_token, opts)
|
575
|
+
p result
|
576
|
+
rescue MergeTicketingClient::ApiError => e
|
577
|
+
puts "Error when calling TicketsApi->tickets_remote_field_classes_list: #{e}"
|
578
|
+
end
|
579
|
+
```
|
580
|
+
|
581
|
+
#### Using the tickets_remote_field_classes_list_with_http_info variant
|
582
|
+
|
583
|
+
This returns an Array which contains the response data, status code and headers.
|
584
|
+
|
585
|
+
> <Array(<PaginatedRemoteFieldClassList>, Integer, Hash)> tickets_remote_field_classes_list_with_http_info(x_account_token, opts)
|
586
|
+
|
587
|
+
```ruby
|
588
|
+
begin
|
589
|
+
|
590
|
+
data, status_code, headers = api_instance.tickets_remote_field_classes_list_with_http_info(x_account_token, opts)
|
591
|
+
p status_code # => 2xx
|
592
|
+
p headers # => { ... }
|
593
|
+
p data # => <PaginatedRemoteFieldClassList>
|
594
|
+
rescue MergeTicketingClient::ApiError => e
|
595
|
+
puts "Error when calling TicketsApi->tickets_remote_field_classes_list_with_http_info: #{e}"
|
596
|
+
end
|
597
|
+
```
|
598
|
+
|
599
|
+
### Parameters
|
600
|
+
|
601
|
+
| Name | Type | Description | Notes |
|
602
|
+
| ---- | ---- | ----------- | ----- |
|
603
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
604
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
605
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
606
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
607
|
+
| **include_remote_fields** | **Boolean** | Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. | [optional] |
|
608
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
609
|
+
|
610
|
+
### Return type
|
611
|
+
|
612
|
+
[**PaginatedRemoteFieldClassList**](PaginatedRemoteFieldClassList.md)
|
613
|
+
|
614
|
+
### Authorization
|
615
|
+
|
616
|
+
[tokenAuth](../README.md#tokenAuth)
|
617
|
+
|
618
|
+
### HTTP request headers
|
619
|
+
|
620
|
+
- **Content-Type**: Not defined
|
621
|
+
- **Accept**: application/json
|
622
|
+
|
623
|
+
|
500
624
|
## tickets_retrieve
|
501
625
|
|
502
626
|
> <Ticket> tickets_retrieve(x_account_token, id, opts)
|
@@ -524,7 +648,9 @@ id = TODO # String |
|
|
524
648
|
opts = {
|
525
649
|
expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
526
650
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
527
|
-
|
651
|
+
include_remote_fields: true, # Boolean | Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
|
652
|
+
remote_fields: 'priority', # String | Deprecated. Use show_enum_origins.
|
653
|
+
show_enum_origins: 'priority' # String | Which fields should be returned in non-normalized form.
|
528
654
|
}
|
529
655
|
|
530
656
|
begin
|
@@ -562,7 +688,9 @@ end
|
|
562
688
|
| **id** | [**String**](.md) | | |
|
563
689
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
564
690
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
565
|
-
| **
|
691
|
+
| **include_remote_fields** | **Boolean** | Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. | [optional] |
|
692
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
693
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
566
694
|
|
567
695
|
### Return type
|
568
696
|
|
data/docs/User.md
CHANGED
@@ -2,17 +2,18 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **id**
|
8
|
-
| **remote_id**
|
9
|
-
| **name**
|
10
|
-
| **email_address**
|
11
|
-
| **is_active**
|
12
|
-
| **teams**
|
13
|
-
| **avatar**
|
14
|
-
| **remote_data**
|
15
|
-
| **remote_was_deleted** | **Boolean**
|
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 user's name. | [optional] |
|
10
|
+
| **email_address** | **String** | The user's email address. | [optional] |
|
11
|
+
| **is_active** | **Boolean** | Whether or not the user is active. | [optional] |
|
12
|
+
| **teams** | **Array<String>** | | [optional] |
|
13
|
+
| **avatar** | **String** | The user's avatar picture. | [optional] |
|
14
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
15
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
16
|
+
| **field_mappings** | [**Hash<String, Object>**](Object.md) | | [optional][readonly] |
|
16
17
|
|
17
18
|
## Example
|
18
19
|
|
@@ -28,7 +29,7 @@ instance = MergeTicketingClient::User.new(
|
|
28
29
|
teams: ["28b54125-287f-494d-965e-3c5b330c9a68","17a54124-287f-494d-965e-3c5b330c9a68"],
|
29
30
|
avatar: https://merge.dev/user_profile_pic.png,
|
30
31
|
remote_data: null,
|
31
|
-
remote_was_deleted: null
|
32
|
+
remote_was_deleted: null,
|
33
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}}
|
32
34
|
)
|
33
35
|
```
|
34
|
-
|
data/docs/UsersApi.md
CHANGED
@@ -35,6 +35,7 @@ opts = {
|
|
35
35
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
|
+
email_address: 'email_address_example', # String | If provided, will only return users with emails equal to this value (case insensitive).
|
38
39
|
expand: 'teams', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
39
40
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
40
41
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
@@ -79,6 +80,7 @@ end
|
|
79
80
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
80
81
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
81
82
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
83
|
+
| **email_address** | **String** | If provided, will only return users with emails equal to this value (case insensitive). | [optional] |
|
82
84
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
83
85
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
84
86
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|