ultracart_api 4.1.232 → 4.1.233

data/docs/SfvbApprovalCreateRequest.md

@@ -10,6 +10,7 @@
 | **comms_settings** | [**SfvbCommsSettingsUpdateRequest**](SfvbCommsSettingsUpdateRequest.md) |  | [optional] |
 | **content** | **String** | For a file.put_script write, the exact script to be written, at most 256 KB.  For tracking_html.put, the exact HTML the write will send, at most 256 KB.  UltraCart reviews it and keeps only its hash, so send the same bytes again on the write.  Leave it out for a revert, which names params.version. | [optional] |
 | **experiment_start** | [**SfvbExperimentStartRequest**](SfvbExperimentStartRequest.md) |  | [optional] |
+| **flow_backfill** | [**SfvbFlowBackfillRequest**](SfvbFlowBackfillRequest.md) |  | [optional] |
 | **item_attribute_rows** | [**Array<SfvbItemAttributeBatchRow>**](SfvbItemAttributeBatchRow.md) | For item.attribute_batch, exactly the rows the batch will send - the dry run's change rows, each with merchant_item_oid and current_sha256.  UltraCart keeps only their hash. | [optional] |
 | **item_pricing** | [**SfvbItemPricingRequest**](SfvbItemPricingRequest.md) |  | [optional] |
 | **params** | [**SfvbApprovalParams**](SfvbApprovalParams.md) |  | [optional] |
