ultracart_api 4.0.200 → 4.0.202

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 (87) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +88 -4
  3. data/docs/ConversationApi.md +3565 -549
  4. data/docs/ConversationPbxAgent.md +34 -0
  5. data/docs/ConversationPbxAgentResponse.md +26 -0
  6. data/docs/ConversationPbxAgentsResponse.md +26 -0
  7. data/docs/ConversationPbxAudio.md +34 -0
  8. data/docs/ConversationPbxAudioResponse.md +26 -0
  9. data/docs/ConversationPbxAudiosResponse.md +26 -0
  10. data/docs/ConversationPbxCustomerSnapshotRequest.md +32 -0
  11. data/docs/ConversationPbxCustomerSnapshotResponse.md +30 -0
  12. data/docs/ConversationPbxMenu.md +36 -0
  13. data/docs/ConversationPbxMenuMapping.md +24 -0
  14. data/docs/ConversationPbxMenuResponse.md +26 -0
  15. data/docs/ConversationPbxMenusResponse.md +26 -0
  16. data/docs/ConversationPbxPhoneNumber.md +26 -0
  17. data/docs/ConversationPbxPhoneNumberResponse.md +26 -0
  18. data/docs/ConversationPbxPhoneNumbersResponse.md +26 -0
  19. data/docs/ConversationPbxQueue.md +52 -0
  20. data/docs/ConversationPbxQueueMembers.md +20 -0
  21. data/docs/ConversationPbxQueueResponse.md +26 -0
  22. data/docs/ConversationPbxQueuesResponse.md +26 -0
  23. data/docs/ConversationPbxTimeBased.md +24 -0
  24. data/docs/ConversationPbxTimeBasedMapping.md +24 -0
  25. data/docs/ConversationPbxTimeBasedMappingConfig.md +20 -0
  26. data/docs/ConversationPbxTimeBasedResponse.md +26 -0
  27. data/docs/ConversationPbxTimeBasedsResponse.md +26 -0
  28. data/docs/ConversationPbxTimeRange.md +26 -0
  29. data/docs/ConversationPbxTimeRangeConfig.md +28 -0
  30. data/docs/ConversationPbxTimeRangeResponse.md +26 -0
  31. data/docs/ConversationPbxTimeRangesResponse.md +26 -0
  32. data/docs/ConversationPbxVoicemailMailbox.md +38 -0
  33. data/docs/ConversationPbxVoicemailMailboxResponse.md +26 -0
  34. data/docs/ConversationPbxVoicemailMailboxesResponse.md +26 -0
  35. data/docs/EmailSmsOrder.md +24 -0
  36. data/docs/EmailSmsOrdersResponse.md +26 -0
  37. data/docs/EmailSmsStat.md +76 -0
  38. data/docs/EmailStatSmsSummaryRequest.md +20 -0
  39. data/docs/EmailStatSmsSummaryResponse.md +26 -0
  40. data/docs/PricingTier.md +2 -0
  41. data/docs/StorefrontApi.md +152 -0
  42. data/docs/WorkflowApi.md +69 -0
  43. data/docs/WorkflowTaskTagsResponse.md +26 -0
  44. data/lib/ultracart_api/api/conversation_api.rb +3422 -649
  45. data/lib/ultracart_api/api/storefront_api.rb +156 -0
  46. data/lib/ultracart_api/api/workflow_api.rb +58 -0
  47. data/lib/ultracart_api/models/conversation_pbx_agent.rb +360 -0
  48. data/lib/ultracart_api/models/conversation_pbx_agent_response.rb +256 -0
  49. data/lib/ultracart_api/models/conversation_pbx_agents_response.rb +258 -0
  50. data/lib/ultracart_api/models/conversation_pbx_audio.rb +390 -0
  51. data/lib/ultracart_api/models/conversation_pbx_audio_response.rb +256 -0
  52. data/lib/ultracart_api/models/conversation_pbx_audios_response.rb +258 -0
  53. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb +283 -0
  54. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_response.rb +278 -0
  55. data/lib/ultracart_api/models/conversation_pbx_menu.rb +402 -0
  56. data/lib/ultracart_api/models/conversation_pbx_menu_mapping.rb +250 -0
  57. data/lib/ultracart_api/models/conversation_pbx_menu_response.rb +256 -0
  58. data/lib/ultracart_api/models/conversation_pbx_menus_response.rb +258 -0
  59. data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +335 -0
  60. data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +256 -0
  61. data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +258 -0
  62. data/lib/ultracart_api/models/conversation_pbx_queue.rb +539 -0
  63. data/lib/ultracart_api/models/conversation_pbx_queue_members.rb +232 -0
  64. data/lib/ultracart_api/models/conversation_pbx_queue_response.rb +256 -0
  65. data/lib/ultracart_api/models/conversation_pbx_queues_response.rb +258 -0
  66. data/lib/ultracart_api/models/conversation_pbx_time_based.rb +246 -0
  67. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping.rb +310 -0
  68. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping_config.rb +231 -0
  69. data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +256 -0
  70. data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +258 -0
  71. data/lib/ultracart_api/models/conversation_pbx_time_range.rb +322 -0
  72. data/lib/ultracart_api/models/conversation_pbx_time_range_config.rb +270 -0
  73. data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +256 -0
  74. data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +258 -0
  75. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +440 -0
  76. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +256 -0
  77. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +258 -0
  78. data/lib/ultracart_api/models/email_sms_order.rb +249 -0
  79. data/lib/ultracart_api/models/email_sms_orders_response.rb +258 -0
  80. data/lib/ultracart_api/models/email_sms_stat.rb +511 -0
  81. data/lib/ultracart_api/models/email_stat_sms_summary_request.rb +230 -0
  82. data/lib/ultracart_api/models/email_stat_sms_summary_response.rb +258 -0
  83. data/lib/ultracart_api/models/pricing_tier.rb +11 -1
  84. data/lib/ultracart_api/models/workflow_task_tags_response.rb +259 -0
  85. data/lib/ultracart_api/version.rb +1 -1
  86. data/lib/ultracart_api.rb +37 -0
  87. metadata +76 -2
