ultracart_api 4.1.47 → 4.1.48

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 58c5b4d2e08b51c41f430f528888f01495bd7c058a7eb05b8223b767dfdf0cc3
4
- data.tar.gz: 2afc1f4c59ecb12e6d2a73a9bf591232d53472caef883cb827e6c3c37c8383f9
3
+ metadata.gz: 1e65e886beac8d2f14995fa45a138303c3d7522795eccde67368ad5a470d5f34
4
+ data.tar.gz: 3a1a3ddf7f2ef32f707d5b20264cea2879511cc776e2fc7f5ba0d459ae36e918
5
5
  SHA512:
6
- metadata.gz: 971b479b4c7efa1139a10bcbbd966f488bf494d7474e58c2a44beb57af033e2d508ea028cfed8f7ef3692e6aa03be73f44cf9451080dc5d7133601491f5f853e
7
- data.tar.gz: 427fb76cbdfa7b78afc18dc5de103c53d4020996063d019b241c18fcf309db21c9fa4c6654ca54c1d6a8ec56b77887597d5a558379e267559cfceb342c1f0da5
6
+ metadata.gz: 4936fefe0779949411837395eab546ef64a39be126c9b4e4ab176e2ca84eee1c37c525873274e51f7862a70b7dbcd8c6636b1714020591cee15e5fd9880f9374
7
+ data.tar.gz: 34679f608aa7674a4b16d43f9f027d651cc06bab32a1621d79eda5fd4f68fcac2c7ec08e922a7cc679a2b414f2685812f95b09f3af3bbe8b3310b128d6692395
data/README.md CHANGED
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 4.1.47
10
+ - Package version: 4.1.48
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
13
13
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
16
16
  gemfile:
17
17
 
18
18
  ```shell
19
- gem 'ultracart_api', '4.1.47'
19
+ gem 'ultracart_api', '4.1.48'
20
20
  ```
21
21
 
22
22
  install:
