ultracart_api 4.0.200 → 4.0.202

data/docs/ConversationPbxAgent.md

@@ -0,0 +1,34 @@
+# UltracartClient::ConversationPbxAgent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cellphone** | **String** | Cellphone number of agent in E.164 format | [optional] |
+| **conversation_pbx_agent_uuid** | **String** | Conversation Pbx Agent unique identifier | [optional] |
+| **conversation_pbx_voicemail_mailbox_uuid** | **String** | Conversation Pbx Voicemail Mailbox UUID | [optional] |
+| **forward_calls_to_cellphone** | **Boolean** | True if calls to this agent should be forwarded to their cellphone | [optional] |
+| **merchant_id** | **String** | Merchant Id | [optional] |
+| **record_outgoing_automatically** | **Boolean** | True if outgoing calls should be automatically recorded | [optional] |
+| **twilio_taskrouter_worker_id** | **String** | Twilio taskrouter worker Id | [optional] |
+| **user_id** | **Integer** | User Id | [optional] |
+| **voicemail** | **Boolean** | True if this agent has voicemail configured | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxAgent.new(
+  cellphone: null,
+  conversation_pbx_agent_uuid: null,
+  conversation_pbx_voicemail_mailbox_uuid: null,
+  forward_calls_to_cellphone: null,
+  merchant_id: null,
+  record_outgoing_automatically: null,
+  twilio_taskrouter_worker_id: null,
+  user_id: null,
+  voicemail: null
+)
+```
+

data/docs/ConversationPbxAgentResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxAgentResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **agent** | [**ConversationPbxAgent**](ConversationPbxAgent.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxAgentResponse.new(
+  agent: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxAgentsResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxAgentsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **agents** | [**Array<ConversationPbxAgent>**](ConversationPbxAgent.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxAgentsResponse.new(
+  agents: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxAudio.md

@@ -0,0 +1,34 @@
+# UltracartClient::ConversationPbxAudio
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **audio_s3_listing_key** | **String** | Audio S3 Listing Key | [optional] |
+| **conversation_pbx_audio_uuid** | **String** | Conversation Pbx Audio UUID | [optional] |
+| **default_hold_music** | **Boolean** | If true, this will be the default hold music | [optional] |
+| **description** | **String** | Description of this audio | [optional] |
+| **filename** | **String** | Filename | [optional] |
+| **merchant_id** | **String** | Merchant Id | [optional] |
+| **mime_type** | **String** | Mime Type | [optional] |
+| **user_id** | **Integer** | User Id | [optional] |
+| **version** | **Integer** | Version | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxAudio.new(
+  audio_s3_listing_key: null,
+  conversation_pbx_audio_uuid: null,
+  default_hold_music: null,
+  description: null,
+  filename: null,
+  merchant_id: null,
+  mime_type: null,
+  user_id: null,
+  version: null
+)
+```
+

