merge_ticketing_client 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +11 -4
- data/docs/Account.md +9 -10
- data/docs/Attachment.md +13 -14
- data/docs/AttachmentRequest.md +9 -14
- data/docs/Collection.md +11 -12
- data/docs/Comment.md +14 -15
- data/docs/CommentRequest.md +10 -15
- data/docs/Contact.md +12 -13
- data/docs/DataPassthroughRequest.md +10 -11
- data/docs/FieldFormatEnum.md +15 -0
- data/docs/FieldTypeEnum.md +15 -0
- data/docs/Issue.md +10 -11
- data/docs/LinkedAccountCondition.md +8 -9
- data/docs/LinkedAccountConditionRequest.md +5 -6
- data/docs/MetaResponse.md +6 -7
- data/docs/PaginatedRemoteFieldClassList.md +22 -0
- data/docs/PatchedTicketRequest.md +20 -25
- data/docs/Project.md +9 -10
- 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/Tag.md +7 -8
- data/docs/Team.md +9 -10
- data/docs/Ticket.md +29 -28
- data/docs/TicketRequest.md +21 -28
- data/docs/TicketsApi.md +88 -0
- data/docs/User.md +12 -13
- data/lib/merge_ticketing_client/api/tickets_api.rb +83 -0
- data/lib/merge_ticketing_client/models/attachment_request.rb +1 -23
- 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/comment_request.rb +1 -23
- 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/paginated_remote_field_class_list.rb +240 -0
- data/lib/merge_ticketing_client/models/patched_ticket_request.rb +1 -23
- 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/ticket.rb +16 -5
- data/lib/merge_ticketing_client/models/ticket_request.rb +1 -34
- data/lib/merge_ticketing_client/version.rb +1 -1
- data/lib/merge_ticketing_client.rb +6 -0
- metadata +14 -2
|
@@ -2,28 +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
|
-
| **project**
|
|
14
|
-
| **collections**
|
|
15
|
-
| **ticket_type**
|
|
16
|
-
| **account**
|
|
17
|
-
| **contact**
|
|
18
|
-
| **parent_ticket**
|
|
19
|
-
| **tags**
|
|
20
|
-
| **
|
|
21
|
-
| **
|
|
22
|
-
| **
|
|
23
|
-
| **
|
|
24
|
-
| **
|
|
25
|
-
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
26
|
-
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
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
|
+
| **tags** | **Array<String>** | | [optional] |
|
|
20
|
+
| **completed_at** | **Time** | When the ticket was completed. | [optional] |
|
|
21
|
+
| **ticket_url** | **String** | The 3rd party url of the Ticket. | [optional] |
|
|
22
|
+
| **priority** | [**PriorityEnum**](PriorityEnum.md) | The priority or urgency of the Ticket. | [optional] |
|
|
23
|
+
| **integration_params** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
|
24
|
+
| **linked_account_params** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
|
27
25
|
|
|
28
26
|
## Example
|
|
29
27
|
|
|
@@ -44,8 +42,6 @@ instance = MergeTicketingClient::PatchedTicketRequest.new(
|
|
|
44
42
|
contact: 65c345ba-6870-4974-87ba-dd31509c367a,
|
|
45
43
|
parent_ticket: 75b33d04-30d2-4f3e-be45-27838bc94342,
|
|
46
44
|
tags: ["enterprise","other-tag"],
|
|
47
|
-
remote_created_at: 2021-11-10T00:00Z,
|
|
48
|
-
remote_updated_at: 2021-12-09T00:00Z,
|
|
49
45
|
completed_at: 2021-12-09T00:00Z,
|
|
50
46
|
ticket_url: https://thirdpartysoftware.com/project/3/issue/1,
|
|
51
47
|
priority: HIGH,
|
|
@@ -53,4 +49,3 @@ instance = MergeTicketingClient::PatchedTicketRequest.new(
|
|
|
53
49
|
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
|
54
50
|
)
|
|
55
51
|
```
|
|
56
|
-
|
data/docs/Project.md
CHANGED
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
| Name
|
|
6
|
-
|
|
|
7
|
-
| **id**
|
|
8
|
-
| **remote_id**
|
|
9
|
-
| **name**
|
|
10
|
-
| **description**
|
|
11
|
-
| **remote_data**
|
|
12
|
-
| **remote_was_deleted** | **Boolean**
|
|
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_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
12
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
|
13
|
+
| **field_mappings** | [**Hash<String, Object>**](Object.md) | | [optional][readonly] |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -27,4 +27,3 @@ instance = MergeTicketingClient::Project.new(
|
|
|
27
27
|
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}}
|
|
28
28
|
)
|
|
29
29
|
```
|
|
30
|
-
|
data/docs/RemoteData.md
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
| Name
|
|
6
|
-
|
|
|
7
|
-
| **path** | **String**
|
|
8
|
-
| **data** | [**Hash<String,
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| -------- | ------------------------------------------- | ----------- | ---------- |
|
|
7
|
+
| **path** | **String** | | |
|
|
8
|
+
| **data** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -17,4 +17,3 @@ instance = MergeTicketingClient::RemoteData.new(
|
|
|
17
17
|
data: null
|
|
18
18
|
)
|
|
19
19
|
```
|
|
20
|
-
|
data/docs/RemoteField.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# MergeTicketingClient::RemoteField
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---------------------- | ------------------------------------------- | ----------- | ---------- |
|
|
7
|
+
| **value** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
|
8
|
+
| **remote_field_class** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'merge_ticketing_client'
|
|
14
|
+
|
|
15
|
+
instance = MergeTicketingClient::RemoteField.new(
|
|
16
|
+
value: null,
|
|
17
|
+
remote_field_class: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# MergeTicketingClient::RemoteFieldClass
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **display_name** | **String** | | [optional] |
|
|
8
|
+
| **remote_key_name** | **String** | | [optional] |
|
|
9
|
+
| **description** | **String** | | [optional] |
|
|
10
|
+
| **is_required** | **Boolean** | | [optional] |
|
|
11
|
+
| **field_type** | [**FieldTypeEnum**](FieldTypeEnum.md) | | [optional][readonly] |
|
|
12
|
+
| **field_format** | [**FieldFormatEnum**](FieldFormatEnum.md) | | [optional][readonly] |
|
|
13
|
+
| **field_choices** | **Array<String>** | | [optional][readonly] |
|
|
14
|
+
| **item_schema** | [**RemoteFieldClassItemSchema**](RemoteFieldClassItemSchema.md) | | [optional] |
|
|
15
|
+
| **is_custom** | **Boolean** | | [optional] |
|
|
16
|
+
| **id** | **String** | | [optional][readonly] |
|
|
17
|
+
| **remote_fields** | [**Array<RemoteField>**](RemoteField.md) | | [optional][readonly] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'merge_ticketing_client'
|
|
23
|
+
|
|
24
|
+
instance = MergeTicketingClient::RemoteFieldClass.new(
|
|
25
|
+
display_name: null,
|
|
26
|
+
remote_key_name: null,
|
|
27
|
+
description: null,
|
|
28
|
+
is_required: null,
|
|
29
|
+
field_type: null,
|
|
30
|
+
field_format: null,
|
|
31
|
+
field_choices: null,
|
|
32
|
+
item_schema: null,
|
|
33
|
+
is_custom: null,
|
|
34
|
+
id: null,
|
|
35
|
+
remote_fields: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# MergeTicketingClient::RemoteFieldClassItemSchema
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **item_type** | **String** | | [optional] |
|
|
8
|
+
| **item_format** | **String** | | [optional] |
|
|
9
|
+
| **item_choices** | **Array<String>** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'merge_ticketing_client'
|
|
15
|
+
|
|
16
|
+
instance = MergeTicketingClient::RemoteFieldClassItemSchema.new(
|
|
17
|
+
item_type: null,
|
|
18
|
+
item_format: null,
|
|
19
|
+
item_choices: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
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** | [**Object**](.md) | | |
|
|
11
|
+
| **response_headers** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
|
12
|
+
| **response_type** | [**ResponseTypeEnum**](ResponseTypeEnum.md) | | [optional] |
|
|
13
|
+
| **headers** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -27,4 +27,3 @@ instance = MergeTicketingClient::RemoteResponse.new(
|
|
|
27
27
|
headers: {"EXTRA-HEADER":"value","Authorization":"<redacted>"}
|
|
28
28
|
)
|
|
29
29
|
```
|
|
30
|
-
|
data/docs/Tag.md
CHANGED
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
| Name
|
|
6
|
-
|
|
|
7
|
-
| **remote_id**
|
|
8
|
-
| **name**
|
|
9
|
-
| **remote_data**
|
|
10
|
-
| **remote_was_deleted** | **Boolean**
|
|
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_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
10
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
|
11
|
+
| **field_mappings** | [**Hash<String, Object>**](Object.md) | | [optional][readonly] |
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -23,4 +23,3 @@ instance = MergeTicketingClient::Tag.new(
|
|
|
23
23
|
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}}
|
|
24
24
|
)
|
|
25
25
|
```
|
|
26
|
-
|
data/docs/Team.md
CHANGED
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
| Name
|
|
6
|
-
|
|
|
7
|
-
| **id**
|
|
8
|
-
| **remote_id**
|
|
9
|
-
| **name**
|
|
10
|
-
| **description**
|
|
11
|
-
| **remote_data**
|
|
12
|
-
| **remote_was_deleted** | **Boolean**
|
|
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 team's name. | [optional] |
|
|
10
|
+
| **description** | **String** | The team's description. | [optional] |
|
|
11
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
12
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
|
13
|
+
| **field_mappings** | [**Hash<String, Object>**](Object.md) | | [optional][readonly] |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -27,4 +27,3 @@ instance = MergeTicketingClient::Team.new(
|
|
|
27
27
|
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}}
|
|
28
28
|
)
|
|
29
29
|
```
|
|
30
|
-
|
data/docs/Ticket.md
CHANGED
|
@@ -2,32 +2,33 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
| Name
|
|
6
|
-
|
|
|
7
|
-
| **id**
|
|
8
|
-
| **remote_id**
|
|
9
|
-
| **name**
|
|
10
|
-
| **assignees**
|
|
11
|
-
| **creator**
|
|
12
|
-
| **due_date**
|
|
13
|
-
| **status**
|
|
14
|
-
| **description**
|
|
15
|
-
| **project**
|
|
16
|
-
| **collections**
|
|
17
|
-
| **ticket_type**
|
|
18
|
-
| **account**
|
|
19
|
-
| **contact**
|
|
20
|
-
| **parent_ticket**
|
|
21
|
-
| **attachments**
|
|
22
|
-
| **tags**
|
|
23
|
-
| **remote_created_at**
|
|
24
|
-
| **remote_updated_at**
|
|
25
|
-
| **completed_at**
|
|
26
|
-
| **remote_data**
|
|
27
|
-
| **remote_was_deleted** | **Boolean**
|
|
28
|
-
| **ticket_url**
|
|
29
|
-
| **priority**
|
|
30
|
-
| **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 ticket's name. | [optional] |
|
|
10
|
+
| **assignees** | **Array<String>** | | [optional] |
|
|
11
|
+
| **creator** | **String** | The user who created this ticket. | [optional] |
|
|
12
|
+
| **due_date** | **Time** | The ticket's due date. | [optional] |
|
|
13
|
+
| **status** | [**TicketStatusEnum**](TicketStatusEnum.md) | The current status of the ticket. | [optional] |
|
|
14
|
+
| **description** | **String** | The ticket’s description. HTML version of description is mapped if supported by the third-party platform. | [optional] |
|
|
15
|
+
| **project** | **String** | The project the ticket belongs to. | [optional] |
|
|
16
|
+
| **collections** | **Array<String>** | | [optional] |
|
|
17
|
+
| **ticket_type** | **String** | The ticket's type. | [optional] |
|
|
18
|
+
| **account** | **String** | The account associated with the ticket. | [optional] |
|
|
19
|
+
| **contact** | **String** | The contact associated with the ticket. | [optional] |
|
|
20
|
+
| **parent_ticket** | **String** | The ticket's parent ticket. | [optional] |
|
|
21
|
+
| **attachments** | **Array<String>** | | [optional] |
|
|
22
|
+
| **tags** | **Array<String>** | | [optional] |
|
|
23
|
+
| **remote_created_at** | **Time** | When the third party's ticket was created. | [optional] |
|
|
24
|
+
| **remote_updated_at** | **Time** | When the third party's ticket was updated. | [optional] |
|
|
25
|
+
| **completed_at** | **Time** | When the ticket was completed. | [optional] |
|
|
26
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
27
|
+
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
|
28
|
+
| **ticket_url** | **String** | The 3rd party url of the Ticket. | [optional] |
|
|
29
|
+
| **priority** | [**PriorityEnum**](PriorityEnum.md) | The priority or urgency of the Ticket. | [optional] |
|
|
30
|
+
| **field_mappings** | [**Hash<String, Object>**](Object.md) | | [optional][readonly] |
|
|
31
|
+
| **remote_fields** | [**Array<RemoteField>**](RemoteField.md) | | [optional][readonly] |
|
|
31
32
|
|
|
32
33
|
## Example
|
|
33
34
|
|
|
@@ -58,7 +59,7 @@ instance = MergeTicketingClient::Ticket.new(
|
|
|
58
59
|
remote_was_deleted: null,
|
|
59
60
|
ticket_url: https://thirdpartysoftware.com/project/3/issue/1,
|
|
60
61
|
priority: HIGH,
|
|
61
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}}
|
|
62
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
|
63
|
+
remote_fields: null
|
|
62
64
|
)
|
|
63
65
|
```
|
|
64
|
-
|
data/docs/TicketRequest.md
CHANGED
|
@@ -2,30 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
| Name
|
|
6
|
-
|
|
|
7
|
-
| **
|
|
8
|
-
| **
|
|
9
|
-
| **
|
|
10
|
-
| **
|
|
11
|
-
| **
|
|
12
|
-
| **
|
|
13
|
-
| **
|
|
14
|
-
| **
|
|
15
|
-
| **
|
|
16
|
-
| **
|
|
17
|
-
| **
|
|
18
|
-
| **
|
|
19
|
-
| **
|
|
20
|
-
| **
|
|
21
|
-
| **
|
|
22
|
-
| **
|
|
23
|
-
| **
|
|
24
|
-
| **
|
|
25
|
-
| **
|
|
26
|
-
| **priority** | [**PriorityEnum**](PriorityEnum.md) | The priority or urgency of the Ticket. | [optional] |
|
|
27
|
-
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
28
|
-
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
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] |
|
|
29
26
|
|
|
30
27
|
## Example
|
|
31
28
|
|
|
@@ -33,7 +30,6 @@
|
|
|
33
30
|
require 'merge_ticketing_client'
|
|
34
31
|
|
|
35
32
|
instance = MergeTicketingClient::TicketRequest.new(
|
|
36
|
-
remote_id: 19202938,
|
|
37
33
|
name: Please add more integrations,
|
|
38
34
|
assignees: ["17a54124-287f-494d-965e-3c5b330c9a68"],
|
|
39
35
|
creator: null,
|
|
@@ -48,8 +44,6 @@ instance = MergeTicketingClient::TicketRequest.new(
|
|
|
48
44
|
parent_ticket: 75b33d04-30d2-4f3e-be45-27838bc94342,
|
|
49
45
|
attachments: ["42747df1-95e7-46e2-93cc-66f1191edca5","92f972d0-2526-434b-9409-4c3b468e08f0"],
|
|
50
46
|
tags: ["enterprise","other-tag"],
|
|
51
|
-
remote_created_at: 2021-11-10T00:00Z,
|
|
52
|
-
remote_updated_at: 2021-12-09T00:00Z,
|
|
53
47
|
completed_at: 2021-12-09T00:00Z,
|
|
54
48
|
ticket_url: https://thirdpartysoftware.com/project/3/issue/1,
|
|
55
49
|
priority: HIGH,
|
|
@@ -57,4 +51,3 @@ instance = MergeTicketingClient::TicketRequest.new(
|
|
|
57
51
|
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
|
58
52
|
)
|
|
59
53
|
```
|
|
60
|
-
|
data/docs/TicketsApi.md
CHANGED
|
@@ -10,6 +10,7 @@ All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
|
|
|
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
|
|
|
@@ -215,6 +216,7 @@ opts = {
|
|
|
215
216
|
expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
216
217
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
|
217
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.
|
|
218
220
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
|
219
221
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
|
220
222
|
page_size: 56, # Integer | Number of results to return per page.
|
|
@@ -279,6 +281,7 @@ end
|
|
|
279
281
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
280
282
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
|
281
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] |
|
|
282
285
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
|
283
286
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
|
284
287
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
@@ -535,6 +538,89 @@ end
|
|
|
535
538
|
- **Accept**: application/json
|
|
536
539
|
|
|
537
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
|
+
|
|
538
624
|
## tickets_retrieve
|
|
539
625
|
|
|
540
626
|
> <Ticket> tickets_retrieve(x_account_token, id, opts)
|
|
@@ -562,6 +648,7 @@ id = TODO # String |
|
|
|
562
648
|
opts = {
|
|
563
649
|
expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
564
650
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
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.
|
|
565
652
|
remote_fields: 'priority', # String | Deprecated. Use show_enum_origins.
|
|
566
653
|
show_enum_origins: 'priority' # String | Which fields should be returned in non-normalized form.
|
|
567
654
|
}
|
|
@@ -601,6 +688,7 @@ end
|
|
|
601
688
|
| **id** | [**String**](.md) | | |
|
|
602
689
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
603
690
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
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] |
|
|
604
692
|
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
|
605
693
|
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
|
606
694
|
|