ultracart_api 3.10.183 → 3.10.185

Sign up to get free protection for your applications and to get access to all the features.
Files changed (87) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +88 -4
  3. data/docs/ConversationApi.md +2466 -340
  4. data/docs/ConversationPbxAgent.md +16 -0
  5. data/docs/ConversationPbxAgentResponse.md +12 -0
  6. data/docs/ConversationPbxAgentsResponse.md +12 -0
  7. data/docs/ConversationPbxAudio.md +16 -0
  8. data/docs/ConversationPbxAudioResponse.md +12 -0
  9. data/docs/ConversationPbxAudiosResponse.md +12 -0
  10. data/docs/ConversationPbxCustomerSnapshotRequest.md +15 -0
  11. data/docs/ConversationPbxCustomerSnapshotResponse.md +14 -0
  12. data/docs/ConversationPbxMenu.md +17 -0
  13. data/docs/ConversationPbxMenuMapping.md +11 -0
  14. data/docs/ConversationPbxMenuResponse.md +12 -0
  15. data/docs/ConversationPbxMenusResponse.md +12 -0
  16. data/docs/ConversationPbxPhoneNumber.md +12 -0
  17. data/docs/ConversationPbxPhoneNumberResponse.md +12 -0
  18. data/docs/ConversationPbxPhoneNumbersResponse.md +12 -0
  19. data/docs/ConversationPbxQueue.md +25 -0
  20. data/docs/ConversationPbxQueueMembers.md +9 -0
  21. data/docs/ConversationPbxQueueResponse.md +12 -0
  22. data/docs/ConversationPbxQueuesResponse.md +12 -0
  23. data/docs/ConversationPbxTimeBased.md +11 -0
  24. data/docs/ConversationPbxTimeBasedMapping.md +11 -0
  25. data/docs/ConversationPbxTimeBasedMappingConfig.md +9 -0
  26. data/docs/ConversationPbxTimeBasedResponse.md +12 -0
  27. data/docs/ConversationPbxTimeBasedsResponse.md +12 -0
  28. data/docs/ConversationPbxTimeRange.md +12 -0
  29. data/docs/ConversationPbxTimeRangeConfig.md +13 -0
  30. data/docs/ConversationPbxTimeRangeResponse.md +12 -0
  31. data/docs/ConversationPbxTimeRangesResponse.md +12 -0
  32. data/docs/ConversationPbxVoicemailMailbox.md +18 -0
  33. data/docs/ConversationPbxVoicemailMailboxResponse.md +12 -0
  34. data/docs/ConversationPbxVoicemailMailboxesResponse.md +12 -0
  35. data/docs/EmailSmsOrder.md +11 -0
  36. data/docs/EmailSmsOrdersResponse.md +12 -0
  37. data/docs/EmailSmsStat.md +37 -0
  38. data/docs/EmailStatSmsSummaryRequest.md +9 -0
  39. data/docs/EmailStatSmsSummaryResponse.md +12 -0
  40. data/docs/PricingTier.md +1 -0
  41. data/docs/StorefrontApi.md +114 -0
  42. data/docs/WorkflowApi.md +46 -0
  43. data/docs/WorkflowTaskTagsResponse.md +12 -0
  44. data/lib/ultracart_api/api/conversation_api.rb +2919 -609
  45. data/lib/ultracart_api/api/storefront_api.rb +133 -0
  46. data/lib/ultracart_api/api/workflow_api.rb +49 -0
  47. data/lib/ultracart_api/models/conversation_pbx_agent.rb +325 -0
  48. data/lib/ultracart_api/models/conversation_pbx_agent_response.rb +221 -0
  49. data/lib/ultracart_api/models/conversation_pbx_agents_response.rb +223 -0
  50. data/lib/ultracart_api/models/conversation_pbx_audio.rb +355 -0
  51. data/lib/ultracart_api/models/conversation_pbx_audio_response.rb +221 -0
  52. data/lib/ultracart_api/models/conversation_pbx_audios_response.rb +223 -0
  53. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb +248 -0
  54. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_response.rb +243 -0
  55. data/lib/ultracart_api/models/conversation_pbx_menu.rb +367 -0
  56. data/lib/ultracart_api/models/conversation_pbx_menu_mapping.rb +215 -0
  57. data/lib/ultracart_api/models/conversation_pbx_menu_response.rb +221 -0
  58. data/lib/ultracart_api/models/conversation_pbx_menus_response.rb +223 -0
  59. data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +300 -0
  60. data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +221 -0
  61. data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +223 -0
  62. data/lib/ultracart_api/models/conversation_pbx_queue.rb +504 -0
  63. data/lib/ultracart_api/models/conversation_pbx_queue_members.rb +197 -0
  64. data/lib/ultracart_api/models/conversation_pbx_queue_response.rb +221 -0
  65. data/lib/ultracart_api/models/conversation_pbx_queues_response.rb +223 -0
  66. data/lib/ultracart_api/models/conversation_pbx_time_based.rb +211 -0
  67. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping.rb +275 -0
  68. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping_config.rb +196 -0
  69. data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +221 -0
  70. data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +223 -0
  71. data/lib/ultracart_api/models/conversation_pbx_time_range.rb +287 -0
  72. data/lib/ultracart_api/models/conversation_pbx_time_range_config.rb +235 -0
  73. data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +221 -0
  74. data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +223 -0
  75. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +405 -0
  76. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +221 -0
  77. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +223 -0
  78. data/lib/ultracart_api/models/email_sms_order.rb +214 -0
  79. data/lib/ultracart_api/models/email_sms_orders_response.rb +223 -0
  80. data/lib/ultracart_api/models/email_sms_stat.rb +476 -0
  81. data/lib/ultracart_api/models/email_stat_sms_summary_request.rb +195 -0
  82. data/lib/ultracart_api/models/email_stat_sms_summary_response.rb +223 -0
  83. data/lib/ultracart_api/models/pricing_tier.rb +11 -1
  84. data/lib/ultracart_api/models/workflow_task_tags_response.rb +224 -0
  85. data/lib/ultracart_api/version.rb +1 -1
  86. data/lib/ultracart_api.rb +37 -0
  87. metadata +76 -2
