ultracart_api 4.1.168 → 4.1.170

data/docs/SfvbItemContainersResponse.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbItemContainersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item_containers** | [**Array<SfvbItemContainer>**](SfvbItemContainer.md) | The containers on this page, ordered by merchant item id then container name. | [optional] |
+| **max_results** | **Integer** | The cap that was applied. | [optional] |
+| **next_offset** | **Integer** | Offset to send for the next page.  Zero when truncated is false.  Never truncates without giving a way to continue. | [optional] |
+| **offset** | **Integer** | Containers skipped to produce this page. | [optional] |
+| **result_count** | **Integer** | Number of containers returned on this page. | [optional] |
+| **total_count** | **Integer** | Total containers matching the filter.  With container_name supplied this is the answer to how many items carry that slot. | [optional] |
+| **truncated** | **Boolean** | True when containers exist beyond this page.  next_offset is populated when it is. | [optional] |
+| **truncation_advice** | **String** | Advice for the caller when truncated is true. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemContainersResponse.new(
+  item_containers: null,
+  max_results: null,
+  next_offset: null,
+  offset: null,
+  result_count: null,
+  total_count: null,
+  truncated: null,
+  truncation_advice: 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
+)
+```
+