ultracart_api 4.1.199 → 4.1.200

data/docs/SfvbApprovalParams.md

@@ -4,12 +4,22 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **attribute_names** | **Array<String>** | For item.attribute_batch, the attributes the batch would change.  Set by the server. | [optional] |
 | **blog_post_oid** | **Integer** | The blog post, for blog_post.delete. | [optional] |
 | **content_sha256** | **String** | For file.put_script, the SHA-256 of the exact bytes approved.  Set by the server, never by the caller.  The write must send bytes with this hash. | [optional] |
-| **path** | **String** | The file path, for file.delete and file.put_script.  Exactly as the gated call will send it. | [optional] |
-| **rows_sha256** | **String** | For redirect.delete_batch, the plan_hash of the exact rows approved.  Set by the server.  The batch delete must send rows with this hash. | [optional] |
+| **experiment_oid** | **Integer** | For experiment.end, the experiment to end. | [optional] |
+| **item_count** | **Integer** | For item.attribute_batch, how many items the batch would change when it was requested.  Set by the server. | [optional] |
+| **merchant_item_oid** | **Integer** | For item.pricing, the item whose pricing changes. | [optional] |
+| **path** | **String** | The file path, for file.delete and file.put_script, or the page path for experiment.start of a page experiment.  Exactly as the gated call will send it. | [optional] |
+| **request_sha256** | **String** | For experiment.start of a url experiment, the hash of the checked experiment approved, and for item.pricing the hash of the change.  Set by the server.  The gated call must send the same. | [optional] |
+| **rows_sha256** | **String** | For redirect.delete_batch and item.attribute_batch, the plan_hash of the exact rows approved.  Set by the server.  The batch must send rows with this hash. | [optional] |
 | **rule_count** | **Integer** | For redirect.delete_batch, how many rules the batch would delete when it was requested.  Set by the server. | [optional] |
+| **slot** | **String** | For experiment.start of a page experiment, the page body name.  Defaults to body. | [optional] |
+| **upsell_kind** | **String** | For upsell.enable, what to switch on. | [optional] |
+| **upsell_oid** | **Integer** | For upsell.enable, the oid of the offer or path to switch on. | [optional] |
 | **version** | **Integer** | For file.put_script, the history version a revert restores.  Leave it out, and send content instead, for a write. | [optional] |
+| **widget_id** | **String** | For experiment.start of a page experiment, the id of the experiment element. | [optional] |
+| **winner_variation_number** | **Integer** | For experiment.end, the winning variation.  Leave it out to end without a winner, and leave it out of the end call too. | [optional] |
 
 ## Example
 
@@ -17,12 +27,22 @@
 require 'ultracart_api'
 
 instance = UltracartClient::SfvbApprovalParams.new(
+  attribute_names: null,
   blog_post_oid: null,
   content_sha256: null,
+  experiment_oid: null,
+  item_count: null,
+  merchant_item_oid: null,
   path: null,
+  request_sha256: null,
   rows_sha256: null,
   rule_count: null,
-  version: null
+  slot: null,
+  upsell_kind: null,
+  upsell_oid: null,
+  version: null,
+  widget_id: null,
+  winner_variation_number: null
 )
 ```
 

data/docs/SfvbItemAttributeBatchRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbItemAttributeBatchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plan_hash** | **String** | From the dry run.  Required to apply, with exactly the rows the dry run answered as change. | [optional] |
+| **rows** | [**Array<SfvbItemAttributeBatchRow>**](SfvbItemAttributeBatchRow.md) | The changes, up to 5,000 rows on up to 500 items.  Each item and name at most once. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemAttributeBatchRequest.new(
+  plan_hash: null,
+  rows: null
+)
+```
+

data/docs/SfvbItemAttributeBatchResponse.md

