ultracart_api 4.1.229 → 4.1.230

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/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/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] |