ultracart_api 4.1.229 → 4.1.231

data/docs/SfvbApprovalCreateRequest.md

@@ -17,6 +17,7 @@
 | **site_seo** | [**SfvbSiteSeoRequest**](SfvbSiteSeoRequest.md) |  | [optional] |
 | **smart_attribution** | [**SfvbSmartAttributionRequest**](SfvbSmartAttributionRequest.md) |  | [optional] |
 | **tracking_provider** | [**SfvbTrackingProviderRequest**](SfvbTrackingProviderRequest.md) |  | [optional] |
+| **transactional_email** | [**SfvbTransactionalEmailUpdateRequest**](SfvbTransactionalEmailUpdateRequest.md) |  | [optional] |
 
 ## Example
 
@@ -36,7 +37,8 @@ instance = UltracartClient::SfvbApprovalCreateRequest.new(
   segment_update: null,
   site_seo: null,
   smart_attribution: null,
-  tracking_provider: null
+  tracking_provider: null,
+  transactional_email: null
 )
 ```
 

data/docs/SfvbCampaign.md

@@ -21,6 +21,7 @@
 | **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] |
+| **sms_phone_number** | **String** | The number this campaign's SMS steps send from.  Without one, every SMS step skips every customer, whatever the account's SMS settings say. | [optional] |
 | **status** | **String** | The status, such as draft, scheduled, sending, sent or archived. | [optional] |
 | **status_dts** | **String** | When the status last changed (ISO 8601, UTC). | [optional] |
 
@@ -47,6 +48,7 @@ instance = UltracartClient::SfvbCampaign.new(
   sending_domain_uuid: null,
   sending_name: null,
   sending_user: null,
+  sms_phone_number: null,
   status: null,
   status_dts: 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/SfvbCommsMember.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbCommsMember
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **added_dts** | **String** | When the customer joined the list or segment. | [optional] |
+| **customer_uuid** | **String** | The customer uuid, the same on every list, segment and flow. | [optional] |
+| **email** | **String** | The email address, masked as w***a@example.com unless show_customer_data was sent. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsMember.new(
+  added_dts: null,
+  customer_uuid: null,
+  email: null
+)
+```
+

data/docs/SfvbCommsMembersResponse.md

@@ -0,0 +1,36 @@
+# UltracartClient::SfvbCommsMembersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_data** | **String** | masked, or shown when show_customer_data was sent. | [optional] |
+| **list_uuid** | **String** | The list, for a list's members. | [optional] |
+| **members** | [**Array<SfvbCommsMember>**](SfvbCommsMember.md) | This page of members. | [optional] |
+| **notes** | **Array<String>** | What to keep in mind, such as how to handle customer data that is shown. | [optional] |
+| **page** | **Integer** | The page number, from 1. | [optional] |
+| **page_size** | **Integer** | Members per page. | [optional] |
+| **rebuild_required** | **Boolean** | For a segment, true while it is being rebuilt, so the members are from the last rebuild. | [optional] |
+| **segment_uuid** | **String** | The segment, for a segment's members. | [optional] |
+| **total_members** | **Integer** | How many members there are. | [optional] |
+| **total_pages** | **Integer** | How many pages there are. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsMembersResponse.new(
+  customer_data: null,
+  list_uuid: null,
+  members: null,
+  notes: null,
+  page: null,
+  page_size: null,
+  rebuild_required: null,
+  segment_uuid: null,
+  total_members: null,
+  total_pages: null
+)
+```
+

data/docs/SfvbFlow.md

@@ -22,6 +22,7 @@
 | **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] |
+| **sms_phone_number** | **String** | The number this flow's SMS steps send from.  Without one, every SMS step skips every customer, whatever the account's SMS settings say. | [optional] |
 | **status** | **String** | The status, such as draft, active, paused, draining or inactive. | [optional] |
 | **status_dts** | **String** | When the status last changed (ISO 8601, UTC). | [optional] |
 | **trigger_parameter** | **String** | The list or segment uuid, or other value, the trigger is limited to. | [optional] |
@@ -52,6 +53,7 @@ instance = UltracartClient::SfvbFlow.new(
   sending_domain_uuid: null,
   sending_name: null,
   sending_user: null,
+  sms_phone_number: null,
   status: null,
   status_dts: null,
   trigger_parameter: 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/SfvbPostcardAddress.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbPostcardAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address_line_1** | **String** | The first street line.  For the recipient, [hidden] unless customer data was asked for. | [optional] |
+| **address_line_2** | **String** | The second street line, masked the same way. | [optional] |
+| **city** | **String** | The city. | [optional] |
+| **name** | **String** | The name.  For the recipient, an initial unless customer data was asked for. | [optional] |
+| **state** | **String** | The state or region. | [optional] |
+| **zip** | **String** | The postal code. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPostcardAddress.new(
+  address_line_1: null,
+  address_line_2: null,
+  city: null,
+  name: null,
+  state: null,
+  zip: null
+)
+```
+

data/docs/SfvbPostcardCard.md

