ultracart_api 4.1.169 → 4.1.171

data/docs/SfvbItemAttribute.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbItemAttribute
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conflicting_types** | **Array<String>** | Set only when templates disagree about this attribute's type, listing every type declared for it.  The render does not resolve this - each element parses the value as its own itemAttributeType says - so one of the elements reading it is showing nothing. | [optional] |
+| **deprecated** | **Boolean** | True when the declaring template marks this attribute as on its way out.  Prefer not to build on it. | [optional] |
+| **name** | **String** | The attribute name, which is what an itemattribute element's itemAttributeName refers to.  Matching is forgiving on the render side - uppercased, trimmed, runs of whitespace collapsed - so Care Notes and care notes are the same attribute. | [optional] |
+| **type** | **String** | How the templates declaring this attribute expect its value to be shaped.  orphan means no template declares it, so nothing here can say what shape it should be. | [optional] |
+| **undeclared** | **Boolean** | True when the attribute is stored on the item but no template declares it.  Not an error - a value set for an element placed in a container is undeclared by design, because the container is not a template. | [optional] |
+| **used_by** | **String** | The other themes that declare this attribute, when the active theme does not. | [optional] |
+| **used_by_current_theme** | **Boolean** | True when a template in the active theme declares this attribute. | [optional] |
+| **value** | **String** | The stored value.  Empty when a template declares the attribute and nothing has set it. | [optional] |
+| **writable** | **Boolean** | True when this API will change the value.  An item attribute is a plain value column, so unlike a page attribute the list types are writable here; their per entry translation handles are assigned on first read rather than stored with the value. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemAttribute.new(
+  conflicting_types: null,
+  deprecated: null,
+  name: null,
+  type: null,
+  undeclared: null,
+  used_by: null,
+  used_by_current_theme: null,
+  value: null,
+  writable: null
+)
+```
+

data/docs/SfvbItemAttributeUpdate.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbItemAttributeUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The attribute to change, matched without regard to case.  An attribute that does not exist yet is created. | [optional] |
+| **type** | **String** | Only consulted for a name no template declares, to say how the value should be validated and what the attribute is recorded as.  Ignored otherwise, because a declared attribute's type comes from the template that declares it. | [optional] |
+| **value** | **String** | The new value.  Send an empty string to clear it.  For the list types this is the JSON document as text, not a nested object - see the type's own format, because a shape the renderer cannot parse renders exactly like an attribute that was never set. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemAttributeUpdate.new(
+  name: null,
+  type: null,
+  value: null
+)
+```
+

data/docs/SfvbItemAttributeUpdateRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbItemAttributeUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attributes** | [**Array<SfvbItemAttributeUpdate>**](SfvbItemAttributeUpdate.md) | The attributes to change.  Every entry is validated before any is written, so one refused attribute changes nothing. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemAttributeUpdateRequest.new(
+  attributes: null
+)
+```
+

data/docs/SfvbItemContentRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbItemContentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | What an itemdescription element renders, the item's extended description.  HTML is accepted; the element's excerpt settings only decide how much of it is shown. | [optional] |
+| **title** | **String** | What an itemtitle element renders.  This is the item's short description in the catalog, so it changes the item everywhere, not only on this storefront. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemContentRequest.new(
+  description: null,
+  title: null
+)
+```
+

