merge_ticketing_client 1.0.0 → 1.0.2

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