data/docs/WorkflowApi.md CHANGED
@@ -10,6 +10,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
10
10
  | [**get_workflow_task**](WorkflowApi.md#get_workflow_task) | **GET** /workflow/tasks/{task_uuid} | Retrieve a workflow task |
11
11
  | [**get_workflow_task_attachment_upload_url**](WorkflowApi.md#get_workflow_task_attachment_upload_url) | **GET** /workflow/tasks/attachments/{extension} | Get a presigned workflow task attachment upload URL |
12
12
  | [**get_workflow_task_by_object_type**](WorkflowApi.md#get_workflow_task_by_object_type) | **GET** /workflow/tasks/by/{object_type}/{object_id} | Retrieve a workflow task by object type and id |
13
+ | [**get_workflow_task_tags**](WorkflowApi.md#get_workflow_task_tags) | **GET** /workflow/tasks/tags | Get a list of existing workflow task tags |
13
14
  | [**get_workflow_tasks**](WorkflowApi.md#get_workflow_tasks) | **POST** /workflow/tasks/search | Search workflow tasks |
14
15
  | [**insert_workflow_task**](WorkflowApi.md#insert_workflow_task) | **POST** /workflow/tasks | Insert a workflow task |
15
16
  | [**update_workflow_task**](WorkflowApi.md#update_workflow_task) | **PUT** /workflow/tasks/{task_uuid} | Update a workflow task |
@@ -448,6 +449,74 @@ end
448
449
  - **Accept**: application/json
449
450
 
450
451
 
452
+ ## get_workflow_task_tags
453
+
454
+ > <WorkflowTaskTagsResponse> get_workflow_task_tags
455
+
456
+ Get a list of existing workflow task tags
457
+
458
+ Retrieves a unique list of all the existing workflow task tags.
459
+
460
+ ### Examples
461
+
462
+ ```ruby
463
+ require 'time'
464
+ require 'ultracart_api'
465
+ require 'json'
466
+ require 'yaml'
467
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
468
+
469
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
470
+ # As such, this might not be the best way to use this object.
471
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
472
+
473
+ api = UltracartClient::WorkflowApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
474
+
475
+ begin
476
+ # Get a list of existing workflow task tags
477
+ result = api_instance.get_workflow_task_tags
478
+ p result
479
+ rescue UltracartClient::ApiError => e
480
+ puts "Error when calling WorkflowApi->get_workflow_task_tags: #{e}"
481
+ end
482
+ ```
483
+
484
+ #### Using the get_workflow_task_tags_with_http_info variant
485
+
486
+ This returns an Array which contains the response data, status code and headers.
487
+
488
+ > <Array(<WorkflowTaskTagsResponse>, Integer, Hash)> get_workflow_task_tags_with_http_info
489
+
490
+ ```ruby
491
+ begin
492
+ # Get a list of existing workflow task tags
493
+ data, status_code, headers = api_instance.get_workflow_task_tags_with_http_info
494
+ p status_code # => 2xx
495
+ p headers # => { ... }
496
+ p data # => <WorkflowTaskTagsResponse>
497
+ rescue UltracartClient::ApiError => e
498
+ puts "Error when calling WorkflowApi->get_workflow_task_tags_with_http_info: #{e}"
499
+ end
500
+ ```
501
+
502
+ ### Parameters
503
+
504
+ This endpoint does not need any parameter.
505
+
506
+ ### Return type
507
+
508
+ [**WorkflowTaskTagsResponse**](WorkflowTaskTagsResponse.md)
509
+
510
+ ### Authorization
511
+
512
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
513
+
514
+ ### HTTP request headers
515
+
516
+ - **Content-Type**: Not defined
517
+ - **Accept**: application/json
518
+
519
+
451
520
  ## get_workflow_tasks
452
521
 
453
522
  > <WorkflowTasksResponse> get_workflow_tasks(workflow_tasks_query, opts)
@@ -0,0 +1,26 @@
1
+ # UltracartClient::WorkflowTaskTagsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
10
+ | **tags** | **Array&lt;String&gt;** | Tags | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::WorkflowTaskTagsResponse.new(
19
+ error: null,
20
+ metadata: null,
21
+ success: null,
22
+ tags: null,
23
+ warning: null
24
+ )
25
+ ```
26
+