ultracart_api 4.1.230 → 4.1.232

data/docs/SfvbCommsSettingsUpdateRequest.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbCommsSettingsUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dry_run** | **Boolean** | Check the change and show it without writing or using an approval. | [optional] |
+| **marketing_sender** | [**SfvbCommsSenderUpdate**](SfvbCommsSenderUpdate.md) |  | [optional] |
+| **postcard_return_address** | [**SfvbPostcardAddress**](SfvbPostcardAddress.md) |  | [optional] |
+| **sms_phone_number** | **String** | The default SMS number, one of the account's Twilio numbers, or an empty string to clear it. | [optional] |
+| **transactional_sender** | [**SfvbCommsSenderUpdate**](SfvbCommsSenderUpdate.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSettingsUpdateRequest.new(
+  dry_run: null,
+  marketing_sender: null,
+  postcard_return_address: null,
+  sms_phone_number: null,
+  transactional_sender: null
+)
+```
+

data/docs/SfvbCommsStat.md

@@ -0,0 +1,54 @@
+# UltracartClient::SfvbCommsStat
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bounced** | **Integer** | Permanent bounces. | [optional] |
+| **channel** | **String** | email, sms, postcard, branch or sequence. | [optional] |
+| **clicked** | **Integer** | Clicks (for a postcard, scans of its QR code). | [optional] |
+| **conversions** | **Integer** | Conversions. | [optional] |
+| **customers** | **Integer** | Customers who reached it (a branch side), or started (a whole sequence). | [optional] |
+| **delivered** | **Integer** | Deliveries. | [optional] |
+| **finished** | **Integer** | Customers who finished the sequence. | [optional] |
+| **in_progress** | **Integer** | Customers in the sequence now. | [optional] |
+| **invalid** | **Integer** | Addresses the email validator refused. | [optional] |
+| **not_measured** | **Array<String>** | The counts this channel doesn't record, left out above. | [optional] |
+| **opened** | **Integer** | Opens. | [optional] |
+| **orders** | **Integer** | Orders attributed. | [optional] |
+| **profit** | **Float** | Profit attributed. | [optional] |
+| **returned_to_sender** | **Integer** | Postcards returned to sender. | [optional] |
+| **revenue** | **Float** | Revenue attributed. | [optional] |
+| **sent** | **Integer** | Sends. | [optional] |
+| **skipped** | **Integer** | Customers skipped. | [optional] |
+| **spam** | **Integer** | Spam complaints. | [optional] |
+| **unsubscribed** | **Integer** | Unsubscribes. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsStat.new(
+  bounced: null,
+  channel: null,
+  clicked: null,
+  conversions: null,
+  customers: null,
+  delivered: null,
+  finished: null,
+  in_progress: null,
+  invalid: null,
+  not_measured: null,
+  opened: null,
+  orders: null,
+  profit: null,
+  returned_to_sender: null,
+  revenue: null,
+  sent: null,
+  skipped: null,
+  spam: null,
+  unsubscribed: null
+)
+```
+

data/docs/SfvbCommsStepStat.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbCommsStepStat
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **branches** | [**Array<SfvbCommsBranchStat>**](SfvbCommsBranchStat.md) | Each side's counts, for a condition, split or InboxGeek step. | [optional] |
+| **email_uuid** | **String** | The email it sends, for an email or experiment variant. | [optional] |
+| **label** | **String** | The step type as the admin shows it. | [optional] |
+| **name** | **String** | The step's name, if it has one. | [optional] |
+| **postcard_uuid** | **String** | The postcard it mails, for a postcard step. | [optional] |
+| **stats** | [**SfvbCommsStat**](SfvbCommsStat.md) |  | [optional] |
+| **step_uuid** | **String** | The step. | [optional] |
+| **type** | **String** | The step type. | [optional] |
+| **variant_name** | **String** | The experiment variant, for an experiment step. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsStepStat.new(
+  branches: null,
+  email_uuid: null,
+  label: null,
+  name: null,
+  postcard_uuid: null,
+  stats: null,
+  step_uuid: null,
+  type: null,
+  variant_name: null
+)
+```
+

data/docs/SfvbCommsTemplate.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbCommsTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | The description. | [optional] |
+| **email_template_oid** | **Integer** | The saved template's id, for a storefront or system template. | [optional] |
+| **name** | **String** | The name. | [optional] |
+| **path** | **String** | The theme file, for a base template. | [optional] |
+| **sort_order** | **Integer** | The admin's order. | [optional] |
+| **source** | **String** | storefront (saved on this storefront), system (UltraCart's), or base (a theme file an email renders inside). | [optional] |
+| **trigger_type** | **String** | The flow trigger the template is meant for, or none. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTemplate.new(
+  description: null,
+  email_template_oid: null,
+  name: null,
+  path: null,
+  sort_order: null,
+  source: null,
+  trigger_type: null
+)
+```
+

data/docs/SfvbCommsTemplateResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbCommsTemplateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **container_cjson** | **String** | The template's body, as CJSON. | [optional] |
+| **email_template_vm_path** | **String** | The Velocity template it renders inside.  Its content isn't shown here. | [optional] |
+| **notes** | **Array<String>** | What isn't shown. | [optional] |
+| **template** | [**SfvbCommsTemplate**](SfvbCommsTemplate.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTemplateResponse.new(
+  container_cjson: null,
+  email_template_vm_path: null,
+  notes: null,
+  template: null
+)
+```
+

data/docs/SfvbCommsTemplatesResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbCommsTemplatesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **notes** | **Array<String>** | What each source is. | [optional] |
+| **templates** | [**Array<SfvbCommsTemplate>**](SfvbCommsTemplate.md) | Saved templates first (system, then this storefront's), then base templates. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTemplatesResponse.new(
+  notes: null,
+  templates: null
+)
+```
+

data/docs/SfvbCommsTestEmailRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbCommsTestEmailRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cart_item_ids** | **Array<String>** | Items for a cart flow's email.  The cart is built for the test. | [optional] |
+| **email_uuid** | **String** | The email, which this step sends.  For an experiment step, one variant's email. | [optional] |
+| **order_id** | **String** | A test order to render an order flow's email with.  A real customer's order is refused. | [optional] |
+| **to_email** | **String** | The recipient, which must be the email address of a user on this account. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTestEmailRequest.new(
+  cart_item_ids: null,
+  email_uuid: null,
+  order_id: null,
+  to_email: null
+)
+```
+

data/docs/SfvbCommsTestPostcardRequest.md

@@ -0,0 +1,36 @@
+# UltracartClient::SfvbCommsTestPostcardRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address1** | **String** | The street address. | [optional] |
+| **address2** | **String** | The second address line. | [optional] |
+| **cart_item_ids** | **Array<String>** | Items for a cart flow's card. | [optional] |
+| **city** | **String** | The city. | [optional] |
+| **dry_run** | **Boolean** | Check everything, including that postcards are turned on, and show the cost, without mailing or using an approval. | [optional] |
+| **mail_card** | **Boolean** | Must be true.  Without it nothing is mailed; use the postcard proof to see the card. | [optional] |
+| **name** | **String** | The recipient's name. | [optional] |
+| **order_id** | **String** | A test order to render an order flow's card with.  A real customer's order is refused. | [optional] |
+| **postal_code** | **String** | The postal code. | [optional] |
+| **state** | **String** | The state. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTestPostcardRequest.new(
+  address1: null,
+  address2: null,
+  cart_item_ids: null,
+  city: null,
+  dry_run: null,
+  mail_card: null,
+  name: null,
+  order_id: null,
+  postal_code: null,
+  state: null
+)
+```
+

data/docs/SfvbCommsTestSendResponse.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbCommsTestSendResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** | For an SMS, the message as sent. | [optional] |
+| **channel** | **String** | email, sms or postcard. | [optional] |
+| **cost** | **Float** | For a postcard, what this card costs the account. | [optional] |
+| **dry_run** | **Boolean** | True when nothing was sent. | [optional] |
+| **notes** | **Array<String>** | What else happened, such as records created by the test. | [optional] |
+| **recipient** | **String** | Who it went to, as a user on this account (their login), or the postcard's city and state. | [optional] |
+| **sent** | **Boolean** | True when it was sent or mailed.  False on a dry run or when it was skipped. | [optional] |
+| **skipped_reason** | **String** | Why it wasn't sent or mailed, when it wasn't. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTestSendResponse.new(
+  body: null,
+  channel: null,
+  cost: null,
+  dry_run: null,
+  notes: null,
+  recipient: null,
+  sent: null,
+  skipped_reason: null
+)
+```
+

data/docs/SfvbCommsTestSmsRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbCommsTestSmsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **to_phone** | **String** | The recipient in E.164 form, such as +14045550100.  It must be the cell phone of a user on this account. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTestSmsRequest.new(
+  to_phone: null
+)
+```
+

data/docs/SfvbFlow.md

@@ -22,6 +22,7 @@
 | **sending_domain_uuid** | **String** | The sending domain uuid.  Defaults to the storefront's marketing sending domain. | [optional] |
 | **sending_name** | **String** | The from name.  Defaults to the storefront's marketing setting. | [optional] |
 | **sending_user** | **String** | The part of the from address before the at sign.  Defaults to the storefront's marketing setting. | [optional] |
+| **sms_phone_number** | **String** | The number this flow's SMS steps send from.  Without one, every SMS step skips every customer, whatever the account's SMS settings say. | [optional] |
 | **status** | **String** | The status, such as draft, active, paused, draining or inactive. | [optional] |
 | **status_dts** | **String** | When the status last changed (ISO 8601, UTC). | [optional] |
 | **trigger_parameter** | **String** | The list or segment uuid, or other value, the trigger is limited to. | [optional] |
@@ -52,6 +53,7 @@ instance = UltracartClient::SfvbFlow.new(
   sending_domain_uuid: null,
   sending_name: null,
   sending_user: null,
+  sms_phone_number: null,
   status: null,
   status_dts: null,
   trigger_parameter: null,

data/docs/SfvbPostcardAddress.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbPostcardAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address_line_1** | **String** | The first street line.  For the recipient, [hidden] unless customer data was asked for. | [optional] |
+| **address_line_2** | **String** | The second street line, masked the same way. | [optional] |
+| **city** | **String** | The city. | [optional] |
+| **name** | **String** | The name.  For the recipient, an initial unless customer data was asked for. | [optional] |
+| **state** | **String** | The state or region. | [optional] |
+| **zip** | **String** | The postal code. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPostcardAddress.new(
+  address_line_1: null,
+  address_line_2: null,
+  city: null,
+  name: null,
+  state: null,
+  zip: null
+)
+```
+

data/docs/SfvbPostcardCard.md

@@ -0,0 +1,40 @@
+# UltracartClient::SfvbPostcardCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversion_dts** | **String** | When the customer ordered after it. | [optional] |
+| **cost** | **Float** | What the account is billed for this card. | [optional] |
+| **customer_uuid** | **String** | The customer it was mailed to. | [optional] |
+| **delivered_dts** | **String** | When it was delivered. | [optional] |
+| **from** | [**SfvbPostcardAddress**](SfvbPostcardAddress.md) |  | [optional] |
+| **mailed_dts** | **String** | When it was mailed. | [optional] |
+| **order_id** | **String** | The order it converted to. | [optional] |
+| **print_record_uuid** | **String** | The print vendor's record for this card. | [optional] |
+| **status** | **String** | The vendor's latest status. | [optional] |
+| **submit_dts** | **String** | When it was sent to the printer. | [optional] |
+| **to** | [**SfvbPostcardAddress**](SfvbPostcardAddress.md) |  | [optional] |
+| **tracking_description** | **String** | The vendor's own words for the latest status.  Only when customer data was asked for, since it can name where the card went. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPostcardCard.new(
+  conversion_dts: null,
+  cost: null,
+  customer_uuid: null,
+  delivered_dts: null,
+  from: null,
+  mailed_dts: null,
+  order_id: null,
+  print_record_uuid: null,
+  status: null,
+  submit_dts: null,
+  to: null,
+  tracking_description: null
+)
+```
+

data/docs/SfvbPostcardTrackingResponse.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbPostcardTrackingResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cards** | [**Array<SfvbPostcardCard>**](SfvbPostcardCard.md) | This page of cards. | [optional] |
+| **customer_data** | **String** | masked, or shown when show_customer_data was sent. | [optional] |
+| **notes** | **Array<String>** | What to keep in mind, such as how to handle customer data that is shown. | [optional] |
+| **page** | **Integer** | The page number, from 1. | [optional] |
+| **page_cost** | **Float** | The total cost of the cards on this page. | [optional] |
+| **page_size** | **Integer** | Cards per page. | [optional] |
+| **postcard_uuid** | **String** | The postcard. | [optional] |
+| **total_cards** | **Integer** | How many cards have been mailed for this postcard. | [optional] |
+| **total_pages** | **Integer** | How many pages there are. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPostcardTrackingResponse.new(
+  cards: null,
+  customer_data: null,
+  notes: null,
+  page: null,
+  page_cost: null,
+  page_size: null,
+  postcard_uuid: null,
+  total_cards: null,
+  total_pages: null
+)
+```
+

data/docs/SfvbTransactionalChange.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbTransactionalChange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | subject, option, sending_domain_uuid, sending_user or sending_name. | [optional] |
+| **from** | **String** | The value before. | [optional] |
+| **name** | **String** | For an option, its name. | [optional] |
+| **to** | **String** | The value after. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTransactionalChange.new(
+  field: null,
+  from: null,
+  name: null,
+  to: null
+)
+```
+

data/docs/SfvbTransactionalDeliveryOption.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbTransactionalDeliveryOption
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | What the option does. | [optional] |
+| **name** | **String** | The option's name.  An update names options by it. | [optional] |
+| **selected** | **Boolean** | True when the option is on. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTransactionalDeliveryOption.new(
+  description: null,
+  name: null,
+  selected: null
+)
+```
+

data/docs/SfvbTransactionalEmailDetail.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbTransactionalEmailDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **delivery_options** | [**Array<SfvbTransactionalDeliveryOption>**](SfvbTransactionalDeliveryOption.md) | Its delivery options.  Empty for an email that has none. | [optional] |
+| **file_name** | **String** | The HTML template file, such as receipt_html.vm. | [optional] |
+| **hash_sha256** | **String** | The hash of the subject, the options and the sender.  Send it as If-Match to change them. | [optional] |
+| **name** | **String** | The display name, such as Order - Receipt. | [optional] |
+| **sender** | [**SfvbTransactionalSender**](SfvbTransactionalSender.md) |  | [optional] |
+| **sender_shared_with** | **Array<String>** | Every storefront on this account that shares the sender, this one included. | [optional] |
+| **subject** | **String** | The subject line. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTransactionalEmailDetail.new(
+  delivery_options: null,
+  file_name: null,
+  hash_sha256: null,
+  name: null,
+  sender: null,
+  sender_shared_with: null,
+  subject: null
+)
+```
+

data/docs/SfvbTransactionalEmailResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbTransactionalEmailResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **changes** | [**Array<SfvbTransactionalChange>**](SfvbTransactionalChange.md) | What the update changes, or would change on a dry run. | [optional] |
+| **dry_run** | **Boolean** | True when nothing was written. | [optional] |
+| **email** | [**SfvbTransactionalEmailDetail**](SfvbTransactionalEmailDetail.md) |  | [optional] |
+| **notes** | **Array<String>** | What the change means, such as the orders it reaches and the storefronts that share a sender. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTransactionalEmailResponse.new(
+  changes: null,
+  dry_run: null,
+  email: null,
+  notes: null
+)
+```
+

data/docs/SfvbTransactionalEmailUpdateRequest.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbTransactionalEmailUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **delivery_options** | [**Array<SfvbTransactionalDeliveryOption>**](SfvbTransactionalDeliveryOption.md) | Options to turn on or off, each by name with selected. | [optional] |
+| **dry_run** | **Boolean** | True to check the change and show it without writing anything or using an approval. | [optional] |
+| **sending_domain_uuid** | **String** | A sending domain on this account. | [optional] |
+| **sending_name** | **String** | The from name. | [optional] |
+| **sending_user** | **String** | The part of the from address before the at sign. | [optional] |
+| **subject** | **String** | The subject line, 1 to 150 characters. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTransactionalEmailUpdateRequest.new(
+  delivery_options: null,
+  dry_run: null,
+  sending_domain_uuid: null,
+  sending_name: null,
+  sending_user: null,
+  subject: null
+)
+```
+

data/docs/SfvbTransactionalSender.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbTransactionalSender
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sending_domain_uuid** | **String** | The sending domain uuid, or none. | [optional] |
+| **sending_name** | **String** | The from name. | [optional] |
+| **sending_user** | **String** | The part of the from address before the at sign. | [optional] |
+| **smtp** | **Boolean** | True when it sends through the merchant's own mail server, which only the admin changes.  Its credentials are never returned. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTransactionalSender.new(
+  sending_domain_uuid: null,
+  sending_name: null,
+  sending_user: null,
+  smtp: null
+)
+```
+