ultracart_api 4.1.231 → 4.1.233

data/docs/SfvbCommsSequenceFoldersResponse.md

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

data/docs/SfvbCommsSequenceStatsResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbCommsSequenceStatsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **communication_sequence_uuid** | **String** | The sequence. | [optional] |
+| **days** | **Integer** | The window, in days, for the step counts. | [optional] |
+| **notes** | **Array<String>** | What the windows are and what a missing count means. | [optional] |
+| **overall** | [**SfvbCommsStat**](SfvbCommsStat.md) |  | [optional] |
+| **steps** | [**Array<SfvbCommsStepStat>**](SfvbCommsStepStat.md) | Each email, SMS, postcard and branch step, in the stored order. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSequenceStatsResponse.new(
+  communication_sequence_uuid: null,
+  days: null,
+  notes: null,
+  overall: null,
+  steps: null
+)
+```
+

data/docs/SfvbCommsSettings.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbCommsSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hash_sha256** | **String** | The hash of the settings.  Send it as If-Match to change them. | [optional] |
+| **machine_open_ignore** | **Boolean** | True when opens by mail privacy proxies are ignored.  Account-wide; changed in the admin. | [optional] |
+| **marketing_sender** | [**SfvbCommsSender**](SfvbCommsSender.md) |  | [optional] |
+| **postcard_return_address** | [**SfvbPostcardAddress**](SfvbPostcardAddress.md) |  | [optional] |
+| **postcard_return_address_complete** | **Boolean** | True when the name, street, city, state and postal code are all set.  Until then postcards fall back as the send code does. | [optional] |
+| **reviews_io_configured** | **Boolean** | True when a Reviews.io key is set for the account. | [optional] |
+| **sms_phone_number** | **String** | The default SMS number the admin offers for a new flow or campaign.  No send reads it.  An SMS step sends from its flow's or campaign's own number. | [optional] |
+| **sms_twilio_uuid** | **String** | The Twilio account that holds sms_phone_number. | [optional] |
+| **transactional_sender** | [**SfvbCommsSender**](SfvbCommsSender.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSettings.new(
+  hash_sha256: null,
+  machine_open_ignore: null,
+  marketing_sender: null,
+  postcard_return_address: null,
+  postcard_return_address_complete: null,
+  reviews_io_configured: null,
+  sms_phone_number: null,
+  sms_twilio_uuid: null,
+  transactional_sender: null
+)
+```
+