@@ -137,6 +137,7 @@ Class | Method | HTTP request | Description
137
137
  *UltracartClient::ConversationApi* | [**delete_pbx_address**](docs/ConversationApi.md#delete_pbx_address) | **DELETE** /conversation/pbx/address/{conversationPbxAddressUuid} | Delete pbx address
138
138
  *UltracartClient::ConversationApi* | [**delete_pbx_agent_voicemail**](docs/ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail
139
139
  *UltracartClient::ConversationApi* | [**delete_pbx_audio**](docs/ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
140
+ *UltracartClient::ConversationApi* | [**delete_pbx_hardware_phone**](docs/ConversationApi.md#delete_pbx_hardware_phone) | **DELETE** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Delete pbx hardware phone
140
141
  *UltracartClient::ConversationApi* | [**delete_pbx_menu**](docs/ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
141
142
  *UltracartClient::ConversationApi* | [**delete_pbx_phone_number**](docs/ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
142
143
  *UltracartClient::ConversationApi* | [**delete_pbx_queue**](docs/ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue
@@ -179,6 +180,9 @@ Class | Method | HTTP request | Description
179
180
  *UltracartClient::ConversationApi* | [**get_pbx_audio**](docs/ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
180
181
  *UltracartClient::ConversationApi* | [**get_pbx_audio_usage**](docs/ConversationApi.md#get_pbx_audio_usage) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid}/usage | Get pbx audio usage
181
182
  *UltracartClient::ConversationApi* | [**get_pbx_audios**](docs/ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
183
+ *UltracartClient::ConversationApi* | [**get_pbx_hardware_phone**](docs/ConversationApi.md#get_pbx_hardware_phone) | **GET** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Get pbx hardware phone
184
+ *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
185
+ *UltracartClient::ConversationApi* | [**get_pbx_hardware_phones**](docs/ConversationApi.md#get_pbx_hardware_phones) | **GET** /conversation/pbx/hardware_phone | Get pbx hardware phones
182
186
  *UltracartClient::ConversationApi* | [**get_pbx_menu**](docs/ConversationApi.md#get_pbx_menu) | **GET** /conversation/pbx/menu/{conversationPbxMenuUuid} | Get pbx menu
183
187
  *UltracartClient::ConversationApi* | [**get_pbx_menus**](docs/ConversationApi.md#get_pbx_menus) | **GET** /conversation/pbx/menu | Get pbx menus
184
188
  *UltracartClient::ConversationApi* | [**get_pbx_phone_number**](docs/ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber
@@ -202,6 +206,7 @@ Class | Method | HTTP request | Description
202
206
  *UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
203
207
  *UltracartClient::ConversationApi* | [**insert_pbx_address**](docs/ConversationApi.md#insert_pbx_address) | **POST** /conversation/pbx/address | Insert pbx address
204
208
  *UltracartClient::ConversationApi* | [**insert_pbx_audio**](docs/ConversationApi.md#insert_pbx_audio) | **POST** /conversation/pbx/audio | Insert pbx audio
209
+ *UltracartClient::ConversationApi* | [**insert_pbx_hardware_phone**](docs/ConversationApi.md#insert_pbx_hardware_phone) | **POST** /conversation/pbx/hardware_phone | Insert pbx hardware phone
205
210
  *UltracartClient::ConversationApi* | [**insert_pbx_menu**](docs/ConversationApi.md#insert_pbx_menu) | **POST** /conversation/pbx/menu | Insert pbx menu
206
211
  *UltracartClient::ConversationApi* | [**insert_pbx_queue**](docs/ConversationApi.md#insert_pbx_queue) | **POST** /conversation/pbx/queue | Insert pbx queue
207
212
  *UltracartClient::ConversationApi* | [**insert_pbx_time_based**](docs/ConversationApi.md#insert_pbx_time_based) | **POST** /conversation/pbx/time_based | Insert pbx timeBased
@@ -214,6 +219,7 @@ Class | Method | HTTP request | Description
214
219
  *UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
215
220
  *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
216
221
  *UltracartClient::ConversationApi* | [**purchase_pbx_phone_number**](docs/ConversationApi.md#purchase_pbx_phone_number) | **POST** /conversation/pbx/phone_number | Purchase pbx phone number
222
+ *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
217
223
  *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
218
224
  *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
219
225
  *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
@@ -228,6 +234,7 @@ Class | Method | HTTP request | Description
228
234
  *UltracartClient::ConversationApi* | [**update_pbx_address**](docs/ConversationApi.md#update_pbx_address) | **PUT** /conversation/pbx/address/{conversationPbxAddressUuid} | Update pbx address
229
235
  *UltracartClient::ConversationApi* | [**update_pbx_agent**](docs/ConversationApi.md#update_pbx_agent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent
230
236
  *UltracartClient::ConversationApi* | [**update_pbx_audio**](docs/ConversationApi.md#update_pbx_audio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio
237
+ *UltracartClient::ConversationApi* | [**update_pbx_hardware_phone**](docs/ConversationApi.md#update_pbx_hardware_phone) | **PUT** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Update pbx hardware phone
231
238
  *UltracartClient::ConversationApi* | [**update_pbx_menu**](docs/ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu
232
239
  *UltracartClient::ConversationApi* | [**update_pbx_phone_number**](docs/ConversationApi.md#update_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Update pbx phoneNumber
233
240
  *UltracartClient::ConversationApi* | [**update_pbx_queue**](docs/ConversationApi.md#update_pbx_queue) | **PUT** /conversation/pbx/queue/{conversationPbxQueueUuid} | Update pbx queue
@@ -831,10 +838,16 @@ Class | Method | HTTP request | Description
831
838
  - [UltracartClient::ConversationPbxAvailablePhoneNumbersResponse](docs/ConversationPbxAvailablePhoneNumbersResponse.md)
832
839
  - [UltracartClient::ConversationPbxCustomerSnapshotRequest](docs/ConversationPbxCustomerSnapshotRequest.md)
833
840
  - [UltracartClient::ConversationPbxCustomerSnapshotResponse](docs/ConversationPbxCustomerSnapshotResponse.md)
841
+ - [UltracartClient::ConversationPbxHardwarePhone](docs/ConversationPbxHardwarePhone.md)
842
+ - [UltracartClient::ConversationPbxHardwarePhoneResponse](docs/ConversationPbxHardwarePhoneResponse.md)
843
+ - [UltracartClient::ConversationPbxHardwarePhonesResponse](docs/ConversationPbxHardwarePhonesResponse.md)
834
844
  - [UltracartClient::ConversationPbxMenu](docs/ConversationPbxMenu.md)
835
845
  - [UltracartClient::ConversationPbxMenuMapping](docs/ConversationPbxMenuMapping.md)
836
846
  - [UltracartClient::ConversationPbxMenuResponse](docs/ConversationPbxMenuResponse.md)
837
847
  - [UltracartClient::ConversationPbxMenusResponse](docs/ConversationPbxMenusResponse.md)
848
+ - [UltracartClient::ConversationPbxPhoneManufacturer](docs/ConversationPbxPhoneManufacturer.md)
849
+ - [UltracartClient::ConversationPbxPhoneManufacturersResponse](docs/ConversationPbxPhoneManufacturersResponse.md)
850
+ - [UltracartClient::ConversationPbxPhoneModel](docs/ConversationPbxPhoneModel.md)
838
851
  - [UltracartClient::ConversationPbxPhoneNumber](docs/ConversationPbxPhoneNumber.md)
839
852
  - [UltracartClient::ConversationPbxPhoneNumberPurchaseRequest](docs/ConversationPbxPhoneNumberPurchaseRequest.md)
840
853
  - [UltracartClient::ConversationPbxPhoneNumberResponse](docs/ConversationPbxPhoneNumberResponse.md)
@@ -1622,6 +1635,7 @@ Not every change is committed to every SDK.
1622
1635
 
1623
1636
  | Version | Date | Comments |
1624
1637
  | --: | :-: | --- |
1638
+ | 4.1.48 | 01/26/2026 | conversation - hardware phone methods and objects |
1625
1639
  | 4.1.47 | 01/26/2026 | conversation - agent auth object chat admin/user properties |
1626
1640
  | 4.1.46 | 01/26/2026 | cart - expose utm array for use in abandon webhook only |
1627
1641
  | 4.1.45 | 01/26/2026 | added multimedia file size to ItemContentMultimedia object |
@@ -12,6 +12,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
12
12
  | [**delete_pbx_address**](ConversationApi.md#delete_pbx_address) | **DELETE** /conversation/pbx/address/{conversationPbxAddressUuid} | Delete pbx address |
13
13
  | [**delete_pbx_agent_voicemail**](ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail |
14
14
  | [**delete_pbx_audio**](ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio |
15
+ | [**delete_pbx_hardware_phone**](ConversationApi.md#delete_pbx_hardware_phone) | **DELETE** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Delete pbx hardware phone |
15
16
  | [**delete_pbx_menu**](ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu |
16
17
  | [**delete_pbx_phone_number**](ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber |
17
18
  | [**delete_pbx_queue**](ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue |
@@ -54,6 +55,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
54
55
  | [**get_pbx_audio**](ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio |
55
56
  | [**get_pbx_audio_usage**](ConversationApi.md#get_pbx_audio_usage) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid}/usage | Get pbx audio usage |
56
57
  | [**get_pbx_audios**](ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios |
58
+ | [**get_pbx_hardware_phone**](ConversationApi.md#get_pbx_hardware_phone) | **GET** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Get pbx hardware phone |
59
+ | [**get_pbx_hardware_phone_manufacturers**](ConversationApi.md#get_pbx_hardware_phone_manufacturers) | **GET** /conversation/pbx/hardware_phone/manufacturers | Get pbx hardware phone manufacturers |
60
+ | [**get_pbx_hardware_phones**](ConversationApi.md#get_pbx_hardware_phones) | **GET** /conversation/pbx/hardware_phone | Get pbx hardware phones |
57
61
  | [**get_pbx_menu**](ConversationApi.md#get_pbx_menu) | **GET** /conversation/pbx/menu/{conversationPbxMenuUuid} | Get pbx menu |
58
62
  | [**get_pbx_menus**](ConversationApi.md#get_pbx_menus) | **GET** /conversation/pbx/menu | Get pbx menus |
59
63
  | [**get_pbx_phone_number**](ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber |
@@ -77,6 +81,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
77
81
  | [**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement |
78
82
  | [**insert_pbx_address**](ConversationApi.md#insert_pbx_address) | **POST** /conversation/pbx/address | Insert pbx address |
79
83
  | [**insert_pbx_audio**](ConversationApi.md#insert_pbx_audio) | **POST** /conversation/pbx/audio | Insert pbx audio |
84
+ | [**insert_pbx_hardware_phone**](ConversationApi.md#insert_pbx_hardware_phone) | **POST** /conversation/pbx/hardware_phone | Insert pbx hardware phone |
80
85
  | [**insert_pbx_menu**](ConversationApi.md#insert_pbx_menu) | **POST** /conversation/pbx/menu | Insert pbx menu |
81
86
  | [**insert_pbx_queue**](ConversationApi.md#insert_pbx_queue) | **POST** /conversation/pbx/queue | Insert pbx queue |
82
87
  | [**insert_pbx_time_based**](ConversationApi.md#insert_pbx_time_based) | **POST** /conversation/pbx/time_based | Insert pbx timeBased |
@@ -89,6 +94,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
89
94
  | [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read |
90
95
  | [**protect_pbx_phone_number**](ConversationApi.md#protect_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}/protect | Protect pbx phoneNumber from deletion |
91
96
  | [**purchase_pbx_phone_number**](ConversationApi.md#purchase_pbx_phone_number) | **POST** /conversation/pbx/phone_number | Purchase pbx phone number |
97
+ | [**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 |
92
98
  | [**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 |
93
99
  | [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code |
94
100
  | [**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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
103
109
  | [**update_pbx_address**](ConversationApi.md#update_pbx_address) | **PUT** /conversation/pbx/address/{conversationPbxAddressUuid} | Update pbx address |
104
110
  | [**update_pbx_agent**](ConversationApi.md#update_pbx_agent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent |
105
111
  | [**update_pbx_audio**](ConversationApi.md#update_pbx_audio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio |
112
+ | [**update_pbx_hardware_phone**](ConversationApi.md#update_pbx_hardware_phone) | **PUT** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Update pbx hardware phone |
106
113
  | [**update_pbx_menu**](ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu |
107
114
  | [**update_pbx_phone_number**](ConversationApi.md#update_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Update pbx phoneNumber |
108
115
  | [**update_pbx_queue**](ConversationApi.md#update_pbx_queue) | **PUT** /conversation/pbx/queue/{conversationPbxQueueUuid} | Update pbx queue |
@@ -544,6 +551,59 @@ end
544
551
  - **Accept**: application/json
545
552
 
546
553
 
554
+ ## delete_pbx_hardware_phone
555
+
556
+ > <ConversationPbxHardwarePhoneResponse> delete_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid)
557
+
558
+ Delete pbx hardware phone
559
+
560
+ Delete a pbx hardware phone
561
+
562
+
563
+ ### Examples
564
+
565
+
566
+ (No example for this operation).
567
+
568
+
569
+ #### Using the delete_pbx_hardware_phone_with_http_info variant
570
+
571
+ This returns an Array which contains the response data, status code and headers.
572
+
573
+ > <Array(<ConversationPbxHardwarePhoneResponse>, Integer, Hash)> delete_pbx_hardware_phone_with_http_info(conversation_pbx_hardware_phone_uuid)
574
+
575
+ ```ruby
576
+ begin
577
+ # Delete pbx hardware phone
578
+ data, status_code, headers = api_instance.delete_pbx_hardware_phone_with_http_info(conversation_pbx_hardware_phone_uuid)
579
+ p status_code # => 2xx
580
+ p headers # => { ... }
581
+ p data # => <ConversationPbxHardwarePhoneResponse>
582
+ rescue UltracartClient::ApiError => e
583
+ puts "Error when calling ConversationApi->delete_pbx_hardware_phone_with_http_info: #{e}"
584
+ end
585
+ ```
586
+
587
+ ### Parameters
588
+
589
+ | Name | Type | Description | Notes |
590
+ | ---- | ---- | ----------- | ----- |
591
+ | **conversation_pbx_hardware_phone_uuid** | **String** | | |
592
+
593
+ ### Return type
594
+
595
+ [**ConversationPbxHardwarePhoneResponse**](ConversationPbxHardwarePhoneResponse.md)
596
+
597
+ ### Authorization
598
+
599
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
600
+
601
+ ### HTTP request headers
602
+
603
+ - **Content-Type**: Not defined
604
+ - **Accept**: application/json
605
+
606
+
547
607
  ## delete_pbx_menu
548
608
 
549
609
  > <ConversationPbxMenuResponse> delete_pbx_menu(conversation_pbx_menu_uuid)
@@ -2784,6 +2844,161 @@ This endpoint does not need any parameter.
2784
2844
  - **Accept**: application/json
2785
2845
 
2786
2846
 
2847
+ ## get_pbx_hardware_phone
2848
+
2849
+ > <ConversationPbxHardwarePhoneResponse> get_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid)
2850
+
2851
+ Get pbx hardware phone
2852
+
2853
+ Retrieve a pbx hardware phone
2854
+
2855
+
2856
+ ### Examples
2857
+
2858
+
2859
+ (No example for this operation).
2860
+
2861
+
2862
+ #### Using the get_pbx_hardware_phone_with_http_info variant
2863
+
2864
+ This returns an Array which contains the response data, status code and headers.
2865
+
2866
+ > <Array(<ConversationPbxHardwarePhoneResponse>, Integer, Hash)> get_pbx_hardware_phone_with_http_info(conversation_pbx_hardware_phone_uuid)
2867
+
2868
+ ```ruby
2869
+ begin
2870
+ # Get pbx hardware phone
2871
+ data, status_code, headers = api_instance.get_pbx_hardware_phone_with_http_info(conversation_pbx_hardware_phone_uuid)
2872
+ p status_code # => 2xx
2873
+ p headers # => { ... }
2874
+ p data # => <ConversationPbxHardwarePhoneResponse>
2875
+ rescue UltracartClient::ApiError => e
2876
+ puts "Error when calling ConversationApi->get_pbx_hardware_phone_with_http_info: #{e}"
2877
+ end
2878
+ ```
2879
+
2880
+ ### Parameters
2881
+
2882
+ | Name | Type | Description | Notes |
2883
+ | ---- | ---- | ----------- | ----- |
2884
+ | **conversation_pbx_hardware_phone_uuid** | **String** | | |
2885
+
2886
+ ### Return type
2887
+
2888
+ [**ConversationPbxHardwarePhoneResponse**](ConversationPbxHardwarePhoneResponse.md)
2889
+
2890
+ ### Authorization
2891
+
2892
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2893
+
2894
+ ### HTTP request headers
2895
+
2896
+ - **Content-Type**: Not defined
2897
+ - **Accept**: application/json
2898
+
2899
+
2900
+ ## get_pbx_hardware_phone_manufacturers
2901
+
2902
+ > <ConversationPbxPhoneManufacturersResponse> get_pbx_hardware_phone_manufacturers
2903
+
2904
+ Get pbx hardware phone manufacturers
2905
+
2906
+ Retrieve pbx hardware phone manufacturers and models for auto-provisioning
2907
+
2908
+
2909
+ ### Examples
2910
+
2911
+
2912
+ (No example for this operation).
2913
+
2914
+
2915
+ #### Using the get_pbx_hardware_phone_manufacturers_with_http_info variant
2916
+
2917
+ This returns an Array which contains the response data, status code and headers.
2918
+
2919
+ > <Array(<ConversationPbxPhoneManufacturersResponse>, Integer, Hash)> get_pbx_hardware_phone_manufacturers_with_http_info
2920
+
2921
+ ```ruby
2922
+ begin
2923
+ # Get pbx hardware phone manufacturers
2924
+ data, status_code, headers = api_instance.get_pbx_hardware_phone_manufacturers_with_http_info
2925
+ p status_code # => 2xx
2926
+ p headers # => { ... }
2927
+ p data # => <ConversationPbxPhoneManufacturersResponse>
2928
+ rescue UltracartClient::ApiError => e
2929
+ puts "Error when calling ConversationApi->get_pbx_hardware_phone_manufacturers_with_http_info: #{e}"
2930
+ end
2931
+ ```
2932
+
2933
+ ### Parameters
2934
+
2935
+ This endpoint does not need any parameter.
2936
+
2937
+ ### Return type
2938
+
2939
+ [**ConversationPbxPhoneManufacturersResponse**](ConversationPbxPhoneManufacturersResponse.md)
2940
+
2941
+ ### Authorization
2942
+
2943
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2944
+
2945
+ ### HTTP request headers
2946
+
2947
+ - **Content-Type**: Not defined
2948
+ - **Accept**: application/json
2949
+
2950
+
2951
+ ## get_pbx_hardware_phones
2952
+
2953
+ > <ConversationPbxHardwarePhonesResponse> get_pbx_hardware_phones
2954
+
2955
+ Get pbx hardware phones
2956
+
2957
+ Retrieve pbx hardware phones
2958
+
2959
+
2960
+ ### Examples
2961
+
2962
+
2963
+ (No example for this operation).
2964
+
2965
+
2966
+ #### Using the get_pbx_hardware_phones_with_http_info variant
2967
+
2968
+ This returns an Array which contains the response data, status code and headers.
2969
+
2970
+ > <Array(<ConversationPbxHardwarePhonesResponse>, Integer, Hash)> get_pbx_hardware_phones_with_http_info
2971
+
2972
+ ```ruby
2973
+ begin
2974
+ # Get pbx hardware phones
2975
+ data, status_code, headers = api_instance.get_pbx_hardware_phones_with_http_info
2976
+ p status_code # => 2xx
2977
+ p headers # => { ... }
2978
+ p data # => <ConversationPbxHardwarePhonesResponse>
2979
+ rescue UltracartClient::ApiError => e
2980
+ puts "Error when calling ConversationApi->get_pbx_hardware_phones_with_http_info: #{e}"
2981
+ end
2982
+ ```
2983
+
2984
+ ### Parameters
2985
+
2986
+ This endpoint does not need any parameter.
2987
+
2988
+ ### Return type
2989
+
2990
+ [**ConversationPbxHardwarePhonesResponse**](ConversationPbxHardwarePhonesResponse.md)
2991
+
2992
+ ### Authorization
2993
+
2994
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2995
+
2996
+ ### HTTP request headers
2997
+
2998
+ - **Content-Type**: Not defined
2999
+ - **Accept**: application/json
3000
+
3001
+
2787
3002
  ## get_pbx_menu
2788
3003
 
2789
3004
  > <ConversationPbxMenuResponse> get_pbx_menu(conversation_pbx_menu_uuid)
@@ -4008,6 +4223,59 @@ end
4008
4223
  - **Accept**: application/json
4009
4224
 
4010
4225
 
4226
+ ## insert_pbx_hardware_phone
4227
+
4228
+ > <ConversationPbxHardwarePhoneResponse> insert_pbx_hardware_phone(pbx_hardware_phone)
4229
+
4230
+ Insert pbx hardware phone
4231
+
4232
+ Insert a pbx hardware phone
4233
+
4234
+
4235
+ ### Examples
4236
+
4237
+
4238
+ (No example for this operation).
4239
+
4240
+
4241
+ #### Using the insert_pbx_hardware_phone_with_http_info variant
4242
+
4243
+ This returns an Array which contains the response data, status code and headers.
4244
+
4245
+ > <Array(<ConversationPbxHardwarePhoneResponse>, Integer, Hash)> insert_pbx_hardware_phone_with_http_info(pbx_hardware_phone)
4246
+
4247
+ ```ruby
4248
+ begin
4249
+ # Insert pbx hardware phone
4250
+ data, status_code, headers = api_instance.insert_pbx_hardware_phone_with_http_info(pbx_hardware_phone)
4251
+ p status_code # => 2xx
4252
+ p headers # => { ... }
4253
+ p data # => <ConversationPbxHardwarePhoneResponse>
4254
+ rescue UltracartClient::ApiError => e
4255
+ puts "Error when calling ConversationApi->insert_pbx_hardware_phone_with_http_info: #{e}"
4256
+ end
4257
+ ```
4258
+
4259
+ ### Parameters
4260
+
4261
+ | Name | Type | Description | Notes |
4262
+ | ---- | ---- | ----------- | ----- |
4263
+ | **pbx_hardware_phone** | [**ConversationPbxHardwarePhone**](ConversationPbxHardwarePhone.md) | Pbx Hardware Phone | |
4264
+
4265
+ ### Return type
4266
+
4267
+ [**ConversationPbxHardwarePhoneResponse**](ConversationPbxHardwarePhoneResponse.md)
4268
+
4269
+ ### Authorization
4270
+
4271
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4272
+
4273
+ ### HTTP request headers
4274
+
4275
+ - **Content-Type**: application/json
4276
+ - **Accept**: application/json
4277
+
4278
+
4011
4279
  ## insert_pbx_menu
4012
4280
 
4013
4281
  > <ConversationPbxMenuResponse> insert_pbx_menu(pbx_menu)
@@ -4656,6 +4924,60 @@ end
4656
4924
  - **Accept**: application/json
4657
4925
 
4658
4926
 
4927
+ ## regenerate_password_for_pbx_hardware_phone
4928
+
4929
+ > <ConversationPbxHardwarePhoneResponse> regenerate_password_for_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid, pbx_hardware_phone)
4930
+
4931
+ Update pbx hardware phone
4932
+
4933
+ Update a pbx hardware phone
4934
+
4935
+
4936
+ ### Examples
4937
+
4938
+
4939
+ (No example for this operation).
4940
+
4941
+
4942
+ #### Using the regenerate_password_for_pbx_hardware_phone_with_http_info variant
4943
+
4944
+ This returns an Array which contains the response data, status code and headers.
4945
+
4946
+ > <Array(<ConversationPbxHardwarePhoneResponse>, Integer, Hash)> regenerate_password_for_pbx_hardware_phone_with_http_info(conversation_pbx_hardware_phone_uuid, pbx_hardware_phone)
4947
+
4948
+ ```ruby
4949
+ begin
4950
+ # Update pbx hardware phone
4951
+ data, status_code, headers = api_instance.regenerate_password_for_pbx_hardware_phone_with_http_info(conversation_pbx_hardware_phone_uuid, pbx_hardware_phone)
4952
+ p status_code # => 2xx
4953
+ p headers # => { ... }
4954
+ p data # => <ConversationPbxHardwarePhoneResponse>
4955
+ rescue UltracartClient::ApiError => e
4956
+ puts "Error when calling ConversationApi->regenerate_password_for_pbx_hardware_phone_with_http_info: #{e}"
4957
+ end
4958
+ ```
4959
+
4960
+ ### Parameters
4961
+
4962
+ | Name | Type | Description | Notes |
4963
+ | ---- | ---- | ----------- | ----- |
4964
+ | **conversation_pbx_hardware_phone_uuid** | **String** | | |
4965
+ | **pbx_hardware_phone** | [**ConversationPbxHardwarePhone**](ConversationPbxHardwarePhone.md) | Pbx Hardware Phone | |
4966
+
4967
+ ### Return type
4968
+
4969
+ [**ConversationPbxHardwarePhoneResponse**](ConversationPbxHardwarePhoneResponse.md)
4970
+
4971
+ ### Authorization
4972
+
4973
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4974
+
4975
+ ### HTTP request headers
4976
+
4977
+ - **Content-Type**: application/json
4978
+ - **Accept**: application/json
4979
+
4980
+
4659
4981
  ## reset_conversation_pbx_queue_statistics
4660
4982
 
4661
4983
  > reset_conversation_pbx_queue_statistics(queue_uuid)
@@ -5424,6 +5746,60 @@ end
5424
5746
  - **Accept**: application/json
5425
5747
 
5426
5748
 
5749
+ ## update_pbx_hardware_phone
5750
+
5751
+ > <ConversationPbxHardwarePhoneResponse> update_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid, pbx_hardware_phone)
5752
+
5753
+ Update pbx hardware phone
5754
+
5755
+ Update a pbx hardware phone
5756
+
5757
+
5758
+ ### Examples
5759
+
5760
+
5761
+ (No example for this operation).
5762
+
5763
+
5764
+ #### Using the update_pbx_hardware_phone_with_http_info variant
5765
+
5766
+ This returns an Array which contains the response data, status code and headers.
5767
+
5768
+ > <Array(<ConversationPbxHardwarePhoneResponse>, Integer, Hash)> update_pbx_hardware_phone_with_http_info(conversation_pbx_hardware_phone_uuid, pbx_hardware_phone)
5769
+
5770
+ ```ruby
5771
+ begin
5772
+ # Update pbx hardware phone
5773
+ data, status_code, headers = api_instance.update_pbx_hardware_phone_with_http_info(conversation_pbx_hardware_phone_uuid, pbx_hardware_phone)
5774
+ p status_code # => 2xx
5775
+ p headers # => { ... }
5776
+ p data # => <ConversationPbxHardwarePhoneResponse>
5777
+ rescue UltracartClient::ApiError => e
5778
+ puts "Error when calling ConversationApi->update_pbx_hardware_phone_with_http_info: #{e}"
5779
+ end
5780
+ ```
5781
+
5782
+ ### Parameters
5783
+
5784
+ | Name | Type | Description | Notes |
5785
+ | ---- | ---- | ----------- | ----- |
5786
+ | **conversation_pbx_hardware_phone_uuid** | **String** | | |
5787
+ | **pbx_hardware_phone** | [**ConversationPbxHardwarePhone**](ConversationPbxHardwarePhone.md) | Pbx Hardware Phone | |
5788
+
5789
+ ### Return type
5790
+
5791
+ [**ConversationPbxHardwarePhoneResponse**](ConversationPbxHardwarePhoneResponse.md)
5792
+
5793
+ ### Authorization
5794
+
5795
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
5796
+
5797
+ ### HTTP request headers
5798
+
5799
+ - **Content-Type**: application/json
5800
+ - **Accept**: application/json
5801
+
5802
+
5427
5803
  ## update_pbx_menu
5428
5804
 
5429
5805
  > <ConversationPbxMenuResponse> update_pbx_menu(conversation_pbx_menu_uuid, pbx_menu)
@@ -0,0 +1,42 @@
1
+ # UltracartClient::ConversationPbxHardwarePhone
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **conversation_pbx_hardware_phone_uuid** | **String** | Conversation Pbx Hardware Phone UUID | [optional] |
8
+ | **created_at** | **Object** | Created At | [optional] |
9
+ | **description** | **String** | Description | [optional] |
10
+ | **mac_address** | **String** | MAC Address | [optional] |
11
+ | **manufacturer** | **String** | Manufacturer | [optional] |
12
+ | **merchant_id** | **String** | Merchant Id | [optional] |
13
+ | **model** | **String** | Model | [optional] |
14
+ | **name** | **String** | Name | [optional] |
15
+ | **provisioning_url** | **String** | Auto-provisioning URL for phone configuration | [optional] |
16
+ | **sip_domain** | **String** | SIP Domain | [optional] |
17
+ | **sip_password** | **String** | SIP Password | [optional] |
18
+ | **sip_username** | **String** | SIP Username | [optional] |
19
+ | **updated_at** | **Object** | Updated At | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'ultracart_api'
25
+
26
+ instance = UltracartClient::ConversationPbxHardwarePhone.new(
27
+ conversation_pbx_hardware_phone_uuid: null,
28
+ created_at: null,
29
+ description: null,
30
+ mac_address: null,
31
+ manufacturer: null,
32
+ merchant_id: null,
33
+ model: null,
34
+ name: null,
35
+ provisioning_url: null,
36
+ sip_domain: null,
37
+ sip_password: null,
38
+ sip_username: null,
39
+ updated_at: null
40
+ )
41
+ ```
42
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ConversationPbxHardwarePhoneResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **hardware_phone** | [**ConversationPbxHardwarePhone**](ConversationPbxHardwarePhone.md) | | [optional] |
9
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::ConversationPbxHardwarePhoneResponse.new(
19
+ error: null,
20
+ hardware_phone: null,
21
+ metadata: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,18 @@
1
+ # UltracartClient::ConversationPbxHardwarePhonesResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **hardware_phones** | [**Array&lt;ConversationPbxHardwarePhone&gt;**](ConversationPbxHardwarePhone.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ultracart_api'
13
+
14
+ instance = UltracartClient::ConversationPbxHardwarePhonesResponse.new(
15
+ hardware_phones: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,22 @@
1
+ # UltracartClient::ConversationPbxPhoneManufacturer
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **manufacturer_id** | **String** | | [optional] |
8
+ | **models** | [**Array&lt;ConversationPbxPhoneModel&gt;**](ConversationPbxPhoneModel.md) | | [optional] |
9
+ | **name** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::ConversationPbxPhoneManufacturer.new(
17
+ manufacturer_id: null,
18
+ models: null,
19
+ name: null
20
+ )
21
+ ```
22
+