ultracart_api 4.1.228 → 4.1.230

data/docs/SfvbApprovalCreateRequest.md

@@ -14,6 +14,7 @@
 | **reason** | **String** | Why the agent wants to do this, in a sentence.  Shown to the person as unverified text, capped at 500 characters. | [optional] |
 | **redirect_rows** | [**Array<SfvbRedirectDeleteRow>**](SfvbRedirectDeleteRow.md) | For redirect.delete_batch, exactly the rows the batch delete will send, up to 5,000, each with its hash_sha256.  UltraCart keeps only their hash. | [optional] |
 | **segment_update** | [**SfvbCommsSegmentWriteRequest**](SfvbCommsSegmentWriteRequest.md) |  | [optional] |
+| **site_seo** | [**SfvbSiteSeoRequest**](SfvbSiteSeoRequest.md) |  | [optional] |
 | **smart_attribution** | [**SfvbSmartAttributionRequest**](SfvbSmartAttributionRequest.md) |  | [optional] |
 | **tracking_provider** | [**SfvbTrackingProviderRequest**](SfvbTrackingProviderRequest.md) |  | [optional] |
 
@@ -33,6 +34,7 @@ instance = UltracartClient::SfvbApprovalCreateRequest.new(
   reason: null,
   redirect_rows: null,
   segment_update: null,
+  site_seo: null,
   smart_attribution: null,
   tracking_provider: null
 )

data/docs/SfvbCommsFolder.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbCommsFolder
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **folder_uuid** | **String** | The folder uuid. | [optional] |
+| **hash_sha256** | **String** | The hash of the name.  Send it as If-Match to rename or delete the folder. | [optional] |
+| **list_count** | **Integer** | How many lists are filed in it. | [optional] |
+| **name** | **String** | The folder name. | [optional] |
+| **segment_count** | **Integer** | How many segments are filed in it. | [optional] |
+| **system_generated** | **Boolean** | True for a folder the admin manages, which can't be renamed or deleted here. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsFolder.new(
+  folder_uuid: null,
+  hash_sha256: null,
+  list_count: null,
+  name: null,
+  segment_count: null,
+  system_generated: null
+)
+```
+

data/docs/SfvbCommsFolderItem.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbCommsFolderItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The list or segment name. | [optional] |
+| **type** | **String** | list or segment. | [optional] |
+| **uuid** | **String** | The list or segment uuid. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsFolderItem.new(
+  name: null,
+  type: null,
+  uuid: null
+)
+```
+

data/docs/SfvbCommsFolderResponse.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbCommsFolderResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **folder** | [**SfvbCommsFolder**](SfvbCommsFolder.md) |  | [optional] |
+| **items** | [**Array<SfvbCommsFolderItem>**](SfvbCommsFolderItem.md) | The lists and segments filed in it.  After a delete, the ones moved to no folder. | [optional] |
+| **notes** | **Array<String>** | What the change did. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsFolderResponse.new(
+  folder: null,
+  items: null,
+  notes: null
+)
+```
+

data/docs/SfvbCommsFolderWriteRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbCommsFolderWriteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The folder name, 1 to 250 characters. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsFolderWriteRequest.new(
+  name: null
+)
+```
+

data/docs/SfvbCommsFoldersResponse.md

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

data/docs/SfvbCommsListDetail.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbCommsListDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_dts** | **String** | When the list was created. | [optional] |
+| **folder_uuid** | **String** | The list and segment folder it is filed in, or none. | [optional] |
+| **hash_sha256** | **String** | The hash of the name, folder and public settings.  Send it as If-Match to change or archive the list. | [optional] |
+| **list_uuid** | **String** | The list uuid. | [optional] |
+| **member_count** | **Integer** | How many customers are on the list. | [optional] |
+| **name** | **String** | The list name. | [optional] |
+| **public_description** | **String** | The description subscribers see for a public list. | [optional] |
+| **public_list** | **Boolean** | True when subscribers can choose this list on the storefront's email preferences page. | [optional] |
+| **used_by** | [**Array<SfvbCommsSegmentUsedBy>**](SfvbCommsSegmentUsedBy.md) | The campaigns that send to the list and the flows it starts, each with whether it is live. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsListDetail.new(
+  created_dts: null,
+  folder_uuid: null,
+  hash_sha256: null,
+  list_uuid: null,
+  member_count: null,
+  name: null,
+  public_description: null,
+  public_list: null,
+  used_by: null
+)
+```
+

data/docs/SfvbCommsListResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbCommsListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **list** | [**SfvbCommsListDetail**](SfvbCommsListDetail.md) |  | [optional] |
+| **notes** | **Array<String>** | What the change means, such as the campaigns and flows that can no longer use an archived list. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsListResponse.new(
+  list: null,
+  notes: null
+)
+```
+

