ultracart_api 4.1.231 → 4.1.232

data/docs/SfvbApprovalCreateRequest.md

@@ -6,11 +6,14 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
 | **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 +30,14 @@ require 'ultracart_api'
 instance = UltracartClient::SfvbApprovalCreateRequest.new(
   action: null,
   affiliate_network: null,
+  comms_list_import: null,
+  comms_settings: null,
   content: null,
   experiment_start: null,
   item_attribute_rows: null,
   item_pricing: null,
   params: null,
+  postcard_test_mail: null,
   reason: null,
   redirect_rows: null,
   segment_update: 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/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/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/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. | [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
+)
+```
+