data/docs/SfvbItemMultimedia.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbItemMultimedia
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The image code, which is what an itemimage element's itemImageCode refers to.  Empty for the default image. | [optional] |
+| **declared** | **Boolean** | True when a template declares this code.  A slot that is attached but not declared is an image nothing on the page is asking for. | [optional] |
+| **default** | **Boolean** | True for the image an itemimage element with no code renders.  Default is per media type, so an item may have one default image and one default PDF at the same time. | [optional] |
+| **description** | **String** | Stored with the image and rendered as its alt text.  When it is empty the render falls back to the item's own description, so an empty value here is not an empty alt attribute. | [optional] |
+| **dimensions** | **String** | Width x height in pixels, when the storage measured the file. | [optional] |
+| **exclude_from_gallery** | **Boolean** | True when the storage marks this image as kept out of the item gallery. | [optional] |
+| **filename** | **String** | The stored file's name.  Empty when the slot is declared and nothing is attached. | [optional] |
+| **type** | **String** | The media type the storage recorded. | [optional] |
+| **view_url** | **String** | Where the stored image is served.  Absent when nothing is attached to the slot. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemMultimedia.new(
+  code: null,
+  declared: null,
+  default: null,
+  description: null,
+  dimensions: null,
+  exclude_from_gallery: null,
+  filename: null,
+  type: null,
+  view_url: null
+)
+```
+

data/docs/SfvbItemMultimediaRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbItemMultimediaRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Attach under this image code, the value an itemimage element's itemImageCode names. | [optional] |
+| **default** | **Boolean** | Attach as the item's default image, which is what an itemimage element with no code renders.  Name exactly one of this or code. | [optional] |
+| **description** | **String** | Stored with the image and rendered as its alt text.  Left out, the slot keeps the description it already had. | [optional] |
+| **path** | **String** | Storefront file system path of the image to attach, such as /assets/img/mug-front.jpg.  Upload it with files/upload first.  Unlike a page image this does not have to sit in any particular folder, because an item has no folder of its own - the bytes are copied into the item's own storage on attach. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemMultimediaRequest.new(
+  code: null,
+  default: null,
+  description: null,
+  path: null
+)
+```
+

data/docs/SfvbItemResponse.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbItemResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attributes** | [**Array<SfvbItemAttribute>**](SfvbItemAttribute.md) | Every attribute a template declares for this item plus every one stored on it, so the list answers what can be set as well as what is set. | [optional] |
+| **description** | **String** | What an itemdescription element renders, the item's extended description.  Like title this is the catalog's own field rather than a storefront copy of it. | [optional] |
+| **groups** | **Array<String>** | The page paths this item is assigned to on this storefront.  The templates behind those pages are what the attribute and image declarations were reconciled against, so an empty list is why an item can report no declared attributes at all. | [optional] |
+| **merchant_item_id** | **String** | The item id a storefront carries, and the one data-context-item-id holds. | [optional] |
+| **merchant_item_oid** | **Integer** | The item's internal oid, which appears nowhere on a rendered storefront. | [optional] |
+| **multimedia** | [**Array<SfvbItemMultimedia>**](SfvbItemMultimedia.md) | Every image slot a template declares plus every image attached to the item. | [optional] |
+| **seo** | [**SfvbItemSeo**](SfvbItemSeo.md) |  | [optional] |
+| **title** | **String** | What an itemtitle element renders.  This is the item's short description in the catalog, not a storefront only field, so changing it changes the item everywhere. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemResponse.new(
+  attributes: null,
+  description: null,
+  groups: null,
+  merchant_item_id: null,
+  merchant_item_oid: null,
+  multimedia: null,
+  seo: null,
+  title: null
+)
+```
+

data/docs/SfvbItemSeo.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbItemSeo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | storefrontSEODescription as stored on this item.  Empty when it has never been set. | [optional] |
+| **description_source** | **String** | Where effective_description comes from. | [optional] |
+| **effective_description** | **String** | What the meta description renders as, after the item to page to site fallback. | [optional] |
+| **effective_keywords** | **String** | What the meta keywords render as, after the item to page to site fallback. | [optional] |
+| **effective_title** | **String** | What the document title renders as. | [optional] |
+| **keywords** | **String** | storefrontSEOKeywords as stored on this item.  Empty when it has never been set. | [optional] |
+| **keywords_source** | **String** | Where effective_keywords comes from. | [optional] |
+| **title** | **String** | storefrontSEOTitle as stored on this item.  Empty when it has never been set. | [optional] |
+| **title_source** | **String** | Where effective_title comes from.  item_description means nothing is set here and the item's own description is being used. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemSeo.new(
+  description: null,
+  description_source: null,
+  effective_description: null,
+  effective_keywords: null,
+  effective_title: null,
+  keywords: null,
+  keywords_source: null,
+  title: null,
+  title_source: null
+)
+```
+