data/docs/SfvbCommsSettingsResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbCommsSettingsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **changes** | [**Array<SfvbCommsChange>**](SfvbCommsChange.md) | Each setting the call changed, or would change on a dry run. | [optional] |
+| **dry_run** | **Boolean** | True when nothing was written. | [optional] |
+| **notes** | **Array<String>** | Where each change takes effect. | [optional] |
+| **settings** | [**SfvbCommsSettings**](SfvbCommsSettings.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSettingsResponse.new(
+  changes: null,
+  dry_run: null,
+  notes: null,
+  settings: null
+)
+```
+

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, or step for a step type that records no counts of its own, with every count named in not_measured. | [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,30 @@
+# 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, as stored.  It is looked up in the storefront's active theme. | [optional] |
+| **notes** | **Array<String>** | What isn't shown. | [optional] |
+| **template** | [**SfvbCommsTemplate**](SfvbCommsTemplate.md) |  | [optional] |
+| **template_exists** | **Boolean** | True when the file at template_path exists. | [optional] |
+| **template_note** | **String** | Why there is no template file, or null when there is one. | [optional] |
+| **template_path** | **String** | The theme file that template is, as a render finds it.  Read it with the files endpoints, whose read also reports valid and velocity_errors.  Null when it couldn't be worked out, with template_note saying why. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTemplateResponse.new(
+  container_cjson: null,
+  email_template_vm_path: null,
+  notes: null,
+  template: null,
+  template_exists: null,
+  template_note: null,
+  template_path: 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/SfvbCommsUnreferencedEmail.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbCommsUnreferencedEmail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **container_last_modified_dts** | **String** | When its body last changed. | [optional] |
+| **email_uuid** | **String** | The email. | [optional] |
+| **pending_review** | **Boolean** | True while a review is pending. | [optional] |
+| **rejected** | **Boolean** | True when its last review was rejected. | [optional] |
+| **requires_review** | **Boolean** | True when it needs a review before it can send. | [optional] |
+| **subject** | **String** | Its subject. | [optional] |
+| **version** | **Integer** | Its stored version. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsUnreferencedEmail.new(
+  container_last_modified_dts: null,
+  email_uuid: null,
+  pending_review: null,
+  rejected: null,
+  requires_review: null,
+  subject: null,
+  version: null
+)
+```
+

data/docs/SfvbCommsUnreferencedPostcard.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbCommsUnreferencedPostcard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **back_container_uuid** | **String** | Its back container. | [optional] |
+| **container_last_modified_dts** | **String** | When a side last changed. | [optional] |
+| **front_container_uuid** | **String** | Its front container. | [optional] |
+| **postcard_uuid** | **String** | The postcard. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsUnreferencedPostcard.new(
+  back_container_uuid: null,
+  container_last_modified_dts: null,
+  front_container_uuid: null,
+  postcard_uuid: null
+)
+```
+

data/docs/SfvbCommsUnreferencedResponse.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbCommsUnreferencedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_count** | **Integer** | How many emails no step names. | [optional] |
+| **emails** | [**Array<SfvbCommsUnreferencedEmail>**](SfvbCommsUnreferencedEmail.md) | Emails no step names, most recently changed first. | [optional] |
+| **emails_checked** | **Integer** | How many emails the storefront has. | [optional] |
+| **notes** | **Array<String>** | What the report means, in sentences. | [optional] |
+| **postcard_count** | **Integer** | How many postcards no step names. | [optional] |
+| **postcards** | [**Array<SfvbCommsUnreferencedPostcard>**](SfvbCommsUnreferencedPostcard.md) | Postcards no step names, most recently changed first. | [optional] |
+| **postcards_checked** | **Integer** | How many postcards the storefront has. | [optional] |
+| **sequences_checked** | **Integer** | How many sequences were read for the steps that name them. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsUnreferencedResponse.new(
+  email_count: null,
+  emails: null,
+  emails_checked: null,
+  notes: null,
+  postcard_count: null,
+  postcards: null,
+  postcards_checked: null,
+  sequences_checked: null
+)
+```
+

data/docs/SfvbEmail.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **container_last_modified_dts** | **String** | When the email container was last changed (ISO 8601, UTC). | [optional] |
+| **email_template_vm_path** | **String** | The Velocity template the email body renders inside, as stored, such as templates/template_email.vm.  It is looked up in the storefront's active theme. | [optional] |
 | **email_uuid** | **String** | The email uuid.  The same uuid the email container (owner type email) and the email render take. | [optional] |
 | **hash_sha256** | **String** | Hash of the subject and preview text.  Send it as If-Match when updating.  A change to the email body does not change it. | [optional] |
 | **live** | **Boolean** | True when the email is in a flow or campaign that is sending, so a change reaches customers and needs sfvb_publish.  An email in neither is reported live. | [optional] |
@@ -15,6 +16,9 @@
 | **requires_review** | **Boolean** | True when a change to this email must be reviewed before it sends. | [optional] |
 | **subject** | **String** | The subject line.  Merge tokens such as firstName are filled in at send. | [optional] |
 | **suspended_for_spam** | **Boolean** | True when UltraCart suspended the email for spam.  Edits are refused until the merchant resolves it with UltraCart support. | [optional] |
+| **template_exists** | **Boolean** | True when the file at template_path exists.  False means the email can't render. | [optional] |
+| **template_note** | **String** | Why there is no template file, or null when there is one. | [optional] |
+| **template_path** | **String** | The theme file that template is, as the render finds it.  Read it with the files endpoints, whose read also reports valid and velocity_errors.  Null when it couldn't be worked out, with template_note saying why. | [optional] |
 | **transactional** | **Boolean** | True for a transactional email, which skips the marketing footer rules. | [optional] |
 | **version** | **Integer** | The email version.  Every save adds one. | [optional] |
 
@@ -25,6 +29,7 @@ require 'ultracart_api'
 
 instance = UltracartClient::SfvbEmail.new(
   container_last_modified_dts: null,
+  email_template_vm_path: null,
   email_uuid: null,
   hash_sha256: null,
   live: null,
@@ -35,6 +40,9 @@ instance = UltracartClient::SfvbEmail.new(
   requires_review: null,
   subject: null,
   suspended_for_spam: null,
+  template_exists: null,
+  template_note: null,
+  template_path: null,
   transactional: null,
   version: null
 )

data/docs/SfvbFlow.md

@@ -12,6 +12,8 @@
 | **end_once_customer_purchases** | **Boolean** | True when a customer leaves the flow once they buy from one of its emails. | [optional] |
 | **end_once_customer_purchases_anywhere** | **Boolean** | True when a customer leaves the flow once they buy from any source. | [optional] |
 | **flow_uuid** | **String** | The flow uuid. | [optional] |
+| **folder_name** | **String** | That folder's name. | [optional] |
+| **folder_uuid** | **String** | The flow folder it is filed in, or none. | [optional] |
 | **hash_sha256** | **String** | Send this as If-Match when changing, archiving or turning the flow on or off. | [optional] |
 | **live** | **Boolean** | True when the emails and postcards reach customers now, so a change to one shows at once.  False only in a status that sends nothing. | [optional] |
 | **name** | **String** | The flow name. | [optional] |
@@ -43,6 +45,8 @@ instance = UltracartClient::SfvbFlow.new(
   end_once_customer_purchases: null,
   end_once_customer_purchases_anywhere: null,
   flow_uuid: null,
+  folder_name: null,
+  folder_uuid: null,
   hash_sha256: null,
   live: null,
   name: null,

data/docs/SfvbFlowBackfillRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbFlowBackfillRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dry_run** | **Boolean** | Count who would be enrolled and enroll nobody. | [optional] |
+| **flow_uuid** | **String** | The flow.  Used by a flow.backfill approval request.  The backfill call takes it from the path. | [optional] |
+| **order_days_old** | **Integer** | For an order trigger, how many days of orders to enroll, 1 to 90 (default 5). | [optional] |
+| **relative_to_event** | **Boolean** | For an order trigger, shorten the flow's first wait by each order's age. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFlowBackfillRequest.new(
+  dry_run: null,
+  flow_uuid: null,
+  order_days_old: null,
+  relative_to_event: null
+)
+```
+

data/docs/SfvbFlowBackfillResponse.md

@@ -0,0 +1,38 @@
+# UltracartClient::SfvbFlowBackfillResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **capped** | **Boolean** | True when the plan's customer limit stopped the count. | [optional] |
+| **customers** | **Integer** | How many different customers those are. | [optional] |
+| **dry_run** | **Boolean** | True when nothing was enrolled. | [optional] |
+| **enrollments** | **Integer** | How many enrollments the backfill makes (a purchased product trigger makes one per item). | [optional] |
+| **flow_uuid** | **String** | The flow. | [optional] |
+| **notes** | **Array<String>** | What happens next, in sentences. | [optional] |
+| **order_days_old** | **Integer** | The days of orders, for an order trigger. | [optional] |
+| **relative_to_event** | **Boolean** | Whether the first wait is shortened by each order's age. | [optional] |
+| **segment_rebuild_required** | **Boolean** | True when the segment needs a rebuild, so the count is from its last one. | [optional] |
+| **started** | **Boolean** | True when the backfill started in the background.  The signed-in user is emailed when it ends. | [optional] |
+| **trigger_type** | **String** | The flow's trigger. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFlowBackfillResponse.new(
+  capped: null,
+  customers: null,
+  dry_run: null,
+  enrollments: null,
+  flow_uuid: null,
+  notes: null,
+  order_days_old: null,
+  relative_to_event: null,
+  segment_rebuild_required: null,
+  started: null,
+  trigger_type: null
+)
+```
+

data/docs/SfvbFlowWriteRequest.md

@@ -7,6 +7,7 @@
 | **allow_multiple_concurrent_enrollments** | **Boolean** | True when a customer may be in this flow more than once at a time. | [optional] |
 | **end_once_customer_purchases** | **Boolean** | True to end the flow for a customer once they buy from one of its emails. | [optional] |
 | **end_once_customer_purchases_anywhere** | **Boolean** | True to end the flow for a customer once they buy from any source. | [optional] |
+| **folder_uuid** | **String** | File it in this flow folder.  An empty value takes it out of its folder. | [optional] |
 | **name** | **String** | The flow name, 1 to 250 characters.  Required to create. | [optional] |
 | **reentry_delay_days** | **Integer** | Days before a customer may enter again, 1 to 1095.  Only with after_days. | [optional] |
 | **reentry_policy** | **String** | Whether a customer may enter again, anytime, after_days or never. | [optional] |
@@ -25,6 +26,7 @@ instance = UltracartClient::SfvbFlowWriteRequest.new(
   allow_multiple_concurrent_enrollments: null,
   end_once_customer_purchases: null,
   end_once_customer_purchases_anywhere: null,
+  folder_uuid: null,
   name: null,
   reentry_delay_days: null,
   reentry_policy: null,

data/docs/SfvbStepCounts.md

@@ -10,7 +10,7 @@
 | **opened** | **Integer** | Emails opened. | [optional] |
 | **sent** | **Integer** | Messages sent. | [optional] |
 | **skipped** | **Integer** | Customers who reached the step and were not sent anything.  The dispatch log says why. | [optional] |
-| **source** | **String** | email (the step's email, all time), sequence (the begin step, customers who started the sequence, all time) or step (this step, the last 90 days). | [optional] |
+| **source** | **String** | email (the step's email, all time), sequence (the begin step, customers who started the sequence, all time), resend (a Resend Email step, what it resent, the last 90 days), experiment (an experiment step, its variants together, the last 90 days), sms or postcard (the step's own sends, the last 90 days), step (the end step or a condition, split or InboxGeek step, the last 90 days) or not_recorded (a step type the send path keeps no counts for, such as a wait; no counts are given). | [optional] |
 | **spam** | **Integer** | Spam complaints. | [optional] |
 | **unsubscribed** | **Integer** | Unsubscribes from these messages. | [optional] |