merge_ticketing_client 1.0.1 → 1.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (139) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -6
  3. data/docs/Account.md +11 -10
  4. data/docs/AccountIntegration.md +1 -1
  5. data/docs/Attachment.md +15 -14
  6. data/docs/AttachmentRequest.md +11 -12
  7. data/docs/Collection.md +33 -0
  8. data/docs/CollectionTypeEnum.md +15 -0
  9. data/docs/CollectionsApi.md +193 -0
  10. data/docs/Comment.md +16 -15
  11. data/docs/CommentRequest.md +12 -13
  12. data/docs/ConditionSchema.md +30 -0
  13. data/docs/ConditionTypeEnum.md +15 -0
  14. data/docs/Contact.md +14 -13
  15. data/docs/DataPassthroughRequest.md +10 -11
  16. data/docs/EndUserDetailsRequest.md +2 -2
  17. data/docs/FieldFormatEnum.md +15 -0
  18. data/docs/FieldTypeEnum.md +15 -0
  19. data/docs/Issue.md +18 -17
  20. data/docs/LinkToken.md +1 -1
  21. data/docs/LinkedAccountCondition.md +27 -0
  22. data/docs/LinkedAccountConditionRequest.md +21 -0
  23. data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
  24. data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
  25. data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
  26. data/docs/MetaResponse.md +6 -7
  27. data/docs/OperatorSchema.md +20 -0
  28. data/docs/PaginatedCollectionList.md +22 -0
  29. data/docs/PaginatedConditionSchemaList.md +22 -0
  30. data/docs/PaginatedRemoteFieldClassList.md +22 -0
  31. data/docs/PatchedTicketRequest.md +25 -22
  32. data/docs/Project.md +11 -10
  33. data/docs/ProjectsApi.md +10 -8
  34. data/docs/RemoteData.md +4 -5
  35. data/docs/RemoteField.md +19 -0
  36. data/docs/RemoteFieldClass.md +38 -0
  37. data/docs/RemoteFieldClassItemSchema.md +22 -0
  38. data/docs/RemoteResponse.md +9 -10
  39. data/docs/SelectiveSyncApi.md +233 -0
  40. data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
  41. data/docs/SyncStatus.md +5 -3
  42. data/docs/Tag.md +9 -8
  43. data/docs/Team.md +11 -10
  44. data/docs/Ticket.md +32 -25
  45. data/docs/TicketRequest.md +26 -25
  46. data/docs/TicketsApi.md +141 -13
  47. data/docs/User.md +14 -13
  48. data/docs/UsersApi.md +2 -0
  49. data/lib/merge_ticketing_client/api/collections_api.rb +234 -0
  50. data/lib/merge_ticketing_client/api/linked_accounts_api.rb +1 -1
  51. data/lib/merge_ticketing_client/api/projects_api.rb +14 -11
  52. data/lib/merge_ticketing_client/api/selective_sync_api.rb +225 -0
  53. data/lib/merge_ticketing_client/api/tickets_api.rb +177 -19
  54. data/lib/merge_ticketing_client/api/users_api.rb +3 -0
  55. data/lib/merge_ticketing_client/models/account.rb +16 -4
  56. data/lib/merge_ticketing_client/models/account_details_and_actions_status_enum.rb +1 -1
  57. data/lib/merge_ticketing_client/models/account_integration.rb +1 -1
  58. data/lib/merge_ticketing_client/models/attachment.rb +18 -4
  59. data/lib/merge_ticketing_client/models/attachment_request.rb +24 -20
  60. data/lib/merge_ticketing_client/models/categories_enum.rb +3 -2
  61. data/lib/merge_ticketing_client/models/category_enum.rb +3 -2
  62. data/lib/merge_ticketing_client/models/collection.rb +308 -0
  63. data/lib/merge_ticketing_client/models/collection_type_enum.rb +45 -0
  64. data/lib/merge_ticketing_client/models/comment.rb +19 -4
  65. data/lib/merge_ticketing_client/models/comment_request.rb +25 -20
  66. data/lib/merge_ticketing_client/models/condition_schema.rb +297 -0
  67. data/lib/merge_ticketing_client/models/condition_type_enum.rb +50 -0
  68. data/lib/merge_ticketing_client/models/contact.rb +16 -4
  69. data/lib/merge_ticketing_client/models/data_passthrough_request.rb +1 -0
  70. data/lib/merge_ticketing_client/models/encoding_enum.rb +1 -1
  71. data/lib/merge_ticketing_client/models/end_user_details_request.rb +2 -2
  72. data/lib/merge_ticketing_client/models/field_format_enum.rb +49 -0
  73. data/lib/merge_ticketing_client/models/field_type_enum.rb +49 -0
  74. data/lib/merge_ticketing_client/models/issue.rb +15 -4
  75. data/lib/merge_ticketing_client/models/link_token.rb +0 -5
  76. data/lib/merge_ticketing_client/models/linked_account_condition.rb +282 -0
  77. data/lib/merge_ticketing_client/models/linked_account_condition_request.rb +269 -0
  78. data/lib/merge_ticketing_client/models/linked_account_selective_sync_configuration.rb +221 -0
  79. data/lib/merge_ticketing_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
  80. data/lib/merge_ticketing_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
  81. data/lib/merge_ticketing_client/models/method_enum.rb +1 -1
  82. data/lib/merge_ticketing_client/models/operator_schema.rb +229 -0
  83. data/lib/merge_ticketing_client/models/paginated_collection_list.rb +240 -0
  84. data/lib/merge_ticketing_client/models/paginated_condition_schema_list.rb +240 -0
  85. data/lib/merge_ticketing_client/models/paginated_remote_field_class_list.rb +240 -0
  86. data/lib/merge_ticketing_client/models/patched_ticket_request.rb +57 -29
  87. data/lib/merge_ticketing_client/models/priority_enum.rb +1 -1
  88. data/lib/merge_ticketing_client/models/project.rb +16 -4
  89. data/lib/merge_ticketing_client/models/remote_data.rb +9 -7
  90. data/lib/merge_ticketing_client/models/remote_field.rb +231 -0
  91. data/lib/merge_ticketing_client/models/remote_field_class.rb +318 -0
  92. data/lib/merge_ticketing_client/models/remote_field_class_item_schema.rb +241 -0
  93. data/lib/merge_ticketing_client/models/request_format_enum.rb +1 -1
  94. data/lib/merge_ticketing_client/models/response_type_enum.rb +1 -1
  95. data/lib/merge_ticketing_client/models/selective_sync_configurations_usage_enum.rb +45 -0
  96. data/lib/merge_ticketing_client/models/sync_status.rb +13 -4
  97. data/lib/merge_ticketing_client/models/sync_status_status_enum.rb +1 -1
  98. data/lib/merge_ticketing_client/models/tag.rb +16 -4
  99. data/lib/merge_ticketing_client/models/team.rb +16 -4
  100. data/lib/merge_ticketing_client/models/ticket.rb +56 -7
  101. data/lib/merge_ticketing_client/models/ticket_request.rb +57 -40
  102. data/lib/merge_ticketing_client/models/ticket_status_enum.rb +1 -1
  103. data/lib/merge_ticketing_client/models/user.rb +16 -4
  104. data/lib/merge_ticketing_client/version.rb +1 -1
  105. data/lib/merge_ticketing_client.rb +21 -0
  106. data/spec/api/collections_api_spec.rb +76 -0
  107. data/spec/api/projects_api_spec.rb +3 -2
  108. data/spec/api/selective_sync_api_spec.rb +72 -0
  109. data/spec/api/tickets_api_spec.rb +24 -4
  110. data/spec/api/users_api_spec.rb +1 -0
  111. data/spec/models/account_spec.rb +6 -0
  112. data/spec/models/attachment_request_spec.rb +12 -0
  113. data/spec/models/attachment_spec.rb +6 -0
  114. data/spec/models/collection_spec.rb +82 -0
  115. data/spec/models/collection_type_enum_spec.rb +28 -0
  116. data/spec/models/comment_request_spec.rb +12 -0
  117. data/spec/models/comment_spec.rb +6 -0
  118. data/spec/models/condition_schema_spec.rb +70 -0
  119. data/spec/models/condition_type_enum_spec.rb +28 -0
  120. data/spec/models/contact_spec.rb +6 -0
  121. data/spec/models/issue_spec.rb +6 -0
  122. data/spec/models/linked_account_condition_request_spec.rb +46 -0
  123. data/spec/models/linked_account_condition_spec.rb +64 -0
  124. data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
  125. data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
  126. data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
  127. data/spec/models/operator_schema_spec.rb +40 -0
  128. data/spec/models/paginated_collection_list_spec.rb +46 -0
  129. data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
  130. data/spec/models/patched_ticket_request_spec.rb +24 -0
  131. data/spec/models/project_spec.rb +6 -0
  132. data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
  133. data/spec/models/sync_status_spec.rb +6 -0
  134. data/spec/models/tag_spec.rb +6 -0
  135. data/spec/models/team_spec.rb +6 -0
  136. data/spec/models/ticket_request_spec.rb +24 -0
  137. data/spec/models/ticket_spec.rb +18 -0
  138. data/spec/models/user_spec.rb +6 -0
  139. metadata +144 -72