data/docs/SfvbItemSeoRequest.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbItemSeoRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | The meta description.  Cleared, the page falls back to its group's value and then to the site's. | [optional] |
+| **keywords** | **String** | The meta keywords.  Cleared, the page falls back to its group's value and then to the site's. | [optional] |
+| **title** | **String** | The document title for this item's page.  Cleared, the page falls back to the item's own description.  This does not reach og:title or twitter:title, which render the item description either way. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemSeoRequest.new(
+  description: null,
+  keywords: null,
+  title: null
+)
+```
+

data/docs/SfvbPageResponse.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **attributes** | [**Array<SfvbPageAttribute>**](SfvbPageAttribute.md) | Every attribute this page has, including ones a template declares but nothing has set yet.  These are what the pageattribute element renders.  Sorted by name. | [optional] |
+| **description** | **String** | The page description, the text a page template renders as the page's description.  Omitted when empty. | [optional] |
 | **exclude_from_sitemap** | **Boolean** | True when the page is left out of the sitemap and marked noindex. | [optional] |
 | **group_template** | **String** | Template file that renders the page itself, a bare .vm name found anywhere in the active theme. | [optional] |
 | **item_template** | **String** | Template file that renders the item pages under this page. | [optional] |
@@ -21,6 +22,7 @@ require 'ultracart_api'
 
 instance = UltracartClient::SfvbPageResponse.new(
   attributes: null,
+  description: null,
   exclude_from_sitemap: null,
   group_template: null,
   item_template: null,

data/docs/SfvbUpsellItemLogic.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbUpsellItemLogic
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<SfvbUpsellItemLogicItem>**](SfvbUpsellItemLogicItem.md) | The items this logic looks at.  Every item id must exist on the merchant account. | [optional] |
+| **logic** | **String** | How items is read.  contains_any, contains_all, all, any or total.  Omitted or null means no item logic. | [optional] |
+| **total_quantity_comparison** | **Integer** | For total only.  The quantity the summed quantity is compared with. | [optional] |
+| **total_quantity_operator** | **String** | For total only.  The comparison applied to the summed quantity.  One of <, <=, =, >=, >. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbUpsellItemLogic.new(
+  items: null,
+  logic: null,
+  total_quantity_comparison: null,
+  total_quantity_operator: null
+)
+```
+

