ultracart_api 4.1.203 → 4.1.205

data/docs/SfvbApprovalParams.md

@@ -7,6 +7,8 @@
 | **attribute_names** | **Array<String>** | For item.attribute_batch, the attributes the batch would change.  Set by the server. | [optional] |
 | **blog_post_oid** | **Integer** | The blog post, for blog_post.delete. | [optional] |
 | **content_sha256** | **String** | For file.put_script, the SHA-256 of the exact bytes approved.  Set by the server, never by the caller.  The write must send bytes with this hash. | [optional] |
+| **domain** | **String** | For sending_domain.delete, the sending domain. | [optional] |
+| **esp_twilio_uuid** | **String** | For twilio_account.delete, the Twilio account's esp_twilio_uuid, as GET comms/twilio_account returns it. | [optional] |
 | **experiment_oid** | **Integer** | For experiment.end, the experiment to end. | [optional] |
 | **item_count** | **Integer** | For item.attribute_batch, how many items the batch would change when it was requested.  Set by the server. | [optional] |
 | **merchant_item_oid** | **Integer** | For item.pricing, the item whose pricing changes. | [optional] |
@@ -30,6 +32,8 @@ instance = UltracartClient::SfvbApprovalParams.new(
   attribute_names: null,
   blog_post_oid: null,
   content_sha256: null,
+  domain: null,
+  esp_twilio_uuid: null,
   experiment_oid: null,
   item_count: null,
   merchant_item_oid: null,

data/docs/SfvbCommsDnsRecord.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbCommsDnsRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The host name, relative to the domain.  @ is the domain itself. | [optional] |
+| **purpose** | **String** | What the record is for.  verification proves the domain is yours, spf lists who may send for it, and dkim signs its mail. | [optional] |
+| **type** | **String** | The record type. | [optional] |
+| **value** | **String** | The value to publish. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsDnsRecord.new(
+  name: null,
+  purpose: null,
+  type: null,
+  value: null
+)
+```
+

data/docs/SfvbCommsSendingDomain.md

@@ -0,0 +1,38 @@
+# UltracartClient::SfvbCommsSendingDomain
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **comment** | **String** | For an amazon domain, what UltraCart did last, such as restarting a verification that failed. | [optional] |
+| **dkim_status** | **String** | For an amazon domain, whether the DKIM records were found.  Pending, Success or Failed. | [optional] |
+| **dns_records** | [**Array<SfvbCommsDnsRecord>**](SfvbCommsDnsRecord.md) | For an amazon domain, the DNS records to publish.  Empty for a mailgun domain, whose records are in Mailgun. | [optional] |
+| **domain** | **String** | The domain mail is sent from.  A leading www. or secure. is dropped.  Required to create. | [optional] |
+| **esp_domain_uuid** | **String** | UltraCart's id for the sending domain.  Set by the server. | [optional] |
+| **identity_status** | **String** | For an amazon domain, whether the verification record was found.  Pending until it is, then Success, or Failed after 72 hours. | [optional] |
+| **mailgun_api_key** | **String** | For a mailgun domain, the Mailgun account's private API key.  A secret field.  Reads return a mask.  To set it, send a secret handle (sec_...) made for this domain by POST secrets with sink mailgun.domain.api_key.  Send the mask back, or leave it out, to keep it.  Required to create a mailgun domain. | [optional] |
+| **provider** | **String** | Who sends the mail.  amazon sends through UltraCart after the DNS records are published.  mailgun sends through the merchant's own Mailgun account.  Required to create, and fixed after. | [optional] |
+| **start_dkim_dts** | **String** | For an amazon domain, when the current DKIM check started. | [optional] |
+| **start_identity_dts** | **String** | For an amazon domain, when the current verification started. | [optional] |
+| **verified** | **Boolean** | True when an amazon domain's verification and DKIM records have both been found, so it can send. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSendingDomain.new(
+  comment: null,
+  dkim_status: null,
+  dns_records: null,
+  domain: null,
+  esp_domain_uuid: null,
+  identity_status: null,
+  mailgun_api_key: null,
+  provider: null,
+  start_dkim_dts: null,
+  start_identity_dts: null,
+  verified: null
+)
+```
+

data/docs/SfvbCommsSendingDomainsResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbCommsSendingDomainsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sending_domains** | [**Array<SfvbCommsSendingDomain>**](SfvbCommsSendingDomain.md) | Every sending domain on the account, in domain order.  Mailgun API keys are masked. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSendingDomainsResponse.new(
+  sending_domains: null
+)
+```
+

data/docs/SfvbCommsTwilioAccount.md

@@ -0,0 +1,38 @@
+# UltracartClient::SfvbCommsTwilioAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **ai_twiml_app_sid** | **String** | The SID of the TwiML app UltraCart made for the AI agent.  Set by the server. | [optional] |
+| **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] |
+| **api_key_name** | **String** | The name of the Twilio API key UltraCart made for this account.  Set by the server. | [optional] |
+| **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] |
+| **esp_twilio_uuid** | **String** | UltraCart's id for the Twilio account.  Set by the server. | [optional] |
+| **inbound_twiml_app_sid** | **String** | The SID of the TwiML app UltraCart made for inbound calls and SMS.  Set by the server. | [optional] |
+| **outbound_twiml_app_sid** | **String** | The SID of the TwiML app UltraCart made for outbound calls.  Set by the server. | [optional] |
+| **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] |
+| **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] |
+| **twilio_workspace_sid** | **String** | The SID of the TaskRouter workspace the phone system uses, when it has one.  Set by the server. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTwilioAccount.new(
+  account_sid: null,
+  ai_twiml_app_sid: null,
+  api_key_id: null,
+  api_key_name: null,
+  auth_token: null,
+  esp_twilio_uuid: null,
+  inbound_twiml_app_sid: null,
+  outbound_twiml_app_sid: null,
+  phone_numbers: null,
+  public_key_sid: null,
+  twilio_workspace_sid: null
+)
+```
+

data/docs/SfvbCommsTwilioAccountResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbCommsTwilioAccountResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **twilio_account** | [**SfvbCommsTwilioAccount**](SfvbCommsTwilioAccount.md) |  | [optional] |
+| **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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTwilioAccountResponse.new(
+  twilio_account: null,
+  warnings: null
+)
+```
+

data/docs/SfvbEmailRenderRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbEmailRenderRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cart_item_ids** | **Array<String>** | Item ids for the cart the email renders with.  For a cart flow email, or the transactional email this cart and email this item templates. | [optional] |
+| **cjson** | **String** | An unsaved draft to render in place of the saved content.  For a flow or campaign email, the email container.  For a transactional email, the body container (the theme file core/emails/<name>_body.cjson). | [optional] |
+| **customer_name** | **String** | The customer name a flow or campaign email greets.  Defaults to the signed in user. | [optional] |
+| **order_id** | **String** | A test order to render the email with.  Real orders are refused.  Without one, an order email renders with a made up order. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbEmailRenderRequest.new(
+  cart_item_ids: null,
+  cjson: null,
+  customer_name: null,
+  order_id: null
+)
+```
+

data/docs/SfvbEmailRenderResponse.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbEmailRenderResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **draft** | **Boolean** | True when an unsaved draft was rendered. | [optional] |
+| **html** | **String** | The HTML body. | [optional] |
+| **order_id** | **String** | The order the email rendered with, when it used one. | [optional] |
+| **order_source** | **String** | Where that order came from.  test (the order given), dummy (made up) or none. | [optional] |
+| **preview_text** | **String** | The preview text an inbox shows after the subject, when the email has one. | [optional] |
+| **subject** | **String** | The subject line. | [optional] |
+| **text** | **String** | The plain text body. | [optional] |
+| **validation** | [**SfvbValidationResponse**](SfvbValidationResponse.md) |  | [optional] |
+| **warnings** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Problems a real send would hit, such as a missing required footer token, and placeholders used in place of values a send creates. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbEmailRenderResponse.new(
+  draft: null,
+  html: null,
+  order_id: null,
+  order_source: null,
+  preview_text: null,
+  subject: null,
+  text: null,
+  validation: null,
+  warnings: null
+)
+```
+

data/docs/SfvbSecretRequestCreate.md

@@ -8,7 +8,7 @@
 | **label** | **String** | A short name the person sees, marked as unverified.  At most 120 characters. | [optional] |
 | **reason** | **String** | Why the agent needs it.  Shown to the person, marked as unverified.  At most 500 characters. | [optional] |
 | **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] |
-| **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] |
+| **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] |
 | **ttl_seconds** | **Integer** | How long each handle stays usable once the values are entered.  60 to 86400, default 3600. | [optional] |
 | **uses** | **Integer** | How many writes each handle may make.  1 to 100, default 1. | [optional] |
 

data/docs/SfvbTransactionalEmail.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbTransactionalEmail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body_file_name** | **String** | The body container a draft replaces, such as receipt_body.cjson. | [optional] |
+| **file_name** | **String** | The HTML template file, such as receipt_html.vm. | [optional] |
+| **name** | **String** | The display name, such as Order - Receipt. | [optional] |
+| **text_file_name** | **String** | The plain text template file, when the email has one. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTransactionalEmail.new(
+  body_file_name: null,
+  file_name: null,
+  name: null,
+  text_file_name: null
+)
+```
+

data/docs/SfvbTransactionalEmailsResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbTransactionalEmailsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **emails** | [**Array<SfvbTransactionalEmail>**](SfvbTransactionalEmail.md) | The emails, sorted by name. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTransactionalEmailsResponse.new(
+  emails: null
+)
+```
+