ultracart_api 4.1.39 → 4.1.41

data/docs/ConversationApi.md

@@ -9,9 +9,11 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**delete_conversation_canned_message**](ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message |
 | [**delete_department**](ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department |
 | [**delete_engagement**](ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement |
+| [**delete_pbx_address**](ConversationApi.md#delete_pbx_address) | **DELETE** /conversation/pbx/address/{conversationPbxAddressUuid} | Delete pbx address |
 | [**delete_pbx_agent_voicemail**](ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail |
 | [**delete_pbx_audio**](ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio |
 | [**delete_pbx_menu**](ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu |
+| [**delete_pbx_phone_number**](ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber |
 | [**delete_pbx_queue**](ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue |
 | [**delete_pbx_queue_voicemail**](ConversationApi.md#delete_pbx_queue_voicemail) | **DELETE** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Delete Queue Voicemail |
 | [**delete_pbx_time_based**](ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased |
@@ -43,6 +45,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_conversations_autocomplete**](ConversationApi.md#get_conversations_autocomplete) | **POST** /conversation/conversations/autocomplete | Retrieve a list of matching terms for a search field |
 | [**get_conversations_search**](ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations |
 | [**get_locations_for_engagement**](ConversationApi.md#get_locations_for_engagement) | **POST** /conversation/locations | Get location data for engagement configuration |
+| [**get_pbx_address**](ConversationApi.md#get_pbx_address) | **GET** /conversation/pbx/address/{conversationPbxAddressUuid} | Get pbx address |
+| [**get_pbx_addresses**](ConversationApi.md#get_pbx_addresses) | **GET** /conversation/pbx/address | Get pbx addresses |
 | [**get_pbx_agent**](ConversationApi.md#get_pbx_agent) | **GET** /conversation/pbx/agent/{conversationPbxAgentUuid} | Get pbx agent |
 | [**get_pbx_agent_voicemail**](ConversationApi.md#get_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid} | Get Agent Voicemail |
 | [**get_pbx_agent_voicemails**](ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails |
@@ -71,6 +75,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message |
 | [**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department |
 | [**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement |
+| [**insert_pbx_address**](ConversationApi.md#insert_pbx_address) | **POST** /conversation/pbx/address | Insert pbx address |
 | [**insert_pbx_audio**](ConversationApi.md#insert_pbx_audio) | **POST** /conversation/pbx/audio | Insert pbx audio |
 | [**insert_pbx_menu**](ConversationApi.md#insert_pbx_menu) | **POST** /conversation/pbx/menu | Insert pbx menu |
 | [**insert_pbx_queue**](ConversationApi.md#insert_pbx_queue) | **POST** /conversation/pbx/queue | Insert pbx queue |
@@ -82,8 +87,11 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**listened_pbx_agent_voicemail**](ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail |
 | [**listened_pbx_queue_voicemail**](ConversationApi.md#listened_pbx_queue_voicemail) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}/listened | Listened Queue Voicemail |
 | [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read |
+| [**protect_pbx_phone_number**](ConversationApi.md#protect_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}/protect | Protect pbx phoneNumber from deletion |
+| [**purchase_pbx_phone_number**](ConversationApi.md#purchase_pbx_phone_number) | **POST** /conversation/pbx/phone_number | Purchase pbx phone number |
 | [**reset_conversation_pbx_queue_statistics**](ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue |
 | [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code |
+| [**search_pbx_available_phone_numbers**](ConversationApi.md#search_pbx_available_phone_numbers) | **GET** /conversation/pbx/phone_number/search | Search for available phone numbers |
 | [**sms_unsubscribe_conversation**](ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation |
 | [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation |
 | [**update_agent_profile**](ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile |
@@ -92,6 +100,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**update_conversation_department**](ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department |
 | [**update_conversation_engagement**](ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement |
 | [**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue |
+| [**update_pbx_address**](ConversationApi.md#update_pbx_address) | **PUT** /conversation/pbx/address/{conversationPbxAddressUuid} | Update pbx address |
 | [**update_pbx_agent**](ConversationApi.md#update_pbx_agent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent |
 | [**update_pbx_audio**](ConversationApi.md#update_pbx_audio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio |
 | [**update_pbx_menu**](ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu |
@@ -374,6 +383,59 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## delete_pbx_address
+
+> <ConversationPbxAddressResponse> delete_pbx_address(conversation_pbx_address_uuid)
+
+Delete pbx address
+
+Delete a pbx address 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the delete_pbx_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationPbxAddressResponse>, Integer, Hash)> delete_pbx_address_with_http_info(conversation_pbx_address_uuid)
+
+```ruby
+begin
+  # Delete pbx address
+  data, status_code, headers = api_instance.delete_pbx_address_with_http_info(conversation_pbx_address_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationPbxAddressResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->delete_pbx_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_pbx_address_uuid** | **String** |  |  |
+
+### Return type
+
+[**ConversationPbxAddressResponse**](ConversationPbxAddressResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## delete_pbx_agent_voicemail
 
 > delete_pbx_agent_voicemail(recording_sid)
@@ -536,6 +598,60 @@ end
 - **Accept**: application/json
 
 
+## delete_pbx_phone_number
+
+> delete_pbx_phone_number(conversation_pbx_phone_number_uuid)
+
+Delete pbx phoneNumber
+
+Delete a pbx phoneNumber. Only works if deletion_protected is false. 
+
+
+### Examples
+
+```ruby
+# Internal API.  No samples are provided as merchants will never need this api method
+```
+
+
+#### Using the delete_pbx_phone_number_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid)
+
+```ruby
+begin
+  # Delete pbx phoneNumber
+  data, status_code, headers = api_instance.delete_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->delete_pbx_phone_number_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_pbx_phone_number_uuid** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## delete_pbx_queue
 
 > <ConversationPbxQueueResponse> delete_pbx_queue(conversation_pbx_queue_uuid)
@@ -2192,6 +2308,110 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## get_pbx_address
+
+> <ConversationPbxAddressResponse> get_pbx_address(conversation_pbx_address_uuid)
+
+Get pbx address
+
+Retrieve a pbx address 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_pbx_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationPbxAddressResponse>, Integer, Hash)> get_pbx_address_with_http_info(conversation_pbx_address_uuid)
+
+```ruby
+begin
+  # Get pbx address
+  data, status_code, headers = api_instance.get_pbx_address_with_http_info(conversation_pbx_address_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationPbxAddressResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_pbx_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_pbx_address_uuid** | **String** |  |  |
+
+### Return type
+
+[**ConversationPbxAddressResponse**](ConversationPbxAddressResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_pbx_addresses
+
+> <ConversationPbxAddressesResponse> get_pbx_addresses
+
+Get pbx addresses
+
+Retrieve pbx addresses 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_pbx_addresses_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationPbxAddressesResponse>, Integer, Hash)> get_pbx_addresses_with_http_info
+
+```ruby
+begin
+  # Get pbx addresses
+  data, status_code, headers = api_instance.get_pbx_addresses_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationPbxAddressesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_pbx_addresses_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConversationPbxAddressesResponse**](ConversationPbxAddressesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_pbx_agent
 
 > <ConversationPbxAgentResponse> get_pbx_agent(conversation_pbx_agent_uuid)
@@ -3681,6 +3901,59 @@ end
 - **Accept**: application/json
 
 
+## insert_pbx_address
+
+> <ConversationPbxAddressResponse> insert_pbx_address(pbx_address)
+
+Insert pbx address
+
+Insert a pbx address 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the insert_pbx_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationPbxAddressResponse>, Integer, Hash)> insert_pbx_address_with_http_info(pbx_address)
+
+```ruby
+begin
+  # Insert pbx address
+  data, status_code, headers = api_instance.insert_pbx_address_with_http_info(pbx_address)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationPbxAddressResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->insert_pbx_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pbx_address** | [**ConversationPbxAddress**](ConversationPbxAddress.md) | Pbx Address |  |
+
+### Return type
+
+[**ConversationPbxAddressResponse**](ConversationPbxAddressResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## insert_pbx_audio
 
 > <ConversationPbxAudioResponse> insert_pbx_audio(pbx_audio)
@@ -4277,6 +4550,112 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## protect_pbx_phone_number
+
+> <ConversationPbxPhoneNumberResponse> protect_pbx_phone_number(conversation_pbx_phone_number_uuid)
+
+Protect pbx phoneNumber from deletion
+
+Protect a pbx phoneNumber from deletion. This is a one-way operation and cannot be undone through the API. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the protect_pbx_phone_number_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationPbxPhoneNumberResponse>, Integer, Hash)> protect_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid)
+
+```ruby
+begin
+  # Protect pbx phoneNumber from deletion
+  data, status_code, headers = api_instance.protect_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationPbxPhoneNumberResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->protect_pbx_phone_number_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_pbx_phone_number_uuid** | **String** |  |  |
+
+### Return type
+
+[**ConversationPbxPhoneNumberResponse**](ConversationPbxPhoneNumberResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## purchase_pbx_phone_number
+
+> <ConversationPbxPhoneNumberResponse> purchase_pbx_phone_number(phone_number_purchase_request)
+
+Purchase pbx phone number
+
+Purchase a phone number from Twilio. The phone_number must be from the available phone number search results. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the purchase_pbx_phone_number_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationPbxPhoneNumberResponse>, Integer, Hash)> purchase_pbx_phone_number_with_http_info(phone_number_purchase_request)
+
+```ruby
+begin
+  # Purchase pbx phone number
+  data, status_code, headers = api_instance.purchase_pbx_phone_number_with_http_info(phone_number_purchase_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationPbxPhoneNumberResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->purchase_pbx_phone_number_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number_purchase_request** | [**ConversationPbxPhoneNumberPurchaseRequest**](ConversationPbxPhoneNumberPurchaseRequest.md) | Phone number purchase request |  |
+
+### Return type
+
+[**ConversationPbxPhoneNumberResponse**](ConversationPbxPhoneNumberResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## reset_conversation_pbx_queue_statistics
 
 > reset_conversation_pbx_queue_statistics(queue_uuid)
@@ -4385,6 +4764,65 @@ end
 - **Accept**: application/json
 
 
+## search_pbx_available_phone_numbers
+
+> <ConversationPbxAvailablePhoneNumbersResponse> search_pbx_available_phone_numbers(country, opts)
+
+Search for available phone numbers
+
+Search for available phone numbers from Twilio that can be purchased 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the search_pbx_available_phone_numbers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationPbxAvailablePhoneNumbersResponse>, Integer, Hash)> search_pbx_available_phone_numbers_with_http_info(country, opts)
+
+```ruby
+begin
+  # Search for available phone numbers
+  data, status_code, headers = api_instance.search_pbx_available_phone_numbers_with_http_info(country, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationPbxAvailablePhoneNumbersResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->search_pbx_available_phone_numbers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **country** | **String** | ISO country code (e.g., US, CA, GB) |  |
+| **area_code** | **String** | Area code filter (e.g., 614) | [optional] |
+| **contains** | **String** | Pattern to match (e.g., 555, *PIZZA) | [optional] |
+| **sms_enabled** | **Boolean** | Filter for SMS capability | [optional] |
+| **voice_enabled** | **Boolean** | Filter for voice capability | [optional] |
+| **type** | **String** | Phone number type | [optional] |
+| **limit** | **Integer** | Max results (default 20, max 100) | [optional] |
+
+### Return type
+
+[**ConversationPbxAvailablePhoneNumbersResponse**](ConversationPbxAvailablePhoneNumbersResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## sms_unsubscribe_conversation
 
 > sms_unsubscribe_conversation(conversation_uuid)
@@ -4822,6 +5260,60 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## update_pbx_address
+
+> <ConversationPbxAddressResponse> update_pbx_address(conversation_pbx_address_uuid, pbx_address)
+
+Update pbx address
+
+Update a pbx address 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the update_pbx_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationPbxAddressResponse>, Integer, Hash)> update_pbx_address_with_http_info(conversation_pbx_address_uuid, pbx_address)
+
+```ruby
+begin
+  # Update pbx address
+  data, status_code, headers = api_instance.update_pbx_address_with_http_info(conversation_pbx_address_uuid, pbx_address)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationPbxAddressResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->update_pbx_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_pbx_address_uuid** | **String** |  |  |
+| **pbx_address** | [**ConversationPbxAddress**](ConversationPbxAddress.md) | Pbx Address |  |
+
+### Return type
+
+[**ConversationPbxAddressResponse**](ConversationPbxAddressResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## update_pbx_agent
 
 > <ConversationPbxAgentResponse> update_pbx_agent(conversation_pbx_agent_uuid, pbx_agent)

data/docs/ConversationPbxAddress.md

@@ -0,0 +1,40 @@
+# UltracartClient::ConversationPbxAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address_sid** | **String** | Twilio Address SID | [optional] |
+| **city** | **String** | City | [optional] |
+| **conversation_pbx_address_uuid** | **String** | Conversation Pbx Address UUID | [optional] |
+| **country_code** | **String** | ISO country code (2 characters) | [optional] |
+| **customer_name** | **String** | Customer name | [optional] |
+| **friendly_name** | **String** | Friendly name for the address | [optional] |
+| **merchant_id** | **String** | Merchant Id | [optional] |
+| **postal_code** | **String** | Postal code | [optional] |
+| **region** | **String** | State/Province/Region | [optional] |
+| **street** | **String** | Street address | [optional] |
+| **validated** | **Boolean** | Whether the address has been validated by Twilio | [optional] |
+| **verified** | **Boolean** | Whether the address has been verified by Twilio | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxAddress.new(
+  address_sid: null,
+  city: null,
+  conversation_pbx_address_uuid: null,
+  country_code: null,
+  customer_name: null,
+  friendly_name: null,
+  merchant_id: null,
+  postal_code: null,
+  region: null,
+  street: null,
+  validated: null,
+  verified: null
+)
+```
+

data/docs/ConversationPbxAddressResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationPbxAddressResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | [**ConversationPbxAddress**](ConversationPbxAddress.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::ConversationPbxAddressResponse.new(
+  address: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationPbxAddressesResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::ConversationPbxAddressesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **addresses** | [**Array<ConversationPbxAddress>**](ConversationPbxAddress.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxAddressesResponse.new(
+  addresses: null
+)
+```
+

data/docs/ConversationPbxAvailablePhoneNumber.md

@@ -0,0 +1,34 @@
+# UltracartClient::ConversationPbxAvailablePhoneNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address_requirements** | **String** | Address requirements | [optional] |
+| **country** | **String** | ISO country code | [optional] |
+| **friendly_name** | **String** | Friendly formatted phone number | [optional] |
+| **locality** | **String** | City/Locality | [optional] |
+| **mms** | **Boolean** | MMS capability | [optional] |
+| **phone_number** | **String** | Phone number in E.164 format | [optional] |
+| **region** | **String** | State/Province/Region | [optional] |
+| **sms** | **Boolean** | SMS capability | [optional] |
+| **voice** | **Boolean** | Voice capability | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationPbxAvailablePhoneNumber.new(
+  address_requirements: null,
+  country: null,
+  friendly_name: null,
+  locality: null,
+  mms: null,
+  phone_number: null,
+  region: null,
+  sms: null,
+  voice: null
+)
+```
+