@@ -0,0 +1,40 @@
+# UltracartClient::SfvbPostcardCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversion_dts** | **String** | When the customer ordered after it. | [optional] |
+| **cost** | **Float** | What the account is billed for this card. | [optional] |
+| **customer_uuid** | **String** | The customer it was mailed to. | [optional] |
+| **delivered_dts** | **String** | When it was delivered. | [optional] |
+| **from** | [**SfvbPostcardAddress**](SfvbPostcardAddress.md) |  | [optional] |
+| **mailed_dts** | **String** | When it was mailed. | [optional] |
+| **order_id** | **String** | The order it converted to. | [optional] |
+| **print_record_uuid** | **String** | The print vendor's record for this card. | [optional] |
+| **status** | **String** | The vendor's latest status. | [optional] |
+| **submit_dts** | **String** | When it was sent to the printer. | [optional] |
+| **to** | [**SfvbPostcardAddress**](SfvbPostcardAddress.md) |  | [optional] |
+| **tracking_description** | **String** | The vendor's own words for the latest status.  Only when customer data was asked for, since it can name where the card went. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPostcardCard.new(
+  conversion_dts: null,
+  cost: null,
+  customer_uuid: null,
+  delivered_dts: null,
+  from: null,
+  mailed_dts: null,
+  order_id: null,
+  print_record_uuid: null,
+  status: null,
+  submit_dts: null,
+  to: null,
+  tracking_description: null
+)
+```
+

data/docs/SfvbPostcardTrackingResponse.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbPostcardTrackingResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cards** | [**Array<SfvbPostcardCard>**](SfvbPostcardCard.md) | This page of cards. | [optional] |
+| **customer_data** | **String** | masked, or shown when show_customer_data was sent. | [optional] |
+| **notes** | **Array<String>** | What to keep in mind, such as how to handle customer data that is shown. | [optional] |
+| **page** | **Integer** | The page number, from 1. | [optional] |
+| **page_cost** | **Float** | The total cost of the cards on this page. | [optional] |
+| **page_size** | **Integer** | Cards per page. | [optional] |
+| **postcard_uuid** | **String** | The postcard. | [optional] |
+| **total_cards** | **Integer** | How many cards have been mailed for this postcard. | [optional] |
+| **total_pages** | **Integer** | How many pages there are. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPostcardTrackingResponse.new(
+  cards: null,
+  customer_data: null,
+  notes: null,
+  page: null,
+  page_cost: null,
+  page_size: null,
+  postcard_uuid: null,
+  total_cards: null,
+  total_pages: 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/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] |
 

data/docs/SfvbTransactionalChange.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbTransactionalChange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | subject, option, sending_domain_uuid, sending_user or sending_name. | [optional] |
+| **from** | **String** | The value before. | [optional] |
+| **name** | **String** | For an option, its name. | [optional] |
+| **to** | **String** | The value after. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTransactionalChange.new(
+  field: null,
+  from: null,
+  name: null,
+  to: null
+)
+```
+

data/docs/SfvbTransactionalDeliveryOption.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbTransactionalDeliveryOption
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | What the option does. | [optional] |
+| **name** | **String** | The option's name.  An update names options by it. | [optional] |
+| **selected** | **Boolean** | True when the option is on. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTransactionalDeliveryOption.new(
+  description: null,
+  name: null,
+  selected: null
+)
+```
+

data/docs/SfvbTransactionalEmailDetail.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbTransactionalEmailDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **delivery_options** | [**Array<SfvbTransactionalDeliveryOption>**](SfvbTransactionalDeliveryOption.md) | Its delivery options.  Empty for an email that has none. | [optional] |
+| **file_name** | **String** | The HTML template file, such as receipt_html.vm. | [optional] |
+| **hash_sha256** | **String** | The hash of the subject, the options and the sender.  Send it as If-Match to change them. | [optional] |
+| **name** | **String** | The display name, such as Order - Receipt. | [optional] |
+| **sender** | [**SfvbTransactionalSender**](SfvbTransactionalSender.md) |  | [optional] |
+| **sender_shared_with** | **Array<String>** | Every storefront on this account that shares the sender, this one included. | [optional] |
+| **subject** | **String** | The subject line. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTransactionalEmailDetail.new(
+  delivery_options: null,
+  file_name: null,
+  hash_sha256: null,
+  name: null,
+  sender: null,
+  sender_shared_with: null,
+  subject: null
+)
+```
+

data/docs/SfvbTransactionalEmailResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbTransactionalEmailResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **changes** | [**Array<SfvbTransactionalChange>**](SfvbTransactionalChange.md) | What the update changes, or would change on a dry run. | [optional] |
+| **dry_run** | **Boolean** | True when nothing was written. | [optional] |
+| **email** | [**SfvbTransactionalEmailDetail**](SfvbTransactionalEmailDetail.md) |  | [optional] |
+| **notes** | **Array<String>** | What the change means, such as the orders it reaches and the storefronts that share a sender. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTransactionalEmailResponse.new(
+  changes: null,
+  dry_run: null,
+  email: null,
+  notes: null
+)
+```
+

data/docs/SfvbTransactionalEmailUpdateRequest.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbTransactionalEmailUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **delivery_options** | [**Array<SfvbTransactionalDeliveryOption>**](SfvbTransactionalDeliveryOption.md) | Options to turn on or off, each by name with selected. | [optional] |
+| **dry_run** | **Boolean** | True to check the change and show it without writing anything or using an approval. | [optional] |
+| **sending_domain_uuid** | **String** | A sending domain on this account. | [optional] |
+| **sending_name** | **String** | The from name. | [optional] |
+| **sending_user** | **String** | The part of the from address before the at sign. | [optional] |
+| **subject** | **String** | The subject line, 1 to 150 characters. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTransactionalEmailUpdateRequest.new(
+  delivery_options: null,
+  dry_run: null,
+  sending_domain_uuid: null,
+  sending_name: null,
+  sending_user: null,
+  subject: null
+)
+```
+

data/docs/SfvbTransactionalSender.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbTransactionalSender
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **smtp** | **Boolean** | True when it sends through the merchant's own mail server, which only the admin changes.  Its credentials are never returned. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTransactionalSender.new(
+  sending_domain_uuid: null,
+  sending_name: null,
+  sending_user: null,
+  smtp: null
+)
+```
+