@@ -0,0 +1,40 @@
+# UltracartClient::SfvbItemAttributeBatchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **applied** | **Boolean** | True after an apply. | [optional] |
+| **change** | **Integer** | Rows that would change, from a dry run. | [optional] |
+| **error** | **Integer** | Rows on an item that could not be saved, after an apply. | [optional] |
+| **invalid** | **Integer** | Rows refused by the attribute checks. | [optional] |
+| **item_count** | **Integer** | Distinct items with at least one row that would change, or did. | [optional] |
+| **not_found** | **Integer** | Rows naming an item that does not exist. | [optional] |
+| **plan_hash** | **String** | The hash of the rows answered as change, with their current_sha256.  Apply exactly those rows with this hash. | [optional] |
+| **rows** | [**Array<SfvbItemAttributeBatchRowResult>**](SfvbItemAttributeBatchRowResult.md) | One result per row, in request order. | [optional] |
+| **stale** | **Integer** | Rows skipped because the value is not the one expected. | [optional] |
+| **total** | **Integer** | Rows checked. | [optional] |
+| **unchanged** | **Integer** | Rows whose value is already the new one. | [optional] |
+| **updated** | **Integer** | Rows written, after an apply. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemAttributeBatchResponse.new(
+  applied: null,
+  change: null,
+  error: null,
+  invalid: null,
+  item_count: null,
+  not_found: null,
+  plan_hash: null,
+  rows: null,
+  stale: null,
+  total: null,
+  unchanged: null,
+  updated: null
+)
+```
+

data/docs/SfvbItemAttributeBatchRow.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbItemAttributeBatchRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **current_sha256** | **String** | The current_sha256 the dry run answered for this row.  Required to apply; a row whose value changed since is skipped as stale. | [optional] |
+| **expected_value** | **String** | For a dry run, the value the caller believes the item holds now.  A different current value makes the row stale. | [optional] |
+| **merchant_item_id** | **String** | The item by its merchant item id, for a dry run.  Send this or merchant_item_oid, not both. | [optional] |
+| **merchant_item_oid** | **Integer** | The item.  Required to apply; the dry run answers it for a row that named merchant_item_id. | [optional] |
+| **name** | **String** | The attribute name, matched without regard to case. | [optional] |
+| **type** | **String** | The attribute type, used only when no template on the item's pages declares the name. | [optional] |
+| **value** | **String** | The new value.  An empty string clears the attribute. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemAttributeBatchRow.new(
+  current_sha256: null,
+  expected_value: null,
+  merchant_item_id: null,
+  merchant_item_oid: null,
+  name: null,
+  type: null,
+  value: null
+)
+```
+

data/docs/SfvbItemAttributeBatchRowResult.md

@@ -0,0 +1,36 @@
+# UltracartClient::SfvbItemAttributeBatchRowResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **current_present** | **Boolean** | Whether the item had the attribute before this batch. | [optional] |
+| **current_sha256** | **String** | The hash of the value before this batch.  Send it back with the row to apply. | [optional] |
+| **current_value** | **String** | The value before this batch, for a backup.  Empty when the item has no such attribute. | [optional] |
+| **merchant_item_id** | **String** | The item's merchant item id.  Absent when not_found. | [optional] |
+| **merchant_item_oid** | **Integer** | The item.  Absent when not_found. | [optional] |
+| **message** | **String** | Why a row is invalid, stale or error. | [optional] |
+| **name** | **String** | The attribute name as sent. | [optional] |
+| **result** | **String** | change or unchanged from a dry run, updated after an apply, stale (the value differs from expected_value or changed since the dry run), not_found, invalid, or error when the item could not be saved. | [optional] |
+| **row** | **Integer** | The row's position in the request, from 1. | [optional] |
+| **type** | **String** | The type the value is checked and stored as - the declaring template's, else the one sent. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemAttributeBatchRowResult.new(
+  current_present: null,
+  current_sha256: null,
+  current_value: null,
+  merchant_item_id: null,
+  merchant_item_oid: null,
+  message: null,
+  name: null,
+  result: null,
+  row: null,
+  type: null
+)
+```
+

data/docs/SfvbItemPricing.md

@@ -0,0 +1,38 @@
+# UltracartClient::SfvbItemPricing
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cost** | **Float** | The price. | [optional] |
+| **currency_code** | **String** | The currency every amount is in.  Read only here. | [optional] |
+| **hash_sha256** | **String** | The hash of the pricing above.  Send it as If-Match to change it. | [optional] |
+| **merchant_item_id** | **String** | The item's merchant item id. | [optional] |
+| **merchant_item_oid** | **Integer** | The item. | [optional] |
+| **msrp** | **Float** | The manufacturer suggested retail price, when set. | [optional] |
+| **sale_active** | **Boolean** | Whether the sale price applies right now. | [optional] |
+| **sale_cost** | **Float** | The sale price, when a sale is set. | [optional] |
+| **sale_end** | **String** | When the sale ends, ISO 8601. | [optional] |
+| **sale_start** | **String** | When the sale starts, ISO 8601. | [optional] |
+| **volume_discounts** | [**Array<SfvbItemVolumeDiscount>**](SfvbItemVolumeDiscount.md) | Retail quantity breaks, lowest quantity first.  Wholesale pricing tiers are not shown or changed here. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemPricing.new(
+  cost: null,
+  currency_code: null,
+  hash_sha256: null,
+  merchant_item_id: null,
+  merchant_item_oid: null,
+  msrp: null,
+  sale_active: null,
+  sale_cost: null,
+  sale_end: null,
+  sale_start: null,
+  volume_discounts: null
+)
+```
+