data/docs/SfvbUpsellItemLogicItem.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbUpsellItemLogicItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **comparison** | **Integer** | For logic all or any.  The quantity this item's quantity is compared with. | [optional] |
+| **item_id** | **String** | Merchant item id.  Must exist on the merchant account. | [optional] |
+| **operator** | **String** | For logic all or any.  The comparison applied to this item's quantity.  One of <, <=, =, >=, >. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbUpsellItemLogicItem.new(
+  comparison: null,
+  item_id: null,
+  operator: null
+)
+```
+

data/docs/SfvbUpsellOffer.md

@@ -4,15 +4,70 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **active** | **Boolean** | Whether the offer is switched on. | [optional] |
-| **active_overall** | **Boolean** | Whether the offer is active once its date window and daily pricing are taken into account.  This is the one that says whether shoppers are actually seeing it. | [optional] |
-| **cjson_size** | **Integer** | Size of the offer's container JSON in bytes.  A large value here alongside a low element count is the signature of a hand pasted HTML dump. | [optional] |
-| **has_container** | **Boolean** | Whether a container has been authored for this offer. | [optional] |
-| **name** | **String** | Offer name. | [optional] |
-| **path_name** | **String** | Name of the upsell path this offer sits on. | [optional] |
-| **storefront_oid** | **Integer** | Storefront oid. | [optional] |
+| **active** | **Boolean** | Whether the offer is switched on.  Setting it true, or changing an offer that is active overall, needs the sfvb_publish scope. | [optional] |
+| **active_overall** | **Boolean** | Read only.  Whether the offer is active once its date window and daily pricing are taken into account.  This is the one that says whether shoppers are actually seeing it. | [optional] |
+| **add_accessory_item_ids** | **Array<String>** | Accessory items added when the offer is accepted. | [optional] |
+| **adjust_trigger_item_option** | **String** | Option on the trigger item to adjust when the offer is accepted.  Omitted or null for none. | [optional] |
+| **allow_upsell_item_in_cart_already** | **Boolean** | Whether to show the offer when the upsell item is already in the cart. | [optional] |
+| **arbitrary_unit_cost** | **Float** | Price per unit when the offer is accepted.  Omitted or null to charge the item's own price. | [optional] |
+| **arbitrary_unit_cost_friday** | **Float** | Price on Fridays, overriding arbitrary_unit_cost. | [optional] |
+| **arbitrary_unit_cost_monday** | **Float** | Price on Mondays, overriding arbitrary_unit_cost.  Omitted or null for no override. | [optional] |
+| **arbitrary_unit_cost_saturday** | **Float** | Price on Saturdays, overriding arbitrary_unit_cost. | [optional] |
+| **arbitrary_unit_cost_sunday** | **Float** | Price on Sundays, overriding arbitrary_unit_cost. | [optional] |
+| **arbitrary_unit_cost_thursday** | **Float** | Price on Thursdays, overriding arbitrary_unit_cost. | [optional] |
+| **arbitrary_unit_cost_tuesday** | **Float** | Price on Tuesdays, overriding arbitrary_unit_cost. | [optional] |
+| **arbitrary_unit_cost_wednesday** | **Float** | Price on Wednesdays, overriding arbitrary_unit_cost. | [optional] |
+| **cjson_size** | **Integer** | Read only.  Size of the offer's container JSON in bytes.  A large value here alongside a low element count is the signature of a hand pasted HTML dump. | [optional] |
+| **end_date** | **String** | Last day the offer runs, as YYYY-MM-DD, inclusive.  Omitted or null for no end. | [optional] |
+| **everflow_advertiser_event_id** | **String** | Everflow advertiser event id recorded when the offer is accepted.  Omitted or null for none. | [optional] |
+| **first_time_item** | **Boolean** | Show only to shoppers who have not bought the upsell item before. | [optional] |
+| **first_time_store** | **Boolean** | Show only to shoppers buying from this store for the first time. | [optional] |
+| **free_shipping** | **Boolean** | Whether the upsell item ships free. | [optional] |
+| **has_container** | **Boolean** | Read only.  Whether a container has been authored for this offer. | [optional] |
+| **has_everflow_configured** | **Boolean** | Read only.  Whether the merchant has Everflow set up. | [optional] |
+| **has_loyalty_configured** | **Boolean** | Read only.  Whether the merchant has loyalty set up, so the loyalty tier lists apply. | [optional] |
+| **has_towerdata_configured** | **Boolean** | Read only.  Whether the merchant has TowerData set up, so the age and gender lists apply. | [optional] |
+| **hash_sha256** | **String** | Read only.  Hash of the offer's writable fields.  Send it in If-Match on an update. | [optional] |
+| **item_logic_suppression** | [**SfvbUpsellItemLogic**](SfvbUpsellItemLogic.md) |  | [optional] |
+| **item_logic_trigger** | [**SfvbUpsellItemLogic**](SfvbUpsellItemLogic.md) |  | [optional] |
+| **lock_shipping** | **Boolean** | Whether the shipping method is locked once the offer is accepted. | [optional] |
+| **max_quantity** | **Integer** | Most units a shopper can take.  Omitted or null for no limit. | [optional] |
+| **migrate_accessory_item_ids_from** | **Array<String>** | Accessory items to migrate from, paired by position with migrate_accessory_item_ids_to. | [optional] |
+| **migrate_accessory_item_ids_to** | **Array<String>** | Accessory items to migrate to, paired by position with migrate_accessory_item_ids_from. | [optional] |
+| **name** | **String** | Offer name, at most 50 characters. | [optional] |
+| **offsite_content_url** | **String** | URL of offsite content shown instead of the container.  Omitted or null for none. | [optional] |
+| **out_of_stock_upsell_item_ids** | **Array<String>** | Read only.  Upsell items that are out of stock now, so the offer would not be shown. | [optional] |
+| **path_name** | **String** | Read only.  Name of the upsell path this offer was last served on.  Written by checkout traffic, so it is empty until shoppers have seen the offer and can be stale.  Use referenced_by_path_oids for the configured answer. | [optional] |
+| **record_as_regular_item** | **Boolean** | Whether the accepted item is recorded as a regular item rather than an upsell. | [optional] |
+| **referenced_by_path_oids** | **Array<Integer>** | Read only.  The storefront's upsell paths whose steps use this offer, as an offer or a downsell. | [optional] |
+| **removable_on_confirmation** | **Boolean** | Whether the shopper can remove the accepted item on the confirmation step. | [optional] |
+| **remove_accessory_item_ids** | **Array<String>** | Accessory items removed when the offer is accepted. | [optional] |
+| **remove_trigger_item** | **Boolean** | Whether accepting the offer removes the item that triggered it (a swap rather than an add). | [optional] |
+| **skip_previous_customers** | **Boolean** | Do not show to previous customers. | [optional] |
+| **start_date** | **String** | First day the offer runs, as YYYY-MM-DD.  Omitted or null for no start. | [optional] |
+| **stats** | [**SfvbUpsellStats**](SfvbUpsellStats.md) |  | [optional] |
+| **storefront_oid** | **Integer** | Read only.  Storefront oid. | [optional] |
+| **suppress_large** | **Boolean** | Do not show on large screens. | [optional] |
+| **suppress_medium** | **Boolean** | Do not show on medium screens. | [optional] |
+| **suppress_small** | **Boolean** | Do not show on small screens. | [optional] |
+| **suppression_country_codes** | **Array<String>** | Shipping countries that stop the offer from showing. | [optional] |
+| **suppression_loyalty_tier_oids** | **Array<Integer>** | Loyalty tiers that stop the offer from showing. | [optional] |
+| **suppression_payment_methods** | **Array<String>** | Payment methods that stop the offer from showing. | [optional] |
+| **suppression_shipping_methods** | **Array<String>** | Shipping methods that stop the offer from showing. | [optional] |
+| **suppression_state_codes** | **Array<String>** | Shipping states that stop the offer from showing. | [optional] |
+| **suppression_tags** | **Array<String>** | Customer tags that stop the offer from showing. | [optional] |
 | **test_only** | **Boolean** | Whether the offer is restricted to test traffic. | [optional] |
-| **upsell_offer_oid** | **Integer** | Upsell offer oid. | [optional] |
+| **trigger_ages** | **Array<String>** | TowerData age bands the offer is shown to.  18-20, 21-24, 25-34, 35-44, 45-54, 55-64, 65+ or Unknown. | [optional] |
+| **trigger_country_codes** | **Array<String>** | Shipping countries (ISO 3166 two letter codes) that trigger the offer. | [optional] |
+| **trigger_genders** | **Array<String>** | TowerData genders the offer is shown to.  Male, Female or Unknown. | [optional] |
+| **trigger_loyalty_tier_oids** | **Array<Integer>** | Loyalty tiers that trigger the offer.  Each must be one of the merchant's loyalty tiers. | [optional] |
+| **trigger_payment_methods** | **Array<String>** | Payment methods that trigger the offer.  Each must be one of the merchant's payment methods. | [optional] |
+| **trigger_shipping_methods** | **Array<String>** | Shipping methods that trigger the offer.  Each must be one of the merchant's shipping methods. | [optional] |
+| **trigger_state_codes** | **Array<String>** | Shipping states that trigger the offer. | [optional] |
+| **trigger_tags** | **Array<String>** | Customer tags that trigger the offer. | [optional] |
+| **upsell_item_id_javascript** | **String** | JavaScript that chooses the upsell item at runtime.  Omitted or null for none. | [optional] |
+| **upsell_item_ids** | **Array<String>** | The items offered.  Every item id must exist on the merchant account. | [optional] |
+| **upsell_offer_oid** | **Integer** | Read only.  Upsell offer oid. | [optional] |
 
 ## Example
 
@@ -22,12 +77,67 @@ require 'ultracart_api'
 instance = UltracartClient::SfvbUpsellOffer.new(
   active: null,
   active_overall: null,
+  add_accessory_item_ids: null,
+  adjust_trigger_item_option: null,
+  allow_upsell_item_in_cart_already: null,
+  arbitrary_unit_cost: null,
+  arbitrary_unit_cost_friday: null,
+  arbitrary_unit_cost_monday: null,
+  arbitrary_unit_cost_saturday: null,
+  arbitrary_unit_cost_sunday: null,
+  arbitrary_unit_cost_thursday: null,
+  arbitrary_unit_cost_tuesday: null,
+  arbitrary_unit_cost_wednesday: null,
   cjson_size: null,
+  end_date: null,
+  everflow_advertiser_event_id: null,
+  first_time_item: null,
+  first_time_store: null,
+  free_shipping: null,
   has_container: null,
+  has_everflow_configured: null,
+  has_loyalty_configured: null,
+  has_towerdata_configured: null,
+  hash_sha256: null,
+  item_logic_suppression: null,
+  item_logic_trigger: null,
+  lock_shipping: null,
+  max_quantity: null,
+  migrate_accessory_item_ids_from: null,
+  migrate_accessory_item_ids_to: null,
   name: null,
+  offsite_content_url: null,
+  out_of_stock_upsell_item_ids: null,
   path_name: null,
+  record_as_regular_item: null,
+  referenced_by_path_oids: null,
+  removable_on_confirmation: null,
+  remove_accessory_item_ids: null,
+  remove_trigger_item: null,
+  skip_previous_customers: null,
+  start_date: null,
+  stats: null,
   storefront_oid: null,
+  suppress_large: null,
+  suppress_medium: null,
+  suppress_small: null,
+  suppression_country_codes: null,
+  suppression_loyalty_tier_oids: null,
+  suppression_payment_methods: null,
+  suppression_shipping_methods: null,
+  suppression_state_codes: null,
+  suppression_tags: null,
   test_only: null,
+  trigger_ages: null,
+  trigger_country_codes: null,
+  trigger_genders: null,
+  trigger_loyalty_tier_oids: null,
+  trigger_payment_methods: null,
+  trigger_shipping_methods: null,
+  trigger_state_codes: null,
+  trigger_tags: null,
+  upsell_item_id_javascript: null,
+  upsell_item_ids: null,
   upsell_offer_oid: null
 )
 ```

