merge_ticketing_client 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE.md +16 -0
- data/README.md +208 -0
- data/Rakefile +10 -0
- data/docs/Account.md +28 -0
- data/docs/AccountDetails.md +36 -0
- data/docs/AccountDetailsAndActions.md +36 -0
- data/docs/AccountDetailsAndActionsIntegration.md +32 -0
- data/docs/AccountDetailsAndActionsStatusEnum.md +15 -0
- data/docs/AccountDetailsApi.md +79 -0
- data/docs/AccountIntegration.md +28 -0
- data/docs/AccountToken.md +20 -0
- data/docs/AccountTokenApi.md +79 -0
- data/docs/AccountsApi.md +177 -0
- data/docs/Attachment.md +36 -0
- data/docs/AttachmentRequest.md +30 -0
- data/docs/AttachmentsApi.md +335 -0
- data/docs/AvailableActions.md +22 -0
- data/docs/AvailableActionsApi.md +79 -0
- data/docs/CategoriesEnum.md +15 -0
- data/docs/CategoryEnum.md +15 -0
- data/docs/Comment.md +38 -0
- data/docs/CommentEndpointRequest.md +18 -0
- data/docs/CommentRequest.md +32 -0
- data/docs/CommentResponse.md +24 -0
- data/docs/CommentsApi.md +335 -0
- data/docs/Contact.md +34 -0
- data/docs/ContactsApi.md +181 -0
- data/docs/DataPassthroughRequest.md +32 -0
- data/docs/DebugModeLog.md +22 -0
- data/docs/DebugModelLogSummary.md +22 -0
- data/docs/DeleteAccountApi.md +78 -0
- data/docs/EncodingEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +30 -0
- data/docs/ErrorValidationProblem.md +24 -0
- data/docs/ForceResyncApi.md +79 -0
- data/docs/GenerateKeyApi.md +79 -0
- data/docs/GenerateRemoteKeyRequest.md +18 -0
- data/docs/Issue.md +30 -0
- data/docs/IssueStatusEnum.md +15 -0
- data/docs/IssuesApi.md +177 -0
- data/docs/LinkToken.md +22 -0
- data/docs/LinkTokenApi.md +79 -0
- data/docs/LinkedAccountStatus.md +20 -0
- data/docs/LinkedAccountsApi.md +105 -0
- data/docs/MetaResponse.md +24 -0
- data/docs/MethodEnum.md +15 -0
- data/docs/ModelOperation.md +24 -0
- data/docs/MultipartFormFieldRequest.md +26 -0
- data/docs/PaginatedAccountDetailsAndActionsList.md +22 -0
- data/docs/PaginatedAccountList.md +22 -0
- data/docs/PaginatedAttachmentList.md +22 -0
- data/docs/PaginatedCommentList.md +22 -0
- data/docs/PaginatedContactList.md +22 -0
- data/docs/PaginatedIssueList.md +22 -0
- data/docs/PaginatedProjectList.md +22 -0
- data/docs/PaginatedSyncStatusList.md +22 -0
- data/docs/PaginatedTagList.md +22 -0
- data/docs/PaginatedTeamList.md +22 -0
- data/docs/PaginatedTicketList.md +22 -0
- data/docs/PaginatedUserList.md +22 -0
- data/docs/PassthroughApi.md +81 -0
- data/docs/Project.md +28 -0
- data/docs/ProjectsApi.md +261 -0
- data/docs/RegenerateKeyApi.md +79 -0
- data/docs/RemoteData.md +20 -0
- data/docs/RemoteKey.md +20 -0
- data/docs/RemoteKeyForRegenerationRequest.md +18 -0
- data/docs/RemoteResponse.md +28 -0
- data/docs/RequestFormatEnum.md +15 -0
- data/docs/SyncStatus.md +28 -0
- data/docs/SyncStatusApi.md +85 -0
- data/docs/SyncStatusStatusEnum.md +15 -0
- data/docs/Tag.md +24 -0
- data/docs/TagsApi.md +177 -0
- data/docs/Team.md +28 -0
- data/docs/TeamsApi.md +177 -0
- data/docs/Ticket.md +52 -0
- data/docs/TicketEndpointRequest.md +18 -0
- data/docs/TicketRequest.md +46 -0
- data/docs/TicketResponse.md +24 -0
- data/docs/TicketStatusEnum.md +15 -0
- data/docs/TicketingAttachmentEndpointRequest.md +18 -0
- data/docs/TicketingAttachmentResponse.md +24 -0
- data/docs/TicketsApi.md +425 -0
- data/docs/User.md +32 -0
- data/docs/UsersApi.md +181 -0
- data/docs/ValidationProblemSource.md +18 -0
- data/docs/WarningValidationProblem.md +24 -0
- data/docs/WebhookReceiver.md +22 -0
- data/docs/WebhookReceiverRequest.md +22 -0
- data/docs/WebhookReceiversApi.md +153 -0
- data/git_push.sh +58 -0
- data/lib/merge_ticketing_client/api/account_details_api.rb +84 -0
- data/lib/merge_ticketing_client/api/account_token_api.rb +83 -0
- data/lib/merge_ticketing_client/api/accounts_api.rb +182 -0
- data/lib/merge_ticketing_client/api/attachments_api.rb +337 -0
- data/lib/merge_ticketing_client/api/available_actions_api.rb +84 -0
- data/lib/merge_ticketing_client/api/comments_api.rb +337 -0
- data/lib/merge_ticketing_client/api/contacts_api.rb +196 -0
- data/lib/merge_ticketing_client/api/delete_account_api.rb +82 -0
- data/lib/merge_ticketing_client/api/force_resync_api.rb +84 -0
- data/lib/merge_ticketing_client/api/generate_key_api.rb +85 -0
- data/lib/merge_ticketing_client/api/issues_api.rb +181 -0
- data/lib/merge_ticketing_client/api/link_token_api.rb +85 -0
- data/lib/merge_ticketing_client/api/linked_accounts_api.rb +120 -0
- data/lib/merge_ticketing_client/api/passthrough_api.rb +92 -0
- data/lib/merge_ticketing_client/api/projects_api.rb +266 -0
- data/lib/merge_ticketing_client/api/regenerate_key_api.rb +85 -0
- data/lib/merge_ticketing_client/api/sync_status_api.rb +90 -0
- data/lib/merge_ticketing_client/api/tags_api.rb +182 -0
- data/lib/merge_ticketing_client/api/teams_api.rb +182 -0
- data/lib/merge_ticketing_client/api/tickets_api.rb +438 -0
- data/lib/merge_ticketing_client/api/users_api.rb +196 -0
- data/lib/merge_ticketing_client/api/webhook_receivers_api.rb +154 -0
- data/lib/merge_ticketing_client/api_client.rb +390 -0
- data/lib/merge_ticketing_client/api_error.rb +57 -0
- data/lib/merge_ticketing_client/configuration.rb +281 -0
- data/lib/merge_ticketing_client/models/account.rb +276 -0
- data/lib/merge_ticketing_client/models/account_details.rb +302 -0
- data/lib/merge_ticketing_client/models/account_details_and_actions.rb +327 -0
- data/lib/merge_ticketing_client/models/account_details_and_actions_integration.rb +310 -0
- data/lib/merge_ticketing_client/models/account_details_and_actions_status_enum.rb +46 -0
- data/lib/merge_ticketing_client/models/account_integration.rb +303 -0
- data/lib/merge_ticketing_client/models/account_token.rb +237 -0
- data/lib/merge_ticketing_client/models/attachment.rb +315 -0
- data/lib/merge_ticketing_client/models/attachment_request.rb +285 -0
- data/lib/merge_ticketing_client/models/available_actions.rb +249 -0
- data/lib/merge_ticketing_client/models/categories_enum.rb +48 -0
- data/lib/merge_ticketing_client/models/category_enum.rb +48 -0
- data/lib/merge_ticketing_client/models/comment.rb +325 -0
- data/lib/merge_ticketing_client/models/comment_endpoint_request.rb +223 -0
- data/lib/merge_ticketing_client/models/comment_request.rb +295 -0
- data/lib/merge_ticketing_client/models/comment_response.rb +266 -0
- data/lib/merge_ticketing_client/models/contact.rb +307 -0
- data/lib/merge_ticketing_client/models/data_passthrough_request.rb +352 -0
- data/lib/merge_ticketing_client/models/debug_mode_log.rb +251 -0
- data/lib/merge_ticketing_client/models/debug_model_log_summary.rb +251 -0
- data/lib/merge_ticketing_client/models/encoding_enum.rb +46 -0
- data/lib/merge_ticketing_client/models/end_user_details_request.rb +430 -0
- data/lib/merge_ticketing_client/models/error_validation_problem.rb +260 -0
- data/lib/merge_ticketing_client/models/generate_remote_key_request.rb +243 -0
- data/lib/merge_ticketing_client/models/issue.rb +281 -0
- data/lib/merge_ticketing_client/models/issue_status_enum.rb +45 -0
- data/lib/merge_ticketing_client/models/link_token.rb +246 -0
- data/lib/merge_ticketing_client/models/linked_account_status.rb +237 -0
- data/lib/merge_ticketing_client/models/meta_response.rb +262 -0
- data/lib/merge_ticketing_client/models/method_enum.rb +50 -0
- data/lib/merge_ticketing_client/models/model_operation.rb +272 -0
- data/lib/merge_ticketing_client/models/multipart_form_field_request.rb +341 -0
- data/lib/merge_ticketing_client/models/paginated_account_details_and_actions_list.rb +240 -0
- data/lib/merge_ticketing_client/models/paginated_account_list.rb +240 -0
- data/lib/merge_ticketing_client/models/paginated_attachment_list.rb +240 -0
- data/lib/merge_ticketing_client/models/paginated_comment_list.rb +240 -0
- data/lib/merge_ticketing_client/models/paginated_contact_list.rb +240 -0
- data/lib/merge_ticketing_client/models/paginated_issue_list.rb +240 -0
- data/lib/merge_ticketing_client/models/paginated_project_list.rb +240 -0
- data/lib/merge_ticketing_client/models/paginated_sync_status_list.rb +240 -0
- data/lib/merge_ticketing_client/models/paginated_tag_list.rb +240 -0
- data/lib/merge_ticketing_client/models/paginated_team_list.rb +240 -0
- data/lib/merge_ticketing_client/models/paginated_ticket_list.rb +240 -0
- data/lib/merge_ticketing_client/models/paginated_user_list.rb +240 -0
- data/lib/merge_ticketing_client/models/project.rb +274 -0
- data/lib/merge_ticketing_client/models/remote_data.rb +234 -0
- data/lib/merge_ticketing_client/models/remote_key.rb +238 -0
- data/lib/merge_ticketing_client/models/remote_key_for_regeneration_request.rb +243 -0
- data/lib/merge_ticketing_client/models/remote_response.rb +290 -0
- data/lib/merge_ticketing_client/models/request_format_enum.rb +46 -0
- data/lib/merge_ticketing_client/models/sync_status.rb +294 -0
- data/lib/merge_ticketing_client/models/sync_status_status_enum.rb +48 -0
- data/lib/merge_ticketing_client/models/tag.rb +254 -0
- data/lib/merge_ticketing_client/models/team.rb +274 -0
- data/lib/merge_ticketing_client/models/ticket.rb +401 -0
- data/lib/merge_ticketing_client/models/ticket_endpoint_request.rb +223 -0
- data/lib/merge_ticketing_client/models/ticket_request.rb +371 -0
- data/lib/merge_ticketing_client/models/ticket_response.rb +266 -0
- data/lib/merge_ticketing_client/models/ticket_status_enum.rb +45 -0
- data/lib/merge_ticketing_client/models/ticketing_attachment_endpoint_request.rb +223 -0
- data/lib/merge_ticketing_client/models/ticketing_attachment_response.rb +266 -0
- data/lib/merge_ticketing_client/models/user.rb +296 -0
- data/lib/merge_ticketing_client/models/validation_problem_source.rb +223 -0
- data/lib/merge_ticketing_client/models/warning_validation_problem.rb +260 -0
- data/lib/merge_ticketing_client/models/webhook_receiver.rb +246 -0
- data/lib/merge_ticketing_client/models/webhook_receiver_request.rb +280 -0
- data/lib/merge_ticketing_client/version.rb +15 -0
- data/lib/merge_ticketing_client.rb +127 -0
- data/merge_ticketing_client.gemspec +38 -0
- data/pull_request_template.md +20 -0
- data/spec/api/account_details_api_spec.rb +46 -0
- data/spec/api/account_token_api_spec.rb +46 -0
- data/spec/api/accounts_api_spec.rb +68 -0
- data/spec/api/attachments_api_spec.rb +96 -0
- data/spec/api/available_actions_api_spec.rb +46 -0
- data/spec/api/comments_api_spec.rb +96 -0
- data/spec/api/contacts_api_spec.rb +70 -0
- data/spec/api/delete_account_api_spec.rb +46 -0
- data/spec/api/force_resync_api_spec.rb +46 -0
- data/spec/api/generate_key_api_spec.rb +46 -0
- data/spec/api/issues_api_spec.rb +69 -0
- data/spec/api/link_token_api_spec.rb +46 -0
- data/spec/api/linked_accounts_api_spec.rb +58 -0
- data/spec/api/passthrough_api_spec.rb +47 -0
- data/spec/api/projects_api_spec.rb +84 -0
- data/spec/api/regenerate_key_api_spec.rb +46 -0
- data/spec/api/sync_status_api_spec.rb +48 -0
- data/spec/api/tags_api_spec.rb +68 -0
- data/spec/api/teams_api_spec.rb +68 -0
- data/spec/api/tickets_api_spec.rb +115 -0
- data/spec/api/users_api_spec.rb +70 -0
- data/spec/api/webhook_receivers_api_spec.rb +58 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_details_and_actions_integration_spec.rb +76 -0
- data/spec/models/account_details_and_actions_spec.rb +88 -0
- data/spec/models/account_details_and_actions_status_enum_spec.rb +28 -0
- data/spec/models/account_details_spec.rb +88 -0
- data/spec/models/account_integration_spec.rb +64 -0
- data/spec/models/account_spec.rb +64 -0
- data/spec/models/account_token_spec.rb +40 -0
- data/spec/models/attachment_request_spec.rb +70 -0
- data/spec/models/attachment_spec.rb +88 -0
- data/spec/models/available_actions_spec.rb +46 -0
- data/spec/models/categories_enum_spec.rb +28 -0
- data/spec/models/category_enum_spec.rb +28 -0
- data/spec/models/comment_endpoint_request_spec.rb +34 -0
- data/spec/models/comment_request_spec.rb +76 -0
- data/spec/models/comment_response_spec.rb +52 -0
- data/spec/models/comment_spec.rb +94 -0
- data/spec/models/contact_spec.rb +82 -0
- data/spec/models/data_passthrough_request_spec.rb +76 -0
- data/spec/models/debug_mode_log_spec.rb +46 -0
- data/spec/models/debug_model_log_summary_spec.rb +46 -0
- data/spec/models/encoding_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +70 -0
- data/spec/models/error_validation_problem_spec.rb +52 -0
- data/spec/models/generate_remote_key_request_spec.rb +34 -0
- data/spec/models/issue_spec.rb +70 -0
- data/spec/models/issue_status_enum_spec.rb +28 -0
- data/spec/models/link_token_spec.rb +46 -0
- data/spec/models/linked_account_status_spec.rb +40 -0
- data/spec/models/meta_response_spec.rb +52 -0
- data/spec/models/method_enum_spec.rb +28 -0
- data/spec/models/model_operation_spec.rb +52 -0
- data/spec/models/multipart_form_field_request_spec.rb +58 -0
- data/spec/models/paginated_account_details_and_actions_list_spec.rb +46 -0
- data/spec/models/paginated_account_list_spec.rb +46 -0
- data/spec/models/paginated_attachment_list_spec.rb +46 -0
- data/spec/models/paginated_comment_list_spec.rb +46 -0
- data/spec/models/paginated_contact_list_spec.rb +46 -0
- data/spec/models/paginated_issue_list_spec.rb +46 -0
- data/spec/models/paginated_project_list_spec.rb +46 -0
- data/spec/models/paginated_sync_status_list_spec.rb +46 -0
- data/spec/models/paginated_tag_list_spec.rb +46 -0
- data/spec/models/paginated_team_list_spec.rb +46 -0
- data/spec/models/paginated_ticket_list_spec.rb +46 -0
- data/spec/models/paginated_user_list_spec.rb +46 -0
- data/spec/models/project_spec.rb +64 -0
- data/spec/models/remote_data_spec.rb +40 -0
- data/spec/models/remote_key_for_regeneration_request_spec.rb +34 -0
- data/spec/models/remote_key_spec.rb +40 -0
- data/spec/models/remote_response_spec.rb +64 -0
- data/spec/models/request_format_enum_spec.rb +28 -0
- data/spec/models/sync_status_spec.rb +64 -0
- data/spec/models/sync_status_status_enum_spec.rb +28 -0
- data/spec/models/tag_spec.rb +52 -0
- data/spec/models/team_spec.rb +64 -0
- data/spec/models/ticket_endpoint_request_spec.rb +34 -0
- data/spec/models/ticket_request_spec.rb +118 -0
- data/spec/models/ticket_response_spec.rb +52 -0
- data/spec/models/ticket_spec.rb +136 -0
- data/spec/models/ticket_status_enum_spec.rb +28 -0
- data/spec/models/ticketing_attachment_endpoint_request_spec.rb +34 -0
- data/spec/models/ticketing_attachment_response_spec.rb +52 -0
- data/spec/models/user_spec.rb +76 -0
- data/spec/models/validation_problem_source_spec.rb +34 -0
- data/spec/models/warning_validation_problem_spec.rb +52 -0
- data/spec/models/webhook_receiver_request_spec.rb +46 -0
- data/spec/models/webhook_receiver_spec.rb +46 -0
- data/spec/spec_helper.rb +111 -0
- metadata +454 -0
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeTicketingClient::CategoryEnum
|
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::CategoryEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/Comment.md
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
# MergeTicketingClient::Comment
|
2
|
+
|
3
|
+
## Properties
|
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
|
+
| **user** | **String** | | [optional] |
|
10
|
+
| **contact** | **String** | | [optional] |
|
11
|
+
| **body** | **String** | The comment's text body. | [optional] |
|
12
|
+
| **html_body** | **String** | The comment's text body formatted as html. | [optional] |
|
13
|
+
| **ticket** | **String** | | [optional] |
|
14
|
+
| **is_private** | **Boolean** | Whether or not the comment is internal. | [optional] |
|
15
|
+
| **remote_created_at** | **Time** | When the third party's comment was created. | [optional] |
|
16
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
17
|
+
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'merge_ticketing_client'
|
23
|
+
|
24
|
+
instance = MergeTicketingClient::Comment.new(
|
25
|
+
id: 0958cbc6-6040-430a-848e-aafacbadf4ae,
|
26
|
+
remote_id: 19202938,
|
27
|
+
user: 17a54124-287f-494d-965e-3c5b330c9a68,
|
28
|
+
contact: dde3fb16-b8eb-483d-81c4-b78100816f15,
|
29
|
+
body: When will these integrations be done? You all should use Merge.,
|
30
|
+
html_body: When will these integrations be done? You all should use <b>Merge<b>.,
|
31
|
+
ticket: fb8c55b6-1cb8-4b4c-9fb6-17924231619d,
|
32
|
+
is_private: null,
|
33
|
+
remote_created_at: 1990-11-10T00:00Z,
|
34
|
+
remote_data: null,
|
35
|
+
remote_was_deleted: null
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeTicketingClient::CommentEndpointRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**CommentRequest**](CommentRequest.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_ticketing_client'
|
13
|
+
|
14
|
+
instance = MergeTicketingClient::CommentEndpointRequest.new(
|
15
|
+
model: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# MergeTicketingClient::CommentRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
8
|
+
| **user** | **String** | | [optional] |
|
9
|
+
| **contact** | **String** | | [optional] |
|
10
|
+
| **body** | **String** | The comment's text body. | [optional] |
|
11
|
+
| **html_body** | **String** | The comment's text body formatted as html. | [optional] |
|
12
|
+
| **ticket** | **String** | | [optional] |
|
13
|
+
| **is_private** | **Boolean** | Whether or not the comment is internal. | [optional] |
|
14
|
+
| **remote_created_at** | **Time** | When the third party's comment was created. | [optional] |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'merge_ticketing_client'
|
20
|
+
|
21
|
+
instance = MergeTicketingClient::CommentRequest.new(
|
22
|
+
remote_id: 19202938,
|
23
|
+
user: 17a54124-287f-494d-965e-3c5b330c9a68,
|
24
|
+
contact: dde3fb16-b8eb-483d-81c4-b78100816f15,
|
25
|
+
body: When will these integrations be done? You all should use Merge.,
|
26
|
+
html_body: When will these integrations be done? You all should use <b>Merge<b>.,
|
27
|
+
ticket: fb8c55b6-1cb8-4b4c-9fb6-17924231619d,
|
28
|
+
is_private: null,
|
29
|
+
remote_created_at: 1990-11-10T00:00Z
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeTicketingClient::CommentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**Comment**](Comment.md) | | |
|
8
|
+
| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) | | |
|
9
|
+
| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) | | |
|
10
|
+
| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'merge_ticketing_client'
|
16
|
+
|
17
|
+
instance = MergeTicketingClient::CommentResponse.new(
|
18
|
+
model: null,
|
19
|
+
warnings: null,
|
20
|
+
errors: null,
|
21
|
+
logs: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/CommentsApi.md
ADDED
@@ -0,0 +1,335 @@
|
|
1
|
+
# MergeTicketingClient::CommentsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**comments_create**](CommentsApi.md#comments_create) | **POST** /comments | |
|
8
|
+
| [**comments_list**](CommentsApi.md#comments_list) | **GET** /comments | |
|
9
|
+
| [**comments_meta_post_retrieve**](CommentsApi.md#comments_meta_post_retrieve) | **GET** /comments/meta/post | |
|
10
|
+
| [**comments_retrieve**](CommentsApi.md#comments_retrieve) | **GET** /comments/{id} | |
|
11
|
+
|
12
|
+
|
13
|
+
## comments_create
|
14
|
+
|
15
|
+
> <CommentResponse> comments_create(x_account_token, comment_endpoint_request, opts)
|
16
|
+
|
17
|
+
|
18
|
+
|
19
|
+
Creates a `Comment` object with the given values.
|
20
|
+
|
21
|
+
### Examples
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'time'
|
25
|
+
require 'merge_ticketing_client'
|
26
|
+
# setup authorization
|
27
|
+
MergeTicketingClient.configure do |config|
|
28
|
+
# Configure API key authorization: tokenAuth
|
29
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
30
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
31
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
32
|
+
end
|
33
|
+
|
34
|
+
api_instance = MergeTicketingClient::CommentsApi.new
|
35
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
36
|
+
comment_endpoint_request = MergeTicketingClient::CommentEndpointRequest.new({model: MergeTicketingClient::CommentRequest.new}) # CommentEndpointRequest |
|
37
|
+
opts = {
|
38
|
+
is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
|
39
|
+
run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
|
44
|
+
result = api_instance.comments_create(x_account_token, comment_endpoint_request, opts)
|
45
|
+
p result
|
46
|
+
rescue MergeTicketingClient::ApiError => e
|
47
|
+
puts "Error when calling CommentsApi->comments_create: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
#### Using the comments_create_with_http_info variant
|
52
|
+
|
53
|
+
This returns an Array which contains the response data, status code and headers.
|
54
|
+
|
55
|
+
> <Array(<CommentResponse>, Integer, Hash)> comments_create_with_http_info(x_account_token, comment_endpoint_request, opts)
|
56
|
+
|
57
|
+
```ruby
|
58
|
+
begin
|
59
|
+
|
60
|
+
data, status_code, headers = api_instance.comments_create_with_http_info(x_account_token, comment_endpoint_request, opts)
|
61
|
+
p status_code # => 2xx
|
62
|
+
p headers # => { ... }
|
63
|
+
p data # => <CommentResponse>
|
64
|
+
rescue MergeTicketingClient::ApiError => e
|
65
|
+
puts "Error when calling CommentsApi->comments_create_with_http_info: #{e}"
|
66
|
+
end
|
67
|
+
```
|
68
|
+
|
69
|
+
### Parameters
|
70
|
+
|
71
|
+
| Name | Type | Description | Notes |
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
73
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
74
|
+
| **comment_endpoint_request** | [**CommentEndpointRequest**](CommentEndpointRequest.md) | | |
|
75
|
+
| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
|
76
|
+
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
77
|
+
|
78
|
+
### Return type
|
79
|
+
|
80
|
+
[**CommentResponse**](CommentResponse.md)
|
81
|
+
|
82
|
+
### Authorization
|
83
|
+
|
84
|
+
[tokenAuth](../README.md#tokenAuth)
|
85
|
+
|
86
|
+
### HTTP request headers
|
87
|
+
|
88
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
89
|
+
- **Accept**: application/json
|
90
|
+
|
91
|
+
|
92
|
+
## comments_list
|
93
|
+
|
94
|
+
> <PaginatedCommentList> comments_list(x_account_token, opts)
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
Returns a list of `Comment` objects.
|
99
|
+
|
100
|
+
### Examples
|
101
|
+
|
102
|
+
```ruby
|
103
|
+
require 'time'
|
104
|
+
require 'merge_ticketing_client'
|
105
|
+
# setup authorization
|
106
|
+
MergeTicketingClient.configure do |config|
|
107
|
+
# Configure API key authorization: tokenAuth
|
108
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
109
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
110
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
111
|
+
end
|
112
|
+
|
113
|
+
api_instance = MergeTicketingClient::CommentsApi.new
|
114
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
115
|
+
opts = {
|
116
|
+
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
117
|
+
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
118
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
119
|
+
expand: 'contact', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
120
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
121
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
122
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
123
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
124
|
+
page_size: 56, # Integer | Number of results to return per page.
|
125
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
126
|
+
ticket_id: 'ticket_id_example' # String | If provided, will only return comments for this ticket.
|
127
|
+
}
|
128
|
+
|
129
|
+
begin
|
130
|
+
|
131
|
+
result = api_instance.comments_list(x_account_token, opts)
|
132
|
+
p result
|
133
|
+
rescue MergeTicketingClient::ApiError => e
|
134
|
+
puts "Error when calling CommentsApi->comments_list: #{e}"
|
135
|
+
end
|
136
|
+
```
|
137
|
+
|
138
|
+
#### Using the comments_list_with_http_info variant
|
139
|
+
|
140
|
+
This returns an Array which contains the response data, status code and headers.
|
141
|
+
|
142
|
+
> <Array(<PaginatedCommentList>, Integer, Hash)> comments_list_with_http_info(x_account_token, opts)
|
143
|
+
|
144
|
+
```ruby
|
145
|
+
begin
|
146
|
+
|
147
|
+
data, status_code, headers = api_instance.comments_list_with_http_info(x_account_token, opts)
|
148
|
+
p status_code # => 2xx
|
149
|
+
p headers # => { ... }
|
150
|
+
p data # => <PaginatedCommentList>
|
151
|
+
rescue MergeTicketingClient::ApiError => e
|
152
|
+
puts "Error when calling CommentsApi->comments_list_with_http_info: #{e}"
|
153
|
+
end
|
154
|
+
```
|
155
|
+
|
156
|
+
### Parameters
|
157
|
+
|
158
|
+
| Name | Type | Description | Notes |
|
159
|
+
| ---- | ---- | ----------- | ----- |
|
160
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
161
|
+
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
162
|
+
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
163
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
164
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
165
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
166
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
167
|
+
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
168
|
+
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
169
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
170
|
+
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
171
|
+
| **ticket_id** | **String** | If provided, will only return comments for this ticket. | [optional] |
|
172
|
+
|
173
|
+
### Return type
|
174
|
+
|
175
|
+
[**PaginatedCommentList**](PaginatedCommentList.md)
|
176
|
+
|
177
|
+
### Authorization
|
178
|
+
|
179
|
+
[tokenAuth](../README.md#tokenAuth)
|
180
|
+
|
181
|
+
### HTTP request headers
|
182
|
+
|
183
|
+
- **Content-Type**: Not defined
|
184
|
+
- **Accept**: application/json
|
185
|
+
|
186
|
+
|
187
|
+
## comments_meta_post_retrieve
|
188
|
+
|
189
|
+
> <MetaResponse> comments_meta_post_retrieve(x_account_token)
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
Returns metadata for `Comment` POSTs.
|
194
|
+
|
195
|
+
### Examples
|
196
|
+
|
197
|
+
```ruby
|
198
|
+
require 'time'
|
199
|
+
require 'merge_ticketing_client'
|
200
|
+
# setup authorization
|
201
|
+
MergeTicketingClient.configure do |config|
|
202
|
+
# Configure API key authorization: tokenAuth
|
203
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
204
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
205
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
206
|
+
end
|
207
|
+
|
208
|
+
api_instance = MergeTicketingClient::CommentsApi.new
|
209
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
210
|
+
|
211
|
+
begin
|
212
|
+
|
213
|
+
result = api_instance.comments_meta_post_retrieve(x_account_token)
|
214
|
+
p result
|
215
|
+
rescue MergeTicketingClient::ApiError => e
|
216
|
+
puts "Error when calling CommentsApi->comments_meta_post_retrieve: #{e}"
|
217
|
+
end
|
218
|
+
```
|
219
|
+
|
220
|
+
#### Using the comments_meta_post_retrieve_with_http_info variant
|
221
|
+
|
222
|
+
This returns an Array which contains the response data, status code and headers.
|
223
|
+
|
224
|
+
> <Array(<MetaResponse>, Integer, Hash)> comments_meta_post_retrieve_with_http_info(x_account_token)
|
225
|
+
|
226
|
+
```ruby
|
227
|
+
begin
|
228
|
+
|
229
|
+
data, status_code, headers = api_instance.comments_meta_post_retrieve_with_http_info(x_account_token)
|
230
|
+
p status_code # => 2xx
|
231
|
+
p headers # => { ... }
|
232
|
+
p data # => <MetaResponse>
|
233
|
+
rescue MergeTicketingClient::ApiError => e
|
234
|
+
puts "Error when calling CommentsApi->comments_meta_post_retrieve_with_http_info: #{e}"
|
235
|
+
end
|
236
|
+
```
|
237
|
+
|
238
|
+
### Parameters
|
239
|
+
|
240
|
+
| Name | Type | Description | Notes |
|
241
|
+
| ---- | ---- | ----------- | ----- |
|
242
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
243
|
+
|
244
|
+
### Return type
|
245
|
+
|
246
|
+
[**MetaResponse**](MetaResponse.md)
|
247
|
+
|
248
|
+
### Authorization
|
249
|
+
|
250
|
+
[tokenAuth](../README.md#tokenAuth)
|
251
|
+
|
252
|
+
### HTTP request headers
|
253
|
+
|
254
|
+
- **Content-Type**: Not defined
|
255
|
+
- **Accept**: application/json
|
256
|
+
|
257
|
+
|
258
|
+
## comments_retrieve
|
259
|
+
|
260
|
+
> <Comment> comments_retrieve(x_account_token, id, opts)
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
Returns a `Comment` object with the given `id`.
|
265
|
+
|
266
|
+
### Examples
|
267
|
+
|
268
|
+
```ruby
|
269
|
+
require 'time'
|
270
|
+
require 'merge_ticketing_client'
|
271
|
+
# setup authorization
|
272
|
+
MergeTicketingClient.configure do |config|
|
273
|
+
# Configure API key authorization: tokenAuth
|
274
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
275
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
276
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
277
|
+
end
|
278
|
+
|
279
|
+
api_instance = MergeTicketingClient::CommentsApi.new
|
280
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
281
|
+
id = TODO # String |
|
282
|
+
opts = {
|
283
|
+
expand: 'contact', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
284
|
+
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
285
|
+
}
|
286
|
+
|
287
|
+
begin
|
288
|
+
|
289
|
+
result = api_instance.comments_retrieve(x_account_token, id, opts)
|
290
|
+
p result
|
291
|
+
rescue MergeTicketingClient::ApiError => e
|
292
|
+
puts "Error when calling CommentsApi->comments_retrieve: #{e}"
|
293
|
+
end
|
294
|
+
```
|
295
|
+
|
296
|
+
#### Using the comments_retrieve_with_http_info variant
|
297
|
+
|
298
|
+
This returns an Array which contains the response data, status code and headers.
|
299
|
+
|
300
|
+
> <Array(<Comment>, Integer, Hash)> comments_retrieve_with_http_info(x_account_token, id, opts)
|
301
|
+
|
302
|
+
```ruby
|
303
|
+
begin
|
304
|
+
|
305
|
+
data, status_code, headers = api_instance.comments_retrieve_with_http_info(x_account_token, id, opts)
|
306
|
+
p status_code # => 2xx
|
307
|
+
p headers # => { ... }
|
308
|
+
p data # => <Comment>
|
309
|
+
rescue MergeTicketingClient::ApiError => e
|
310
|
+
puts "Error when calling CommentsApi->comments_retrieve_with_http_info: #{e}"
|
311
|
+
end
|
312
|
+
```
|
313
|
+
|
314
|
+
### Parameters
|
315
|
+
|
316
|
+
| Name | Type | Description | Notes |
|
317
|
+
| ---- | ---- | ----------- | ----- |
|
318
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
319
|
+
| **id** | [**String**](.md) | | |
|
320
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
321
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
322
|
+
|
323
|
+
### Return type
|
324
|
+
|
325
|
+
[**Comment**](Comment.md)
|
326
|
+
|
327
|
+
### Authorization
|
328
|
+
|
329
|
+
[tokenAuth](../README.md#tokenAuth)
|
330
|
+
|
331
|
+
### HTTP request headers
|
332
|
+
|
333
|
+
- **Content-Type**: Not defined
|
334
|
+
- **Accept**: application/json
|
335
|
+
|
data/docs/Contact.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# MergeTicketingClient::Contact
|
2
|
+
|
3
|
+
## Properties
|
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] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'merge_ticketing_client'
|
21
|
+
|
22
|
+
instance = MergeTicketingClient::Contact.new(
|
23
|
+
id: 17a54124-287f-494d-965e-3c5b330c9a68,
|
24
|
+
remote_id: 19202938,
|
25
|
+
name: Cousin Greg,
|
26
|
+
email_address: greg@waystar-royco.com,
|
27
|
+
phone_number: 5108890293,
|
28
|
+
details: Executive Assistant to Tom Wambsgans,
|
29
|
+
account: 28b54125-287f-494d-965e-3c5b330c9a68,
|
30
|
+
remote_data: null,
|
31
|
+
remote_was_deleted: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
data/docs/ContactsApi.md
ADDED
@@ -0,0 +1,181 @@
|
|
1
|
+
# MergeTicketingClient::ContactsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/ticketing/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**contacts_list**](ContactsApi.md#contacts_list) | **GET** /contacts | |
|
8
|
+
| [**contacts_retrieve**](ContactsApi.md#contacts_retrieve) | **GET** /contacts/{id} | |
|
9
|
+
|
10
|
+
|
11
|
+
## contacts_list
|
12
|
+
|
13
|
+
> <PaginatedContactList> contacts_list(x_account_token, opts)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
Returns a list of `Contact` objects.
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'merge_ticketing_client'
|
24
|
+
# setup authorization
|
25
|
+
MergeTicketingClient.configure do |config|
|
26
|
+
# Configure API key authorization: tokenAuth
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = MergeTicketingClient::ContactsApi.new
|
33
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
|
+
opts = {
|
35
|
+
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
|
+
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
|
+
expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
39
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
40
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
42
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
43
|
+
page_size: 56, # Integer | Number of results to return per page.
|
44
|
+
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
45
|
+
}
|
46
|
+
|
47
|
+
begin
|
48
|
+
|
49
|
+
result = api_instance.contacts_list(x_account_token, opts)
|
50
|
+
p result
|
51
|
+
rescue MergeTicketingClient::ApiError => e
|
52
|
+
puts "Error when calling ContactsApi->contacts_list: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
#### Using the contacts_list_with_http_info variant
|
57
|
+
|
58
|
+
This returns an Array which contains the response data, status code and headers.
|
59
|
+
|
60
|
+
> <Array(<PaginatedContactList>, Integer, Hash)> contacts_list_with_http_info(x_account_token, opts)
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
begin
|
64
|
+
|
65
|
+
data, status_code, headers = api_instance.contacts_list_with_http_info(x_account_token, opts)
|
66
|
+
p status_code # => 2xx
|
67
|
+
p headers # => { ... }
|
68
|
+
p data # => <PaginatedContactList>
|
69
|
+
rescue MergeTicketingClient::ApiError => e
|
70
|
+
puts "Error when calling ContactsApi->contacts_list_with_http_info: #{e}"
|
71
|
+
end
|
72
|
+
```
|
73
|
+
|
74
|
+
### Parameters
|
75
|
+
|
76
|
+
| Name | Type | Description | Notes |
|
77
|
+
| ---- | ---- | ----------- | ----- |
|
78
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
79
|
+
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
80
|
+
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
81
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
82
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
83
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
84
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
85
|
+
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
86
|
+
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
87
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
88
|
+
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
89
|
+
|
90
|
+
### Return type
|
91
|
+
|
92
|
+
[**PaginatedContactList**](PaginatedContactList.md)
|
93
|
+
|
94
|
+
### Authorization
|
95
|
+
|
96
|
+
[tokenAuth](../README.md#tokenAuth)
|
97
|
+
|
98
|
+
### HTTP request headers
|
99
|
+
|
100
|
+
- **Content-Type**: Not defined
|
101
|
+
- **Accept**: application/json
|
102
|
+
|
103
|
+
|
104
|
+
## contacts_retrieve
|
105
|
+
|
106
|
+
> <Contact> contacts_retrieve(x_account_token, id, opts)
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
Returns a `Contact` object with the given `id`.
|
111
|
+
|
112
|
+
### Examples
|
113
|
+
|
114
|
+
```ruby
|
115
|
+
require 'time'
|
116
|
+
require 'merge_ticketing_client'
|
117
|
+
# setup authorization
|
118
|
+
MergeTicketingClient.configure do |config|
|
119
|
+
# Configure API key authorization: tokenAuth
|
120
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
121
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
122
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
123
|
+
end
|
124
|
+
|
125
|
+
api_instance = MergeTicketingClient::ContactsApi.new
|
126
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
127
|
+
id = TODO # String |
|
128
|
+
opts = {
|
129
|
+
expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
130
|
+
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
131
|
+
}
|
132
|
+
|
133
|
+
begin
|
134
|
+
|
135
|
+
result = api_instance.contacts_retrieve(x_account_token, id, opts)
|
136
|
+
p result
|
137
|
+
rescue MergeTicketingClient::ApiError => e
|
138
|
+
puts "Error when calling ContactsApi->contacts_retrieve: #{e}"
|
139
|
+
end
|
140
|
+
```
|
141
|
+
|
142
|
+
#### Using the contacts_retrieve_with_http_info variant
|
143
|
+
|
144
|
+
This returns an Array which contains the response data, status code and headers.
|
145
|
+
|
146
|
+
> <Array(<Contact>, Integer, Hash)> contacts_retrieve_with_http_info(x_account_token, id, opts)
|
147
|
+
|
148
|
+
```ruby
|
149
|
+
begin
|
150
|
+
|
151
|
+
data, status_code, headers = api_instance.contacts_retrieve_with_http_info(x_account_token, id, opts)
|
152
|
+
p status_code # => 2xx
|
153
|
+
p headers # => { ... }
|
154
|
+
p data # => <Contact>
|
155
|
+
rescue MergeTicketingClient::ApiError => e
|
156
|
+
puts "Error when calling ContactsApi->contacts_retrieve_with_http_info: #{e}"
|
157
|
+
end
|
158
|
+
```
|
159
|
+
|
160
|
+
### Parameters
|
161
|
+
|
162
|
+
| Name | Type | Description | Notes |
|
163
|
+
| ---- | ---- | ----------- | ----- |
|
164
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
165
|
+
| **id** | [**String**](.md) | | |
|
166
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
167
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
168
|
+
|
169
|
+
### Return type
|
170
|
+
|
171
|
+
[**Contact**](Contact.md)
|
172
|
+
|
173
|
+
### Authorization
|
174
|
+
|
175
|
+
[tokenAuth](../README.md#tokenAuth)
|
176
|
+
|
177
|
+
### HTTP request headers
|
178
|
+
|
179
|
+
- **Content-Type**: Not defined
|
180
|
+
- **Accept**: application/json
|
181
|
+
|