ultracart_api 4.1.208 → 4.1.210

data/docs/SfvbArchiveRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbArchiveRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **archived** | **Boolean** | True to archive, false to unarchive. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbArchiveRequest.new(
+  archived: null
+)
+```
+

data/docs/SfvbCampaign.md

@@ -9,10 +9,18 @@
 | **created_dts** | **String** | When the campaign was created (ISO 8601, UTC). | [optional] |
 | **deleted** | **Boolean** | True when the campaign was deleted. | [optional] |
 | **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] |
+| **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] |
 | **name** | **String** | The campaign name. | [optional] |
+| **notes** | **Array<String>** | What a write did beyond the fields it was asked to change, such as putting emails back to needing review or setting a scheduled campaign back to draft.  Only on a write. | [optional] |
 | **postcards** | [**Array<SfvbCommsPostcard>**](SfvbCommsPostcard.md) | Its postcards, in step order. | [optional] |
 | **scheduled_dts** | **String** | When the campaign is scheduled to send (ISO 8601, UTC), when it is. | [optional] |
+| **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] |
 | **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] |
 
@@ -27,10 +35,18 @@ instance = UltracartClient::SfvbCampaign.new(
   created_dts: null,
   deleted: null,
   emails: null,
+  end_once_customer_purchases: null,
+  end_once_customer_purchases_anywhere: null,
+  hash_sha256: null,
   live: null,
+  memberships: null,
   name: null,
+  notes: null,
   postcards: null,
   scheduled_dts: null,
+  sending_domain_uuid: null,
+  sending_name: null,
+  sending_user: null,
   status: null,
   status_dts: null
 )

data/docs/SfvbCampaignMembership.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbCampaignMembership
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **exclude** | **Boolean** | True to leave its members out instead of sending to them. | [optional] |
+| **list_uuid** | **String** | The list uuid, for a list. | [optional] |
+| **name** | **String** | The list or segment name.  Set by the server. | [optional] |
+| **segment_uuid** | **String** | The segment uuid, for a segment. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCampaignMembership.new(
+  exclude: null,
+  list_uuid: null,
+  name: null,
+  segment_uuid: null
+)
+```
+

data/docs/SfvbCampaignWriteRequest.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbCampaignWriteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCampaignWriteRequest.new(
+  end_once_customer_purchases: null,
+  end_once_customer_purchases_anywhere: null,
+  memberships: null,
+  name: null,
+  scheduled_dts: null,
+  sending_domain_uuid: null,
+  sending_name: null,
+  sending_user: null
+)
+```
+

data/docs/SfvbCommsEmail.md

@@ -14,6 +14,9 @@
 | **step_uuid** | **String** | The step that sends this email. | [optional] |
 | **subject** | **String** | The subject line. | [optional] |
 | **transactional** | **Boolean** | True for a transactional email, which skips the marketing footer rules. | [optional] |
+| **variant_name** | **String** | For an email in an experiment step, the variant name.  Absent otherwise. | [optional] |
+| **variant_percentage** | **Float** | For an email in an experiment step, the share of customers it is sent to. | [optional] |
+| **variant_winner** | **Boolean** | For an email in an experiment step, true when the experiment chose it as the winner. | [optional] |
 | **version** | **Integer** | The email version. | [optional] |
 
 ## Example
@@ -32,6 +35,9 @@ instance = UltracartClient::SfvbCommsEmail.new(
   step_uuid: null,
   subject: null,
   transactional: null,
+  variant_name: null,
+  variant_percentage: null,
+  variant_winner: null,
   version: null
 )
 ```

data/docs/SfvbCommsList.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbCommsList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_dts** | **String** | When it was created (ISO 8601, UTC). | [optional] |
+| **list_uuid** | **String** | The list uuid. | [optional] |
+| **member_count** | **Integer** | How many customers are on it. | [optional] |
+| **name** | **String** | The list name. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsList.new(
+  created_dts: null,
+  list_uuid: null,
+  member_count: null,
+  name: null
+)
+```
+

data/docs/SfvbCommsListsResponse.md

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

data/docs/SfvbCommsSegment.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbCommsSegment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_dts** | **String** | When it was created (ISO 8601, UTC). | [optional] |
+| **member_count** | **Integer** | How many customers it held at its last rebuild. | [optional] |
+| **name** | **String** | The segment name. | [optional] |
+| **rebuild_required** | **Boolean** | True when the rule changed and the count is out of date until the segment rebuilds. | [optional] |
+| **segment_uuid** | **String** | The segment uuid. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsSegment.new(
+  created_dts: null,
+  member_count: null,
+  name: null,
+  rebuild_required: null,
+  segment_uuid: null
+)
+```
+

data/docs/SfvbCommsSegmentsResponse.md

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

data/docs/SfvbEmail.md

@@ -8,6 +8,7 @@
 | **email_uuid** | **String** | The email uuid.  The same uuid the email container (owner type email) and the email render take. | [optional] |
 | **hash_sha256** | **String** | Hash of the subject and preview text.  Send it as If-Match when updating.  A change to the email body does not change it. | [optional] |
 | **live** | **Boolean** | True when the email is in a flow or campaign that is sending, so a change reaches customers and needs sfvb_publish.  An email in neither is reported live. | [optional] |
