merge_ticketing_client 1.0.3 → 1.0.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +72 -0
- data/README.md +17 -6
- data/docs/AccessLevelEnum.md +15 -0
- data/docs/Account.md +14 -11
- data/docs/AccountIntegration.md +5 -1
- data/docs/AccountsApi.md +4 -4
- data/docs/AsyncPassthroughApi.md +155 -0
- data/docs/AsyncPassthroughReciept.md +18 -0
- data/docs/Attachment.md +18 -15
- data/docs/AttachmentRequest.md +10 -9
- data/docs/AttachmentsApi.md +80 -4
- data/docs/Collection.md +18 -13
- data/docs/CollectionsApi.md +92 -6
- data/docs/Comment.md +19 -16
- data/docs/CommentRequest.md +11 -10
- data/docs/CommentsApi.md +6 -4
- data/docs/CommonModelScopesBodyRequest.md +22 -0
- data/docs/ConditionSchema.md +1 -1
- data/docs/Contact.md +17 -14
- data/docs/ContactsApi.md +4 -4
- data/docs/DataPassthroughRequest.md +11 -10
- data/docs/DeleteAccountApi.md +9 -9
- data/docs/EnabledActionsEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +4 -2
- data/docs/ForceResyncApi.md +1 -1
- data/docs/Issue.md +11 -10
- data/docs/IssuesApi.md +6 -6
- data/docs/ItemFormatEnum.md +15 -0
- data/docs/ItemSchema.md +22 -0
- data/docs/ItemTypeEnum.md +15 -0
- data/docs/LinkedAccountCondition.md +9 -8
- data/docs/LinkedAccountConditionRequest.md +6 -5
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/MetaResponse.md +9 -6
- data/docs/MultipartFormFieldRequest.md +1 -1
- data/docs/PatchedTicketRequest.md +23 -22
- data/docs/Project.md +14 -11
- data/docs/ProjectsApi.md +5 -5
- data/docs/RemoteData.md +5 -4
- data/docs/RemoteField.md +7 -6
- data/docs/RemoteFieldClass.md +9 -11
- data/docs/RemoteFieldRequest.md +20 -0
- data/docs/RemoteResponse.md +10 -9
- data/docs/SyncStatus.md +1 -1
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tag.md +12 -9
- data/docs/TagsApi.md +4 -4
- data/docs/Team.md +14 -11
- data/docs/TeamsApi.md +4 -4
- data/docs/Ticket.md +30 -29
- data/docs/TicketRequest.md +24 -23
- data/docs/TicketsApi.md +9 -11
- data/docs/User.md +17 -14
- data/docs/UsersApi.md +6 -6
- data/lib/merge_ticketing_client/api/accounts_api.rb +4 -4
- data/lib/merge_ticketing_client/api/async_passthrough_api.rb +160 -0
- data/lib/merge_ticketing_client/api/attachments_api.rb +75 -4
- data/lib/merge_ticketing_client/api/collections_api.rb +93 -6
- data/lib/merge_ticketing_client/api/comments_api.rb +7 -4
- data/lib/merge_ticketing_client/api/contacts_api.rb +4 -4
- data/lib/merge_ticketing_client/api/delete_account_api.rb +7 -7
- data/lib/merge_ticketing_client/api/force_resync_api.rb +2 -2
- data/lib/merge_ticketing_client/api/issues_api.rb +6 -6
- data/lib/merge_ticketing_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_ticketing_client/api/projects_api.rb +5 -5
- data/lib/merge_ticketing_client/api/sync_status_api.rb +2 -2
- data/lib/merge_ticketing_client/api/tags_api.rb +4 -4
- data/lib/merge_ticketing_client/api/teams_api.rb +4 -4
- data/lib/merge_ticketing_client/api/tickets_api.rb +11 -14
- data/lib/merge_ticketing_client/api/users_api.rb +6 -6
- data/lib/merge_ticketing_client/models/access_level_enum.rb +46 -0
- data/lib/merge_ticketing_client/models/account.rb +27 -17
- data/lib/merge_ticketing_client/models/account_integration.rb +29 -7
- data/lib/merge_ticketing_client/models/async_passthrough_reciept.rb +223 -0
- data/lib/merge_ticketing_client/models/attachment.rb +29 -19
- data/lib/merge_ticketing_client/models/attachment_request.rb +2 -2
- data/lib/merge_ticketing_client/models/categories_enum.rb +2 -1
- data/lib/merge_ticketing_client/models/category_enum.rb +2 -1
- data/lib/merge_ticketing_client/models/collection.rb +39 -18
- data/lib/merge_ticketing_client/models/comment.rb +27 -17
- data/lib/merge_ticketing_client/models/common_model_scopes_body_request.rb +274 -0
- data/lib/merge_ticketing_client/models/condition_schema.rb +1 -0
- data/lib/merge_ticketing_client/models/contact.rb +27 -17
- data/lib/merge_ticketing_client/models/enabled_actions_enum.rb +45 -0
- data/lib/merge_ticketing_client/models/end_user_details_request.rb +19 -6
- data/lib/merge_ticketing_client/models/issue.rb +3 -2
- data/lib/merge_ticketing_client/models/item_format_enum.rb +49 -0
- data/lib/merge_ticketing_client/models/item_schema.rb +238 -0
- data/lib/merge_ticketing_client/models/item_type_enum.rb +49 -0
- data/lib/merge_ticketing_client/models/meta_response.rb +12 -1
- data/lib/merge_ticketing_client/models/multipart_form_field_request.rb +1 -1
- data/lib/merge_ticketing_client/models/patched_ticket_request.rb +18 -18
- data/lib/merge_ticketing_client/models/project.rb +27 -17
- data/lib/merge_ticketing_client/models/remote_data.rb +6 -9
- data/lib/merge_ticketing_client/models/remote_field.rb +18 -15
- data/lib/merge_ticketing_client/models/remote_field_class.rb +22 -39
- data/lib/merge_ticketing_client/models/remote_field_request.rb +234 -0
- data/lib/merge_ticketing_client/models/sync_status_status_enum.rb +2 -1
- data/lib/merge_ticketing_client/models/tag.rb +27 -17
- data/lib/merge_ticketing_client/models/team.rb +27 -17
- data/lib/merge_ticketing_client/models/ticket.rb +25 -26
- data/lib/merge_ticketing_client/models/ticket_request.rb +18 -18
- data/lib/merge_ticketing_client/models/user.rb +27 -17
- data/lib/merge_ticketing_client/version.rb +1 -1
- data/lib/merge_ticketing_client.rb +9 -1
- data/spec/api/accounts_api_spec.rb +2 -2
- data/spec/api/async_passthrough_api_spec.rb +59 -0
- data/spec/api/attachments_api_spec.rb +15 -2
- data/spec/api/collections_api_spec.rb +20 -3
- data/spec/api/comments_api_spec.rb +3 -2
- data/spec/api/contacts_api_spec.rb +2 -2
- data/spec/api/delete_account_api_spec.rb +2 -2
- data/spec/api/force_resync_api_spec.rb +1 -1
- data/spec/api/issues_api_spec.rb +3 -3
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/projects_api_spec.rb +2 -2
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/api/tags_api_spec.rb +2 -2
- data/spec/api/teams_api_spec.rb +2 -2
- data/spec/api/tickets_api_spec.rb +21 -4
- data/spec/api/users_api_spec.rb +2 -2
- data/spec/models/access_level_enum_spec.rb +28 -0
- data/spec/models/account_integration_spec.rb +12 -0
- data/spec/models/account_spec.rb +8 -2
- data/spec/models/async_passthrough_reciept_spec.rb +34 -0
- data/spec/models/attachment_request_spec.rb +0 -12
- data/spec/models/attachment_spec.rb +8 -2
- data/spec/models/collection_spec.rb +14 -2
- data/spec/models/comment_request_spec.rb +0 -12
- data/spec/models/comment_spec.rb +8 -2
- data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
- data/spec/models/contact_spec.rb +8 -2
- data/spec/models/enabled_actions_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/field_format_enum_spec.rb +28 -0
- data/spec/models/field_type_enum_spec.rb +28 -0
- data/spec/models/item_format_enum_spec.rb +28 -0
- data/spec/models/item_schema_spec.rb +46 -0
- data/spec/models/item_type_enum_spec.rb +28 -0
- data/spec/models/meta_response_spec.rb +6 -0
- data/spec/models/paginated_remote_field_class_list_spec.rb +46 -0
- data/spec/models/patched_ticket_request_spec.rb +6 -18
- data/spec/models/project_spec.rb +8 -2
- data/spec/models/remote_field_class_spec.rb +88 -0
- data/spec/models/remote_field_request_spec.rb +40 -0
- data/spec/models/remote_field_spec.rb +40 -0
- data/spec/models/tag_spec.rb +8 -2
- data/spec/models/team_spec.rb +8 -2
- data/spec/models/ticket_request_spec.rb +6 -24
- data/spec/models/ticket_spec.rb +16 -10
- data/spec/models/user_spec.rb +8 -2
- metadata +139 -92
data/docs/AttachmentsApi.md
CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**attachments_create**](AttachmentsApi.md#attachments_create) | **POST** /attachments | |
|
8
|
+
| [**attachments_download_retrieve**](AttachmentsApi.md#attachments_download_retrieve) | **GET** /attachments/{id}/download | |
|
8
9
|
| [**attachments_list**](AttachmentsApi.md#attachments_list) | **GET** /attachments | |
|
9
10
|
| [**attachments_meta_post_retrieve**](AttachmentsApi.md#attachments_meta_post_retrieve) | **GET** /attachments/meta/post | |
|
10
11
|
| [**attachments_retrieve**](AttachmentsApi.md#attachments_retrieve) | **GET** /attachments/{id} | |
|
@@ -89,6 +90,79 @@ end
|
|
89
90
|
- **Accept**: application/json
|
90
91
|
|
91
92
|
|
93
|
+
## attachments_download_retrieve
|
94
|
+
|
95
|
+
> File attachments_download_retrieve(x_account_token, id)
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
Returns an `Attachment` object with the given `id`.
|
100
|
+
|
101
|
+
### Examples
|
102
|
+
|
103
|
+
```ruby
|
104
|
+
require 'time'
|
105
|
+
require 'merge_ticketing_client'
|
106
|
+
# setup authorization
|
107
|
+
MergeTicketingClient.configure do |config|
|
108
|
+
# Configure API key authorization: tokenAuth
|
109
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
110
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
111
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
112
|
+
end
|
113
|
+
|
114
|
+
api_instance = MergeTicketingClient::AttachmentsApi.new
|
115
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
116
|
+
id = TODO # String |
|
117
|
+
|
118
|
+
begin
|
119
|
+
|
120
|
+
result = api_instance.attachments_download_retrieve(x_account_token, id)
|
121
|
+
p result
|
122
|
+
rescue MergeTicketingClient::ApiError => e
|
123
|
+
puts "Error when calling AttachmentsApi->attachments_download_retrieve: #{e}"
|
124
|
+
end
|
125
|
+
```
|
126
|
+
|
127
|
+
#### Using the attachments_download_retrieve_with_http_info variant
|
128
|
+
|
129
|
+
This returns an Array which contains the response data, status code and headers.
|
130
|
+
|
131
|
+
> <Array(File, Integer, Hash)> attachments_download_retrieve_with_http_info(x_account_token, id)
|
132
|
+
|
133
|
+
```ruby
|
134
|
+
begin
|
135
|
+
|
136
|
+
data, status_code, headers = api_instance.attachments_download_retrieve_with_http_info(x_account_token, id)
|
137
|
+
p status_code # => 2xx
|
138
|
+
p headers # => { ... }
|
139
|
+
p data # => File
|
140
|
+
rescue MergeTicketingClient::ApiError => e
|
141
|
+
puts "Error when calling AttachmentsApi->attachments_download_retrieve_with_http_info: #{e}"
|
142
|
+
end
|
143
|
+
```
|
144
|
+
|
145
|
+
### Parameters
|
146
|
+
|
147
|
+
| Name | Type | Description | Notes |
|
148
|
+
| ---- | ---- | ----------- | ----- |
|
149
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
150
|
+
| **id** | [**String**](.md) | | |
|
151
|
+
|
152
|
+
### Return type
|
153
|
+
|
154
|
+
**File**
|
155
|
+
|
156
|
+
### Authorization
|
157
|
+
|
158
|
+
[tokenAuth](../README.md#tokenAuth)
|
159
|
+
|
160
|
+
### HTTP request headers
|
161
|
+
|
162
|
+
- **Content-Type**: Not defined
|
163
|
+
- **Accept**: */*
|
164
|
+
|
165
|
+
|
92
166
|
## attachments_list
|
93
167
|
|
94
168
|
> <PaginatedAttachmentList> attachments_list(x_account_token, opts)
|
@@ -119,9 +193,10 @@ opts = {
|
|
119
193
|
expand: 'ticket', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
120
194
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
121
195
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
122
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
123
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
196
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
197
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
124
198
|
page_size: 56, # Integer | Number of results to return per page.
|
199
|
+
remote_created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return attachments created in the third party platform after this datetime.
|
125
200
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
126
201
|
ticket_id: 'ticket_id_example' # String | If provided, will only return comments for this ticket.
|
127
202
|
}
|
@@ -164,9 +239,10 @@ end
|
|
164
239
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
165
240
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
166
241
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
167
|
-
| **modified_after** | **Time** | If provided,
|
168
|
-
| **modified_before** | **Time** | If provided,
|
242
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
243
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
169
244
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
245
|
+
| **remote_created_after** | **Time** | If provided, will only return attachments created in the third party platform after this datetime. | [optional] |
|
170
246
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
171
247
|
| **ticket_id** | **String** | If provided, will only return comments for this ticket. | [optional] |
|
172
248
|
|
data/docs/Collection.md
CHANGED
@@ -2,17 +2,19 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **id**
|
8
|
-
| **remote_id**
|
9
|
-
| **name**
|
10
|
-
| **description**
|
11
|
-
| **collection_type**
|
12
|
-
| **parent_collection**
|
13
|
-
| **
|
14
|
-
| **
|
15
|
-
| **
|
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 collection's name. | [optional] |
|
10
|
+
| **description** | **String** | The collection's description. | [optional] |
|
11
|
+
| **collection_type** | [**CollectionTypeEnum**](CollectionTypeEnum.md) | The collection's type. * `LIST` - LIST * `PROJECT` - PROJECT | [optional] |
|
12
|
+
| **parent_collection** | **String** | The parent collection for this collection. | [optional] |
|
13
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
14
|
+
| **access_level** | [**AccessLevelEnum**](AccessLevelEnum.md) | The level of access a User has to the Collection and its sub-objects. * `PRIVATE` - PRIVATE * `COMPANY` - COMPANY * `PUBLIC` - PUBLIC | [optional] |
|
15
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
16
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
17
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
16
18
|
|
17
19
|
## Example
|
18
20
|
|
@@ -26,8 +28,11 @@ instance = MergeTicketingClient::Collection.new(
|
|
26
28
|
description: For tracking all tasks related to Platform for Q1,
|
27
29
|
collection_type: LIST,
|
28
30
|
parent_collection: 25782302-5be1-4d78-8f46-2a5db72204ef,
|
29
|
-
remote_data: null,
|
30
31
|
remote_was_deleted: null,
|
31
|
-
|
32
|
+
access_level: PUBLIC,
|
33
|
+
modified_at: 2021-10-16T00:00Z,
|
34
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
35
|
+
remote_data: null
|
32
36
|
)
|
33
37
|
```
|
38
|
+
|
data/docs/CollectionsApi.md
CHANGED
@@ -6,6 +6,7 @@ All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
|
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**collections_list**](CollectionsApi.md#collections_list) | **GET** /collections | |
|
8
8
|
| [**collections_retrieve**](CollectionsApi.md#collections_retrieve) | **GET** /collections/{id} | |
|
9
|
+
| [**collections_users_list**](CollectionsApi.md#collections_users_list) | **GET** /collections/{parent_id}/users | |
|
9
10
|
|
10
11
|
|
11
12
|
## collections_list
|
@@ -32,15 +33,15 @@ end
|
|
32
33
|
api_instance = MergeTicketingClient::CollectionsApi.new
|
33
34
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
35
|
opts = {
|
35
|
-
collection_type: 'LIST', # String | If provided, will only return collections of the given type.
|
36
|
+
collection_type: 'LIST', # String | If provided, will only return collections of the given type. * `LIST` - LIST * `PROJECT` - PROJECT
|
36
37
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
37
38
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
38
39
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
39
40
|
expand: 'parent_collection', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
40
41
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
41
42
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
42
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
43
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
43
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
44
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
44
45
|
page_size: 56, # Integer | Number of results to return per page.
|
45
46
|
parent_collection_id: 'parent_collection_id_example', # String | If provided, will only return collections whose parent collection matches the given id.
|
46
47
|
remote_fields: 'collection_type', # String | Deprecated. Use show_enum_origins.
|
@@ -80,15 +81,15 @@ end
|
|
80
81
|
| Name | Type | Description | Notes |
|
81
82
|
| ---- | ---- | ----------- | ----- |
|
82
83
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
83
|
-
| **collection_type** | **String** | If provided, will only return collections of the given type. | [optional] |
|
84
|
+
| **collection_type** | **String** | If provided, will only return collections of the given type. * `LIST` - LIST * `PROJECT` - PROJECT | [optional] |
|
84
85
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
85
86
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
86
87
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
87
88
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
88
89
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
89
90
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
90
|
-
| **modified_after** | **Time** | If provided,
|
91
|
-
| **modified_before** | **Time** | If provided,
|
91
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
92
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
92
93
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
93
94
|
| **parent_collection_id** | **String** | If provided, will only return collections whose parent collection matches the given id. | [optional] |
|
94
95
|
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
@@ -191,3 +192,88 @@ end
|
|
191
192
|
- **Content-Type**: Not defined
|
192
193
|
- **Accept**: application/json
|
193
194
|
|
195
|
+
|
196
|
+
## collections_users_list
|
197
|
+
|
198
|
+
> <PaginatedUserList> collections_users_list(x_account_token, parent_id, opts)
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
Returns a list of `User` objects.
|
203
|
+
|
204
|
+
### Examples
|
205
|
+
|
206
|
+
```ruby
|
207
|
+
require 'time'
|
208
|
+
require 'merge_ticketing_client'
|
209
|
+
# setup authorization
|
210
|
+
MergeTicketingClient.configure do |config|
|
211
|
+
# Configure API key authorization: tokenAuth
|
212
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
213
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
214
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
215
|
+
end
|
216
|
+
|
217
|
+
api_instance = MergeTicketingClient::CollectionsApi.new
|
218
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
219
|
+
parent_id = TODO # String |
|
220
|
+
opts = {
|
221
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
222
|
+
expand: 'roles', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
223
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
224
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
225
|
+
page_size: 56 # Integer | Number of results to return per page.
|
226
|
+
}
|
227
|
+
|
228
|
+
begin
|
229
|
+
|
230
|
+
result = api_instance.collections_users_list(x_account_token, parent_id, opts)
|
231
|
+
p result
|
232
|
+
rescue MergeTicketingClient::ApiError => e
|
233
|
+
puts "Error when calling CollectionsApi->collections_users_list: #{e}"
|
234
|
+
end
|
235
|
+
```
|
236
|
+
|
237
|
+
#### Using the collections_users_list_with_http_info variant
|
238
|
+
|
239
|
+
This returns an Array which contains the response data, status code and headers.
|
240
|
+
|
241
|
+
> <Array(<PaginatedUserList>, Integer, Hash)> collections_users_list_with_http_info(x_account_token, parent_id, opts)
|
242
|
+
|
243
|
+
```ruby
|
244
|
+
begin
|
245
|
+
|
246
|
+
data, status_code, headers = api_instance.collections_users_list_with_http_info(x_account_token, parent_id, opts)
|
247
|
+
p status_code # => 2xx
|
248
|
+
p headers # => { ... }
|
249
|
+
p data # => <PaginatedUserList>
|
250
|
+
rescue MergeTicketingClient::ApiError => e
|
251
|
+
puts "Error when calling CollectionsApi->collections_users_list_with_http_info: #{e}"
|
252
|
+
end
|
253
|
+
```
|
254
|
+
|
255
|
+
### Parameters
|
256
|
+
|
257
|
+
| Name | Type | Description | Notes |
|
258
|
+
| ---- | ---- | ----------- | ----- |
|
259
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
260
|
+
| **parent_id** | [**String**](.md) | | |
|
261
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
262
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
263
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
264
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
265
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
266
|
+
|
267
|
+
### Return type
|
268
|
+
|
269
|
+
[**PaginatedUserList**](PaginatedUserList.md)
|
270
|
+
|
271
|
+
### Authorization
|
272
|
+
|
273
|
+
[tokenAuth](../README.md#tokenAuth)
|
274
|
+
|
275
|
+
### HTTP request headers
|
276
|
+
|
277
|
+
- **Content-Type**: Not defined
|
278
|
+
- **Accept**: application/json
|
279
|
+
|
data/docs/Comment.md
CHANGED
@@ -2,20 +2,21 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **id**
|
8
|
-
| **remote_id**
|
9
|
-
| **user**
|
10
|
-
| **contact**
|
11
|
-
| **body**
|
12
|
-
| **html_body**
|
13
|
-
| **ticket**
|
14
|
-
| **is_private**
|
15
|
-
| **remote_created_at**
|
16
|
-
| **
|
17
|
-
| **
|
18
|
-
| **field_mappings**
|
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
|
+
| **user** | **String** | The author of the Comment, if the author is a User. | [optional] |
|
10
|
+
| **contact** | **String** | The author of the Comment, if the author is a Contact. | [optional] |
|
11
|
+
| **body** | **String** | The comment's text body. | [optional] |
|
12
|
+
| **html_body** | **String** | The comment's text body formatted as html. | [optional] |
|
13
|
+
| **ticket** | **String** | The ticket associated with the comment. | [optional] |
|
14
|
+
| **is_private** | **Boolean** | Whether or not the comment is internal. | [optional] |
|
15
|
+
| **remote_created_at** | **Time** | When the third party's comment was created. | [optional] |
|
16
|
+
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
17
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
18
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
19
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
19
20
|
|
20
21
|
## Example
|
21
22
|
|
@@ -32,8 +33,10 @@ instance = MergeTicketingClient::Comment.new(
|
|
32
33
|
ticket: fb8c55b6-1cb8-4b4c-9fb6-17924231619d,
|
33
34
|
is_private: null,
|
34
35
|
remote_created_at: 1990-11-10T00:00Z,
|
35
|
-
remote_data: null,
|
36
36
|
remote_was_deleted: null,
|
37
|
-
|
37
|
+
modified_at: 2021-10-16T00:00Z,
|
38
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
39
|
+
remote_data: null
|
38
40
|
)
|
39
41
|
```
|
42
|
+
|
data/docs/CommentRequest.md
CHANGED
@@ -2,16 +2,16 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **user**
|
8
|
-
| **contact**
|
9
|
-
| **body**
|
10
|
-
| **html_body**
|
11
|
-
| **ticket**
|
12
|
-
| **is_private**
|
13
|
-
| **integration_params**
|
14
|
-
| **linked_account_params** | [**Hash<String,
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **user** | **String** | The author of the Comment, if the author is a User. | [optional] |
|
8
|
+
| **contact** | **String** | The author of the Comment, if the author is a Contact. | [optional] |
|
9
|
+
| **body** | **String** | The comment's text body. | [optional] |
|
10
|
+
| **html_body** | **String** | The comment's text body formatted as html. | [optional] |
|
11
|
+
| **ticket** | **String** | The ticket associated with the comment. | [optional] |
|
12
|
+
| **is_private** | **Boolean** | Whether or not the comment is internal. | [optional] |
|
13
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
14
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
15
15
|
|
16
16
|
## Example
|
17
17
|
|
@@ -29,3 +29,4 @@ instance = MergeTicketingClient::CommentRequest.new(
|
|
29
29
|
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
30
30
|
)
|
31
31
|
```
|
32
|
+
|
data/docs/CommentsApi.md
CHANGED
@@ -119,9 +119,10 @@ opts = {
|
|
119
119
|
expand: 'contact', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
120
120
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
121
121
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
122
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
123
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
122
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
123
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
124
124
|
page_size: 56, # Integer | Number of results to return per page.
|
125
|
+
remote_created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return Comments created in the third party platform after this datetime.
|
125
126
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
126
127
|
ticket_id: 'ticket_id_example' # String | If provided, will only return comments for this ticket.
|
127
128
|
}
|
@@ -164,9 +165,10 @@ end
|
|
164
165
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
165
166
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
166
167
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
167
|
-
| **modified_after** | **Time** | If provided,
|
168
|
-
| **modified_before** | **Time** | If provided,
|
168
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
169
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
169
170
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
171
|
+
| **remote_created_after** | **Time** | If provided, will only return Comments created in the third party platform after this datetime. | [optional] |
|
170
172
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
171
173
|
| **ticket_id** | **String** | If provided, will only return comments for this ticket. | [optional] |
|
172
174
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeTicketingClient::CommonModelScopesBodyRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model_id** | **String** | | |
|
8
|
+
| **enabled_actions** | [**Array<EnabledActionsEnum>**](EnabledActionsEnum.md) | | |
|
9
|
+
| **disabled_fields** | **Array<String>** | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_ticketing_client'
|
15
|
+
|
16
|
+
instance = MergeTicketingClient::CommonModelScopesBodyRequest.new(
|
17
|
+
model_id: hris.Employee,
|
18
|
+
enabled_actions: ["READ","WRITE"],
|
19
|
+
disabled_fields: ["first_name"]
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/ConditionSchema.md
CHANGED
@@ -9,7 +9,7 @@
|
|
9
9
|
| **native_name** | **String** | User-facing *native condition* name. e.g. \"Skip Manager\". | |
|
10
10
|
| **field_name** | **String** | The name of the field on the common model that this condition corresponds to, if they conceptually match. e.g. \"location_type\". | |
|
11
11
|
| **is_unique** | **Boolean** | Whether this condition can only be applied once. If false, the condition can be AND'd together multiple times. | [optional] |
|
12
|
-
| **condition_type** | [**ConditionTypeEnum**](ConditionTypeEnum.md) | | |
|
12
|
+
| **condition_type** | [**ConditionTypeEnum**](ConditionTypeEnum.md) | The type of value(s) that can be set for this condition. * `BOOLEAN` - BOOLEAN * `DATE` - DATE * `DATE_TIME` - DATE_TIME * `INTEGER` - INTEGER * `FLOAT` - FLOAT * `STRING` - STRING * `LIST_OF_STRINGS` - LIST_OF_STRINGS | |
|
13
13
|
| **operators** | [**Array<OperatorSchema>**](OperatorSchema.md) | The schemas for the operators that can be used on a condition. | |
|
14
14
|
|
15
15
|
## Example
|
data/docs/Contact.md
CHANGED
@@ -2,18 +2,19 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **id**
|
8
|
-
| **remote_id**
|
9
|
-
| **name**
|
10
|
-
| **email_address**
|
11
|
-
| **phone_number**
|
12
|
-
| **details**
|
13
|
-
| **account**
|
14
|
-
| **
|
15
|
-
| **
|
16
|
-
| **field_mappings**
|
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 contact's name. | [optional] |
|
10
|
+
| **email_address** | **String** | The contact's email address. | [optional] |
|
11
|
+
| **phone_number** | **String** | The contact's phone number. | [optional] |
|
12
|
+
| **details** | **String** | The contact's details. | [optional] |
|
13
|
+
| **account** | **String** | The contact's account. | [optional] |
|
14
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
15
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
16
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
17
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
17
18
|
|
18
19
|
## Example
|
19
20
|
|
@@ -28,8 +29,10 @@ instance = MergeTicketingClient::Contact.new(
|
|
28
29
|
phone_number: 5108890293,
|
29
30
|
details: Executive Assistant to Tom Wambsgans,
|
30
31
|
account: 28b54125-287f-494d-965e-3c5b330c9a68,
|
31
|
-
remote_data: null,
|
32
32
|
remote_was_deleted: null,
|
33
|
-
|
33
|
+
modified_at: 2021-10-16T00:00Z,
|
34
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
35
|
+
remote_data: null
|
34
36
|
)
|
35
37
|
```
|
38
|
+
|
data/docs/ContactsApi.md
CHANGED
@@ -38,8 +38,8 @@ opts = {
|
|
38
38
|
expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
39
39
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
40
40
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
42
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
41
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
42
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
43
43
|
page_size: 56, # Integer | Number of results to return per page.
|
44
44
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
45
45
|
}
|
@@ -82,8 +82,8 @@ end
|
|
82
82
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
83
83
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
84
84
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
85
|
-
| **modified_after** | **Time** | If provided,
|
86
|
-
| **modified_before** | **Time** | If provided,
|
85
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
86
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
87
87
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
88
88
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
89
89
|
|
@@ -2,16 +2,16 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **method**
|
8
|
-
| **path**
|
9
|
-
| **base_url_override**
|
10
|
-
| **data**
|
11
|
-
| **multipart_form_data** | [**Array<MultipartFormFieldRequest>**](MultipartFormFieldRequest.md) | Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`.
|
12
|
-
| **headers**
|
13
|
-
| **request_format**
|
14
|
-
| **normalize_response**
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **method** | [**MethodEnum**](MethodEnum.md) | | |
|
8
|
+
| **path** | **String** | | |
|
9
|
+
| **base_url_override** | **String** | | [optional] |
|
10
|
+
| **data** | **String** | | [optional] |
|
11
|
+
| **multipart_form_data** | [**Array<MultipartFormFieldRequest>**](MultipartFormFieldRequest.md) | Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`. | [optional] |
|
12
|
+
| **headers** | [**Hash<String, AnyType>**](AnyType.md) | The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. | [optional] |
|
13
|
+
| **request_format** | [**RequestFormatEnum**](RequestFormatEnum.md) | | [optional] |
|
14
|
+
| **normalize_response** | **Boolean** | Optional. If true, the response will always be an object of the form `{\"type\": T, \"value\": ...}` where `T` will be one of `string, boolean, number, null, array, object`. | [optional] |
|
15
15
|
|
16
16
|
## Example
|
17
17
|
|
@@ -29,3 +29,4 @@ instance = MergeTicketingClient::DataPassthroughRequest.new(
|
|
29
29
|
normalize_response: null
|
30
30
|
)
|
31
31
|
```
|
32
|
+
|
data/docs/DeleteAccountApi.md
CHANGED
@@ -4,12 +4,12 @@ All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
7
|
+
| [**delete_account_delete**](DeleteAccountApi.md#delete_account_delete) | **POST** /delete-account | |
|
8
8
|
|
9
9
|
|
10
|
-
##
|
10
|
+
## delete_account_delete
|
11
11
|
|
12
|
-
>
|
12
|
+
> delete_account_delete(x_account_token)
|
13
13
|
|
14
14
|
|
15
15
|
|
@@ -33,27 +33,27 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
33
33
|
|
34
34
|
begin
|
35
35
|
|
36
|
-
api_instance.
|
36
|
+
api_instance.delete_account_delete(x_account_token)
|
37
37
|
rescue MergeTicketingClient::ApiError => e
|
38
|
-
puts "Error when calling DeleteAccountApi->
|
38
|
+
puts "Error when calling DeleteAccountApi->delete_account_delete: #{e}"
|
39
39
|
end
|
40
40
|
```
|
41
41
|
|
42
|
-
#### Using the
|
42
|
+
#### Using the delete_account_delete_with_http_info variant
|
43
43
|
|
44
44
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
45
45
|
|
46
|
-
> <Array(nil, Integer, Hash)>
|
46
|
+
> <Array(nil, Integer, Hash)> delete_account_delete_with_http_info(x_account_token)
|
47
47
|
|
48
48
|
```ruby
|
49
49
|
begin
|
50
50
|
|
51
|
-
data, status_code, headers = api_instance.
|
51
|
+
data, status_code, headers = api_instance.delete_account_delete_with_http_info(x_account_token)
|
52
52
|
p status_code # => 2xx
|
53
53
|
p headers # => { ... }
|
54
54
|
p data # => nil
|
55
55
|
rescue MergeTicketingClient::ApiError => e
|
56
|
-
puts "Error when calling DeleteAccountApi->
|
56
|
+
puts "Error when calling DeleteAccountApi->delete_account_delete_with_http_info: #{e}"
|
57
57
|
end
|
58
58
|
```
|
59
59
|
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeTicketingClient::EnabledActionsEnum
|
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::EnabledActionsEnum.new()
|
14
|
+
```
|
15
|
+
|