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
@@ -10,7 +10,8 @@
|
|
10
10
|
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | The integration categories to show in Merge Link. | |
|
11
11
|
| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://www.merge.dev/docs/basics/integration-metadata/. | [optional] |
|
12
12
|
| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. | [optional][default to 30] |
|
13
|
-
| **should_create_magic_link_url** | **Boolean** | Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/
|
13
|
+
| **should_create_magic_link_url** | **Boolean** | Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. | [optional][default to false] |
|
14
|
+
| **common_models** | [**Array<CommonModelScopesBodyRequest>**](CommonModelScopesBodyRequest.md) | An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. | [optional] |
|
14
15
|
|
15
16
|
## Example
|
16
17
|
|
@@ -24,7 +25,8 @@ instance = MergeTicketingClient::EndUserDetailsRequest.new(
|
|
24
25
|
categories: null,
|
25
26
|
integration: null,
|
26
27
|
link_expiry_mins: null,
|
27
|
-
should_create_magic_link_url: null
|
28
|
+
should_create_magic_link_url: null,
|
29
|
+
common_models: null
|
28
30
|
)
|
29
31
|
```
|
30
32
|
|
data/docs/ForceResyncApi.md
CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
|
|
13
13
|
|
14
14
|
|
15
15
|
|
16
|
-
Force re-sync of all models. This is
|
16
|
+
Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Core, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
|
17
17
|
|
18
18
|
### Examples
|
19
19
|
|
data/docs/Issue.md
CHANGED
@@ -2,16 +2,16 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **id**
|
8
|
-
| **status**
|
9
|
-
| **error_description**
|
10
|
-
| **end_user**
|
11
|
-
| **first_incident_time** | **Time**
|
12
|
-
| **last_incident_time**
|
13
|
-
| **is_muted**
|
14
|
-
| **error_details**
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional][readonly] |
|
8
|
+
| **status** | [**IssueStatusEnum**](IssueStatusEnum.md) | Status of the issue. Options: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED | [optional] |
|
9
|
+
| **error_description** | **String** | | |
|
10
|
+
| **end_user** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
11
|
+
| **first_incident_time** | **Time** | | [optional] |
|
12
|
+
| **last_incident_time** | **Time** | | [optional] |
|
13
|
+
| **is_muted** | **Boolean** | | [optional][readonly] |
|
14
|
+
| **error_details** | **Array<String>** | | [optional][readonly] |
|
15
15
|
|
16
16
|
## Example
|
17
17
|
|
@@ -29,3 +29,4 @@ instance = MergeTicketingClient::Issue.new(
|
|
29
29
|
error_details: ["Missing employee permissions.","Missing time off permissions."]
|
30
30
|
)
|
31
31
|
```
|
32
|
+
|
data/docs/IssuesApi.md
CHANGED
@@ -39,11 +39,11 @@ opts = {
|
|
39
39
|
first_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
|
40
40
|
include_muted: 'include_muted_example', # String | If True, will include muted issues
|
41
41
|
integration_name: 'integration_name_example', # String |
|
42
|
-
last_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose
|
43
|
-
last_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose
|
42
|
+
last_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose last incident time was after this datetime.
|
43
|
+
last_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose last incident time was before this datetime.
|
44
44
|
page_size: 56, # Integer | Number of results to return per page.
|
45
45
|
start_date: 'start_date_example', # String | If included, will only include issues whose most recent action occurred after this time
|
46
|
-
status: 'ONGOING' # String |
|
46
|
+
status: 'ONGOING' # String | Status of the issue. Options: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED
|
47
47
|
}
|
48
48
|
|
49
49
|
begin
|
@@ -85,11 +85,11 @@ end
|
|
85
85
|
| **first_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
|
86
86
|
| **include_muted** | **String** | If True, will include muted issues | [optional] |
|
87
87
|
| **integration_name** | **String** | | [optional] |
|
88
|
-
| **last_incident_time_after** | **Time** | If provided, will only return issues whose
|
89
|
-
| **last_incident_time_before** | **Time** | If provided, will only return issues whose
|
88
|
+
| **last_incident_time_after** | **Time** | If provided, will only return issues whose last incident time was after this datetime. | [optional] |
|
89
|
+
| **last_incident_time_before** | **Time** | If provided, will only return issues whose last incident time was before this datetime. | [optional] |
|
90
90
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
91
91
|
| **start_date** | **String** | If included, will only include issues whose most recent action occurred after this time | [optional] |
|
92
|
-
| **status** | **String** | | [optional] |
|
92
|
+
| **status** | **String** | Status of the issue. Options: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED | [optional] |
|
93
93
|
|
94
94
|
### Return type
|
95
95
|
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeTicketingClient::ItemFormatEnum
|
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::ItemFormatEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/ItemSchema.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeTicketingClient::ItemSchema
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **item_type** | [**ItemTypeEnum**](ItemTypeEnum.md) | | [optional] |
|
8
|
+
| **item_format** | [**ItemFormatEnum**](ItemFormatEnum.md) | | [optional] |
|
9
|
+
| **item_choices** | **Array<String>** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_ticketing_client'
|
15
|
+
|
16
|
+
instance = MergeTicketingClient::ItemSchema.new(
|
17
|
+
item_type: null,
|
18
|
+
item_format: null,
|
19
|
+
item_choices: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeTicketingClient::ItemTypeEnum
|
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::ItemTypeEnum.new()
|
14
|
+
```
|
15
|
+
|
@@ -2,14 +2,14 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **condition_schema_id** | **String**
|
8
|
-
| **common_model**
|
9
|
-
| **native_name**
|
10
|
-
| **operator**
|
11
|
-
| **value**
|
12
|
-
| **field_name**
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **condition_schema_id** | **String** | The ID indicating which condition schema to use for a specific condition. | |
|
8
|
+
| **common_model** | **String** | The common model for a specific condition. | [optional][readonly] |
|
9
|
+
| **native_name** | **String** | User-facing *native condition* name. e.g. \"Skip Manager\". | |
|
10
|
+
| **operator** | **String** | The operator for a specific condition. | |
|
11
|
+
| **value** | [**AnyType**](.md) | The value for a condition. | [optional][readonly] |
|
12
|
+
| **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\". | |
|
13
13
|
|
14
14
|
## Example
|
15
15
|
|
@@ -25,3 +25,4 @@ instance = MergeTicketingClient::LinkedAccountCondition.new(
|
|
25
25
|
field_name: null
|
26
26
|
)
|
27
27
|
```
|
28
|
+
|
@@ -2,11 +2,11 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **condition_schema_id** | **String**
|
8
|
-
| **operator**
|
9
|
-
| **value**
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **condition_schema_id** | **String** | The ID indicating which condition schema to use for a specific condition. | |
|
8
|
+
| **operator** | **String** | The operator for a specific condition. | |
|
9
|
+
| **value** | [**AnyType**](.md) | The value for a specific condition. | |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
@@ -19,3 +19,4 @@ instance = MergeTicketingClient::LinkedAccountConditionRequest.new(
|
|
19
19
|
value: null
|
20
20
|
)
|
21
21
|
```
|
22
|
+
|
data/docs/LinkedAccountsApi.md
CHANGED
@@ -30,7 +30,7 @@ end
|
|
30
30
|
|
31
31
|
api_instance = MergeTicketingClient::LinkedAccountsApi.new
|
32
32
|
opts = {
|
33
|
-
category: 'accounting', # String |
|
33
|
+
category: 'accounting', # String | Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage') * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage
|
34
34
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
35
35
|
end_user_email_address: 'end_user_email_address_example', # String | If provided, will only return linked accounts associated with the given email address.
|
36
36
|
end_user_organization_name: 'end_user_organization_name_example', # String | If provided, will only return linked accounts associated with the given organization name.
|
@@ -76,7 +76,7 @@ end
|
|
76
76
|
|
77
77
|
| Name | Type | Description | Notes |
|
78
78
|
| ---- | ---- | ----------- | ----- |
|
79
|
-
| **category** | **String** | | [optional] |
|
79
|
+
| **category** | **String** | Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage') * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage | [optional] |
|
80
80
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
81
81
|
| **end_user_email_address** | **String** | If provided, will only return linked accounts associated with the given email address. | [optional] |
|
82
82
|
| **end_user_organization_name** | **String** | If provided, will only return linked accounts associated with the given organization name. | [optional] |
|
data/docs/MetaResponse.md
CHANGED
@@ -2,12 +2,13 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **request_schema**
|
8
|
-
| **
|
9
|
-
| **
|
10
|
-
| **
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **request_schema** | [**Hash<String, AnyType>**](AnyType.md) | | |
|
8
|
+
| **remote_field_classes** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
9
|
+
| **status** | [**LinkedAccountStatus**](LinkedAccountStatus.md) | | [optional] |
|
10
|
+
| **has_conditional_params** | **Boolean** | | |
|
11
|
+
| **has_required_linked_account_params** | **Boolean** | | |
|
11
12
|
|
12
13
|
## Example
|
13
14
|
|
@@ -16,8 +17,10 @@ require 'merge_ticketing_client'
|
|
16
17
|
|
17
18
|
instance = MergeTicketingClient::MetaResponse.new(
|
18
19
|
request_schema: null,
|
20
|
+
remote_field_classes: null,
|
19
21
|
status: null,
|
20
22
|
has_conditional_params: null,
|
21
23
|
has_required_linked_account_params: null
|
22
24
|
)
|
23
25
|
```
|
26
|
+
|
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **name** | **String** | The name of the form field | |
|
8
8
|
| **data** | **String** | The data for the form field. | |
|
9
|
-
| **encoding** | [**EncodingEnum**](EncodingEnum.md) | The encoding of the value of `data`. Defaults to `RAW` if not defined. | [optional] |
|
9
|
+
| **encoding** | [**EncodingEnum**](EncodingEnum.md) | The encoding of the value of `data`. Defaults to `RAW` if not defined. * `RAW` - RAW * `BASE64` - BASE64 * `GZIP_BASE64` - GZIP_BASE64 | [optional] |
|
10
10
|
| **file_name** | **String** | The file name of the form field, if the field is for a file. | [optional] |
|
11
11
|
| **content_type** | **String** | The MIME type of the file, if the field is for a file. | [optional] |
|
12
12
|
|
@@ -2,26 +2,26 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **name**
|
8
|
-
| **assignees**
|
9
|
-
| **creator**
|
10
|
-
| **due_date**
|
11
|
-
| **status**
|
12
|
-
| **description**
|
13
|
-
| **
|
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. * `OPEN` - OPEN * `CLOSED` - CLOSED * `IN_PROGRESS` - IN_PROGRESS * `ON_HOLD` - ON_HOLD | [optional] |
|
12
|
+
| **description** | **String** | The ticket’s description. HTML version of description is mapped if supported by the third-party platform. | [optional] |
|
13
|
+
| **collections** | **Array<String>** | | [optional] |
|
14
|
+
| **ticket_type** | **String** | The ticket's type. | [optional] |
|
15
|
+
| **account** | **String** | The account associated with the ticket. | [optional] |
|
16
|
+
| **contact** | **String** | The contact associated with the ticket. | [optional] |
|
17
|
+
| **parent_ticket** | **String** | The ticket's parent ticket. | [optional] |
|
18
|
+
| **tags** | **Array<String>** | | [optional] |
|
19
|
+
| **completed_at** | **Time** | When the ticket was completed. | [optional] |
|
20
|
+
| **ticket_url** | **String** | The 3rd party url of the Ticket. | [optional] |
|
21
|
+
| **priority** | [**PriorityEnum**](PriorityEnum.md) | The priority or urgency of the Ticket. * `URGENT` - URGENT * `HIGH` - HIGH * `NORMAL` - NORMAL * `LOW` - LOW | [optional] |
|
22
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
23
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
24
|
+
| **remote_fields** | [**Array<RemoteFieldRequest>**](RemoteFieldRequest.md) | | [optional] |
|
25
25
|
|
26
26
|
## Example
|
27
27
|
|
@@ -35,7 +35,6 @@ instance = MergeTicketingClient::PatchedTicketRequest.new(
|
|
35
35
|
due_date: 2022-10-11T00:00Z,
|
36
36
|
status: OPEN,
|
37
37
|
description: Can you please add more integrations? It'll make syncing data much easier!,
|
38
|
-
project: fb8c55b6-1cb8-4b4c-9fb6-17924231619d,
|
39
38
|
collections: ["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],
|
40
39
|
ticket_type: incident,
|
41
40
|
account: 0958cbc6-6040-430a-848e-aafacbadf4ae,
|
@@ -46,6 +45,8 @@ instance = MergeTicketingClient::PatchedTicketRequest.new(
|
|
46
45
|
ticket_url: https://thirdpartysoftware.com/project/3/issue/1,
|
47
46
|
priority: HIGH,
|
48
47
|
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
49
|
-
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
48
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"},
|
49
|
+
remote_fields: null
|
50
50
|
)
|
51
51
|
```
|
52
|
+
|
data/docs/Project.md
CHANGED
@@ -2,15 +2,16 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **id**
|
8
|
-
| **remote_id**
|
9
|
-
| **name**
|
10
|
-
| **description**
|
11
|
-
| **
|
12
|
-
| **
|
13
|
-
| **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 project's name. | [optional] |
|
10
|
+
| **description** | **String** | The project's description. | [optional] |
|
11
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
12
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
13
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
14
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
14
15
|
|
15
16
|
## Example
|
16
17
|
|
@@ -22,8 +23,10 @@ instance = MergeTicketingClient::Project.new(
|
|
22
23
|
remote_id: 19202938,
|
23
24
|
name: Q1 Platform,
|
24
25
|
description: For tracking all tasks related to Platform for Q1,
|
25
|
-
remote_data: null,
|
26
26
|
remote_was_deleted: null,
|
27
|
-
|
27
|
+
modified_at: 2021-10-16T00:00Z,
|
28
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
29
|
+
remote_data: null
|
28
30
|
)
|
29
31
|
```
|
32
|
+
|
data/docs/ProjectsApi.md
CHANGED
@@ -38,8 +38,8 @@ opts = {
|
|
38
38
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
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
|
}
|
@@ -81,8 +81,8 @@ end
|
|
81
81
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
82
82
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
83
83
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
84
|
-
| **modified_after** | **Time** | If provided,
|
85
|
-
| **modified_before** | **Time** | If provided,
|
84
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
85
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
86
86
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
87
87
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
88
88
|
|
@@ -203,7 +203,7 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
203
203
|
parent_id = TODO # String |
|
204
204
|
opts = {
|
205
205
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
206
|
-
expand: '
|
206
|
+
expand: 'roles', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
207
207
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
208
208
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
209
209
|
page_size: 56 # Integer | Number of results to return per page.
|
data/docs/RemoteData.md
CHANGED
@@ -2,10 +2,10 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **path** | **String**
|
8
|
-
| **data** | [**
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **path** | **String** | | |
|
8
|
+
| **data** | [**AnyType**](.md) | | [optional][readonly] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -17,3 +17,4 @@ instance = MergeTicketingClient::RemoteData.new(
|
|
17
17
|
data: null
|
18
18
|
)
|
19
19
|
```
|
20
|
+
|
data/docs/RemoteField.md
CHANGED
@@ -2,10 +2,10 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **
|
8
|
-
| **
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **remote_field_class** | [**RemoteFieldClass**](RemoteFieldClass.md) | | |
|
8
|
+
| **value** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -13,7 +13,8 @@
|
|
13
13
|
require 'merge_ticketing_client'
|
14
14
|
|
15
15
|
instance = MergeTicketingClient::RemoteField.new(
|
16
|
-
|
17
|
-
|
16
|
+
remote_field_class: null,
|
17
|
+
value: string
|
18
18
|
)
|
19
19
|
```
|
20
|
+
|
data/docs/RemoteFieldClass.md
CHANGED
@@ -4,17 +4,16 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional] |
|
7
8
|
| **display_name** | **String** | | [optional] |
|
8
9
|
| **remote_key_name** | **String** | | [optional] |
|
9
10
|
| **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<String>** | | [optional][readonly] |
|
14
|
-
| **item_schema** | [**RemoteFieldClassItemSchema**](RemoteFieldClassItemSchema.md) | | [optional] |
|
15
11
|
| **is_custom** | **Boolean** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **
|
12
|
+
| **is_required** | **Boolean** | | [optional] |
|
13
|
+
| **field_type** | [**FieldTypeEnum**](FieldTypeEnum.md) | | [optional] |
|
14
|
+
| **field_format** | [**FieldFormatEnum**](FieldFormatEnum.md) | | [optional] |
|
15
|
+
| **field_choices** | **Array<String>** | | [optional] |
|
16
|
+
| **item_schema** | [**ItemSchema**](ItemSchema.md) | | [optional] |
|
18
17
|
|
19
18
|
## Example
|
20
19
|
|
@@ -22,17 +21,16 @@
|
|
22
21
|
require 'merge_ticketing_client'
|
23
22
|
|
24
23
|
instance = MergeTicketingClient::RemoteFieldClass.new(
|
24
|
+
id: null,
|
25
25
|
display_name: null,
|
26
26
|
remote_key_name: null,
|
27
27
|
description: null,
|
28
|
+
is_custom: null,
|
28
29
|
is_required: null,
|
29
30
|
field_type: null,
|
30
31
|
field_format: null,
|
31
32
|
field_choices: null,
|
32
|
-
item_schema: null
|
33
|
-
is_custom: null,
|
34
|
-
id: null,
|
35
|
-
remote_fields: null
|
33
|
+
item_schema: null
|
36
34
|
)
|
37
35
|
```
|
38
36
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeTicketingClient::RemoteFieldRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **remote_field_class** | **String** | | |
|
8
|
+
| **value** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_ticketing_client'
|
14
|
+
|
15
|
+
instance = MergeTicketingClient::RemoteFieldRequest.new(
|
16
|
+
remote_field_class: b057d1d2-c204-4da8-a74c-c91d1a260614,
|
17
|
+
value: string
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/RemoteResponse.md
CHANGED
@@ -2,15 +2,15 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **method**
|
8
|
-
| **path**
|
9
|
-
| **status**
|
10
|
-
| **response**
|
11
|
-
| **response_headers** | [**Hash<String,
|
12
|
-
| **response_type**
|
13
|
-
| **headers**
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **method** | **String** | | |
|
8
|
+
| **path** | **String** | | |
|
9
|
+
| **status** | **Integer** | | |
|
10
|
+
| **response** | [**AnyType**](.md) | | |
|
11
|
+
| **response_headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
12
|
+
| **response_type** | [**ResponseTypeEnum**](ResponseTypeEnum.md) | | [optional] |
|
13
|
+
| **headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
14
14
|
|
15
15
|
## Example
|
16
16
|
|
@@ -27,3 +27,4 @@ instance = MergeTicketingClient::RemoteResponse.new(
|
|
27
27
|
headers: {"EXTRA-HEADER":"value","Authorization":"<redacted>"}
|
28
28
|
)
|
29
29
|
```
|
30
|
+
|
data/docs/SyncStatus.md
CHANGED
data/docs/SyncStatusApi.md
CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
|
|
13
13
|
|
14
14
|
|
15
15
|
|
16
|
-
Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PAUSED`, `SYNCING`
|
16
|
+
Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`
|
17
17
|
|
18
18
|
### Examples
|
19
19
|
|
data/docs/Tag.md
CHANGED
@@ -2,13 +2,14 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
| Name
|
6
|
-
|
|
7
|
-
| **remote_id**
|
8
|
-
| **name**
|
9
|
-
| **
|
10
|
-
| **
|
11
|
-
| **field_mappings**
|
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's name. | [optional] |
|
9
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
10
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
11
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
12
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
12
13
|
|
13
14
|
## Example
|
14
15
|
|
@@ -18,8 +19,10 @@ require 'merge_ticketing_client'
|
|
18
19
|
instance = MergeTicketingClient::Tag.new(
|
19
20
|
remote_id: 19202938,
|
20
21
|
name: Ticketing API,
|
21
|
-
remote_data: null,
|
22
22
|
remote_was_deleted: null,
|
23
|
-
|
23
|
+
modified_at: 2021-10-16T00:00Z,
|
24
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
25
|
+
remote_data: null
|
24
26
|
)
|
25
27
|
```
|
28
|
+
|