+| **notes** | **Array<String>** | What a write did beyond the fields asked for, such as a step label it could not refresh.  Only on a write. | [optional] |
 | **pending_review** | **Boolean** | True while a change waits for review.  An edit puts it back to needing review. | [optional] |
 | **preview_text** | **String** | The preview text an inbox shows after the subject. | [optional] |
 | **rejected** | **Boolean** | True when review rejected the email.  An edit puts it back to needing review. | [optional] |
@@ -27,6 +28,7 @@ instance = UltracartClient::SfvbEmail.new(
   email_uuid: null,
   hash_sha256: null,
   live: null,
+  notes: null,
   pending_review: null,
   preview_text: null,
   rejected: null,

data/docs/SfvbEmailReviewRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbEmailReviewRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_id** | **String** | A test order id.  Required for an email in a flow triggered by an order or an auto order, and refused otherwise. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbEmailReviewRequest.new(
+  order_id: null
+)
+```
+

data/docs/SfvbFlow.md

@@ -4,16 +4,27 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **allow_multiple_concurrent_enrollments** | **Boolean** | True when a customer may be in this flow more than once at a time. | [optional] |
 | **communication_sequence_uuid** | **String** | The communication sequence the steps belong to. | [optional] |
 | **created_dts** | **String** | When the flow was created (ISO 8601, UTC). | [optional] |
 | **deleted** | **Boolean** | True when the flow was deleted. | [optional] |
 | **emails** | [**Array<SfvbCommsEmail>**](SfvbCommsEmail.md) | Its emails, in step order. | [optional] |
+| **end_once_customer_purchases** | **Boolean** | True when a customer leaves the flow once they buy from one of its emails. | [optional] |
+| **end_once_customer_purchases_anywhere** | **Boolean** | True when a customer leaves the flow once they buy from any source. | [optional] |
 | **flow_uuid** | **String** | The flow uuid. | [optional] |
+| **hash_sha256** | **String** | Send this as If-Match when changing, archiving or turning the flow on or off. | [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] |
 | **name** | **String** | The flow name. | [optional] |
+| **notes** | **Array<String>** | What a write did beyond the fields it was asked to change, such as putting emails back to needing review or setting a scheduled campaign back to draft.  Only on a write. | [optional] |
 | **postcards** | [**Array<SfvbCommsPostcard>**](SfvbCommsPostcard.md) | Its postcards, in step order. | [optional] |
+| **reentry_delay_days** | **Integer** | Days before a customer may enter again, with after_days. | [optional] |
+| **reentry_policy** | **String** | Whether a customer may enter again, anytime, after_days or never. | [optional] |
+| **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] |
 | **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] |
 | **trigger_parameter_name** | **String** | The name of the trigger parameter, when the trigger takes one. | [optional] |
 | **trigger_type** | **String** | What starts the flow, such as cart abandon or an order. | [optional] |
 
@@ -23,16 +34,27 @@
 require 'ultracart_api'
 
 instance = UltracartClient::SfvbFlow.new(
+  allow_multiple_concurrent_enrollments: null,
   communication_sequence_uuid: null,
   created_dts: null,
   deleted: null,
   emails: null,
+  end_once_customer_purchases: null,
+  end_once_customer_purchases_anywhere: null,
   flow_uuid: null,
+  hash_sha256: null,
   live: null,
   name: null,
+  notes: null,
   postcards: null,
+  reentry_delay_days: null,
+  reentry_policy: null,
+  sending_domain_uuid: null,
+  sending_name: null,
+  sending_user: null,
   status: null,
   status_dts: null,
+  trigger_parameter: null,
   trigger_parameter_name: null,
   trigger_type: null
 )

data/docs/SfvbFlowStatusRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbFlowStatusRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | active to enroll customers as they trigger it, inactive to stop. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFlowStatusRequest.new(
+  status: null
+)
+```
+

data/docs/SfvbFlowWriteRequest.md

@@ -0,0 +1,38 @@
+# UltracartClient::SfvbFlowWriteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allow_multiple_concurrent_enrollments** | **Boolean** | True when a customer may be in this flow more than once at a time. | [optional] |
+| **end_once_customer_purchases** | **Boolean** | True to end the flow for a customer once they buy from one of its emails. | [optional] |
+| **end_once_customer_purchases_anywhere** | **Boolean** | True to end the flow for a customer once they buy from any source. | [optional] |
+| **name** | **String** | The flow name, 1 to 250 characters.  Required to create. | [optional] |
+| **reentry_delay_days** | **Integer** | Days before a customer may enter again, 1 to 1095.  Only with after_days. | [optional] |
+| **reentry_policy** | **String** | Whether a customer may enter again, anytime, after_days or never. | [optional] |
+| **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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFlowWriteRequest.new(
+  allow_multiple_concurrent_enrollments: null,
+  end_once_customer_purchases: null,
+  end_once_customer_purchases_anywhere: null,
+  name: null,
+  reentry_delay_days: null,
+  reentry_policy: null,
+  sending_domain_uuid: null,
+  sending_name: null,
+  sending_user: null,
+  trigger_parameter: null,
+  trigger_type: null
+)
+```
+