ultracart_api 3.11.47 → 3.11.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9fc4a0df2aef3599e618c0a28ddbfb8dac9964e4975bc4c3f1c12557bea2b8e
-  data.tar.gz: 25f7bfc9e05c3a0b7ec0e6bbdfb34fde3c056f89a8c5a94fe786c80bc0fc95af
+  metadata.gz: 28cd14a424122cfd502ecde7c29ddb811011e4240f211e37d8383bb623adec07
+  data.tar.gz: 451a36daf111f8606e98afcd512499b594501e9b6ec56271030249d9e2847294
 SHA512:
-  metadata.gz: 3002fa2d069b03b91e20165add57a7fff21564381b4369945c5e5b739e6ac2d078de90599955d4ae43f427b64e615f4b3b0bb6e19159e0ffd00c73461e6ebc0e
-  data.tar.gz: f0fd241f7c4dcf972d298d0f9e44871e2e4a52022f4a277470b7ac79268d4de3fb82ac12418ec6a279d802c5e469cd01b62fa77493471c482ccbc99d3e49c25c
+  metadata.gz: '0034283ea5a55dad2e0a6430e30452addd2aba7546aadacd0734f4968c912b07bec8fa65a6b460002b139d0d98ccb79739f72b2551fadcab01ecfd2317ad9293'
+  data.tar.gz: f9e5eed10c957187e344c2d9a429417261b979ad373c7f7afcfbcdce0433c72ba18e8804ae55a8d0b7f40a00f97232117cea4a6cc2f0dec21073f476f78bf523

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.11.47
+- Package version: 3.11.48
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.11.47.gem
+gem install ./ultracart_api-3.11.48.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.11.47.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.11.48.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.11.47'
+    gem 'ultracart_api', '~> 3.11.48'
 
 ### Install from Git
 