data/docs/SfvbCommsListWriteRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbCommsListWriteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **folder_uuid** | **String** | A list and segment folder on this storefront, or an empty string for none. | [optional] |
+| **name** | **String** | The list name, 1 to 250 characters.  Required to create. | [optional] |
+| **public_description** | **String** | Plain text subscribers see for a public list, up to 100 characters, or an empty string for none. | [optional] |
+| **public_list** | **Boolean** | True to let subscribers choose this list on the storefront's email preferences page.  Defaults to false. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsListWriteRequest.new(
+  folder_uuid: null,
+  name: null,
+  public_description: null,
+  public_list: null
+)
+```
+

data/docs/SfvbFlowWriteRequest.md

@@ -13,8 +13,8 @@
 | **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] |
-| **trigger_parameter** | **String** | The list or segment uuid for a list or segment trigger.  Create only. | [optional] |
-| **trigger_type** | **String** | What enrolls a customer, such as cart abandoned.  Create only. | [optional] |
+| **trigger_parameter** | **String** | The list or segment uuid for a list or segment trigger.  Cleared when the trigger changes to one that takes none. | [optional] |
+| **trigger_type** | **String** | What enrolls a customer, such as cart abandoned.  Required to create.  On a change, only while the flow is off. | [optional] |
 
 ## Example
 

data/docs/SfvbNotFoundEntry.md

@@ -8,6 +8,7 @@
 | **bot_share** | **Object** | bot_hits divided by counted_hits, 0 to 1.  Empty when not yet counted. | [optional] |
 | **counted_hits** | **Integer** | Hits since bot counting began, the base for bot_share. | [optional] |
 | **first_seen_dts** | **String** | First hit, ISO 8601. | [optional] |
+| **fixed** | **Boolean** | True when the entry is marked fixed or mapped.  The next hit on the path clears it. | [optional] |
 | **hits** | **Integer** | Every recorded hit, bots included. | [optional] |
 | **ignored** | **Boolean** | True when the entry is ignored and no longer counts. | [optional] |
 | **last_seen_dts** | **String** | Latest hit, ISO 8601. | [optional] |
@@ -26,6 +27,7 @@ instance = UltracartClient::SfvbNotFoundEntry.new(
   bot_share: null,
   counted_hits: null,
   first_seen_dts: null,
+  fixed: null,
   hits: null,
   ignored: null,
   last_seen_dts: null,

data/docs/SfvbNotFoundSummary.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbNotFoundSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **last_24_hours** | **Array<Integer>** | 404 hits per hour for the last 24 hours, oldest first. | [optional] |
+| **last_30_days** | **Array<Integer>** | 404 hits per day, oldest first, ending today in the server's time zone.  Bots and shoppers together. | [optional] |
+| **last_7_days** | **Array<Integer>** | 404 hits per day for the last 7 days, oldest first. | [optional] |
+| **new_paths** | [**Array<SfvbNotFoundEntry>**](SfvbNotFoundEntry.md) | Up to 10 open paths first seen in the last 30 days, most hits first, leaving out paths only bots have hit. | [optional] |
+| **notes** | **Array<String>** | What a person should know about reading these counts. | [optional] |
+| **total_30_days** | **Integer** | The sum of last_30_days. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbNotFoundSummary.new(
+  last_24_hours: null,
+  last_30_days: null,
+  last_7_days: null,
+  new_paths: null,
+  notes: null,
+  total_30_days: null
+)
+```
+

data/docs/SfvbRedirectImportRow.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **exclude_from_sitemap** | **Boolean** | True to leave the rule's source out of the generated sitemap.  Left out means false, as in the admin. | [optional] |
 | **note** | **String** | Why the rule exists. | [optional] |
 | **source** | **String** | The path to catch. | [optional] |
 | **target** | **String** | Where to send it. | [optional] |
