ultracart_api 4.1.203 → 4.1.204

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.
Files changed (21) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -2
  3. data/docs/SfvbApi.md +538 -0
  4. data/docs/SfvbApprovalParams.md +4 -0
  5. data/docs/SfvbCommsDnsRecord.md +24 -0
  6. data/docs/SfvbCommsSendingDomain.md +38 -0
  7. data/docs/SfvbCommsSendingDomainsResponse.md +18 -0
  8. data/docs/SfvbCommsTwilioAccount.md +38 -0
  9. data/docs/SfvbCommsTwilioAccountResponse.md +20 -0
  10. data/docs/SfvbSecretRequestCreate.md +1 -1
  11. data/lib/ultracart_api/api/sfvb_api.rb +654 -0
  12. data/lib/ultracart_api/models/sfvb_approval_params.rb +21 -1
  13. data/lib/ultracart_api/models/sfvb_comms_dns_record.rb +296 -0
  14. data/lib/ultracart_api/models/sfvb_comms_sending_domain.rb +356 -0
  15. data/lib/ultracart_api/models/sfvb_comms_sending_domains_response.rb +222 -0
  16. data/lib/ultracart_api/models/sfvb_comms_twilio_account.rb +322 -0
  17. data/lib/ultracart_api/models/sfvb_comms_twilio_account_response.rb +231 -0
  18. data/lib/ultracart_api/models/sfvb_secret_request_create.rb +1 -1
  19. data/lib/ultracart_api/version.rb +1 -1
  20. data/lib/ultracart_api.rb +5 -0
  21. metadata +11 -1
data/docs/SfvbCommsSendingDomainsResponse.md ADDED
@@ -0,0 +1,18 @@
1
+ # UltracartClient::SfvbCommsSendingDomainsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sending_domains** | [**Array<SfvbCommsSendingDomain>**](SfvbCommsSendingDomain.md) | Every sending domain on the account, in domain order. Mailgun API keys are masked. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ultracart_api'
13
+
14
+ instance = UltracartClient::SfvbCommsSendingDomainsResponse.new(
15
+ sending_domains: null
16
+ )
17
+ ```
18
+
data/docs/SfvbCommsTwilioAccount.md ADDED
@@ -0,0 +1,38 @@
1
+ # UltracartClient::SfvbCommsTwilioAccount
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_sid** | **String** | The Twilio account SID, AC followed by 32 hex digits. It names the account, so it is also the target_id of a secret request for its auth token. Required to create. | [optional] |
8
+ | **ai_twiml_app_sid** | **String** | The SID of the TwiML app UltraCart made for the AI agent. Set by the server. | [optional] |
9
+ | **api_key_id** | **String** | The SID of the Twilio API key UltraCart made for this account. Set by the server. Its secret is never returned. | [optional] |
10
+ | **api_key_name** | **String** | The name of the Twilio API key UltraCart made for this account. Set by the server. | [optional] |
11
+ | **auth_token** | **String** | The Twilio auth token. A secret field. Reads return a mask. To set it, send a secret handle (sec_...) made for this account SID by POST secrets with sink twilio.account.auth_token. Send the mask back, or leave it out, to keep it. Required to create. | [optional] |
12
+ | **esp_twilio_uuid** | **String** | UltraCart's id for the Twilio account. Set by the server. | [optional] |
13
+ | **inbound_twiml_app_sid** | **String** | The SID of the TwiML app UltraCart made for inbound calls and SMS. Set by the server. | [optional] |
14
+ | **outbound_twiml_app_sid** | **String** | The SID of the TwiML app UltraCart made for outbound calls. Set by the server. | [optional] |
15
+ | **phone_numbers** | **Array<String>** | The account's phone numbers UltraCart uses, in E.164 format. Leave it out of an update to keep them; an update that sends it replaces them all. | [optional] |
16
+ | **public_key_sid** | **String** | The SID of the voice encryption public key UltraCart registered with Twilio. Set by the server. The keys themselves are never returned. | [optional] |
17
+ | **twilio_workspace_sid** | **String** | The SID of the TaskRouter workspace the phone system uses, when it has one. Set by the server. | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'ultracart_api'
23
+
24
+ instance = UltracartClient::SfvbCommsTwilioAccount.new(
25
+ account_sid: null,
26
+ ai_twiml_app_sid: null,
27
+ api_key_id: null,
28
+ api_key_name: null,
29
+ auth_token: null,
30
+ esp_twilio_uuid: null,
31
+ inbound_twiml_app_sid: null,
32
+ outbound_twiml_app_sid: null,
33
+ phone_numbers: null,
34
+ public_key_sid: null,
35
+ twilio_workspace_sid: null
36
+ )
37
+ ```
38
+
data/docs/SfvbCommsTwilioAccountResponse.md ADDED
@@ -0,0 +1,20 @@
1
+ # UltracartClient::SfvbCommsTwilioAccountResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **twilio_account** | [**SfvbCommsTwilioAccount**](SfvbCommsTwilioAccount.md) | | [optional] |
8
+ | **warnings** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Anything worth knowing that did not stop the call, such as a second Twilio account left from before the admin allowed only one. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::SfvbCommsTwilioAccountResponse.new(
16
+ twilio_account: null,
17
+ warnings: null
18
+ )
19
+ ```
20
+
data/docs/SfvbSecretRequestCreate.md CHANGED
@@ -8,7 +8,7 @@
8
8
  | **label** | **String** | A short name the person sees, marked as unverified. At most 120 characters. | [optional] |
9
9
  | **reason** | **String** | Why the agent needs it. Shown to the person, marked as unverified. At most 500 characters. | [optional] |
10
10
  | **sinks** | **Array<String>** | The secret fields to collect, by sink id. GET secrets/kinds lists them. All must take the same kind of target. | [optional] |
11
- | **target_id** | **String** | The object the values are for, such as a Twilio account uuid. Required for sinks that need an authenticator code, unless keys names the targets. Leave it out when keys is sent. | [optional] |
11
+ | **target_id** | **String** | The object the values are for. A Twilio account by its account SID (AC followed by 32 hex digits), and a sending domain by the domain name, which may be one not added yet. Required for sinks that need an authenticator code, unless keys names the targets. Leave it out when keys is sent. | [optional] |
12
12
  | **ttl_seconds** | **Integer** | How long each handle stays usable once the values are entered. 60 to 86400, default 3600. | [optional] |
13
13
  | **uses** | **Integer** | How many writes each handle may make. 1 to 100, default 1. | [optional] |
14
14