@@ -141,6 +141,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**delete_pbx_address**](docs/ConversationApi.md#delete_pbx_address) | **DELETE** /conversation/pbx/address/{conversationPbxAddressUuid} | Delete pbx address
 *UltracartClient::ConversationApi* | [**delete_pbx_agent_voicemail**](docs/ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail
 *UltracartClient::ConversationApi* | [**delete_pbx_audio**](docs/ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
+*UltracartClient::ConversationApi* | [**delete_pbx_hardware_phone**](docs/ConversationApi.md#delete_pbx_hardware_phone) | **DELETE** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Delete pbx hardware phone
 *UltracartClient::ConversationApi* | [**delete_pbx_menu**](docs/ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
 *UltracartClient::ConversationApi* | [**delete_pbx_phone_number**](docs/ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
 *UltracartClient::ConversationApi* | [**delete_pbx_queue**](docs/ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue
@@ -183,6 +184,9 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_pbx_audio**](docs/ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
 *UltracartClient::ConversationApi* | [**get_pbx_audio_usage**](docs/ConversationApi.md#get_pbx_audio_usage) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid}/usage | Get pbx audio usage
 *UltracartClient::ConversationApi* | [**get_pbx_audios**](docs/ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
+*UltracartClient::ConversationApi* | [**get_pbx_hardware_phone**](docs/ConversationApi.md#get_pbx_hardware_phone) | **GET** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Get pbx hardware phone
+*UltracartClient::ConversationApi* | [**get_pbx_hardware_phone_manufacturers**](docs/ConversationApi.md#get_pbx_hardware_phone_manufacturers) | **GET** /conversation/pbx/hardware_phone/manufacturers | Get pbx hardware phone manufacturers
+*UltracartClient::ConversationApi* | [**get_pbx_hardware_phones**](docs/ConversationApi.md#get_pbx_hardware_phones) | **GET** /conversation/pbx/hardware_phone | Get pbx hardware phones
 *UltracartClient::ConversationApi* | [**get_pbx_menu**](docs/ConversationApi.md#get_pbx_menu) | **GET** /conversation/pbx/menu/{conversationPbxMenuUuid} | Get pbx menu
 *UltracartClient::ConversationApi* | [**get_pbx_menus**](docs/ConversationApi.md#get_pbx_menus) | **GET** /conversation/pbx/menu | Get pbx menus
 *UltracartClient::ConversationApi* | [**get_pbx_phone_number**](docs/ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber
@@ -206,6 +210,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
 *UltracartClient::ConversationApi* | [**insert_pbx_address**](docs/ConversationApi.md#insert_pbx_address) | **POST** /conversation/pbx/address | Insert pbx address
 *UltracartClient::ConversationApi* | [**insert_pbx_audio**](docs/ConversationApi.md#insert_pbx_audio) | **POST** /conversation/pbx/audio | Insert pbx audio
+*UltracartClient::ConversationApi* | [**insert_pbx_hardware_phone**](docs/ConversationApi.md#insert_pbx_hardware_phone) | **POST** /conversation/pbx/hardware_phone | Insert pbx hardware phone
 *UltracartClient::ConversationApi* | [**insert_pbx_menu**](docs/ConversationApi.md#insert_pbx_menu) | **POST** /conversation/pbx/menu | Insert pbx menu
 *UltracartClient::ConversationApi* | [**insert_pbx_queue**](docs/ConversationApi.md#insert_pbx_queue) | **POST** /conversation/pbx/queue | Insert pbx queue
 *UltracartClient::ConversationApi* | [**insert_pbx_time_based**](docs/ConversationApi.md#insert_pbx_time_based) | **POST** /conversation/pbx/time_based | Insert pbx timeBased
@@ -218,6 +223,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
 *UltracartClient::ConversationApi* | [**protect_pbx_phone_number**](docs/ConversationApi.md#protect_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}/protect | Protect pbx phoneNumber from deletion
 *UltracartClient::ConversationApi* | [**purchase_pbx_phone_number**](docs/ConversationApi.md#purchase_pbx_phone_number) | **POST** /conversation/pbx/phone_number | Purchase pbx phone number
+*UltracartClient::ConversationApi* | [**regenerate_password_for_pbx_hardware_phone**](docs/ConversationApi.md#regenerate_password_for_pbx_hardware_phone) | **POST** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid}/regenerate_password | Update pbx hardware phone
 *UltracartClient::ConversationApi* | [**reset_conversation_pbx_queue_statistics**](docs/ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue
 *UltracartClient::ConversationApi* | [**search_conversation_canned_messages**](docs/ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
 *UltracartClient::ConversationApi* | [**search_pbx_available_phone_numbers**](docs/ConversationApi.md#search_pbx_available_phone_numbers) | **GET** /conversation/pbx/phone_number/search | Search for available phone numbers
@@ -232,6 +238,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**update_pbx_address**](docs/ConversationApi.md#update_pbx_address) | **PUT** /conversation/pbx/address/{conversationPbxAddressUuid} | Update pbx address
 *UltracartClient::ConversationApi* | [**update_pbx_agent**](docs/ConversationApi.md#update_pbx_agent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent
 *UltracartClient::ConversationApi* | [**update_pbx_audio**](docs/ConversationApi.md#update_pbx_audio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio
+*UltracartClient::ConversationApi* | [**update_pbx_hardware_phone**](docs/ConversationApi.md#update_pbx_hardware_phone) | **PUT** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Update pbx hardware phone
 *UltracartClient::ConversationApi* | [**update_pbx_menu**](docs/ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu
 *UltracartClient::ConversationApi* | [**update_pbx_phone_number**](docs/ConversationApi.md#update_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Update pbx phoneNumber
 *UltracartClient::ConversationApi* | [**update_pbx_queue**](docs/ConversationApi.md#update_pbx_queue) | **PUT** /conversation/pbx/queue/{conversationPbxQueueUuid} | Update pbx queue
@@ -836,10 +843,16 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationPbxAvailablePhoneNumbersResponse](docs/ConversationPbxAvailablePhoneNumbersResponse.md)
  - [UltracartClient::ConversationPbxCustomerSnapshotRequest](docs/ConversationPbxCustomerSnapshotRequest.md)
  - [UltracartClient::ConversationPbxCustomerSnapshotResponse](docs/ConversationPbxCustomerSnapshotResponse.md)
+ - [UltracartClient::ConversationPbxHardwarePhone](docs/ConversationPbxHardwarePhone.md)
+ - [UltracartClient::ConversationPbxHardwarePhoneResponse](docs/ConversationPbxHardwarePhoneResponse.md)
+ - [UltracartClient::ConversationPbxHardwarePhonesResponse](docs/ConversationPbxHardwarePhonesResponse.md)
  - [UltracartClient::ConversationPbxMenu](docs/ConversationPbxMenu.md)
  - [UltracartClient::ConversationPbxMenuMapping](docs/ConversationPbxMenuMapping.md)
  - [UltracartClient::ConversationPbxMenuResponse](docs/ConversationPbxMenuResponse.md)
  - [UltracartClient::ConversationPbxMenusResponse](docs/ConversationPbxMenusResponse.md)
+ - [UltracartClient::ConversationPbxPhoneManufacturer](docs/ConversationPbxPhoneManufacturer.md)
+ - [UltracartClient::ConversationPbxPhoneManufacturersResponse](docs/ConversationPbxPhoneManufacturersResponse.md)
+ - [UltracartClient::ConversationPbxPhoneModel](docs/ConversationPbxPhoneModel.md)
  - [UltracartClient::ConversationPbxPhoneNumber](docs/ConversationPbxPhoneNumber.md)
  - [UltracartClient::ConversationPbxPhoneNumberPurchaseRequest](docs/ConversationPbxPhoneNumberPurchaseRequest.md)
  - [UltracartClient::ConversationPbxPhoneNumberResponse](docs/ConversationPbxPhoneNumberResponse.md)
@@ -1624,6 +1637,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.48 | 01/26/2026 | conversation - hardware phone methods and objects |
 | 3.11.47 | 01/26/2026 | conversation - agent auth object chat admin/user properties |
 | 3.11.46 | 01/26/2026 | cart - expose utm array for use in abandon webhook only |
 | 3.11.45 | 01/26/2026 | added multimedia file size to ItemContentMultimedia object |

data/docs/ConversationApi.md

@@ -12,6 +12,7 @@ Method | HTTP request | Description
 [**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_hardware_phone**](ConversationApi.md#delete_pbx_hardware_phone) | **DELETE** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Delete pbx hardware phone
 [**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
@@ -54,6 +55,9 @@ Method | HTTP request | Description
 [**get_pbx_audio**](ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
 [**get_pbx_audio_usage**](ConversationApi.md#get_pbx_audio_usage) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid}/usage | Get pbx audio usage
 [**get_pbx_audios**](ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
+[**get_pbx_hardware_phone**](ConversationApi.md#get_pbx_hardware_phone) | **GET** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Get pbx hardware phone
+[**get_pbx_hardware_phone_manufacturers**](ConversationApi.md#get_pbx_hardware_phone_manufacturers) | **GET** /conversation/pbx/hardware_phone/manufacturers | Get pbx hardware phone manufacturers
+[**get_pbx_hardware_phones**](ConversationApi.md#get_pbx_hardware_phones) | **GET** /conversation/pbx/hardware_phone | Get pbx hardware phones
 [**get_pbx_menu**](ConversationApi.md#get_pbx_menu) | **GET** /conversation/pbx/menu/{conversationPbxMenuUuid} | Get pbx menu
 [**get_pbx_menus**](ConversationApi.md#get_pbx_menus) | **GET** /conversation/pbx/menu | Get pbx menus
 [**get_pbx_phone_number**](ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber
@@ -77,6 +81,7 @@ Method | HTTP request | Description
 [**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_hardware_phone**](ConversationApi.md#insert_pbx_hardware_phone) | **POST** /conversation/pbx/hardware_phone | Insert pbx hardware phone
 [**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
 [**insert_pbx_time_based**](ConversationApi.md#insert_pbx_time_based) | **POST** /conversation/pbx/time_based | Insert pbx timeBased
@@ -89,6 +94,7 @@ Method | HTTP request | Description
 [**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
+[**regenerate_password_for_pbx_hardware_phone**](ConversationApi.md#regenerate_password_for_pbx_hardware_phone) | **POST** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid}/regenerate_password | Update pbx hardware phone
 [**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
@@ -103,6 +109,7 @@ Method | HTTP request | Description
 [**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_hardware_phone**](ConversationApi.md#update_pbx_hardware_phone) | **PUT** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Update pbx hardware phone
 [**update_pbx_menu**](ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu
 [**update_pbx_phone_number**](ConversationApi.md#update_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Update pbx phoneNumber
 [**update_pbx_queue**](ConversationApi.md#update_pbx_queue) | **PUT** /conversation/pbx/queue/{conversationPbxQueueUuid} | Update pbx queue
@@ -514,6 +521,56 @@ Name | Type | Description  | Notes
 
 
 
+# **delete_pbx_hardware_phone**
+> ConversationPbxHardwarePhoneResponse delete_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid)
+
+Delete pbx hardware phone
+
+Delete a pbx hardware phone 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+conversation_pbx_hardware_phone_uuid = 'conversation_pbx_hardware_phone_uuid_example' # String | 
+
+
+begin
+  #Delete pbx hardware phone
+  result = api_instance.delete_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->delete_pbx_hardware_phone: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_pbx_hardware_phone_uuid** | **String**|  | 
+
+### Return type
+
+[**ConversationPbxHardwarePhoneResponse**](ConversationPbxHardwarePhoneResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **delete_pbx_menu**
 > ConversationPbxMenuResponse delete_pbx_menu(conversation_pbx_menu_uuid)
 
@@ -2566,6 +2623,146 @@ This endpoint does not need any parameter.
 
 
 
+# **get_pbx_hardware_phone**
+> ConversationPbxHardwarePhoneResponse get_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid)
+
+Get pbx hardware phone
+
+Retrieve a pbx hardware phone 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+conversation_pbx_hardware_phone_uuid = 'conversation_pbx_hardware_phone_uuid_example' # String | 
+
+
+begin
+  #Get pbx hardware phone
+  result = api_instance.get_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_pbx_hardware_phone: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_pbx_hardware_phone_uuid** | **String**|  | 
+
+### Return type
+
+[**ConversationPbxHardwarePhoneResponse**](ConversationPbxHardwarePhoneResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_pbx_hardware_phone_manufacturers**
+> ConversationPbxPhoneManufacturersResponse get_pbx_hardware_phone_manufacturers
+
+Get pbx hardware phone manufacturers
+
+Retrieve pbx hardware phone manufacturers and models for auto-provisioning 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Get pbx hardware phone manufacturers
+  result = api_instance.get_pbx_hardware_phone_manufacturers
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_pbx_hardware_phone_manufacturers: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConversationPbxPhoneManufacturersResponse**](ConversationPbxPhoneManufacturersResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_pbx_hardware_phones**
+> ConversationPbxHardwarePhonesResponse get_pbx_hardware_phones
+
+Get pbx hardware phones
+
+Retrieve pbx hardware phones 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Get pbx hardware phones
+  result = api_instance.get_pbx_hardware_phones
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_pbx_hardware_phones: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConversationPbxHardwarePhonesResponse**](ConversationPbxHardwarePhonesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_pbx_menu**
 > ConversationPbxMenuResponse get_pbx_menu(conversation_pbx_menu_uuid)
 
@@ -3685,6 +3882,56 @@ Name | Type | Description  | Notes
 
 
 
+# **insert_pbx_hardware_phone**
+> ConversationPbxHardwarePhoneResponse insert_pbx_hardware_phone(pbx_hardware_phone)
+
+Insert pbx hardware phone
+
+Insert a pbx hardware phone 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+pbx_hardware_phone = UltracartClient::ConversationPbxHardwarePhone.new # ConversationPbxHardwarePhone | Pbx Hardware Phone
+
+
+begin
+  #Insert pbx hardware phone
+  result = api_instance.insert_pbx_hardware_phone(pbx_hardware_phone)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->insert_pbx_hardware_phone: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pbx_hardware_phone** | [**ConversationPbxHardwarePhone**](ConversationPbxHardwarePhone.md)| Pbx Hardware Phone | 
+
+### Return type
+
+[**ConversationPbxHardwarePhoneResponse**](ConversationPbxHardwarePhoneResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **insert_pbx_menu**
 > ConversationPbxMenuResponse insert_pbx_menu(pbx_menu)
 
@@ -4287,6 +4534,59 @@ Name | Type | Description  | Notes
 
 
 
+# **regenerate_password_for_pbx_hardware_phone**
+> ConversationPbxHardwarePhoneResponse regenerate_password_for_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid, pbx_hardware_phone)
+
+Update pbx hardware phone
+
+Update a pbx hardware phone 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+conversation_pbx_hardware_phone_uuid = 'conversation_pbx_hardware_phone_uuid_example' # String | 
+
+pbx_hardware_phone = UltracartClient::ConversationPbxHardwarePhone.new # ConversationPbxHardwarePhone | Pbx Hardware Phone
+
+
+begin
+  #Update pbx hardware phone
+  result = api_instance.regenerate_password_for_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid, pbx_hardware_phone)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->regenerate_password_for_pbx_hardware_phone: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_pbx_hardware_phone_uuid** | **String**|  | 
+ **pbx_hardware_phone** | [**ConversationPbxHardwarePhone**](ConversationPbxHardwarePhone.md)| Pbx Hardware Phone | 
+
+### Return type
+
+[**ConversationPbxHardwarePhoneResponse**](ConversationPbxHardwarePhoneResponse.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)
 
@@ -5025,6 +5325,59 @@ Name | Type | Description  | Notes
 
 
 
+# **update_pbx_hardware_phone**
+> ConversationPbxHardwarePhoneResponse update_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid, pbx_hardware_phone)
+
+Update pbx hardware phone
+
+Update a pbx hardware phone 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+conversation_pbx_hardware_phone_uuid = 'conversation_pbx_hardware_phone_uuid_example' # String | 
+
+pbx_hardware_phone = UltracartClient::ConversationPbxHardwarePhone.new # ConversationPbxHardwarePhone | Pbx Hardware Phone
+
+
+begin
+  #Update pbx hardware phone
+  result = api_instance.update_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid, pbx_hardware_phone)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->update_pbx_hardware_phone: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_pbx_hardware_phone_uuid** | **String**|  | 
+ **pbx_hardware_phone** | [**ConversationPbxHardwarePhone**](ConversationPbxHardwarePhone.md)| Pbx Hardware Phone | 
+
+### Return type
+
+[**ConversationPbxHardwarePhoneResponse**](ConversationPbxHardwarePhoneResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **update_pbx_menu**
 > ConversationPbxMenuResponse update_pbx_menu(conversation_pbx_menu_uuid, pbx_menu)
 

data/docs/ConversationPbxHardwarePhone.md

@@ -0,0 +1,20 @@
+# UltracartClient::ConversationPbxHardwarePhone
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation_pbx_hardware_phone_uuid** | **String** | Conversation Pbx Hardware Phone UUID | [optional] 
+**created_at** | **Object** | Created At | [optional] 
+**description** | **String** | Description | [optional] 
+**mac_address** | **String** | MAC Address | [optional] 
+**manufacturer** | **String** | Manufacturer | [optional] 
+**merchant_id** | **String** | Merchant Id | [optional] 
+**model** | **String** | Model | [optional] 
+**name** | **String** | Name | [optional] 
+**provisioning_url** | **String** | Auto-provisioning URL for phone configuration | [optional] 
+**sip_domain** | **String** | SIP Domain | [optional] 
+**sip_password** | **String** | SIP Password | [optional] 
+**sip_username** | **String** | SIP Username | [optional] 
+**updated_at** | **Object** | Updated At | [optional] 
+
+

data/docs/ConversationPbxHardwarePhoneResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ConversationPbxHardwarePhoneResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**hardware_phone** | [**ConversationPbxHardwarePhone**](ConversationPbxHardwarePhone.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/ConversationPbxHardwarePhonesResponse.md

@@ -0,0 +1,8 @@
+# UltracartClient::ConversationPbxHardwarePhonesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hardware_phones** | [**Array<ConversationPbxHardwarePhone>**](ConversationPbxHardwarePhone.md) |  | [optional] 
+
+

data/docs/ConversationPbxPhoneManufacturer.md

@@ -0,0 +1,10 @@
+# UltracartClient::ConversationPbxPhoneManufacturer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**manufacturer_id** | **String** |  | [optional] 
+**models** | [**Array<ConversationPbxPhoneModel>**](ConversationPbxPhoneModel.md) |  | [optional] 
+**name** | **String** |  | [optional] 
+
+

data/docs/ConversationPbxPhoneManufacturersResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ConversationPbxPhoneManufacturersResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**manufacturers** | [**Array<ConversationPbxPhoneManufacturer>**](ConversationPbxPhoneManufacturer.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/ConversationPbxPhoneModel.md

@@ -0,0 +1,9 @@
+# UltracartClient::ConversationPbxPhoneModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**model_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+