ultracart_api 4.1.231 → 4.1.233

data/docs/SfvbApprovalCreateRequest.md

@@ -6,11 +6,15 @@
 | ---- | ---- | ----------- | ----- |
 | **action** | **String** | The gated action to approve. | [optional] |
 | **affiliate_network** | [**SfvbAffiliateNetworkRequest**](SfvbAffiliateNetworkRequest.md) |  | [optional] |
+| **comms_list_import** | [**SfvbCommsProviderImportRequest**](SfvbCommsProviderImportRequest.md) |  | [optional] |
+| **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] |
+| **postcard_test_mail** | [**SfvbCommsTestPostcardRequest**](SfvbCommsTestPostcardRequest.md) |  | [optional] |
 | **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] |
@@ -27,11 +31,15 @@ require 'ultracart_api'
 instance = UltracartClient::SfvbApprovalCreateRequest.new(
   action: null,
   affiliate_network: null,
+  comms_list_import: null,
+  comms_settings: null,
   content: null,
   experiment_start: null,
+  flow_backfill: null,
   item_attribute_rows: null,
   item_pricing: null,
   params: null,
+  postcard_test_mail: null,
   reason: null,
   redirect_rows: null,
   segment_update: 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/SfvbCommsBranchStat.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbCommsBranchStat
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | The side, as the admin names it (yes or no, left or right). | [optional] |
+| **stats** | [**SfvbCommsStat**](SfvbCommsStat.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsBranchStat.new(
+  label: null,
+  stats: null
+)
+```
+

data/docs/SfvbCommsChange.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbCommsChange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | The setting, such as postcard_return_address.city or marketing_sender.sending_domain_uuid. | [optional] |
+| **from** | **String** | The value before, or none. | [optional] |
+| **to** | **String** | The value after, or none. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsChange.new(
+  field: null,
+  from: null,
+  to: null
+)
+```
+

data/docs/SfvbCommsClick.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbCommsClick
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **clicks** | **Integer** | Clicks in the window. | [optional] |
+| **url** | **String** | The link. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsClick.new(
+  clicks: null,
+  url: null
+)
+```
+

data/docs/SfvbCommsClicksResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbCommsClicksResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **clicks** | [**Array<SfvbCommsClick>**](SfvbCommsClick.md) | Each link, most clicked first. | [optional] |
+| **days** | **Integer** | The window, in days. | [optional] |
+| **email_uuid** | **String** | The email. | [optional] |
+| **notes** | **Array<String>** | What the counts cover. | [optional] |
+| **step_uuid** | **String** | The step that sends it. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsClicksResponse.new(
+  clicks: null,
+  days: null,
+  email_uuid: null,
+  notes: null,
+  step_uuid: null
+)
+```
+

data/docs/SfvbCommsDailyStat.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbCommsDailyStat
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bounced** | **Integer** | Emails bounced. | [optional] |
+| **date** | **String** | The day. | [optional] |
+| **delivered** | **Integer** | Emails delivered. | [optional] |
+| **revenue** | **Float** | Revenue attributed. | [optional] |
+| **sequence_sent** | **Integer** | Flow and campaign emails sent. | [optional] |
+| **spam** | **Integer** | Spam complaints. | [optional] |
+| **transactional_sent** | **Integer** | Transactional emails sent. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsDailyStat.new(
+  bounced: null,
+  date: null,
+  delivered: null,
+  revenue: null,
+  sequence_sent: null,
+  spam: null,
+  transactional_sent: null
+)
+```
+

data/docs/SfvbCommsDashboardResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbCommsDashboardResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **daily** | [**Array<SfvbCommsDailyStat>**](SfvbCommsDailyStat.md) | The account's last 31 days of sending, whatever the window. | [optional] |
+| **days** | **Integer** | The window, in days, for the rows. | [optional] |
+| **notes** | **Array<String>** | What the windows are. | [optional] |
+| **rows** | [**Array<SfvbCommsDashboardRow>**](SfvbCommsDashboardRow.md) | Each flow and campaign with counts in the window. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsDashboardResponse.new(
+  daily: null,
+  days: null,
+  notes: null,
+  rows: null
+)
+```
+

data/docs/SfvbCommsDashboardRow.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbCommsDashboardRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deleted** | **Boolean** | True when it is archived. | [optional] |
+| **name** | **String** | Its name. | [optional] |
+| **stats** | [**SfvbCommsStat**](SfvbCommsStat.md) |  | [optional] |
+| **status** | **String** | Its status. | [optional] |
+| **type** | **String** | flow or campaign. | [optional] |
+| **uuid** | **String** | The flow or campaign uuid. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsDashboardRow.new(
+  deleted: null,
+  name: null,
+  stats: null,
+  status: null,
+  type: null,
+  uuid: 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/SfvbCommsPlan.md

@@ -0,0 +1,66 @@
+# UltracartClient::SfvbCommsPlan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active_customers** | **Integer** | Customers being mailed now. | [optional] |
+| **allow_list_import** | **Boolean** | True when the account may import lists from another email provider. | [optional] |
+| **allow_tracking_emails** | **Boolean** | True when shipment tracking emails are allowed. | [optional] |
+| **bounce_count** | **Integer** | Emails bounced. | [optional] |
+| **bounce_percentage** | **Float** | The bounce percentage. | [optional] |
+| **delivered_count** | **Integer** | Emails delivered. | [optional] |
+| **initial_sending_limits** | **Integer** | The starting sending limit for a new account. | [optional] |
+| **max_active_customers** | **Integer** | The most customers the plan mails. | [optional] |
+| **max_emails_per_day** | **Integer** | The daily sending cap. | [optional] |
+| **max_emails_per_hour** | **Integer** | The hourly sending cap. | [optional] |
+| **max_emails_per_month** | **Integer** | The monthly sending cap. | [optional] |
+| **paused_for_spam** | **Boolean** | True when sending is paused for spam complaints. | [optional] |
+| **plan_customers** | **Integer** | Customers the plan covers. | [optional] |
+| **plan_emails** | **Integer** | Emails a month the plan covers. | [optional] |
+| **plan_name** | **String** | The plan, such as small. | [optional] |
+| **plan_name_formatted** | **String** | The plan's display name. | [optional] |
+| **require_order_within_last_days** | **Integer** | When set, only customers who ordered within this many days are mailed. | [optional] |
+| **sent_emails_per_day** | **Integer** | Emails sent in the last day. | [optional] |
+| **sent_emails_per_hour** | **Integer** | Emails sent in the last hour. | [optional] |
+| **sent_emails_per_month** | **Integer** | Emails sent in the last month. | [optional] |
+| **spam_count** | **Integer** | Spam complaints. | [optional] |
+| **spam_percent_limit** | **Integer** | The spam complaint percentage at which sending pauses. | [optional] |
+| **spam_percentage** | **Float** | The spam complaint percentage. | [optional] |
+| **total_customers** | **Integer** | Customers allowed in all. | [optional] |
+| **total_emails** | **Integer** | Emails a month allowed in all. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsPlan.new(
+  active_customers: null,
+  allow_list_import: null,
+  allow_tracking_emails: null,
+  bounce_count: null,
+  bounce_percentage: null,
+  delivered_count: null,
+  initial_sending_limits: null,
+  max_active_customers: null,
+  max_emails_per_day: null,
+  max_emails_per_hour: null,
+  max_emails_per_month: null,
+  paused_for_spam: null,
+  plan_customers: null,
+  plan_emails: null,
+  plan_name: null,
+  plan_name_formatted: null,
+  require_order_within_last_days: null,
+  sent_emails_per_day: null,
+  sent_emails_per_hour: null,
+  sent_emails_per_month: null,
+  spam_count: null,
+  spam_percent_limit: null,
+  spam_percentage: null,
+  total_customers: null,
+  total_emails: null
+)
+```
+

data/docs/SfvbCommsPlanResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbCommsPlanResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **notes** | **Array<String>** | What stands out, such as a paused account or a cap nearly reached. | [optional] |
+| **plan** | [**SfvbCommsPlan**](SfvbCommsPlan.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsPlanResponse.new(
+  notes: null,
+  plan: null
+)
+```
+

data/docs/SfvbCommsProvider.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbCommsProvider
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connected** | **Boolean** | True when the account has connected this provider.  One that isn't connected has no lists and is connected in the admin. | [optional] |
+| **lists** | [**Array<SfvbCommsProviderList>**](SfvbCommsProviderList.md) | The provider's lists. | [optional] |
+| **logo_url** | **String** | The provider's logo. | [optional] |
+| **name** | **String** | The provider, such as Mailchimp. | [optional] |
+| **supports_list_unsubscribe** | **Boolean** | True when the provider supports unsubscribing. | [optional] |
+| **supports_tags** | **Boolean** | True when the provider supports contact tags. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsProvider.new(
+  connected: null,
+  lists: null,
+  logo_url: null,
+  name: null,
+  supports_list_unsubscribe: null,
+  supports_tags: null
+)
+```
+

data/docs/SfvbCommsProviderImportRequest.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbCommsProviderImportRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dry_run** | **Boolean** | Check the import and name what it would create, without importing or using an approval. | [optional] |
+| **list_ids** | **Array<String>** | The provider's list ids to import. | [optional] |
+| **provider** | **String** | The provider's name, from the providers list. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsProviderImportRequest.new(
+  dry_run: null,
+  list_ids: null,
+  provider: null
+)
+```
+

data/docs/SfvbCommsProviderImportResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbCommsProviderImportResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dry_run** | **Boolean** | True when nothing was imported. | [optional] |
+| **lists** | [**Array<SfvbCommsProviderList>**](SfvbCommsProviderList.md) | The lists imported, each into a new list of the same name. | [optional] |
+| **notes** | **Array<String>** | What the import does. | [optional] |
+| **provider** | **String** | The provider. | [optional] |
+| **queued** | **Boolean** | True when the import was started.  It runs in the background and emails the signed-in user when done. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsProviderImportResponse.new(
+  dry_run: null,
+  lists: null,
+  notes: null,
+  provider: null,
+  queued: null
+)
+```
+

data/docs/SfvbCommsProviderList.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbCommsProviderList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The provider's list id. | [optional] |
+| **name** | **String** | The list name. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsProviderList.new(
+  id: null,
+  name: null
+)
+```
+

data/docs/SfvbCommsProvidersResponse.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbCommsProvidersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **import_allowed** | **Boolean** | True when the account may import lists. | [optional] |
+| **notes** | **Array<String>** | Why import isn't allowed, and what an import does. | [optional] |
+| **providers** | [**Array<SfvbCommsProvider>**](SfvbCommsProvider.md) | Each connected provider that can share list members. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsProvidersResponse.new(
+  import_allowed: null,
+  notes: null,
+  providers: 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/SfvbCommsSender.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbCommsSender
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sending_domain** | **String** | The sending domain's name, such as mail.example.com. | [optional] |
+| **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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSender.new(
+  sending_domain: null,
+  sending_domain_uuid: null,
+  sending_name: null,
+  sending_user: null
+)
+```
+

data/docs/SfvbCommsSenderUpdate.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbCommsSenderUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sending_domain_uuid** | **String** | A sending domain on this account. | [optional] |
+| **sending_name** | **String** | The from name, one line. | [optional] |
+| **sending_user** | **String** | The part of the from address before the at sign. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSenderUpdate.new(
+  sending_domain_uuid: null,
+  sending_name: null,
+  sending_user: 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
+)
+```
+