@@ -14,6 +15,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::SfvbRedirectImportRow.new(
+  exclude_from_sitemap: null,
   note: null,
   source: null,
   target: null

data/docs/SfvbRedirectRequest.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **exclude_from_sitemap** | **Boolean** | True to leave the rule's source out of the generated sitemap.  On a create, left out means false, as in the admin.  On an update, left out keeps the rule's value. | [optional] |
 | **note** | **String** | Why the rule exists, up to 500 characters. | [optional] |
 | **over_live_page** | **Boolean** | Allow a source that is a live, visible page or item, which the rule then hides. | [optional] |
 | **source** | **String** | The path to catch, starting with /.  End it with /* to catch everything below. | [optional] |
@@ -16,6 +17,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::SfvbRedirectRequest.new(
+  exclude_from_sitemap: null,
   note: null,
   over_live_page: null,
   source: null,

data/docs/SfvbRedirectResolveBatchRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbRedirectResolveBatchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **paths** | **Array<String>** | 1 to 1,000 paths, each starting with /.  A query string is kept, as on the single resolve. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirectResolveBatchRequest.new(
+  paths: null
+)
+```
+

data/docs/SfvbRedirectResolveBatchResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbRedirectResolveBatchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **not_found** | **Integer** | How many paths end on a 404 (lands_on not_found), the ones to redirect or create. | [optional] |
+| **redirected** | **Integer** | How many paths at least one rule redirects. | [optional] |
+| **results** | [**Array<SfvbRedirectResolveResponse>**](SfvbRedirectResolveResponse.md) | One result per path, in the order sent, the same as the single resolve's answer. | [optional] |
+| **total** | **Integer** | How many paths were resolved. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirectResolveBatchResponse.new(
+  not_found: null,
+  redirected: null,
+  results: null,
+  total: null
+)
+```
+

data/docs/SfvbSequenceStep.md

@@ -11,7 +11,7 @@
 | **disabled** | **Boolean** | True when the step is switched off in its settings. | [optional] |
 | **email_uuids** | **Array<String>** | The emails it sends.  One for an email step, one per variant for an experiment. | [optional] |
 | **filter_profile_equation_json** | **String** | The step's audience filter as stored, when it has one. | [optional] |
-| **hash_sha256** | **String** | The hash of the step's type, stored settings and audience filter.  Send it back as If-Match when changing the step. | [optional] |
+| **hash_sha256** | **String** | The hash of the step's type, stored settings and audience filter.  Send it back as If-Match when changing the step.  What a running flow records in the settings (a resend step's resend mappings, a rate limiter's inventory refresh time, an experiment's winner) doesn't count.  An email step's smartSending and magicLink are the email's own settings, so the email's hash_sha256 guards them, not this one. | [optional] |
 | **item_ids** | **Array<String>** | The items it names, for a cart or rate limiter step. | [optional] |
 | **label** | **String** | The type as the admin names it, such as Time Delay.  The type itself for one it doesn't know. | [optional] |
 | **list_uuids** | **Array<String>** | The lists it subscribes or unsubscribes, for a list step. | [optional] |

data/docs/SfvbSiteSeo.md

@@ -0,0 +1,40 @@
+# UltracartClient::SfvbSiteSeo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **approval_needed** | **Boolean** | On a change, true when it needs an approved site_seo.change request. | [optional] |
+| **canonical** | **Boolean** | True when pages output canonical links. | [optional] |
+| **changed** | **Boolean** | On a change, true when anything was saved, or would be on a dry run. | [optional] |
+| **changes** | [**Array<SfvbSiteSeoChange>**](SfvbSiteSeoChange.md) | On a change, each switch it changed, or would change on a dry run. | [optional] |
+| **description** | **String** | The default meta description, the storefrontSEODescription site attribute. | [optional] |
+| **dry_run** | **Boolean** | True when nothing was saved because the request was a dry run. | [optional] |
+| **hash_sha256** | **String** | The hash of the three switches.  Send it as If-Match on a change. | [optional] |
+| **keywords** | **String** | The default meta keywords, the storefrontSEOKeywords site attribute. | [optional] |
+| **notes** | **Array<String>** | What a person should know about these settings. | [optional] |
+| **prevent_indexing** | **Boolean** | True when every page tells search engines not to index it.  For a development store only. | [optional] |
+| **schema_org** | **Boolean** | True when pages output Schema.org structured data. | [optional] |
+| **storefront_oid** | **Integer** | The storefront. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSiteSeo.new(
+  approval_needed: null,
+  canonical: null,
+  changed: null,
+  changes: null,
+  description: null,
+  dry_run: null,
+  hash_sha256: null,
+  keywords: null,
+  notes: null,
+  prevent_indexing: null,
+  schema_org: null,
+  storefront_oid: null
+)
+```
+

data/docs/SfvbSiteSeoChange.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbSiteSeoChange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **approval_needed** | **Boolean** | True when this change needs an approved site_seo.change request. | [optional] |
+| **fresh_code** | **Boolean** | True when the approval asks for an authenticator code even inside an open approval session. | [optional] |
+| **from** | **Boolean** | The value before. | [optional] |
+| **setting** | **String** | canonical, schema_org or prevent_indexing. | [optional] |
+| **to** | **Boolean** | The value after. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSiteSeoChange.new(
+  approval_needed: null,
+  fresh_code: null,
+  from: null,
+  setting: null,
+  to: null
+)
+```
+

data/docs/SfvbSiteSeoRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbSiteSeoRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **canonical** | **Boolean** | True to turn Canonical Links on.  Turning them off needs an approved site_seo.change request. | [optional] |
+| **dry_run** | **Boolean** | True to check the change and report it without saving. | [optional] |
+| **prevent_indexing** | **Boolean** | True to tell search engines not to index any page.  Either direction needs an approved site_seo.change request, and turning it on needs a fresh authenticator code. | [optional] |
+| **schema_org** | **Boolean** | True to turn Schema.org structured data on.  Turning it off needs an approved site_seo.change request. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSiteSeoRequest.new(
+  canonical: null,
+  dry_run: null,
+  prevent_indexing: null,
+  schema_org: 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) 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) or step (this step, the last 90 days). | [optional] |
 | **spam** | **Integer** | Spam complaints. | [optional] |
 | **unsubscribed** | **Integer** | Unsubscribes from these messages. | [optional] |