ultracart_api 4.0.218 → 4.0.219
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 +4 -4
- data/README.md +5 -8
- data/docs/ConversationApi.md +0 -288
- data/docs/ConversationPbxAgent.md +12 -0
- data/lib/ultracart_api/api/conversation_api.rb +0 -266
- data/lib/ultracart_api/models/conversation_pbx_agent.rb +91 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 80cb7d4a7b84f624f8a01ded8d6441db5e6ba1b61afbbb95c9bd3414b2a1695b
|
|
4
|
+
data.tar.gz: 665bc115fb8744414f3205c28433493d464c1f485b6394372d12d2c11d6812f7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e30956ecd4331c976027648b5a4b2fc50d8db2aa5d6cd63cc917844d30ccb7dd43d32d98fc23706581607cdfbbc7a3659c0bc737086c368231827d1b3d456237
|
|
7
|
+
data.tar.gz: 9f08ae638367dd5c10f66b2912c09a3becceb89cc7e274fd125b5ae69b504b8fe9b42d04517fb28eb29c63a588aef01a9d34ffd4e1954a29abba0f2f7cfd2580
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
|
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.0.
|
|
10
|
+
- Package version: 4.0.219
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
|
13
13
|
|
|
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
|
|
|
24
24
|
Then either install the gem locally:
|
|
25
25
|
|
|
26
26
|
```shell
|
|
27
|
-
gem install ./ultracart_api-4.0.
|
|
27
|
+
gem install ./ultracart_api-4.0.219.gem
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.219.gem` to install the development dependencies)
|
|
31
31
|
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
33
33
|
|
|
34
34
|
Finally add this to the Gemfile:
|
|
35
35
|
|
|
36
|
-
gem 'ultracart_api', '~> 4.0.
|
|
36
|
+
gem 'ultracart_api', '~> 4.0.219'
|
|
37
37
|
|
|
38
38
|
### Install from Git
|
|
39
39
|
|
|
@@ -142,11 +142,9 @@ Class | Method | HTTP request | Description
|
|
|
142
142
|
*UltracartClient::ConversationApi* | [**delete_conversation_canned_message**](docs/ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
|
|
143
143
|
*UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
|
144
144
|
*UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
|
145
|
-
*UltracartClient::ConversationApi* | [**delete_pbx_agent**](docs/ConversationApi.md#delete_pbx_agent) | **DELETE** /conversation/pbx/agent/{conversationPbxAgentUuid} | Delete pbx agent
|
|
146
145
|
*UltracartClient::ConversationApi* | [**delete_pbx_agent_voicemail**](docs/ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail
|
|
147
146
|
*UltracartClient::ConversationApi* | [**delete_pbx_audio**](docs/ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
|
|
148
147
|
*UltracartClient::ConversationApi* | [**delete_pbx_menu**](docs/ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
|
|
149
|
-
*UltracartClient::ConversationApi* | [**delete_pbx_phone_number**](docs/ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
|
|
150
148
|
*UltracartClient::ConversationApi* | [**delete_pbx_queue**](docs/ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue
|
|
151
149
|
*UltracartClient::ConversationApi* | [**delete_pbx_queue_voicemail**](docs/ConversationApi.md#delete_pbx_queue_voicemail) | **DELETE** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Delete Queue Voicemail
|
|
152
150
|
*UltracartClient::ConversationApi* | [**delete_pbx_time_based**](docs/ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased
|
|
@@ -196,10 +194,8 @@ Class | Method | HTTP request | Description
|
|
|
196
194
|
*UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
|
197
195
|
*UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
|
198
196
|
*UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
|
199
|
-
*UltracartClient::ConversationApi* | [**insert_pbx_agent**](docs/ConversationApi.md#insert_pbx_agent) | **POST** /conversation/pbx/agent | Insert pbx agent
|
|
200
197
|
*UltracartClient::ConversationApi* | [**insert_pbx_audio**](docs/ConversationApi.md#insert_pbx_audio) | **POST** /conversation/pbx/audio | Insert pbx audio
|
|
201
198
|
*UltracartClient::ConversationApi* | [**insert_pbx_menu**](docs/ConversationApi.md#insert_pbx_menu) | **POST** /conversation/pbx/menu | Insert pbx menu
|
|
202
|
-
*UltracartClient::ConversationApi* | [**insert_pbx_phone_number**](docs/ConversationApi.md#insert_pbx_phone_number) | **POST** /conversation/pbx/phone_number | Insert pbx phoneNumber
|
|
203
199
|
*UltracartClient::ConversationApi* | [**insert_pbx_queue**](docs/ConversationApi.md#insert_pbx_queue) | **POST** /conversation/pbx/queue | Insert pbx queue
|
|
204
200
|
*UltracartClient::ConversationApi* | [**insert_pbx_time_based**](docs/ConversationApi.md#insert_pbx_time_based) | **POST** /conversation/pbx/time_based | Insert pbx timeBased
|
|
205
201
|
*UltracartClient::ConversationApi* | [**insert_pbx_time_range**](docs/ConversationApi.md#insert_pbx_time_range) | **POST** /conversation/pbx/time_range | Insert pbx timeRange
|
|
@@ -1513,6 +1509,7 @@ Not every change is committed to every SDK.
|
|
|
1513
1509
|
|
|
1514
1510
|
| Version | Date | Comments |
|
|
1515
1511
|
| --: | :-: | --- |
|
|
1512
|
+
| 4.0.219 | 05/15/2024 | conversation pbx - missing fields on agent object |
|
|
1516
1513
|
| 4.0.218 | 05/14/2024 | conversation pbx - allowed value constants on the action |
|
|
1517
1514
|
| 4.0.217 | 05/13/2024 | conversation pbx - bug fix on camelCase property names |
|
|
1518
1515
|
| 4.0.216 | 05/13/2024 | conversation pbx - allow nullable day of week in time range |
|
data/docs/ConversationApi.md
CHANGED
|
@@ -7,11 +7,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
7
7
|
| [**delete_conversation_canned_message**](ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message |
|
|
8
8
|
| [**delete_department**](ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department |
|
|
9
9
|
| [**delete_engagement**](ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement |
|
|
10
|
-
| [**delete_pbx_agent**](ConversationApi.md#delete_pbx_agent) | **DELETE** /conversation/pbx/agent/{conversationPbxAgentUuid} | Delete pbx agent |
|
|
11
10
|
| [**delete_pbx_agent_voicemail**](ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail |
|
|
12
11
|
| [**delete_pbx_audio**](ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio |
|
|
13
12
|
| [**delete_pbx_menu**](ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu |
|
|
14
|
-
| [**delete_pbx_phone_number**](ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber |
|
|
15
13
|
| [**delete_pbx_queue**](ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue |
|
|
16
14
|
| [**delete_pbx_queue_voicemail**](ConversationApi.md#delete_pbx_queue_voicemail) | **DELETE** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Delete Queue Voicemail |
|
|
17
15
|
| [**delete_pbx_time_based**](ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased |
|
|
@@ -61,10 +59,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
61
59
|
| [**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message |
|
|
62
60
|
| [**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department |
|
|
63
61
|
| [**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement |
|
|
64
|
-
| [**insert_pbx_agent**](ConversationApi.md#insert_pbx_agent) | **POST** /conversation/pbx/agent | Insert pbx agent |
|
|
65
62
|
| [**insert_pbx_audio**](ConversationApi.md#insert_pbx_audio) | **POST** /conversation/pbx/audio | Insert pbx audio |
|
|
66
63
|
| [**insert_pbx_menu**](ConversationApi.md#insert_pbx_menu) | **POST** /conversation/pbx/menu | Insert pbx menu |
|
|
67
|
-
| [**insert_pbx_phone_number**](ConversationApi.md#insert_pbx_phone_number) | **POST** /conversation/pbx/phone_number | Insert pbx phoneNumber |
|
|
68
64
|
| [**insert_pbx_queue**](ConversationApi.md#insert_pbx_queue) | **POST** /conversation/pbx/queue | Insert pbx queue |
|
|
69
65
|
| [**insert_pbx_time_based**](ConversationApi.md#insert_pbx_time_based) | **POST** /conversation/pbx/time_based | Insert pbx timeBased |
|
|
70
66
|
| [**insert_pbx_time_range**](ConversationApi.md#insert_pbx_time_range) | **POST** /conversation/pbx/time_range | Insert pbx timeRange |
|
|
@@ -303,77 +299,6 @@ nil (empty response body)
|
|
|
303
299
|
- **Accept**: application/json
|
|
304
300
|
|
|
305
301
|
|
|
306
|
-
## delete_pbx_agent
|
|
307
|
-
|
|
308
|
-
> <ConversationPbxAgentResponse> delete_pbx_agent(conversation_pbx_agent_uuid)
|
|
309
|
-
|
|
310
|
-
Delete pbx agent
|
|
311
|
-
|
|
312
|
-
Delete a pbx agent
|
|
313
|
-
|
|
314
|
-
### Examples
|
|
315
|
-
|
|
316
|
-
```ruby
|
|
317
|
-
require 'time'
|
|
318
|
-
require 'ultracart_api'
|
|
319
|
-
require 'json'
|
|
320
|
-
require 'yaml'
|
|
321
|
-
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
322
|
-
|
|
323
|
-
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
324
|
-
# As such, this might not be the best way to use this object.
|
|
325
|
-
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
326
|
-
|
|
327
|
-
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
328
|
-
conversation_pbx_agent_uuid = 'conversation_pbx_agent_uuid_example' # String |
|
|
329
|
-
|
|
330
|
-
begin
|
|
331
|
-
# Delete pbx agent
|
|
332
|
-
result = api_instance.delete_pbx_agent(conversation_pbx_agent_uuid)
|
|
333
|
-
p result
|
|
334
|
-
rescue UltracartClient::ApiError => e
|
|
335
|
-
puts "Error when calling ConversationApi->delete_pbx_agent: #{e}"
|
|
336
|
-
end
|
|
337
|
-
```
|
|
338
|
-
|
|
339
|
-
#### Using the delete_pbx_agent_with_http_info variant
|
|
340
|
-
|
|
341
|
-
This returns an Array which contains the response data, status code and headers.
|
|
342
|
-
|
|
343
|
-
> <Array(<ConversationPbxAgentResponse>, Integer, Hash)> delete_pbx_agent_with_http_info(conversation_pbx_agent_uuid)
|
|
344
|
-
|
|
345
|
-
```ruby
|
|
346
|
-
begin
|
|
347
|
-
# Delete pbx agent
|
|
348
|
-
data, status_code, headers = api_instance.delete_pbx_agent_with_http_info(conversation_pbx_agent_uuid)
|
|
349
|
-
p status_code # => 2xx
|
|
350
|
-
p headers # => { ... }
|
|
351
|
-
p data # => <ConversationPbxAgentResponse>
|
|
352
|
-
rescue UltracartClient::ApiError => e
|
|
353
|
-
puts "Error when calling ConversationApi->delete_pbx_agent_with_http_info: #{e}"
|
|
354
|
-
end
|
|
355
|
-
```
|
|
356
|
-
|
|
357
|
-
### Parameters
|
|
358
|
-
|
|
359
|
-
| Name | Type | Description | Notes |
|
|
360
|
-
| ---- | ---- | ----------- | ----- |
|
|
361
|
-
| **conversation_pbx_agent_uuid** | **String** | | |
|
|
362
|
-
|
|
363
|
-
### Return type
|
|
364
|
-
|
|
365
|
-
[**ConversationPbxAgentResponse**](ConversationPbxAgentResponse.md)
|
|
366
|
-
|
|
367
|
-
### Authorization
|
|
368
|
-
|
|
369
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
370
|
-
|
|
371
|
-
### HTTP request headers
|
|
372
|
-
|
|
373
|
-
- **Content-Type**: Not defined
|
|
374
|
-
- **Accept**: application/json
|
|
375
|
-
|
|
376
|
-
|
|
377
302
|
## delete_pbx_agent_voicemail
|
|
378
303
|
|
|
379
304
|
> delete_pbx_agent_voicemail(recording_sid)
|
|
@@ -586,77 +511,6 @@ end
|
|
|
586
511
|
- **Accept**: application/json
|
|
587
512
|
|
|
588
513
|
|
|
589
|
-
## delete_pbx_phone_number
|
|
590
|
-
|
|
591
|
-
> <ConversationPbxPhoneNumberResponse> delete_pbx_phone_number(conversation_pbx_phone_number_uuid)
|
|
592
|
-
|
|
593
|
-
Delete pbx phoneNumber
|
|
594
|
-
|
|
595
|
-
Delete a pbx phoneNumber
|
|
596
|
-
|
|
597
|
-
### Examples
|
|
598
|
-
|
|
599
|
-
```ruby
|
|
600
|
-
require 'time'
|
|
601
|
-
require 'ultracart_api'
|
|
602
|
-
require 'json'
|
|
603
|
-
require 'yaml'
|
|
604
|
-
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
605
|
-
|
|
606
|
-
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
607
|
-
# As such, this might not be the best way to use this object.
|
|
608
|
-
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
609
|
-
|
|
610
|
-
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
611
|
-
conversation_pbx_phone_number_uuid = 'conversation_pbx_phone_number_uuid_example' # String |
|
|
612
|
-
|
|
613
|
-
begin
|
|
614
|
-
# Delete pbx phoneNumber
|
|
615
|
-
result = api_instance.delete_pbx_phone_number(conversation_pbx_phone_number_uuid)
|
|
616
|
-
p result
|
|
617
|
-
rescue UltracartClient::ApiError => e
|
|
618
|
-
puts "Error when calling ConversationApi->delete_pbx_phone_number: #{e}"
|
|
619
|
-
end
|
|
620
|
-
```
|
|
621
|
-
|
|
622
|
-
#### Using the delete_pbx_phone_number_with_http_info variant
|
|
623
|
-
|
|
624
|
-
This returns an Array which contains the response data, status code and headers.
|
|
625
|
-
|
|
626
|
-
> <Array(<ConversationPbxPhoneNumberResponse>, Integer, Hash)> delete_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid)
|
|
627
|
-
|
|
628
|
-
```ruby
|
|
629
|
-
begin
|
|
630
|
-
# Delete pbx phoneNumber
|
|
631
|
-
data, status_code, headers = api_instance.delete_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid)
|
|
632
|
-
p status_code # => 2xx
|
|
633
|
-
p headers # => { ... }
|
|
634
|
-
p data # => <ConversationPbxPhoneNumberResponse>
|
|
635
|
-
rescue UltracartClient::ApiError => e
|
|
636
|
-
puts "Error when calling ConversationApi->delete_pbx_phone_number_with_http_info: #{e}"
|
|
637
|
-
end
|
|
638
|
-
```
|
|
639
|
-
|
|
640
|
-
### Parameters
|
|
641
|
-
|
|
642
|
-
| Name | Type | Description | Notes |
|
|
643
|
-
| ---- | ---- | ----------- | ----- |
|
|
644
|
-
| **conversation_pbx_phone_number_uuid** | **String** | | |
|
|
645
|
-
|
|
646
|
-
### Return type
|
|
647
|
-
|
|
648
|
-
[**ConversationPbxPhoneNumberResponse**](ConversationPbxPhoneNumberResponse.md)
|
|
649
|
-
|
|
650
|
-
### Authorization
|
|
651
|
-
|
|
652
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
653
|
-
|
|
654
|
-
### HTTP request headers
|
|
655
|
-
|
|
656
|
-
- **Content-Type**: Not defined
|
|
657
|
-
- **Accept**: application/json
|
|
658
|
-
|
|
659
|
-
|
|
660
514
|
## delete_pbx_queue
|
|
661
515
|
|
|
662
516
|
> <ConversationPbxQueueResponse> delete_pbx_queue(conversation_pbx_queue_uuid)
|
|
@@ -4099,77 +3953,6 @@ end
|
|
|
4099
3953
|
- **Accept**: application/json
|
|
4100
3954
|
|
|
4101
3955
|
|
|
4102
|
-
## insert_pbx_agent
|
|
4103
|
-
|
|
4104
|
-
> <ConversationPbxAgentResponse> insert_pbx_agent(pbx_agent)
|
|
4105
|
-
|
|
4106
|
-
Insert pbx agent
|
|
4107
|
-
|
|
4108
|
-
Insert a pbx agent
|
|
4109
|
-
|
|
4110
|
-
### Examples
|
|
4111
|
-
|
|
4112
|
-
```ruby
|
|
4113
|
-
require 'time'
|
|
4114
|
-
require 'ultracart_api'
|
|
4115
|
-
require 'json'
|
|
4116
|
-
require 'yaml'
|
|
4117
|
-
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
4118
|
-
|
|
4119
|
-
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
4120
|
-
# As such, this might not be the best way to use this object.
|
|
4121
|
-
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
4122
|
-
|
|
4123
|
-
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
4124
|
-
pbx_agent = UltracartClient::ConversationPbxAgent.new # ConversationPbxAgent | Pbx Agent
|
|
4125
|
-
|
|
4126
|
-
begin
|
|
4127
|
-
# Insert pbx agent
|
|
4128
|
-
result = api_instance.insert_pbx_agent(pbx_agent)
|
|
4129
|
-
p result
|
|
4130
|
-
rescue UltracartClient::ApiError => e
|
|
4131
|
-
puts "Error when calling ConversationApi->insert_pbx_agent: #{e}"
|
|
4132
|
-
end
|
|
4133
|
-
```
|
|
4134
|
-
|
|
4135
|
-
#### Using the insert_pbx_agent_with_http_info variant
|
|
4136
|
-
|
|
4137
|
-
This returns an Array which contains the response data, status code and headers.
|
|
4138
|
-
|
|
4139
|
-
> <Array(<ConversationPbxAgentResponse>, Integer, Hash)> insert_pbx_agent_with_http_info(pbx_agent)
|
|
4140
|
-
|
|
4141
|
-
```ruby
|
|
4142
|
-
begin
|
|
4143
|
-
# Insert pbx agent
|
|
4144
|
-
data, status_code, headers = api_instance.insert_pbx_agent_with_http_info(pbx_agent)
|
|
4145
|
-
p status_code # => 2xx
|
|
4146
|
-
p headers # => { ... }
|
|
4147
|
-
p data # => <ConversationPbxAgentResponse>
|
|
4148
|
-
rescue UltracartClient::ApiError => e
|
|
4149
|
-
puts "Error when calling ConversationApi->insert_pbx_agent_with_http_info: #{e}"
|
|
4150
|
-
end
|
|
4151
|
-
```
|
|
4152
|
-
|
|
4153
|
-
### Parameters
|
|
4154
|
-
|
|
4155
|
-
| Name | Type | Description | Notes |
|
|
4156
|
-
| ---- | ---- | ----------- | ----- |
|
|
4157
|
-
| **pbx_agent** | [**ConversationPbxAgent**](ConversationPbxAgent.md) | Pbx Agent | |
|
|
4158
|
-
|
|
4159
|
-
### Return type
|
|
4160
|
-
|
|
4161
|
-
[**ConversationPbxAgentResponse**](ConversationPbxAgentResponse.md)
|
|
4162
|
-
|
|
4163
|
-
### Authorization
|
|
4164
|
-
|
|
4165
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4166
|
-
|
|
4167
|
-
### HTTP request headers
|
|
4168
|
-
|
|
4169
|
-
- **Content-Type**: application/json
|
|
4170
|
-
- **Accept**: application/json
|
|
4171
|
-
|
|
4172
|
-
|
|
4173
3956
|
## insert_pbx_audio
|
|
4174
3957
|
|
|
4175
3958
|
> <ConversationPbxAudioResponse> insert_pbx_audio(pbx_audio)
|
|
@@ -4312,77 +4095,6 @@ end
|
|
|
4312
4095
|
- **Accept**: application/json
|
|
4313
4096
|
|
|
4314
4097
|
|
|
4315
|
-
## insert_pbx_phone_number
|
|
4316
|
-
|
|
4317
|
-
> <ConversationPbxPhoneNumberResponse> insert_pbx_phone_number(pbx_phone_number)
|
|
4318
|
-
|
|
4319
|
-
Insert pbx phoneNumber
|
|
4320
|
-
|
|
4321
|
-
Insert a pbx phoneNumber
|
|
4322
|
-
|
|
4323
|
-
### Examples
|
|
4324
|
-
|
|
4325
|
-
```ruby
|
|
4326
|
-
require 'time'
|
|
4327
|
-
require 'ultracart_api'
|
|
4328
|
-
require 'json'
|
|
4329
|
-
require 'yaml'
|
|
4330
|
-
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
4331
|
-
|
|
4332
|
-
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
4333
|
-
# As such, this might not be the best way to use this object.
|
|
4334
|
-
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
4335
|
-
|
|
4336
|
-
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
4337
|
-
pbx_phone_number = UltracartClient::ConversationPbxPhoneNumber.new # ConversationPbxPhoneNumber | Pbx PhoneNumber
|
|
4338
|
-
|
|
4339
|
-
begin
|
|
4340
|
-
# Insert pbx phoneNumber
|
|
4341
|
-
result = api_instance.insert_pbx_phone_number(pbx_phone_number)
|
|
4342
|
-
p result
|
|
4343
|
-
rescue UltracartClient::ApiError => e
|
|
4344
|
-
puts "Error when calling ConversationApi->insert_pbx_phone_number: #{e}"
|
|
4345
|
-
end
|
|
4346
|
-
```
|
|
4347
|
-
|
|
4348
|
-
#### Using the insert_pbx_phone_number_with_http_info variant
|
|
4349
|
-
|
|
4350
|
-
This returns an Array which contains the response data, status code and headers.
|
|
4351
|
-
|
|
4352
|
-
> <Array(<ConversationPbxPhoneNumberResponse>, Integer, Hash)> insert_pbx_phone_number_with_http_info(pbx_phone_number)
|
|
4353
|
-
|
|
4354
|
-
```ruby
|
|
4355
|
-
begin
|
|
4356
|
-
# Insert pbx phoneNumber
|
|
4357
|
-
data, status_code, headers = api_instance.insert_pbx_phone_number_with_http_info(pbx_phone_number)
|
|
4358
|
-
p status_code # => 2xx
|
|
4359
|
-
p headers # => { ... }
|
|
4360
|
-
p data # => <ConversationPbxPhoneNumberResponse>
|
|
4361
|
-
rescue UltracartClient::ApiError => e
|
|
4362
|
-
puts "Error when calling ConversationApi->insert_pbx_phone_number_with_http_info: #{e}"
|
|
4363
|
-
end
|
|
4364
|
-
```
|
|
4365
|
-
|
|
4366
|
-
### Parameters
|
|
4367
|
-
|
|
4368
|
-
| Name | Type | Description | Notes |
|
|
4369
|
-
| ---- | ---- | ----------- | ----- |
|
|
4370
|
-
| **pbx_phone_number** | [**ConversationPbxPhoneNumber**](ConversationPbxPhoneNumber.md) | Pbx PhoneNumber | |
|
|
4371
|
-
|
|
4372
|
-
### Return type
|
|
4373
|
-
|
|
4374
|
-
[**ConversationPbxPhoneNumberResponse**](ConversationPbxPhoneNumberResponse.md)
|
|
4375
|
-
|
|
4376
|
-
### Authorization
|
|
4377
|
-
|
|
4378
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4379
|
-
|
|
4380
|
-
### HTTP request headers
|
|
4381
|
-
|
|
4382
|
-
- **Content-Type**: application/json
|
|
4383
|
-
- **Accept**: application/json
|
|
4384
|
-
|
|
4385
|
-
|
|
4386
4098
|
## insert_pbx_queue
|
|
4387
4099
|
|
|
4388
4100
|
> <ConversationPbxQueueResponse> insert_pbx_queue(pbx_queue)
|
|
@@ -7,10 +7,16 @@
|
|
|
7
7
|
| **cellphone** | **String** | Cellphone number of agent in E.164 format | [optional] |
|
|
8
8
|
| **conversation_pbx_agent_uuid** | **String** | Conversation Pbx Agent unique identifier | [optional] |
|
|
9
9
|
| **conversation_pbx_voicemail_mailbox_uuid** | **String** | Conversation Pbx Voicemail Mailbox UUID | [optional] |
|
|
10
|
+
| **extension** | **Integer** | Extension | [optional] |
|
|
10
11
|
| **forward_calls_to_cellphone** | **Boolean** | True if calls to this agent should be forwarded to their cellphone | [optional] |
|
|
12
|
+
| **full_name** | **String** | Full name | [optional] |
|
|
13
|
+
| **login** | **String** | Agent login | [optional] |
|
|
11
14
|
| **merchant_id** | **String** | Merchant Id | [optional] |
|
|
12
15
|
| **record_outgoing_automatically** | **Boolean** | True if outgoing calls should be automatically recorded | [optional] |
|
|
13
16
|
| **twilio_taskrouter_worker_id** | **String** | Twilio taskrouter worker Id | [optional] |
|
|
17
|
+
| **unavailable_play_audio_uuid** | **String** | Unavailable play audio UUID | [optional] |
|
|
18
|
+
| **unavailable_say** | **String** | Unavailable say | [optional] |
|
|
19
|
+
| **unavailable_say_voice** | **String** | Unavailable say voice | [optional] |
|
|
14
20
|
| **user_id** | **Integer** | User Id | [optional] |
|
|
15
21
|
| **voicemail** | **Boolean** | True if this agent has voicemail configured | [optional] |
|
|
16
22
|
|
|
@@ -23,10 +29,16 @@ instance = UltracartClient::ConversationPbxAgent.new(
|
|
|
23
29
|
cellphone: null,
|
|
24
30
|
conversation_pbx_agent_uuid: null,
|
|
25
31
|
conversation_pbx_voicemail_mailbox_uuid: null,
|
|
32
|
+
extension: null,
|
|
26
33
|
forward_calls_to_cellphone: null,
|
|
34
|
+
full_name: null,
|
|
35
|
+
login: null,
|
|
27
36
|
merchant_id: null,
|
|
28
37
|
record_outgoing_automatically: null,
|
|
29
38
|
twilio_taskrouter_worker_id: null,
|
|
39
|
+
unavailable_play_audio_uuid: null,
|
|
40
|
+
unavailable_say: null,
|
|
41
|
+
unavailable_say_voice: null,
|
|
30
42
|
user_id: null,
|
|
31
43
|
voicemail: null
|
|
32
44
|
)
|
|
@@ -224,70 +224,6 @@ module UltracartClient
|
|
|
224
224
|
return data, status_code, headers
|
|
225
225
|
end
|
|
226
226
|
|
|
227
|
-
# Delete pbx agent
|
|
228
|
-
# Delete a pbx agent
|
|
229
|
-
# @param conversation_pbx_agent_uuid [String]
|
|
230
|
-
# @param [Hash] opts the optional parameters
|
|
231
|
-
# @return [ConversationPbxAgentResponse]
|
|
232
|
-
def delete_pbx_agent(conversation_pbx_agent_uuid, opts = {})
|
|
233
|
-
data, _status_code, _headers = delete_pbx_agent_with_http_info(conversation_pbx_agent_uuid, opts)
|
|
234
|
-
data
|
|
235
|
-
end
|
|
236
|
-
|
|
237
|
-
# Delete pbx agent
|
|
238
|
-
# Delete a pbx agent
|
|
239
|
-
# @param conversation_pbx_agent_uuid [String]
|
|
240
|
-
# @param [Hash] opts the optional parameters
|
|
241
|
-
# @return [Array<(ConversationPbxAgentResponse, Integer, Hash)>] ConversationPbxAgentResponse data, response status code and response headers
|
|
242
|
-
def delete_pbx_agent_with_http_info(conversation_pbx_agent_uuid, opts = {})
|
|
243
|
-
if @api_client.config.debugging
|
|
244
|
-
@api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_agent ...'
|
|
245
|
-
end
|
|
246
|
-
# verify the required parameter 'conversation_pbx_agent_uuid' is set
|
|
247
|
-
if @api_client.config.client_side_validation && conversation_pbx_agent_uuid.nil?
|
|
248
|
-
fail ArgumentError, "Missing the required parameter 'conversation_pbx_agent_uuid' when calling ConversationApi.delete_pbx_agent"
|
|
249
|
-
end
|
|
250
|
-
# resource path
|
|
251
|
-
local_var_path = '/conversation/pbx/agent/{conversationPbxAgentUuid}'.sub('{' + 'conversationPbxAgentUuid' + '}', CGI.escape(conversation_pbx_agent_uuid.to_s))
|
|
252
|
-
|
|
253
|
-
# query parameters
|
|
254
|
-
query_params = opts[:query_params] || {}
|
|
255
|
-
|
|
256
|
-
# header parameters
|
|
257
|
-
header_params = opts[:header_params] || {}
|
|
258
|
-
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
259
|
-
# HTTP header 'Accept' (if needed)
|
|
260
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
261
|
-
|
|
262
|
-
# form parameters
|
|
263
|
-
form_params = opts[:form_params] || {}
|
|
264
|
-
|
|
265
|
-
# http body (model)
|
|
266
|
-
post_body = opts[:debug_body]
|
|
267
|
-
|
|
268
|
-
# return_type
|
|
269
|
-
return_type = opts[:debug_return_type] || 'ConversationPbxAgentResponse'
|
|
270
|
-
|
|
271
|
-
# auth_names
|
|
272
|
-
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
273
|
-
|
|
274
|
-
new_options = opts.merge(
|
|
275
|
-
:operation => :"ConversationApi.delete_pbx_agent",
|
|
276
|
-
:header_params => header_params,
|
|
277
|
-
:query_params => query_params,
|
|
278
|
-
:form_params => form_params,
|
|
279
|
-
:body => post_body,
|
|
280
|
-
:auth_names => auth_names,
|
|
281
|
-
:return_type => return_type
|
|
282
|
-
)
|
|
283
|
-
|
|
284
|
-
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
285
|
-
if @api_client.config.debugging
|
|
286
|
-
@api_client.config.logger.debug "API called: ConversationApi#delete_pbx_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
287
|
-
end
|
|
288
|
-
return data, status_code, headers
|
|
289
|
-
end
|
|
290
|
-
|
|
291
227
|
# Delete Agent Voicemail
|
|
292
228
|
# Delete pbx agent Voicemail
|
|
293
229
|
# @param recording_sid [String]
|
|
@@ -480,70 +416,6 @@ module UltracartClient
|
|
|
480
416
|
return data, status_code, headers
|
|
481
417
|
end
|
|
482
418
|
|
|
483
|
-
# Delete pbx phoneNumber
|
|
484
|
-
# Delete a pbx phoneNumber
|
|
485
|
-
# @param conversation_pbx_phone_number_uuid [String]
|
|
486
|
-
# @param [Hash] opts the optional parameters
|
|
487
|
-
# @return [ConversationPbxPhoneNumberResponse]
|
|
488
|
-
def delete_pbx_phone_number(conversation_pbx_phone_number_uuid, opts = {})
|
|
489
|
-
data, _status_code, _headers = delete_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid, opts)
|
|
490
|
-
data
|
|
491
|
-
end
|
|
492
|
-
|
|
493
|
-
# Delete pbx phoneNumber
|
|
494
|
-
# Delete a pbx phoneNumber
|
|
495
|
-
# @param conversation_pbx_phone_number_uuid [String]
|
|
496
|
-
# @param [Hash] opts the optional parameters
|
|
497
|
-
# @return [Array<(ConversationPbxPhoneNumberResponse, Integer, Hash)>] ConversationPbxPhoneNumberResponse data, response status code and response headers
|
|
498
|
-
def delete_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid, opts = {})
|
|
499
|
-
if @api_client.config.debugging
|
|
500
|
-
@api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_phone_number ...'
|
|
501
|
-
end
|
|
502
|
-
# verify the required parameter 'conversation_pbx_phone_number_uuid' is set
|
|
503
|
-
if @api_client.config.client_side_validation && conversation_pbx_phone_number_uuid.nil?
|
|
504
|
-
fail ArgumentError, "Missing the required parameter 'conversation_pbx_phone_number_uuid' when calling ConversationApi.delete_pbx_phone_number"
|
|
505
|
-
end
|
|
506
|
-
# resource path
|
|
507
|
-
local_var_path = '/conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}'.sub('{' + 'conversationPbxPhoneNumberUuid' + '}', CGI.escape(conversation_pbx_phone_number_uuid.to_s))
|
|
508
|
-
|
|
509
|
-
# query parameters
|
|
510
|
-
query_params = opts[:query_params] || {}
|
|
511
|
-
|
|
512
|
-
# header parameters
|
|
513
|
-
header_params = opts[:header_params] || {}
|
|
514
|
-
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
515
|
-
# HTTP header 'Accept' (if needed)
|
|
516
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
517
|
-
|
|
518
|
-
# form parameters
|
|
519
|
-
form_params = opts[:form_params] || {}
|
|
520
|
-
|
|
521
|
-
# http body (model)
|
|
522
|
-
post_body = opts[:debug_body]
|
|
523
|
-
|
|
524
|
-
# return_type
|
|
525
|
-
return_type = opts[:debug_return_type] || 'ConversationPbxPhoneNumberResponse'
|
|
526
|
-
|
|
527
|
-
# auth_names
|
|
528
|
-
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
529
|
-
|
|
530
|
-
new_options = opts.merge(
|
|
531
|
-
:operation => :"ConversationApi.delete_pbx_phone_number",
|
|
532
|
-
:header_params => header_params,
|
|
533
|
-
:query_params => query_params,
|
|
534
|
-
:form_params => form_params,
|
|
535
|
-
:body => post_body,
|
|
536
|
-
:auth_names => auth_names,
|
|
537
|
-
:return_type => return_type
|
|
538
|
-
)
|
|
539
|
-
|
|
540
|
-
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
541
|
-
if @api_client.config.debugging
|
|
542
|
-
@api_client.config.logger.debug "API called: ConversationApi#delete_pbx_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
543
|
-
end
|
|
544
|
-
return data, status_code, headers
|
|
545
|
-
end
|
|
546
|
-
|
|
547
419
|
# Delete pbx queue
|
|
548
420
|
# Delete a pbx queue
|
|
549
421
|
# @param conversation_pbx_queue_uuid [String]
|
|
@@ -3626,75 +3498,6 @@ module UltracartClient
|
|
|
3626
3498
|
return data, status_code, headers
|
|
3627
3499
|
end
|
|
3628
3500
|
|
|
3629
|
-
# Insert pbx agent
|
|
3630
|
-
# Insert a pbx agent
|
|
3631
|
-
# @param pbx_agent [ConversationPbxAgent] Pbx Agent
|
|
3632
|
-
# @param [Hash] opts the optional parameters
|
|
3633
|
-
# @return [ConversationPbxAgentResponse]
|
|
3634
|
-
def insert_pbx_agent(pbx_agent, opts = {})
|
|
3635
|
-
data, _status_code, _headers = insert_pbx_agent_with_http_info(pbx_agent, opts)
|
|
3636
|
-
data
|
|
3637
|
-
end
|
|
3638
|
-
|
|
3639
|
-
# Insert pbx agent
|
|
3640
|
-
# Insert a pbx agent
|
|
3641
|
-
# @param pbx_agent [ConversationPbxAgent] Pbx Agent
|
|
3642
|
-
# @param [Hash] opts the optional parameters
|
|
3643
|
-
# @return [Array<(ConversationPbxAgentResponse, Integer, Hash)>] ConversationPbxAgentResponse data, response status code and response headers
|
|
3644
|
-
def insert_pbx_agent_with_http_info(pbx_agent, opts = {})
|
|
3645
|
-
if @api_client.config.debugging
|
|
3646
|
-
@api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_agent ...'
|
|
3647
|
-
end
|
|
3648
|
-
# verify the required parameter 'pbx_agent' is set
|
|
3649
|
-
if @api_client.config.client_side_validation && pbx_agent.nil?
|
|
3650
|
-
fail ArgumentError, "Missing the required parameter 'pbx_agent' when calling ConversationApi.insert_pbx_agent"
|
|
3651
|
-
end
|
|
3652
|
-
# resource path
|
|
3653
|
-
local_var_path = '/conversation/pbx/agent'
|
|
3654
|
-
|
|
3655
|
-
# query parameters
|
|
3656
|
-
query_params = opts[:query_params] || {}
|
|
3657
|
-
|
|
3658
|
-
# header parameters
|
|
3659
|
-
header_params = opts[:header_params] || {}
|
|
3660
|
-
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
3661
|
-
# HTTP header 'Accept' (if needed)
|
|
3662
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3663
|
-
# HTTP header 'Content-Type'
|
|
3664
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
3665
|
-
if !content_type.nil?
|
|
3666
|
-
header_params['Content-Type'] = content_type
|
|
3667
|
-
end
|
|
3668
|
-
|
|
3669
|
-
# form parameters
|
|
3670
|
-
form_params = opts[:form_params] || {}
|
|
3671
|
-
|
|
3672
|
-
# http body (model)
|
|
3673
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(pbx_agent)
|
|
3674
|
-
|
|
3675
|
-
# return_type
|
|
3676
|
-
return_type = opts[:debug_return_type] || 'ConversationPbxAgentResponse'
|
|
3677
|
-
|
|
3678
|
-
# auth_names
|
|
3679
|
-
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
3680
|
-
|
|
3681
|
-
new_options = opts.merge(
|
|
3682
|
-
:operation => :"ConversationApi.insert_pbx_agent",
|
|
3683
|
-
:header_params => header_params,
|
|
3684
|
-
:query_params => query_params,
|
|
3685
|
-
:form_params => form_params,
|
|
3686
|
-
:body => post_body,
|
|
3687
|
-
:auth_names => auth_names,
|
|
3688
|
-
:return_type => return_type
|
|
3689
|
-
)
|
|
3690
|
-
|
|
3691
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
3692
|
-
if @api_client.config.debugging
|
|
3693
|
-
@api_client.config.logger.debug "API called: ConversationApi#insert_pbx_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3694
|
-
end
|
|
3695
|
-
return data, status_code, headers
|
|
3696
|
-
end
|
|
3697
|
-
|
|
3698
3501
|
# Insert pbx audio
|
|
3699
3502
|
# Insert a pbx audio
|
|
3700
3503
|
# @param pbx_audio [ConversationPbxAudio] Pbx Audio
|
|
@@ -3833,75 +3636,6 @@ module UltracartClient
|
|
|
3833
3636
|
return data, status_code, headers
|
|
3834
3637
|
end
|
|
3835
3638
|
|
|
3836
|
-
# Insert pbx phoneNumber
|
|
3837
|
-
# Insert a pbx phoneNumber
|
|
3838
|
-
# @param pbx_phone_number [ConversationPbxPhoneNumber] Pbx PhoneNumber
|
|
3839
|
-
# @param [Hash] opts the optional parameters
|
|
3840
|
-
# @return [ConversationPbxPhoneNumberResponse]
|
|
3841
|
-
def insert_pbx_phone_number(pbx_phone_number, opts = {})
|
|
3842
|
-
data, _status_code, _headers = insert_pbx_phone_number_with_http_info(pbx_phone_number, opts)
|
|
3843
|
-
data
|
|
3844
|
-
end
|
|
3845
|
-
|
|
3846
|
-
# Insert pbx phoneNumber
|
|
3847
|
-
# Insert a pbx phoneNumber
|
|
3848
|
-
# @param pbx_phone_number [ConversationPbxPhoneNumber] Pbx PhoneNumber
|
|
3849
|
-
# @param [Hash] opts the optional parameters
|
|
3850
|
-
# @return [Array<(ConversationPbxPhoneNumberResponse, Integer, Hash)>] ConversationPbxPhoneNumberResponse data, response status code and response headers
|
|
3851
|
-
def insert_pbx_phone_number_with_http_info(pbx_phone_number, opts = {})
|
|
3852
|
-
if @api_client.config.debugging
|
|
3853
|
-
@api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_phone_number ...'
|
|
3854
|
-
end
|
|
3855
|
-
# verify the required parameter 'pbx_phone_number' is set
|
|
3856
|
-
if @api_client.config.client_side_validation && pbx_phone_number.nil?
|
|
3857
|
-
fail ArgumentError, "Missing the required parameter 'pbx_phone_number' when calling ConversationApi.insert_pbx_phone_number"
|
|
3858
|
-
end
|
|
3859
|
-
# resource path
|
|
3860
|
-
local_var_path = '/conversation/pbx/phone_number'
|
|
3861
|
-
|
|
3862
|
-
# query parameters
|
|
3863
|
-
query_params = opts[:query_params] || {}
|
|
3864
|
-
|
|
3865
|
-
# header parameters
|
|
3866
|
-
header_params = opts[:header_params] || {}
|
|
3867
|
-
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
3868
|
-
# HTTP header 'Accept' (if needed)
|
|
3869
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3870
|
-
# HTTP header 'Content-Type'
|
|
3871
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
3872
|
-
if !content_type.nil?
|
|
3873
|
-
header_params['Content-Type'] = content_type
|
|
3874
|
-
end
|
|
3875
|
-
|
|
3876
|
-
# form parameters
|
|
3877
|
-
form_params = opts[:form_params] || {}
|
|
3878
|
-
|
|
3879
|
-
# http body (model)
|
|
3880
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(pbx_phone_number)
|
|
3881
|
-
|
|
3882
|
-
# return_type
|
|
3883
|
-
return_type = opts[:debug_return_type] || 'ConversationPbxPhoneNumberResponse'
|
|
3884
|
-
|
|
3885
|
-
# auth_names
|
|
3886
|
-
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
3887
|
-
|
|
3888
|
-
new_options = opts.merge(
|
|
3889
|
-
:operation => :"ConversationApi.insert_pbx_phone_number",
|
|
3890
|
-
:header_params => header_params,
|
|
3891
|
-
:query_params => query_params,
|
|
3892
|
-
:form_params => form_params,
|
|
3893
|
-
:body => post_body,
|
|
3894
|
-
:auth_names => auth_names,
|
|
3895
|
-
:return_type => return_type
|
|
3896
|
-
)
|
|
3897
|
-
|
|
3898
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
3899
|
-
if @api_client.config.debugging
|
|
3900
|
-
@api_client.config.logger.debug "API called: ConversationApi#insert_pbx_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3901
|
-
end
|
|
3902
|
-
return data, status_code, headers
|
|
3903
|
-
end
|
|
3904
|
-
|
|
3905
3639
|
# Insert pbx queue
|
|
3906
3640
|
# Insert a pbx queue
|
|
3907
3641
|
# @param pbx_queue [ConversationPbxQueue] Pbx Queue
|
|
@@ -24,9 +24,18 @@ module UltracartClient
|
|
|
24
24
|
# Conversation Pbx Voicemail Mailbox UUID
|
|
25
25
|
attr_accessor :conversation_pbx_voicemail_mailbox_uuid
|
|
26
26
|
|
|
27
|
+
# Extension
|
|
28
|
+
attr_accessor :extension
|
|
29
|
+
|
|
27
30
|
# True if calls to this agent should be forwarded to their cellphone
|
|
28
31
|
attr_accessor :forward_calls_to_cellphone
|
|
29
32
|
|
|
33
|
+
# Full name
|
|
34
|
+
attr_accessor :full_name
|
|
35
|
+
|
|
36
|
+
# Agent login
|
|
37
|
+
attr_accessor :login
|
|
38
|
+
|
|
30
39
|
# Merchant Id
|
|
31
40
|
attr_accessor :merchant_id
|
|
32
41
|
|
|
@@ -36,6 +45,15 @@ module UltracartClient
|
|
|
36
45
|
# Twilio taskrouter worker Id
|
|
37
46
|
attr_accessor :twilio_taskrouter_worker_id
|
|
38
47
|
|
|
48
|
+
# Unavailable play audio UUID
|
|
49
|
+
attr_accessor :unavailable_play_audio_uuid
|
|
50
|
+
|
|
51
|
+
# Unavailable say
|
|
52
|
+
attr_accessor :unavailable_say
|
|
53
|
+
|
|
54
|
+
# Unavailable say voice
|
|
55
|
+
attr_accessor :unavailable_say_voice
|
|
56
|
+
|
|
39
57
|
# User Id
|
|
40
58
|
attr_accessor :user_id
|
|
41
59
|
|
|
@@ -48,10 +66,16 @@ module UltracartClient
|
|
|
48
66
|
:'cellphone' => :'cellphone',
|
|
49
67
|
:'conversation_pbx_agent_uuid' => :'conversation_pbx_agent_uuid',
|
|
50
68
|
:'conversation_pbx_voicemail_mailbox_uuid' => :'conversation_pbx_voicemail_mailbox_uuid',
|
|
69
|
+
:'extension' => :'extension',
|
|
51
70
|
:'forward_calls_to_cellphone' => :'forward_calls_to_cellphone',
|
|
71
|
+
:'full_name' => :'full_name',
|
|
72
|
+
:'login' => :'login',
|
|
52
73
|
:'merchant_id' => :'merchant_id',
|
|
53
74
|
:'record_outgoing_automatically' => :'record_outgoing_automatically',
|
|
54
75
|
:'twilio_taskrouter_worker_id' => :'twilio_taskrouter_worker_id',
|
|
76
|
+
:'unavailable_play_audio_uuid' => :'unavailable_play_audio_uuid',
|
|
77
|
+
:'unavailable_say' => :'unavailable_say',
|
|
78
|
+
:'unavailable_say_voice' => :'unavailable_say_voice',
|
|
55
79
|
:'user_id' => :'user_id',
|
|
56
80
|
:'voicemail' => :'voicemail'
|
|
57
81
|
}
|
|
@@ -68,10 +92,16 @@ module UltracartClient
|
|
|
68
92
|
:'cellphone' => :'String',
|
|
69
93
|
:'conversation_pbx_agent_uuid' => :'String',
|
|
70
94
|
:'conversation_pbx_voicemail_mailbox_uuid' => :'String',
|
|
95
|
+
:'extension' => :'Integer',
|
|
71
96
|
:'forward_calls_to_cellphone' => :'Boolean',
|
|
97
|
+
:'full_name' => :'String',
|
|
98
|
+
:'login' => :'String',
|
|
72
99
|
:'merchant_id' => :'String',
|
|
73
100
|
:'record_outgoing_automatically' => :'Boolean',
|
|
74
101
|
:'twilio_taskrouter_worker_id' => :'String',
|
|
102
|
+
:'unavailable_play_audio_uuid' => :'String',
|
|
103
|
+
:'unavailable_say' => :'String',
|
|
104
|
+
:'unavailable_say_voice' => :'String',
|
|
75
105
|
:'user_id' => :'Integer',
|
|
76
106
|
:'voicemail' => :'Boolean'
|
|
77
107
|
}
|
|
@@ -110,10 +140,22 @@ module UltracartClient
|
|
|
110
140
|
self.conversation_pbx_voicemail_mailbox_uuid = attributes[:'conversation_pbx_voicemail_mailbox_uuid']
|
|
111
141
|
end
|
|
112
142
|
|
|
143
|
+
if attributes.key?(:'extension')
|
|
144
|
+
self.extension = attributes[:'extension']
|
|
145
|
+
end
|
|
146
|
+
|
|
113
147
|
if attributes.key?(:'forward_calls_to_cellphone')
|
|
114
148
|
self.forward_calls_to_cellphone = attributes[:'forward_calls_to_cellphone']
|
|
115
149
|
end
|
|
116
150
|
|
|
151
|
+
if attributes.key?(:'full_name')
|
|
152
|
+
self.full_name = attributes[:'full_name']
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
if attributes.key?(:'login')
|
|
156
|
+
self.login = attributes[:'login']
|
|
157
|
+
end
|
|
158
|
+
|
|
117
159
|
if attributes.key?(:'merchant_id')
|
|
118
160
|
self.merchant_id = attributes[:'merchant_id']
|
|
119
161
|
end
|
|
@@ -126,6 +168,18 @@ module UltracartClient
|
|
|
126
168
|
self.twilio_taskrouter_worker_id = attributes[:'twilio_taskrouter_worker_id']
|
|
127
169
|
end
|
|
128
170
|
|
|
171
|
+
if attributes.key?(:'unavailable_play_audio_uuid')
|
|
172
|
+
self.unavailable_play_audio_uuid = attributes[:'unavailable_play_audio_uuid']
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
if attributes.key?(:'unavailable_say')
|
|
176
|
+
self.unavailable_say = attributes[:'unavailable_say']
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
if attributes.key?(:'unavailable_say_voice')
|
|
180
|
+
self.unavailable_say_voice = attributes[:'unavailable_say_voice']
|
|
181
|
+
end
|
|
182
|
+
|
|
129
183
|
if attributes.key?(:'user_id')
|
|
130
184
|
self.user_id = attributes[:'user_id']
|
|
131
185
|
end
|
|
@@ -155,6 +209,14 @@ module UltracartClient
|
|
|
155
209
|
invalid_properties.push('invalid value for "twilio_taskrouter_worker_id", the character length must be smaller than or equal to 100.')
|
|
156
210
|
end
|
|
157
211
|
|
|
212
|
+
if !@unavailable_play_audio_uuid.nil? && @unavailable_play_audio_uuid.to_s.length > 50
|
|
213
|
+
invalid_properties.push('invalid value for "unavailable_play_audio_uuid", the character length must be smaller than or equal to 50.')
|
|
214
|
+
end
|
|
215
|
+
|
|
216
|
+
if !@unavailable_say_voice.nil? && @unavailable_say_voice.to_s.length > 50
|
|
217
|
+
invalid_properties.push('invalid value for "unavailable_say_voice", the character length must be smaller than or equal to 50.')
|
|
218
|
+
end
|
|
219
|
+
|
|
158
220
|
invalid_properties
|
|
159
221
|
end
|
|
160
222
|
|
|
@@ -165,6 +227,8 @@ module UltracartClient
|
|
|
165
227
|
return false if !@conversation_pbx_voicemail_mailbox_uuid.nil? && @conversation_pbx_voicemail_mailbox_uuid.to_s.length > 50
|
|
166
228
|
return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
|
|
167
229
|
return false if !@twilio_taskrouter_worker_id.nil? && @twilio_taskrouter_worker_id.to_s.length > 100
|
|
230
|
+
return false if !@unavailable_play_audio_uuid.nil? && @unavailable_play_audio_uuid.to_s.length > 50
|
|
231
|
+
return false if !@unavailable_say_voice.nil? && @unavailable_say_voice.to_s.length > 50
|
|
168
232
|
true
|
|
169
233
|
end
|
|
170
234
|
|
|
@@ -208,6 +272,26 @@ module UltracartClient
|
|
|
208
272
|
@twilio_taskrouter_worker_id = twilio_taskrouter_worker_id
|
|
209
273
|
end
|
|
210
274
|
|
|
275
|
+
# Custom attribute writer method with validation
|
|
276
|
+
# @param [Object] unavailable_play_audio_uuid Value to be assigned
|
|
277
|
+
def unavailable_play_audio_uuid=(unavailable_play_audio_uuid)
|
|
278
|
+
if !unavailable_play_audio_uuid.nil? && unavailable_play_audio_uuid.to_s.length > 50
|
|
279
|
+
fail ArgumentError, 'invalid value for "unavailable_play_audio_uuid", the character length must be smaller than or equal to 50.'
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
@unavailable_play_audio_uuid = unavailable_play_audio_uuid
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
# Custom attribute writer method with validation
|
|
286
|
+
# @param [Object] unavailable_say_voice Value to be assigned
|
|
287
|
+
def unavailable_say_voice=(unavailable_say_voice)
|
|
288
|
+
if !unavailable_say_voice.nil? && unavailable_say_voice.to_s.length > 50
|
|
289
|
+
fail ArgumentError, 'invalid value for "unavailable_say_voice", the character length must be smaller than or equal to 50.'
|
|
290
|
+
end
|
|
291
|
+
|
|
292
|
+
@unavailable_say_voice = unavailable_say_voice
|
|
293
|
+
end
|
|
294
|
+
|
|
211
295
|
# Checks equality by comparing each attribute.
|
|
212
296
|
# @param [Object] Object to be compared
|
|
213
297
|
def ==(o)
|
|
@@ -216,10 +300,16 @@ module UltracartClient
|
|
|
216
300
|
cellphone == o.cellphone &&
|
|
217
301
|
conversation_pbx_agent_uuid == o.conversation_pbx_agent_uuid &&
|
|
218
302
|
conversation_pbx_voicemail_mailbox_uuid == o.conversation_pbx_voicemail_mailbox_uuid &&
|
|
303
|
+
extension == o.extension &&
|
|
219
304
|
forward_calls_to_cellphone == o.forward_calls_to_cellphone &&
|
|
305
|
+
full_name == o.full_name &&
|
|
306
|
+
login == o.login &&
|
|
220
307
|
merchant_id == o.merchant_id &&
|
|
221
308
|
record_outgoing_automatically == o.record_outgoing_automatically &&
|
|
222
309
|
twilio_taskrouter_worker_id == o.twilio_taskrouter_worker_id &&
|
|
310
|
+
unavailable_play_audio_uuid == o.unavailable_play_audio_uuid &&
|
|
311
|
+
unavailable_say == o.unavailable_say &&
|
|
312
|
+
unavailable_say_voice == o.unavailable_say_voice &&
|
|
223
313
|
user_id == o.user_id &&
|
|
224
314
|
voicemail == o.voicemail
|
|
225
315
|
end
|
|
@@ -233,7 +323,7 @@ module UltracartClient
|
|
|
233
323
|
# Calculates hash code according to all attributes.
|
|
234
324
|
# @return [Integer] Hash code
|
|
235
325
|
def hash
|
|
236
|
-
[cellphone, conversation_pbx_agent_uuid, conversation_pbx_voicemail_mailbox_uuid, forward_calls_to_cellphone, merchant_id, record_outgoing_automatically, twilio_taskrouter_worker_id, user_id, voicemail].hash
|
|
326
|
+
[cellphone, conversation_pbx_agent_uuid, conversation_pbx_voicemail_mailbox_uuid, extension, forward_calls_to_cellphone, full_name, login, merchant_id, record_outgoing_automatically, twilio_taskrouter_worker_id, unavailable_play_audio_uuid, unavailable_say, unavailable_say_voice, user_id, voicemail].hash
|
|
237
327
|
end
|
|
238
328
|
|
|
239
329
|
# Builds the object from hash
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ultracart_api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 4.0.
|
|
4
|
+
version: 4.0.219
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2024-05-
|
|
11
|
+
date: 2024-05-15 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|