data/docs/ConversationPbxAudioResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxAudioResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **audio** | [**ConversationPbxAudio**](ConversationPbxAudio.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxAudioResponse.new(
+  audio: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxAudiosResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxAudiosResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **audios** | [**Array<ConversationPbxAudio>**](ConversationPbxAudio.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxAudiosResponse.new(
+  audios: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxCustomerSnapshotRequest.md

@@ -0,0 +1,32 @@
+# UltracartClient::ConversationPbxCustomerSnapshotRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_order_expand** | **String** |  | [optional] |
+| **customer_expand** | **String** |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **order_expand** | **String** |  | [optional] |
+| **phone_number** | **String** |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxCustomerSnapshotRequest.new(
+  auto_order_expand: null,
+  customer_expand: null,
+  error: null,
+  metadata: null,
+  order_expand: null,
+  phone_number: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxCustomerSnapshotResponse.md

@@ -0,0 +1,30 @@
+# UltracartClient::ConversationPbxCustomerSnapshotResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_orders** | [**Array<AutoOrder>**](AutoOrder.md) |  | [optional] |
+| **customer** | [**Customer**](Customer.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **orders** | [**Array<Order>**](Order.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxCustomerSnapshotResponse.new(
+  auto_orders: null,
+  customer: null,
+  error: null,
+  metadata: null,
+  orders: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxMenu.md

@@ -0,0 +1,36 @@
+# UltracartClient::ConversationPbxMenu
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allow_direct_extensions** | **Boolean** | If true, the customer is allowed to input direct extensions within this menu | [optional] |
+| **conversation_pbx_menu_uuid** | **String** | Conversation Pbx Menu UUID | [optional] |
+| **default_action** | **String** | The default action for this menu | [optional] |
+| **default_action_target** | **String** | The default action target for this menu | [optional] |
+| **mappings** | [**Array<ConversationPbxMenuMapping>**](ConversationPbxMenuMapping.md) | Action mappings for this menu | [optional] |
+| **merchant_id** | **String** | Merchant Id | [optional] |
+| **name** | **String** | Menu name | [optional] |
+| **play_audio_uuid** | **String** | An optional audio clip that plays when a customer enters this menu | [optional] |
+| **say** | **String** | An optional saying that plays when a customer enters this menu | [optional] |
+| **timeout** | **Integer** | The idle seconds before this menu times out | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxMenu.new(
+  allow_direct_extensions: null,
+  conversation_pbx_menu_uuid: null,
+  default_action: null,
+  default_action_target: null,
+  mappings: null,
+  merchant_id: null,
+  name: null,
+  play_audio_uuid: null,
+  say: null,
+  timeout: null
+)
+```
+

data/docs/ConversationPbxMenuMapping.md

@@ -0,0 +1,24 @@
+# UltracartClient::ConversationPbxMenuMapping
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | Action | [optional] |
+| **action_target** | **String** | Action target | [optional] |
+| **digits** | **Integer** | Digits | [optional] |
+| **speech** | **String** | Speech | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxMenuMapping.new(
+  action: null,
+  action_target: null,
+  digits: null,
+  speech: null
+)
+```
+

data/docs/ConversationPbxMenuResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxMenuResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **menu** | [**ConversationPbxMenu**](ConversationPbxMenu.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxMenuResponse.new(
+  error: null,
+  menu: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxMenusResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxMenusResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **menus** | [**Array<ConversationPbxMenu>**](ConversationPbxMenu.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxMenusResponse.new(
+  error: null,
+  menus: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxPhoneNumber.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxPhoneNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | Action | [optional] |
+| **action_target** | **String** | Action target | [optional] |
+| **conversation_pbx_time_range_uuid** | **String** | Conversation Pbx Phone Number UUID | [optional] |
+| **merchant_id** | **String** | Merchant Id | [optional] |
+| **phone_number** | **String** | Phone number | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxPhoneNumber.new(
+  action: null,
+  action_target: null,
+  conversation_pbx_time_range_uuid: null,
+  merchant_id: null,
+  phone_number: null
+)
+```
+

data/docs/ConversationPbxPhoneNumberResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxPhoneNumberResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **phone_number** | [**ConversationPbxPhoneNumber**](ConversationPbxPhoneNumber.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxPhoneNumberResponse.new(
+  error: null,
+  metadata: null,
+  phone_number: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxPhoneNumbersResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxPhoneNumbersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **phone_numbers** | [**Array<ConversationPbxPhoneNumber>**](ConversationPbxPhoneNumber.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxPhoneNumbersResponse.new(
+  error: null,
+  metadata: null,
+  phone_numbers: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxQueue.md

@@ -0,0 +1,52 @@
+# UltracartClient::ConversationPbxQueue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **announce_queue_position** | **Boolean** | If true, the customer is told their queue position upon entering the queue | [optional] |
+| **conversation_pbx_queue_uuid** | **String** | Conversation Pbx Queue unique identifier | [optional] |
+| **conversation_voicemail_mailbox_uuid** | **String** | The voicemail mailbox associated with this queue | [optional] |
+| **hold_conversation_pbx_audio_uuid** | **String** | The audio to play while holding in a queue | [optional] |
+| **max_hold_seconds** | **Integer** | The maximum number of seconds for a customer to hold in a queue | [optional] |
+| **members** | [**ConversationPbxQueueMembers**](ConversationPbxQueueMembers.md) |  | [optional] |
+| **merchant_id** | **String** | Merchant Id | [optional] |
+| **name** | **String** | Name of queue | [optional] |
+| **no_agent_available_play_audio_uuid** | **String** | When no agent is available after the max_hold_seconds, say this | [optional] |
+| **no_agent_available_say** | **String** | When no agent is available after the max_hold_seconds, say this | [optional] |
+| **no_agent_available_say_voice** | **String** | The type of voice used to say text when no agent is available | [optional] |
+| **play_audio_uuid** | **String** | Audio played when customer enters a queue | [optional] |
+| **record_call** | **Boolean** | If true, any calls in this queue are recorded | [optional] |
+| **say** | **String** | Say text when a customer enters queue | [optional] |
+| **say_voice** | **String** | The type of voice to use when say text is spoken | [optional] |
+| **twilio_taskrouter_workflow_sid** | **String** | Twilio taskrouter workflow sid | [optional] |
+| **twilio_workspace_queue_sid** | **String** | Twilio workspace queue sid | [optional] |
+| **voicemail** | **Boolean** | If true, this queue has a voicemail associated with it | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxQueue.new(
+  announce_queue_position: null,
+  conversation_pbx_queue_uuid: null,
+  conversation_voicemail_mailbox_uuid: null,
+  hold_conversation_pbx_audio_uuid: null,
+  max_hold_seconds: null,
+  members: null,
+  merchant_id: null,
+  name: null,
+  no_agent_available_play_audio_uuid: null,
+  no_agent_available_say: null,
+  no_agent_available_say_voice: null,
+  play_audio_uuid: null,
+  record_call: null,
+  say: null,
+  say_voice: null,
+  twilio_taskrouter_workflow_sid: null,
+  twilio_workspace_queue_sid: null,
+  voicemail: null
+)
+```
+

data/docs/ConversationPbxQueueMembers.md

@@ -0,0 +1,20 @@
+# UltracartClient::ConversationPbxQueueMembers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **groups** | **Array<Integer>** |  | [optional] |
+| **users** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxQueueMembers.new(
+  groups: null,
+  users: null
+)
+```
+

data/docs/ConversationPbxQueueResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxQueueResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **queue** | [**ConversationPbxQueue**](ConversationPbxQueue.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxQueueResponse.new(
+  error: null,
+  metadata: null,
+  queue: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxQueuesResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxQueuesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **queues** | [**Array<ConversationPbxQueue>**](ConversationPbxQueue.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxQueuesResponse.new(
+  error: null,
+  metadata: null,
+  queues: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxTimeBased.md

@@ -0,0 +1,24 @@
+# UltracartClient::ConversationPbxTimeBased
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_pbx_time_based_uuid** | **String** |  | [optional] |
+| **mapping_config** | [**ConversationPbxTimeBasedMappingConfig**](ConversationPbxTimeBasedMappingConfig.md) |  | [optional] |
+| **merchant_id** | **String** |  | [optional] |
+| **time_based_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxTimeBased.new(
+  conversation_pbx_time_based_uuid: null,
+  mapping_config: null,
+  merchant_id: null,
+  time_based_name: null
+)
+```
+

data/docs/ConversationPbxTimeBasedMapping.md

@@ -0,0 +1,24 @@
+# UltracartClient::ConversationPbxTimeBasedMapping
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | Action | [optional] |
+| **action_target** | **String** | Action target | [optional] |
+| **name** | **String** | Name | [optional] |
+| **time_range_uuid** | **String** | Time range UUID | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxTimeBasedMapping.new(
+  action: null,
+  action_target: null,
+  name: null,
+  time_range_uuid: null
+)
+```
+

data/docs/ConversationPbxTimeBasedMappingConfig.md

@@ -0,0 +1,20 @@
+# UltracartClient::ConversationPbxTimeBasedMappingConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **default** | [**ConversationPbxTimeBasedMapping**](ConversationPbxTimeBasedMapping.md) |  | [optional] |
+| **mappings** | [**Array<ConversationPbxTimeBasedMapping>**](ConversationPbxTimeBasedMapping.md) | Mappings | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxTimeBasedMappingConfig.new(
+  default: null,
+  mappings: null
+)
+```
+

data/docs/ConversationPbxTimeBasedResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxTimeBasedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **time_based** | [**ConversationPbxTimeBased**](ConversationPbxTimeBased.md) |  | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxTimeBasedResponse.new(
+  error: null,
+  metadata: null,
+  success: null,
+  time_based: null,
+  warning: null
+)
+```
+