ultracart_api 4.1.202 → 4.1.204

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/SfvbEvent.md

@@ -7,9 +7,9 @@
 | **event_dts** | **String** | When it happened, ISO 8601. | [optional] |
 | **event_id** | **String** | Time-ordered id.  Pass the last one seen as after to replay what came since. | [optional] |
 | **object_id** | **String** | The id of what changed, such as the approval_id. | [optional] |
-| **object_type** | **String** | What changed, such as approval. | [optional] |
+| **object_type** | **String** | What changed, such as approval or secret_sink. | [optional] |
 | **storefront_oid** | **Integer** | The storefront it concerns.  Empty for merchant-level objects. | [optional] |
-| **type** | **String** | approval.decided (approved, denied, cancelled or refused by the script review) or approval.ready (the review finished and the person can decide). | [optional] |
+| **type** | **String** | approval.decided (approved, denied, cancelled or refused by the script review), approval.ready (the review finished and the person can decide) or secret_sink.completed (a person entered the values of a secret request; object_id is the request id). | [optional] |
 
 ## Example
 

data/docs/SfvbSecretHandle.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbSecretHandle
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_at** | **String** | When it stops being usable, ISO 8601 UTC. | [optional] |
+| **fingerprint** | **String** | The last few characters of the value, as a mask shows them, so the person can tell values apart.  Empty until entered. | [optional] |
+| **handle** | **String** | The handle.  Safe to log and keep in plans.  It works only for the sign-in that requested it. | [optional] |
+| **key** | **String** | The bulk key it is for, or empty. | [optional] |
+| **sink** | **String** | The secret field it can be written to. | [optional] |
+| **status** | **String** | pending (no value yet), ready, in_use (a write holds it), consumed, revoked or expired. | [optional] |
+| **target_id** | **String** | The object it can be written to, or empty when the request named none. | [optional] |
+| **uses_left** | **Integer** | Writes left.  Empty once the handle is gone. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretHandle.new(
+  expires_at: null,
+  fingerprint: null,
+  handle: null,
+  key: null,
+  sink: null,
+  status: null,
+  target_id: null,
+  uses_left: null
+)
+```
+

data/docs/SfvbSecretKind.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbSecretKind
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Where the value comes from. | [optional] |
+| **format_hint** | **String** | What the value looks like.  The request page checks it as it is typed, and the server again. | [optional] |
+| **id** | **String** | The kind id. | [optional] |
+| **label** | **String** | What the person is told they are entering. | [optional] |
+| **mask_suffix** | **Integer** | How many trailing characters a mask shows at most. | [optional] |
+| **max_length** | **Integer** | Longest value accepted. | [optional] |
+| **min_length** | **Integer** | Shortest value accepted, after surrounding whitespace is removed. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretKind.new(
+  description: null,
+  format_hint: null,
+  id: null,
+  label: null,
+  mask_suffix: null,
+  max_length: null,
+  min_length: null
+)
+```
+

data/docs/SfvbSecretKindsResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbSecretKindsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kinds** | [**Array<SfvbSecretKind>**](SfvbSecretKind.md) | Every kind of secret this server collects. | [optional] |
+| **sinks** | [**Array<SfvbSecretSink>**](SfvbSecretSink.md) | Every secret field a handle can be written to. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretKindsResponse.new(
+  kinds: null,
+  sinks: null
+)
+```
+

data/docs/SfvbSecretRequest.md

@@ -0,0 +1,54 @@
+# UltracartClient::SfvbSecretRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **String** | When the request was made, ISO 8601 UTC. | [optional] |
+| **delegated** | **Boolean** | True when the requester handed it to a colleague to fill in. | [optional] |
+| **description** | **String** | The sentence the person reads.  Written by the server, not the agent. | [optional] |
+| **expires_at** | **String** | When a pending request lapses, ISO 8601 UTC. | [optional] |
+| **expires_in_seconds** | **Integer** | Seconds until expires_at.  Zero once passed. | [optional] |
+| **fulfilled_at** | **String** | When the values were entered, ISO 8601 UTC. | [optional] |
+| **handle_count** | **Integer** | How many handles the request made. | [optional] |
+| **handles** | [**Array<SfvbSecretHandle>**](SfvbSecretHandle.md) | Every handle with its status.  Left out of the list endpoint; read one request for them. | [optional] |
+| **interval_seconds** | **Integer** | Poll no more often than this. | [optional] |
+| **keys** | **Array<String>** | The bulk keys, or empty. | [optional] |
+| **label** | **String** | The label the agent sent, as stored and shown. | [optional] |
+| **reason** | **String** | The reason the agent sent, as stored and shown. | [optional] |
+| **request_id** | **String** | The request id. | [optional] |
+| **request_url** | **String** | The page where the person enters the values.  Show it to them.  Never open or fill it in yourself. | [optional] |
+| **requires_totp** | **Boolean** | True when the person must enter a code from their authenticator app. | [optional] |
+| **sinks** | **Array<String>** | The secret fields being collected. | [optional] |
+| **status** | **String** | pending, fulfilled, cancelled or expired. | [optional] |
+| **target_id** | **String** | The object the values are for, or empty for a bulk request or an open one. | [optional] |
+| **user_code** | **String** | Short matching code.  Print it next to request_url so the person can check the page shows the same code. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretRequest.new(
+  created_at: null,
+  delegated: null,
+  description: null,
+  expires_at: null,
+  expires_in_seconds: null,
+  fulfilled_at: null,
+  handle_count: null,
+  handles: null,
+  interval_seconds: null,
+  keys: null,
+  label: null,
+  reason: null,
+  request_id: null,
+  request_url: null,
+  requires_totp: null,
+  sinks: null,
+  status: null,
+  target_id: null,
+  user_code: null
+)
+```
+

data/docs/SfvbSecretRequestCreate.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbSecretRequestCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **keys** | **Array<String>** | Bulk.  One handle per key and sink, and each key is that handle's target, such as one sending domain per key.  At most 500 handles in all. | [optional] |
+| **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.  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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretRequestCreate.new(
+  keys: null,
+  label: null,
+  reason: null,
+  sinks: null,
+  target_id: null,
+  ttl_seconds: null,
+  uses: null
+)
+```
+

data/docs/SfvbSecretRequestsResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbSecretRequestsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **requests** | [**Array<SfvbSecretRequest>**](SfvbSecretRequest.md) | This sign-in's secret requests from the last 24 hours, newest first, at most 50, without their handles. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretRequestsResponse.new(
+  requests: null
+)
+```
+

data/docs/SfvbSecretSink.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbSecretSink
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The sink id. | [optional] |
+| **kind** | **String** | The kind of value it holds. | [optional] |
+| **requires_totp** | **Boolean** | True when the person must enter a code from their authenticator app, and the request must name its target. | [optional] |
+| **target_type** | **String** | What a request names as its target_id or keys. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSecretSink.new(
+  id: null,
+  kind: null,
+  requires_totp: null,
+  target_type: null
+)
+```
+