@@ -0,0 +1,30 @@
1
+ # MergeTicketingClient::ConditionSchema
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The ID of the condition schema. This ID is used when updating selective syncs for a linked account. | |
8
+ | **common_model** | **String** | The common model for which a condition schema is defined. | [optional][readonly] |
9
+ | **native_name** | **String** | User-facing *native condition* name. e.g. \"Skip Manager\". | |
10
+ | **field_name** | **String** | The name of the field on the common model that this condition corresponds to, if they conceptually match. e.g. \"location_type\". | |
11
+ | **is_unique** | **Boolean** | Whether this condition can only be applied once. If false, the condition can be AND'd together multiple times. | [optional] |
12
+ | **condition_type** | [**ConditionTypeEnum**](ConditionTypeEnum.md) | | |
13
+ | **operators** | [**Array<OperatorSchema>**](OperatorSchema.md) | The schemas for the operators that can be used on a condition. | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'merge_ticketing_client'
19
+
20
+ instance = MergeTicketingClient::ConditionSchema.new(
21
+ id: null,
22
+ common_model: null,
23
+ native_name: null,
24
+ field_name: null,
25
+ is_unique: null,
26
+ condition_type: null,
27
+ operators: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,15 @@
1
+ # MergeTicketingClient::ConditionTypeEnum
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::ConditionTypeEnum.new()
14
+ ```
15
+
data/docs/Contact.md CHANGED
@@ -2,17 +2,18 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | [optional][readonly] |
8
- | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
- | **name** | **String** | The contact's name. | [optional] |
10
- | **email_address** | **String** | The contact's email address. | [optional] |
11
- | **phone_number** | **String** | The contact's phone number. | [optional] |
12
- | **details** | **String** | The contact's details. | [optional] |
13
- | **account** | **String** | The contact's account. | [optional] |
14
- | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
15
- | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
5
+ | Name | Type | Description | Notes |
6
+ | ---------------------- | -------------------------------------------- | ------------------------------------------------------------------------------ | -------------------- |
7
+ | **id** | **String** | | [optional][readonly] |
8
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
+ | **name** | **String** | The contact's name. | [optional] |
10
+ | **email_address** | **String** | The contact's email address. | [optional] |
11
+ | **phone_number** | **String** | The contact's phone number. | [optional] |
12
+ | **details** | **String** | The contact's details. | [optional] |
13
+ | **account** | **String** | The contact's account. | [optional] |
14
+ | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
15
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
16
+ | **field_mappings** | [**Hash<String, Object>**](Object.md) | | [optional][readonly] |
16
17
 
17
18
  ## Example
18
19
 
@@ -28,7 +29,7 @@ instance = MergeTicketingClient::Contact.new(
28
29
  details: Executive Assistant to Tom Wambsgans,
29
30
  account: 28b54125-287f-494d-965e-3c5b330c9a68,
30
31
  remote_data: null,
31
- remote_was_deleted: null
32
+ remote_was_deleted: null,
33
+ field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}}
32
34
  )
33
35
  ```
34
-
@@ -2,16 +2,16 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **method** | [**MethodEnum**](MethodEnum.md) | | |
8
- | **path** | **String** | | |
9
- | **base_url_override** | **String** | | [optional] |
10
- | **data** | **String** | | [optional] |
11
- | **multipart_form_data** | [**Array<MultipartFormFieldRequest>**](MultipartFormFieldRequest.md) | Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`. | [optional] |
12
- | **headers** | [**Hash<String, AnyType>**](AnyType.md) | The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. | [optional] |
13
- | **request_format** | [**RequestFormatEnum**](RequestFormatEnum.md) | | [optional] |
14
- | **normalize_response** | **Boolean** | | [optional] |
5
+ | Name | Type | Description | Notes |
6
+ | ----------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
7
+ | **method** | [**MethodEnum**](MethodEnum.md) | | |
8
+ | **path** | **String** | | |
9
+ | **base_url_override** | **String** | | [optional] |
10
+ | **data** | **String** | | [optional] |
11
+ | **multipart_form_data** | [**Array<MultipartFormFieldRequest>**](MultipartFormFieldRequest.md) | Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`. | [optional] |
12
+ | **headers** | [**Hash<String, Object>**](Object.md) | The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. | [optional] |
13
+ | **request_format** | [**RequestFormatEnum**](RequestFormatEnum.md) | | [optional] |
14
+ | **normalize_response** | **Boolean** | Optional. If true, the response will always be an object of the form `{\"type\": T, \"value\": ...}` where `T` will be one of `string, boolean, number, null, array, object`. | [optional] |
15
15
 
16
16
  ## Example
17
17
 
@@ -29,4 +29,3 @@ instance = MergeTicketingClient::DataPassthroughRequest.new(
29
29
  normalize_response: null
30
30
  )
31
31
  ```
32
-
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **end_user_email_address** | **String** | Your end user's email address. | |
7
+ | **end_user_email_address** | **String** | Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent. | |
8
8
  | **end_user_organization_name** | **String** | Your end user's organization. | |
9
- | **end_user_origin_id** | **String** | Unique ID for your end user. | |
9
+ | **end_user_origin_id** | **String** | This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers. | |
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] |
@@ -0,0 +1,15 @@
1
+ # MergeTicketingClient::FieldFormatEnum
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::FieldFormatEnum.new()
14
+ ```
15
+
@@ -0,0 +1,15 @@
1
+ # MergeTicketingClient::FieldTypeEnum
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::FieldTypeEnum.new()
14
+ ```
15
+
data/docs/Issue.md CHANGED
@@ -2,15 +2,16 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | [optional][readonly] |
8
- | **status** | [**IssueStatusEnum**](IssueStatusEnum.md) | | [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] |
5
+ | Name | Type | Description | Notes |
6
+ | ----------------------- | ------------------------------------------- | ----------- | -------------------- |
7
+ | **id** | **String** | | [optional][readonly] |
8
+ | **status** | [**IssueStatusEnum**](IssueStatusEnum.md) | | [optional] |
9
+ | **error_description** | **String** | | |
10
+ | **end_user** | [**Hash<String, Object>**](Object.md) | | [optional][readonly] |
11
+ | **first_incident_time** | **Time** | | [optional] |
12
+ | **last_incident_time** | **Time** | | [optional] |
13
+ | **is_muted** | **Boolean** | | [optional][readonly] |
14
+ | **error_details** | [**Hash<String, Object>**](Object.md) | | [optional][readonly] |
14
15
 
15
16
  ## Example
16
17
 
@@ -18,13 +19,13 @@
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
-
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,27 @@
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** | [**Object**](.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
+ ```
@@ -0,0 +1,21 @@
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** | [**Object**](.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
+ ```
@@ -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
+
data/docs/MetaResponse.md CHANGED
@@ -2,12 +2,12 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **request_schema** | [**Hash<String, AnyType>**](AnyType.md) | | |
8
- | **status** | [**LinkedAccountStatus**](LinkedAccountStatus.md) | | [optional] |
9
- | **has_conditional_params** | **Boolean** | | |
10
- | **has_required_linked_account_params** | **Boolean** | | |
5
+ | Name | Type | Description | Notes |
6
+ | -------------------------------------- | ------------------------------------------------- | ----------- | ---------- |
7
+ | **request_schema** | [**Hash<String, Object>**](Object.md) | | |
8
+ | **status** | [**LinkedAccountStatus**](LinkedAccountStatus.md) | | [optional] |
9
+ | **has_conditional_params** | **Boolean** | | |
10
+ | **has_required_linked_account_params** | **Boolean** | | |
11
11
 
12
12
  ## Example
13
13
 
@@ -21,4 +21,3 @@ instance = MergeTicketingClient::MetaResponse.new(
21
21
  has_required_linked_account_params: null
22
22
  )
23
23
  ```
24
-
@@ -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,22 @@
1
+ # MergeTicketingClient::PaginatedRemoteFieldClassList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array<RemoteFieldClass>**](RemoteFieldClass.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_ticketing_client'
15
+
16
+ instance = MergeTicketingClient::PaginatedRemoteFieldClassList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -2,24 +2,26 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | The ticket's name. | [optional] |
8
- | **assignees** | **Array<String>** | | [optional] |
9
- | **due_date** | **Time** | The ticket's due date. | [optional] |
10
- | **status** | [**TicketStatusEnum**](TicketStatusEnum.md) | The current status of the ticket. | [optional] |
11
- | **description** | **String** | The ticket's description. | [optional] |
12
- | **project** | **String** | | [optional] |
13
- | **ticket_type** | **String** | The ticket's type. | [optional] |
14
- | **account** | **String** | | [optional] |
15
- | **contact** | **String** | | [optional] |
16
- | **parent_ticket** | **String** | | [optional] |
17
- | **tags** | **Array<String>** | | [optional] |
18
- | **remote_created_at** | **Time** | When the third party's ticket was created. | [optional] |
19
- | **remote_updated_at** | **Time** | When the third party's ticket was updated. | [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. Possible values include: URGENT, HIGH, NORMAL, LOW - in cases where there is no clear mapping - the original value passed through. | [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] |
23
25
 
24
26
  ## Example
25
27
 
@@ -29,20 +31,21 @@ require 'merge_ticketing_client'
29
31
  instance = MergeTicketingClient::PatchedTicketRequest.new(
30
32
  name: Please add more integrations,
31
33
  assignees: ["17a54124-287f-494d-965e-3c5b330c9a68"],
34
+ creator: null,
32
35
  due_date: 2022-10-11T00:00Z,
33
36
  status: OPEN,
34
37
  description: Can you please add more integrations? It'll make syncing data much easier!,
35
38
  project: fb8c55b6-1cb8-4b4c-9fb6-17924231619d,
39
+ collections: ["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],
36
40
  ticket_type: incident,
37
41
  account: 0958cbc6-6040-430a-848e-aafacbadf4ae,
38
42
  contact: 65c345ba-6870-4974-87ba-dd31509c367a,
39
43
  parent_ticket: 75b33d04-30d2-4f3e-be45-27838bc94342,
40
44
  tags: ["enterprise","other-tag"],
41
- remote_created_at: 2021-11-10T00:00Z,
42
- remote_updated_at: 2021-12-09T00:00Z,
43
45
  completed_at: 2021-12-09T00:00Z,
44
46
  ticket_url: https://thirdpartysoftware.com/project/3/issue/1,
45
- priority: HIGH
47
+ priority: HIGH,
48
+ integration_params: {"unique_integration_field":"unique_integration_field_value"},
49
+ linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
46
50
  )
47
51
  ```
48
-
data/docs/Project.md CHANGED
@@ -2,14 +2,15 @@
2
2
 
3
3
  ## Properties
4
4
 
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] |
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] |
13
14
 
14
15
  ## Example
15
16
 
@@ -22,7 +23,7 @@ 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
-