data/docs/SfvbItemPricingRequest.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbItemPricingRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **clear_msrp** | **Boolean** | True to remove the MSRP.  Not with msrp. | [optional] |
+| **clear_sale** | **Boolean** | True to remove the sale.  Not with sale_cost. | [optional] |
+| **cost** | **Float** | The new price, 0 or more. | [optional] |
+| **msrp** | **Float** | The manufacturer suggested retail price, more than 0 (or 0 when the price is 0). | [optional] |
+| **sale_cost** | **Float** | The sale price, 0 or more.  Sent with sale_start and sale_end, all three or none. | [optional] |
+| **sale_end** | **String** | When the sale ends, ISO 8601 with an offset, after sale_start.  Required with sale_cost. | [optional] |
+| **sale_start** | **String** | When the sale starts, ISO 8601 with an offset.  Required with sale_cost. | [optional] |
+| **volume_discounts** | [**Array<SfvbItemVolumeDiscount>**](SfvbItemVolumeDiscount.md) | Replaces the retail quantity breaks.  An empty list removes them all.  Up to 20, each quantity 2 or more and named once. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemPricingRequest.new(
+  clear_msrp: null,
+  clear_sale: null,
+  cost: null,
+  msrp: null,
+  sale_cost: null,
+  sale_end: null,
+  sale_start: null,
+  volume_discounts: null
+)
+```
+

data/docs/SfvbItemRelated.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbItemRelated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hash_sha256** | **String** | The hash of the above.  Send it as If-Match to change them. | [optional] |
+| **merchant_item_id** | **String** | The item's merchant item id. | [optional] |
+| **merchant_item_oid** | **Integer** | The item. | [optional] |
+| **no_system_calculated_related_items** | **Boolean** | True when UltraCart does not calculate related items for this item. | [optional] |
+| **not_relatable** | **Boolean** | True when this item is never shown as related to another. | [optional] |
+| **related_items** | [**Array<SfvbItemRelatedItem>**](SfvbItemRelatedItem.md) | In stored order - the merchant's own (user, addon, complementary) and UltraCart's calculated ones (system). | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemRelated.new(
+  hash_sha256: null,
+  merchant_item_id: null,
+  merchant_item_oid: null,
+  no_system_calculated_related_items: null,
+  not_relatable: null,
+  related_items: null
+)
+```
+

data/docs/SfvbItemRelatedItem.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbItemRelatedItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchant_item_id** | **String** | The related item.  On a write, send this or merchant_item_oid. | [optional] |
+| **merchant_item_oid** | **Integer** | The related item's oid. | [optional] |
+| **type** | **String** | user (the default on a write), addon or complementary.  system marks one UltraCart calculated and other a kind this API does not change.  Both are read only and kept by a write. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemRelatedItem.new(
+  merchant_item_id: null,
+  merchant_item_oid: null,
+  type: null
+)
+```
+

data/docs/SfvbItemRelatedRequest.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbItemRelatedRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **no_system_calculated_related_items** | **Boolean** | Left out keeps the stored value. | [optional] |
+| **not_relatable** | **Boolean** | Left out keeps the stored value. | [optional] |
+| **related_items** | [**Array<SfvbItemRelatedItem>**](SfvbItemRelatedItem.md) | The merchant's related items, in order, up to 50.  An empty list removes them all.  The calculated (system) ones are kept. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemRelatedRequest.new(
+  no_system_calculated_related_items: null,
+  not_relatable: null,
+  related_items: null
+)
+```
+

data/docs/SfvbItemVolumeDiscount.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbItemVolumeDiscount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cost** | **Float** | The unit price at that quantity, in the item's currency. | [optional] |
+| **quantity** | **Integer** | The quantity from which this unit price applies.  2 or more. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemVolumeDiscount.new(
+  cost: null,
+  quantity: null
+)
+```
+