@@ -34,6 +35,7 @@ instance = UltracartClient::SfvbApprovalCreateRequest.new(
   comms_settings: null,
   content: null,
   experiment_start: null,
+  flow_backfill: null,
   item_attribute_rows: null,
   item_pricing: null,
   params: null,

data/docs/SfvbCampaign.md

@@ -11,6 +11,8 @@
 | **emails** | [**Array<SfvbCommsEmail>**](SfvbCommsEmail.md) | Its emails, in step order. | [optional] |
 | **end_once_customer_purchases** | **Boolean** | True when a customer leaves the campaign once they buy from one of its emails. | [optional] |
 | **end_once_customer_purchases_anywhere** | **Boolean** | True when a customer leaves the campaign once they buy from any source. | [optional] |
+| **folder_name** | **String** | That folder's name. | [optional] |
+| **folder_uuid** | **String** | The campaign folder it is filed in, or none. | [optional] |
 | **hash_sha256** | **String** | Send this as If-Match when changing or archiving the campaign. | [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] |
 | **memberships** | [**Array<SfvbCampaignMembership>**](SfvbCampaignMembership.md) | The lists and segments it sends to or leaves out. | [optional] |
@@ -38,6 +40,8 @@ instance = UltracartClient::SfvbCampaign.new(
   emails: null,
   end_once_customer_purchases: null,
   end_once_customer_purchases_anywhere: null,
+  folder_name: null,
+  folder_uuid: null,
   hash_sha256: null,
   live: null,
   memberships: null,

data/docs/SfvbCampaignWriteRequest.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **end_once_customer_purchases** | **Boolean** | True to end the campaign for a customer once they buy from one of its emails. | [optional] |
 | **end_once_customer_purchases_anywhere** | **Boolean** | True to end the campaign for a customer once they buy from any source. | [optional] |
+| **folder_uuid** | **String** | File it in this campaign folder.  An empty value takes it out of its folder. | [optional] |
 | **memberships** | [**Array<SfvbCampaignMembership>**](SfvbCampaignMembership.md) | The lists and segments it sends to or leaves out.  Replaces the whole set.  An empty array clears it. | [optional] |
 | **name** | **String** | The campaign name, 1 to 250 characters.  Required to create. | [optional] |
 | **scheduled_dts** | **String** | When to send once started (ISO 8601).  An empty string clears the schedule. | [optional] |
@@ -21,6 +22,7 @@ require 'ultracart_api'
 instance = UltracartClient::SfvbCampaignWriteRequest.new(
   end_once_customer_purchases: null,
   end_once_customer_purchases_anywhere: null,
+  folder_uuid: null,
   memberships: null,
   name: null,
   scheduled_dts: null,

data/docs/SfvbCommsLookupOwner.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbCommsLookupOwner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live** | **Boolean** | True when it is sending now, by the same rule the sequence read uses. | [optional] |
+| **name** | **String** | Its name. | [optional] |
+| **status** | **String** | Its status as stored. | [optional] |
+| **type** | **String** | campaign or flow. | [optional] |
+| **uuid** | **String** | The campaign or flow uuid. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsLookupOwner.new(
+  live: null,
+  name: null,
+  status: null,
+  type: null,
+  uuid: null
+)
+```
+

data/docs/SfvbCommsLookupResponse.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbCommsLookupResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **communication_sequence_uuid** | **String** | The sequence it belongs to, when there is one. | [optional] |
+| **kind** | **String** | campaign, flow, sequence, step, email, postcard, list or segment. | [optional] |
+| **name** | **String** | The campaign, flow, list or segment name, or the email subject. | [optional] |
+| **_next** | **String** | The CLI command that reads it. | [optional] |
+| **notes** | **Array<String>** | What the answer means, in sentences. | [optional] |
+| **owner** | [**SfvbCommsLookupOwner**](SfvbCommsLookupOwner.md) |  | [optional] |
+| **step_uuid** | **String** | The step that sends it, for an email or postcard a step names, or the step itself. | [optional] |
+| **storefront_oid** | **Integer** | The storefront it lives on, for the --storefront option. | [optional] |
+| **uuid** | **String** | The uuid looked up. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsLookupResponse.new(
+  communication_sequence_uuid: null,
+  kind: null,
+  name: null,
+  _next: null,
+  notes: null,
+  owner: null,
+  step_uuid: null,
+  storefront_oid: null,
+  uuid: null
+)
+```
+

data/docs/SfvbCommsRulerValidateRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbCommsRulerValidateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ruler** | **String** | The Event Ruler pattern, as JSON text, the same text the rule's bigquery_ruler holds.  At most 16384 characters. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsRulerValidateRequest.new(
+  ruler: null
+)
+```
+

data/docs/SfvbCommsRulerValidateResponse.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbCommsRulerValidateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_message** | **String** | Why it doesn't compile.  Only when valid is false. | [optional] |
+| **notes** | **Array<String>** | How the pattern is used. | [optional] |
+| **valid** | **Boolean** | True when the pattern compiles, so an Is in BigQuery segment rule will accept it. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsRulerValidateResponse.new(
+  error_message: null,
+  notes: null,
+  valid: null
+)
+```
+

data/docs/SfvbCommsSequenceFolder.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbCommsSequenceFolder
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **folder_uuid** | **String** | The folder. | [optional] |
+| **hash_sha256** | **String** | Send it as If-Match to rename or delete the folder. | [optional] |
+| **item_count** | **Integer** | How many campaigns or flows are filed in it, archived ones left out. | [optional] |
+| **kind** | **String** | campaign or flow, what the folder files. | [optional] |
+| **name** | **String** | Its name. | [optional] |
+| **system_generated** | **Boolean** | True when the admin made it itself.  It can't be renamed or deleted here. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSequenceFolder.new(
+  folder_uuid: null,
+  hash_sha256: null,
+  item_count: null,
+  kind: null,
+  name: null,
+  system_generated: null
+)
+```
+

data/docs/SfvbCommsSequenceFolderResponse.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbCommsSequenceFolderResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **folder** | [**SfvbCommsSequenceFolder**](SfvbCommsSequenceFolder.md) |  | [optional] |
+| **items** | [**Array<SfvbCommsFolderItem>**](SfvbCommsFolderItem.md) | The campaigns or flows filed in it, or after a delete the ones moved to no folder. | [optional] |
+| **notes** | **Array<String>** | What happened, in sentences. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSequenceFolderResponse.new(
+  folder: null,
+  items: null,
+  notes: null
+)
+```
+

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

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **bounced** | **Integer** | Permanent bounces. | [optional] |
-| **channel** | **String** | email, sms, postcard, branch or sequence. | [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] |

data/docs/SfvbCommsTemplateResponse.md

@@ -5,9 +5,12 @@
 | 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] |
+| **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
 
@@ -18,7 +21,10 @@ instance = UltracartClient::SfvbCommsTemplateResponse.new(
   container_cjson: null,
   email_template_vm_path: null,
   notes: null,
-  template: null
+  template: null,
+  template_exists: null,
+  template_note: null,
+  template_path: 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] |