@@ -0,0 +1,16 @@
1
+ # UltracartClient::ConversationPbxAgent
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **cellphone** | **String** | Cellphone number of agent in E.164 format | [optional]
7
+ **conversation_pbx_agent_uuid** | **String** | Conversation Pbx Agent unique identifier | [optional]
8
+ **conversation_pbx_voicemail_mailbox_uuid** | **String** | Conversation Pbx Voicemail Mailbox UUID | [optional]
9
+ **forward_calls_to_cellphone** | **BOOLEAN** | True if calls to this agent should be forwarded to their cellphone | [optional]
10
+ **merchant_id** | **String** | Merchant Id | [optional]
11
+ **record_outgoing_automatically** | **BOOLEAN** | True if outgoing calls should be automatically recorded | [optional]
12
+ **twilio_taskrouter_worker_id** | **String** | Twilio taskrouter worker Id | [optional]
13
+ **user_id** | **Integer** | User Id | [optional]
14
+ **voicemail** | **BOOLEAN** | True if this agent has voicemail configured | [optional]
15
+
16
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxAgentResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **agent** | [**ConversationPbxAgent**](ConversationPbxAgent.md) | | [optional]
7
+ **error** | [**Error**](Error.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxAgentsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **agents** | [**Array<ConversationPbxAgent>**](ConversationPbxAgent.md) | | [optional]
7
+ **error** | [**Error**](Error.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,16 @@
1
+ # UltracartClient::ConversationPbxAudio
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **audio_s3_listing_key** | **String** | Audio S3 Listing Key | [optional]
7
+ **conversation_pbx_audio_uuid** | **String** | Conversation Pbx Audio UUID | [optional]
8
+ **default_hold_music** | **BOOLEAN** | If true, this will be the default hold music | [optional]
9
+ **description** | **String** | Description of this audio | [optional]
10
+ **filename** | **String** | Filename | [optional]
11
+ **merchant_id** | **String** | Merchant Id | [optional]
12
+ **mime_type** | **String** | Mime Type | [optional]
13
+ **user_id** | **Integer** | User Id | [optional]
14
+ **version** | **Integer** | Version | [optional]
15
+
16
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxAudioResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **audio** | [**ConversationPbxAudio**](ConversationPbxAudio.md) | | [optional]
7
+ **error** | [**Error**](Error.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxAudiosResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **audios** | [**Array<ConversationPbxAudio>**](ConversationPbxAudio.md) | | [optional]
7
+ **error** | [**Error**](Error.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,15 @@
1
+ # UltracartClient::ConversationPbxCustomerSnapshotRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **auto_order_expand** | **String** | | [optional]
7
+ **customer_expand** | **String** | | [optional]
8
+ **error** | [**Error**](Error.md) | | [optional]
9
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
10
+ **order_expand** | **String** | | [optional]
11
+ **phone_number** | **String** | | [optional]
12
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
13
+ **warning** | [**Warning**](Warning.md) | | [optional]
14
+
15
+
@@ -0,0 +1,14 @@
1
+ # UltracartClient::ConversationPbxCustomerSnapshotResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **auto_orders** | [**Array<AutoOrder>**](AutoOrder.md) | | [optional]
7
+ **customer** | [**Customer**](Customer.md) | | [optional]
8
+ **error** | [**Error**](Error.md) | | [optional]
9
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
10
+ **orders** | [**Array<Order>**](Order.md) | | [optional]
11
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
12
+ **warning** | [**Warning**](Warning.md) | | [optional]
13
+
14
+
@@ -0,0 +1,17 @@
1
+ # UltracartClient::ConversationPbxMenu
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **allow_direct_extensions** | **BOOLEAN** | If true, the customer is allowed to input direct extensions within this menu | [optional]
7
+ **conversation_pbx_menu_uuid** | **String** | Conversation Pbx Menu UUID | [optional]
8
+ **default_action** | **String** | The default action for this menu | [optional]
9
+ **default_action_target** | **String** | The default action target for this menu | [optional]
10
+ **mappings** | [**Array<ConversationPbxMenuMapping>**](ConversationPbxMenuMapping.md) | Action mappings for this menu | [optional]
11
+ **merchant_id** | **String** | Merchant Id | [optional]
12
+ **name** | **String** | Menu name | [optional]
13
+ **play_audio_uuid** | **String** | An optional audio clip that plays when a customer enters this menu | [optional]
14
+ **say** | **String** | An optional saying that plays when a customer enters this menu | [optional]
15
+ **timeout** | **Integer** | The idle seconds before this menu times out | [optional]
16
+
17
+
@@ -0,0 +1,11 @@
1
+ # UltracartClient::ConversationPbxMenuMapping
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **action** | **String** | Action | [optional]
7
+ **action_target** | **String** | Action target | [optional]
8
+ **digits** | **Integer** | Digits | [optional]
9
+ **speech** | **String** | Speech | [optional]
10
+
11
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxMenuResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **menu** | [**ConversationPbxMenu**](ConversationPbxMenu.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxMenusResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **menus** | [**Array<ConversationPbxMenu>**](ConversationPbxMenu.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxPhoneNumber
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **action** | **String** | Action | [optional]
7
+ **action_target** | **String** | Action target | [optional]
8
+ **conversation_pbx_time_range_uuid** | **String** | Conversation Pbx Phone Number UUID | [optional]
9
+ **merchant_id** | **String** | Merchant Id | [optional]
10
+ **phone_number** | **String** | Phone number | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxPhoneNumberResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **phone_number** | [**ConversationPbxPhoneNumber**](ConversationPbxPhoneNumber.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxPhoneNumbersResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **phone_numbers** | [**Array<ConversationPbxPhoneNumber>**](ConversationPbxPhoneNumber.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,25 @@
1
+ # UltracartClient::ConversationPbxQueue
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **announce_queue_position** | **BOOLEAN** | If true, the customer is told their queue position upon entering the queue | [optional]
7
+ **conversation_pbx_queue_uuid** | **String** | Conversation Pbx Queue unique identifier | [optional]
8
+ **conversation_voicemail_mailbox_uuid** | **String** | The voicemail mailbox associated with this queue | [optional]
9
+ **hold_conversation_pbx_audio_uuid** | **String** | The audio to play while holding in a queue | [optional]
10
+ **max_hold_seconds** | **Integer** | The maximum number of seconds for a customer to hold in a queue | [optional]
11
+ **members** | [**ConversationPbxQueueMembers**](ConversationPbxQueueMembers.md) | | [optional]
12
+ **merchant_id** | **String** | Merchant Id | [optional]
13
+ **name** | **String** | Name of queue | [optional]
14
+ **no_agent_available_play_audio_uuid** | **String** | When no agent is available after the max_hold_seconds, say this | [optional]
15
+ **no_agent_available_say** | **String** | When no agent is available after the max_hold_seconds, say this | [optional]
16
+ **no_agent_available_say_voice** | **String** | The type of voice used to say text when no agent is available | [optional]
17
+ **play_audio_uuid** | **String** | Audio played when customer enters a queue | [optional]
18
+ **record_call** | **BOOLEAN** | If true, any calls in this queue are recorded | [optional]
19
+ **say** | **String** | Say text when a customer enters queue | [optional]
20
+ **say_voice** | **String** | The type of voice to use when say text is spoken | [optional]
21
+ **twilio_taskrouter_workflow_sid** | **String** | Twilio taskrouter workflow sid | [optional]
22
+ **twilio_workspace_queue_sid** | **String** | Twilio workspace queue sid | [optional]
23
+ **voicemail** | **BOOLEAN** | If true, this queue has a voicemail associated with it | [optional]
24
+
25
+
@@ -0,0 +1,9 @@
1
+ # UltracartClient::ConversationPbxQueueMembers
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **groups** | **Array<Integer>** | | [optional]
7
+ **users** | **Array<Integer>** | | [optional]
8
+
9
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxQueueResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **queue** | [**ConversationPbxQueue**](ConversationPbxQueue.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxQueuesResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **queues** | [**Array<ConversationPbxQueue>**](ConversationPbxQueue.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,11 @@
1
+ # UltracartClient::ConversationPbxTimeBased
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **conversation_pbx_time_based_uuid** | **String** | | [optional]
7
+ **mapping_config** | [**ConversationPbxTimeBasedMappingConfig**](ConversationPbxTimeBasedMappingConfig.md) | | [optional]
8
+ **merchant_id** | **String** | | [optional]
9
+ **time_based_name** | **String** | | [optional]
10
+
11
+
@@ -0,0 +1,11 @@
1
+ # UltracartClient::ConversationPbxTimeBasedMapping
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **action** | **String** | Action | [optional]
7
+ **action_target** | **String** | Action target | [optional]
8
+ **name** | **String** | Name | [optional]
9
+ **time_range_uuid** | **String** | Time range UUID | [optional]
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # UltracartClient::ConversationPbxTimeBasedMappingConfig
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **default** | [**ConversationPbxTimeBasedMapping**](ConversationPbxTimeBasedMapping.md) | | [optional]
7
+ **mappings** | [**Array<ConversationPbxTimeBasedMapping>**](ConversationPbxTimeBasedMapping.md) | Mappings | [optional]
8
+
9
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxTimeBasedResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
9
+ **time_based** | [**ConversationPbxTimeBased**](ConversationPbxTimeBased.md) | | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxTimeBasedsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
9
+ **time_baseds** | [**Array<ConversationPbxTimeBased>**](ConversationPbxTimeBased.md) | | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxTimeRange
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **configs** | [**Array<ConversationPbxTimeRangeConfig>**](ConversationPbxTimeRangeConfig.md) | Configurations for all ranges in this time range | [optional]
7
+ **conversation_pbx_time_range_uuid** | **String** | Conversation Pbx Time Range UUID | [optional]
8
+ **merchant_id** | **String** | Merchant Id | [optional]
9
+ **time_range_name** | **String** | Time range name | [optional]
10
+ **timezone** | **String** | Timezone | [optional]
11
+
12
+
@@ -0,0 +1,13 @@
1
+ # UltracartClient::ConversationPbxTimeRangeConfig
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **end_date** | **String** | End date | [optional]
7
+ **end_day_of_week** | **Integer** | End day of week | [optional]
8
+ **end_time** | **String** | End time | [optional]
9
+ **start_date** | **String** | Start date | [optional]
10
+ **start_day_of_week** | **Integer** | Start day of week | [optional]
11
+ **start_time** | **String** | Start time | [optional]
12
+
13
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxTimeRangeResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
9
+ **time_range** | [**ConversationPbxTimeRange**](ConversationPbxTimeRange.md) | | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxTimeRangesResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
9
+ **time_ranges** | [**Array<ConversationPbxTimeRange>**](ConversationPbxTimeRange.md) | | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,18 @@
1
+ # UltracartClient::ConversationPbxVoicemailMailbox
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **conversation_pbx_voicemail_mailbox_uuid** | **String** | Conversation Pbx Voicemail Mailbox UUID | [optional]
7
+ **merchant_id** | **String** | Merchant Id | [optional]
8
+ **send_notices_to_email** | **String** | Send notices to email | [optional]
9
+ **user_id** | **Integer** | User Id | [optional]
10
+ **voicemail_follow_play_audio_uuid** | **String** | Voicemail follow play audio UUID | [optional]
11
+ **voicemail_followup_say** | **String** | Voicemail followup say | [optional]
12
+ **voicemail_mailbox_id** | **String** | Voicemail mailbox id | [optional]
13
+ **voicemail_mailbox_type** | **String** | Voicemail mailbox type | [optional]
14
+ **voicemail_prompt_play_audio_uuid** | **String** | Voicemail prompt play audio UUID | [optional]
15
+ **voicemail_prompt_say** | **String** | Voicemail prompt say | [optional]
16
+ **voicemail_say_voice** | **String** | Voicemail say voice | [optional]
17
+
18
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxVoicemailMailboxResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
9
+ **voicemail_mailbox** | [**ConversationPbxVoicemailMailbox**](ConversationPbxVoicemailMailbox.md) | | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationPbxVoicemailMailboxesResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
9
+ **voicemail_mailboxes** | [**Array<ConversationPbxVoicemailMailbox>**](ConversationPbxVoicemailMailbox.md) | | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,11 @@
1
+ # UltracartClient::EmailSmsOrder
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | email | [optional]
7
+ **order_dts** | **String** | order_dts | [optional]
8
+ **order_id** | **String** | order_id | [optional]
9
+ **total** | [**Currency**](Currency.md) | | [optional]
10
+
11
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::EmailSmsOrdersResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **orders** | [**Array<EmailSmsOrder>**](EmailSmsOrder.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,37 @@
1
+ # UltracartClient::EmailSmsStat
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **click_count** | **Integer** | Count of clicked emails | [optional]
7
+ **click_count_formatted** | **String** | Count of clicked emails, formatted | [optional]
8
+ **conversion_count** | **Integer** | Count of conversions | [optional]
9
+ **conversion_count_formatted** | **String** | Count of conversions, formatted | [optional]
10
+ **deleted** | **BOOLEAN** | True if campaign/flow has been archived | [optional]
11
+ **delivered_count** | **Integer** | Count of delivered emails | [optional]
12
+ **delivered_count_formatted** | **String** | Count of delivered emails, formatted | [optional]
13
+ **merchant_id** | **String** | Merchant ID | [optional]
14
+ **name** | **String** | List or segment name | [optional]
15
+ **order_count** | **Integer** | Count of orders | [optional]
16
+ **order_count_formatted** | **String** | Count of orders, formatted | [optional]
17
+ **profit** | **Float** | Profit | [optional]
18
+ **profit_formatted** | **String** | Profit, formatted | [optional]
19
+ **revenue** | **Float** | Revenue | [optional]
20
+ **revenue_formatted** | **String** | Revenue, formatted | [optional]
21
+ **send_count** | **Integer** | Count of emails sent | [optional]
22
+ **send_count_formatted** | **String** | Count of emails sent, formatted | [optional]
23
+ **skipped_count** | **Integer** | Count of skipped emails | [optional]
24
+ **skipped_count_formatted** | **String** | Count of skipped emails, formatted | [optional]
25
+ **stat_type** | **String** | Campaign, Flow or None (for anything else) | [optional]
26
+ **status** | **String** | Status of campaign or flow | [optional]
27
+ **status_dts** | **String** | Status dts of campaign or flow | [optional]
28
+ **step_uuid** | **String** | Step UUID if the statistics are at the step/email level | [optional]
29
+ **steps** | [**Array<EmailSmsStat>**](EmailSmsStat.md) | | [optional]
30
+ **storefront_oid** | **Integer** | Storefront oid | [optional]
31
+ **unsubscribe_count** | **Integer** | Count of emails classified as unsubscribe | [optional]
32
+ **unsubscribe_count_formatted** | **String** | Count of emails classified as unsubscribe, formatted | [optional]
33
+ **uuid** | **String** | List/Segment uuid, or Flow/Campaign uuid depending on level of stat aggregation. | [optional]
34
+ **view_count** | **Integer** | Count of views | [optional]
35
+ **view_count_formatted** | **String** | Count of views, formatted | [optional]
36
+
37
+
@@ -0,0 +1,9 @@
1
+ # UltracartClient::EmailStatSmsSummaryRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **commseq_step_uuids** | **Array<String>** | | [optional]
7
+ **days** | **Integer** | | [optional]
8
+
9
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::EmailStatSmsSummaryResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **stats** | [**Array<EmailSmsStat>**](EmailSmsStat.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
data/docs/PricingTier.md CHANGED
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **approval_notification** | [**PricingTierNotification**](PricingTierNotification.md) | | [optional]
11
11
  **auto_approve_cod** | **BOOLEAN** | Auto approve COD | [optional]
12
12
  **auto_approve_purchase_order** | **BOOLEAN** | Auto approve purchase order | [optional]
13
+ **currency_code** | **String** | Any currency code specified on this pricing tier will force a shopping cart into that currency | [optional]
13
14
  **default_on_wholesale_signup** | **BOOLEAN** | Default on wholesale signup | [optional]
14
15
  **default_percentage_discount** | **Float** | Default percentage discount | [optional]
15
16
  **default_shipping_method_oid** | **Integer** | Default shipping method oid | [optional]