data/docs/SfvbUpsellPath.md

@@ -0,0 +1,48 @@
+# UltracartClient::SfvbUpsellPath
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Whether the path runs.  Setting it true, or changing a path that is active, needs the sfvb_publish scope. | [optional] |
+| **archived** | **Boolean** | Read only here.  Filed out of the default list.  Change it with the archive and unarchive calls. | [optional] |
+| **customer_type** | **String** | Which customers the path runs for.  all (the default), new or existing. | [optional] |
+| **hash_sha256** | **String** | Read only.  Hash of the path's writable fields.  Send it in If-Match on an update. | [optional] |
+| **item_logic_suppression** | [**SfvbUpsellItemLogic**](SfvbUpsellItemLogic.md) |  | [optional] |
+| **item_logic_trigger** | [**SfvbUpsellItemLogic**](SfvbUpsellItemLogic.md) |  | [optional] |
+| **location** | **String** | Where in checkout the path runs.  pre checkout or post checkout (the default). | [optional] |
+| **maximum_offers** | **Integer** | Most offers one shopper is shown on this path.  Omitted or null for no limit. | [optional] |
+| **name** | **String** | Path name, at most 100 characters. | [optional] |
+| **path_order** | **Integer** | Read only here.  Position among this storefront's paths, first to last.  Change it with the move call. | [optional] |
+| **path_type** | **String** | cascading (the default) or single. | [optional] |
+| **towerdata_trigger** | [**SfvbUpsellTowerData**](SfvbUpsellTowerData.md) |  | [optional] |
+| **trigger_item_ids** | **Array<String>** | Read only.  The legacy flat trigger list, derived from item_logic_trigger when its logic is contains_any and empty otherwise. | [optional] |
+| **trigger_tags** | **Array<String>** | Customer tags that trigger the path. | [optional] |
+| **upsell_path_oid** | **Integer** | Read only.  Upsell path oid. | [optional] |
+| **variations** | [**Array<SfvbUpsellVariation>**](SfvbUpsellVariation.md) | The variations shoppers are split between.  At least one. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbUpsellPath.new(
+  active: null,
+  archived: null,
+  customer_type: null,
+  hash_sha256: null,
+  item_logic_suppression: null,
+  item_logic_trigger: null,
+  location: null,
+  maximum_offers: null,
+  name: null,
+  path_order: null,
+  path_type: null,
+  towerdata_trigger: null,
+  trigger_item_ids: null,
+  trigger_tags: null,
+  upsell_path_oid: null,
+  variations: null
+)
+```
+

data/docs/SfvbUpsellPathDuplicateRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbUpsellPathDuplicateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **variation** | **Integer** | Zero-based index into the path's variations.  When set, that variation is copied and appended to the same path.  Omitted or null copies the whole path, placed right after it. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbUpsellPathDuplicateRequest.new(
+  variation: null
+)
+```
+

data/docs/SfvbUpsellPathMoveRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbUpsellPathMoveRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **to** | **String** | up, down, top or bottom.  The paths are renumbered first to last afterwards. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbUpsellPathMoveRequest.new(
+  to: null
+)
+```
+

data/docs/SfvbUpsellPathsResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbUpsellPathsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **max_results** | **Integer** | Page size that was applied. | [optional] |
+| **next_offset** | **Integer** | Offset of the next page.  Omitted on the last page. | [optional] |
+| **offset** | **Integer** | Offset this page starts at. | [optional] |
+| **result_count** | **Integer** | Paths on this page. | [optional] |
+| **total_count** | **Integer** | Paths matching the filters, across all pages. | [optional] |
+| **upsell_paths** | [**Array<SfvbUpsellPath>**](SfvbUpsellPath.md) | The paths on this page, first to last. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbUpsellPathsResponse.new(
+  max_results: null,
+  next_offset: null,
+  offset: null,
+  result_count: null,
+  total_count: null,
+  upsell_paths: null
+)
+```
+

data/docs/SfvbUpsellStats.md

@@ -0,0 +1,54 @@
+# UltracartClient::SfvbUpsellStats
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **abandons** | **Integer** | Times the shopper left while the offer was showing. | [optional] |
+| **average_visitor_net_profit** | **Float** | Profit per view after refunds. | [optional] |
+| **average_visitor_net_revenue** | **Float** | Revenue per view after refunds. | [optional] |
+| **average_visitor_profit** | **Float** | Profit per view. | [optional] |
+| **average_visitor_revenue** | **Float** | Revenue per view. | [optional] |
+| **conversion_rate** | **Float** | Transactions divided by views, as a percentage. | [optional] |
+| **declines** | **Integer** | Times the offer was declined. | [optional] |
+| **per_sale_net_profit** | **Float** | Profit per transaction after refunds. | [optional] |
+| **per_sale_net_revenue** | **Float** | Revenue per transaction after refunds. | [optional] |
+| **per_sale_profit** | **Float** | Profit per transaction. | [optional] |
+| **per_sale_revenue** | **Float** | Revenue per transaction. | [optional] |
+| **profit** | **Float** | Profit from accepted offers. | [optional] |
+| **refunded_profit** | **Float** | Profit later refunded. | [optional] |
+| **refunded_quantity** | **Integer** | Quantity later refunded. | [optional] |
+| **refunded_revenue** | **Float** | Revenue later refunded. | [optional] |
+| **revenue** | **Float** | Revenue from accepted offers. | [optional] |
+| **total_visitors_across_all_paths** | **Integer** | On a path variation only.  Distinct visitors shown any upsell on this storefront in the window, the denominator for comparing variations. | [optional] |
+| **transactions** | **Integer** | Distinct sessions that accepted the offer and were charged successfully. | [optional] |
+| **views** | **Integer** | Distinct sessions that were shown the offer. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbUpsellStats.new(
+  abandons: null,
+  average_visitor_net_profit: null,
+  average_visitor_net_revenue: null,
+  average_visitor_profit: null,
+  average_visitor_revenue: null,
+  conversion_rate: null,
+  declines: null,
+  per_sale_net_profit: null,
+  per_sale_net_revenue: null,
+  per_sale_profit: null,
+  per_sale_revenue: null,
+  profit: null,
+  refunded_profit: null,
+  refunded_quantity: null,
+  refunded_revenue: null,
+  revenue: null,
+  total_visitors_across_all_paths: null,
+  transactions: null,
+  views: null
+)
+```
+