ultracart_api 4.1.40 → 4.1.42
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 +19 -2
- data/docs/ConversationApi.md +492 -0
- data/docs/ConversationPbxAddress.md +42 -0
- data/docs/ConversationPbxAddressResponse.md +26 -0
- data/docs/ConversationPbxAddressesResponse.md +18 -0
- data/docs/ConversationPbxAvailablePhoneNumber.md +36 -0
- data/docs/ConversationPbxAvailablePhoneNumbersResponse.md +26 -0
- data/docs/ConversationPbxPhoneNumber.md +4 -0
- data/docs/ConversationPbxPhoneNumberPurchaseRequest.md +26 -0
- data/lib/ultracart_api/api/conversation_api.rb +610 -0
- data/lib/ultracart_api/models/conversation_pbx_address.rb +490 -0
- data/lib/ultracart_api/models/conversation_pbx_address_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_addresses_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_pbx_available_phone_number.rb +419 -0
- data/lib/ultracart_api/models/conversation_pbx_available_phone_numbers_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +36 -1
- data/lib/ultracart_api/models/conversation_pbx_phone_number_purchase_request.rb +359 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +6 -0
- metadata +14 -2
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxAvailablePhoneNumber
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **address_requirements** | **String** | Address requirements | [optional] |
|
|
8
|
+
| **country** | **String** | ISO country code | [optional] |
|
|
9
|
+
| **friendly_name** | **String** | Friendly formatted phone number | [optional] |
|
|
10
|
+
| **locality** | **String** | City/Locality | [optional] |
|
|
11
|
+
| **mms** | **Boolean** | MMS capability | [optional] |
|
|
12
|
+
| **monthly_cost** | **Float** | Monthly cost for this phone number | [optional] |
|
|
13
|
+
| **phone_number** | **String** | Phone number in E.164 format | [optional] |
|
|
14
|
+
| **region** | **String** | State/Province/Region | [optional] |
|
|
15
|
+
| **sms** | **Boolean** | SMS capability | [optional] |
|
|
16
|
+
| **voice** | **Boolean** | Voice capability | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'ultracart_api'
|
|
22
|
+
|
|
23
|
+
instance = UltracartClient::ConversationPbxAvailablePhoneNumber.new(
|
|
24
|
+
address_requirements: null,
|
|
25
|
+
country: null,
|
|
26
|
+
friendly_name: null,
|
|
27
|
+
locality: null,
|
|
28
|
+
mms: null,
|
|
29
|
+
monthly_cost: null,
|
|
30
|
+
phone_number: null,
|
|
31
|
+
region: null,
|
|
32
|
+
sms: null,
|
|
33
|
+
voice: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxAvailablePhoneNumbersResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **available_phone_numbers** | [**Array<ConversationPbxAvailablePhoneNumber>**](ConversationPbxAvailablePhoneNumber.md) | | [optional] |
|
|
8
|
+
| **error** | [**Error**](Error.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::ConversationPbxAvailablePhoneNumbersResponse.new(
|
|
19
|
+
available_phone_numbers: null,
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -6,7 +6,9 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **action** | **String** | Action | [optional] |
|
|
8
8
|
| **action_target** | **String** | Action target. This is the UUID associated with the configuration object of that particular type. | [optional] |
|
|
9
|
+
| **address_sid** | **String** | Twilio Address SID linked to this phone number for regulatory compliance | [optional] |
|
|
9
10
|
| **conversation_pbx_phone_number_uuid** | **String** | Conversation Pbx Phone Number UUID | [optional] |
|
|
11
|
+
| **deletion_protected** | **Boolean** | If true, this phone number cannot be deleted through the API. It must be deleted via the Twilio console. | [optional] |
|
|
10
12
|
| **merchant_id** | **String** | Merchant Id | [optional] |
|
|
11
13
|
| **phone_number** | **String** | Phone number | [optional] |
|
|
12
14
|
|
|
@@ -18,7 +20,9 @@ require 'ultracart_api'
|
|
|
18
20
|
instance = UltracartClient::ConversationPbxPhoneNumber.new(
|
|
19
21
|
action: null,
|
|
20
22
|
action_target: null,
|
|
23
|
+
address_sid: null,
|
|
21
24
|
conversation_pbx_phone_number_uuid: null,
|
|
25
|
+
deletion_protected: null,
|
|
22
26
|
merchant_id: null,
|
|
23
27
|
phone_number: null
|
|
24
28
|
)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxPhoneNumberPurchaseRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **action** | **String** | Initial action for incoming calls | [optional] |
|
|
8
|
+
| **action_target** | **String** | Initial action target UUID | [optional] |
|
|
9
|
+
| **address_sid** | **String** | Address SID if required for regulatory compliance | [optional] |
|
|
10
|
+
| **friendly_name** | **String** | Friendly name for the phone number | [optional] |
|
|
11
|
+
| **phone_number** | **String** | Phone number to purchase in E.164 format (from search results) | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::ConversationPbxPhoneNumberPurchaseRequest.new(
|
|
19
|
+
action: null,
|
|
20
|
+
action_target: null,
|
|
21
|
+
address_sid: null,
|
|
22
|
+
friendly_name: null,
|
|
23
|
+
phone_number: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|