ultracart_api 4.1.191 → 4.1.192

data/docs/SfvbNotFoundEntry.md

@@ -0,0 +1,38 @@
+# UltracartClient::SfvbNotFoundEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bot_hits** | **Integer** | Bot hits since bot counting began on this entry.  Empty when not yet counted. | [optional] |
+| **bot_share** | **Object** | bot_hits divided by counted_hits, 0 to 1.  Empty when not yet counted. | [optional] |
+| **counted_hits** | **Integer** | Hits since bot counting began, the base for bot_share. | [optional] |
+| **first_seen_dts** | **String** | First hit, ISO 8601. | [optional] |
+| **hits** | **Integer** | Every recorded hit, bots included. | [optional] |
+| **ignored** | **Boolean** | True when the entry is ignored and no longer counts. | [optional] |
+| **last_seen_dts** | **String** | Latest hit, ISO 8601. | [optional] |
+| **not_found_id** | **String** | The entry's id. | [optional] |
+| **path** | **String** | The path, without its query string.  Token-like segments show as {token} unless asked for. | [optional] |
+| **redirected_to** | **String** | Where a redirect rule now sends this path, when one does. | [optional] |
+| **referrer_hosts** | **Array<String>** | Hosts of the pages that linked to it. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbNotFoundEntry.new(
+  bot_hits: null,
+  bot_share: null,
+  counted_hits: null,
+  first_seen_dts: null,
+  hits: null,
+  ignored: null,
+  last_seen_dts: null,
+  not_found_id: null,
+  path: null,
+  redirected_to: null,
+  referrer_hosts: null
+)
+```
+

data/docs/SfvbNotFoundEntryResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbNotFoundEntryResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **entry** | [**SfvbNotFoundEntry**](SfvbNotFoundEntry.md) |  | [optional] |
+| **hits** | [**Array<SfvbNotFoundHit>**](SfvbNotFoundHit.md) | The most recent hits, up to 100. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbNotFoundEntryResponse.new(
+  entry: null,
+  hits: null
+)
+```
+

data/docs/SfvbNotFoundHit.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbNotFoundHit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bot** | **Boolean** | True when the hit was from a bot. | [optional] |
+| **referrer_host** | **String** | Host of the linking page. | [optional] |
+| **request_dts** | **String** | When, ISO 8601. | [optional] |
+| **user_agent** | **String** | The browser or bot. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbNotFoundHit.new(
+  bot: null,
+  referrer_host: null,
+  request_dts: null,
+  user_agent: null
+)
+```
+

data/docs/SfvbNotFoundPage.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbNotFoundPage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **exists** | **Boolean** | False when the theme has no site_404.vm and the plain fallback is served. | [optional] |
+| **fallback** | **String** | What is served when the template is missing. | [optional] |
+| **status** | **Integer** | The HTTP status the page is served with, always 404. | [optional] |
+| **template_path** | **String** | The site_404.vm the storefront uses, relative to the theme. | [optional] |
+| **theme_oid** | **Integer** | The active theme. | [optional] |
+| **theme_path** | **String** | The theme's folder. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbNotFoundPage.new(
+  exists: null,
+  fallback: null,
+  status: null,
+  template_path: null,
+  theme_oid: null,
+  theme_path: null
+)
+```
+

data/docs/SfvbNotFoundResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbNotFoundResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **entries** | [**Array<SfvbNotFoundEntry>**](SfvbNotFoundEntry.md) | The entries, most hits first unless sorted otherwise. | [optional] |
+| **scanned** | **Integer** | How many entries were read to build the list.  Filters apply within them. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbNotFoundResponse.new(
+  entries: null,
+  scanned: null
+)
+```
+

data/docs/SfvbRedirect.md

@@ -0,0 +1,42 @@
+# UltracartClient::SfvbRedirect
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_dts** | **String** | When SFVB created the rule, ISO 8601.  Empty for rules created in the admin. | [optional] |
+| **exclude_from_sitemap** | **Boolean** | Whether the source is left out of the generated sitemap. | [optional] |
+| **hash_sha256** | **String** | Send back as If-Match to update or delete the rule. | [optional] |
+| **modified_dts** | **String** | When SFVB last changed the rule, ISO 8601. | [optional] |
+| **note** | **String** | Why the rule exists. | [optional] |
+| **pinned_page_path** | **String** | When the rule is pinned to a page, that page's current path.  The target follows the page. | [optional] |
+| **redirect_id** | **Integer** | The rule's id. | [optional] |
+| **source** | **String** | The path the rule catches, as stored.  A trailing /* catches everything below it. | [optional] |
+| **status** | **String** | 301, 302 (to another site, admin rules only) or rewrite (an admin rule serving the target at the source with a 200).  Rules written through SFVB are always 301. | [optional] |
+| **target** | **String** | Where the rule sends the shopper. | [optional] |
+| **target_invalid** | **Boolean** | True when the target is a page or item that does not exist. | [optional] |
+| **target_invalid_message** | **String** | Why the target is invalid. | [optional] |
+| **type** | **String** | exact or pattern. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirect.new(
+  created_dts: null,
+  exclude_from_sitemap: null,
+  hash_sha256: null,
+  modified_dts: null,
+  note: null,
+  pinned_page_path: null,
+  redirect_id: null,
+  source: null,
+  status: null,
+  target: null,
+  target_invalid: null,
+  target_invalid_message: null,
+  type: null
+)
+```
+

data/docs/SfvbRedirectCheckResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbRedirectCheckResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Findings that block the rule. | [optional] |
+| **source** | **String** | The source as it matches, lower case without a trailing index.html. | [optional] |
+| **type** | **String** | exact or pattern. | [optional] |
+| **valid** | **Boolean** | True when nothing blocks the rule. | [optional] |
+| **warnings** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Findings that do not block it.  A chain carries the final target as its suggestion. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirectCheckResponse.new(
+  errors: null,
+  source: null,
+  type: null,
+  valid: null,
+  warnings: null
+)
+```
+

data/docs/SfvbRedirectImportRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbRedirectImportRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plan_hash** | **String** | From the dry run.  Required to apply. | [optional] |
+| **rows** | [**Array<SfvbRedirectImportRow>**](SfvbRedirectImportRow.md) | The rows, up to 5,000. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirectImportRequest.new(
+  plan_hash: null,
+  rows: null
+)
+```
+

data/docs/SfvbRedirectImportResponse.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbRedirectImportResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **applied** | **Boolean** | True when the rows were written. | [optional] |
+| **blocked** | **Integer** | How many rows have a blocking finding.  Any blocked row means nothing is applied. | [optional] |
+| **flagged** | **Integer** | How many rows have only warnings. | [optional] |
+| **limit** | **Integer** | The most rules a storefront may have through SFVB. | [optional] |
+| **plan_hash** | **String** | Send back with the same rows to apply exactly this plan. | [optional] |
+| **rows** | [**Array<SfvbRedirectImportRowResult>**](SfvbRedirectImportRowResult.md) | The rows with findings. | [optional] |
+| **rule_count** | **Integer** | How many rules the storefront has, or would have after applying. | [optional] |
+| **total** | **Integer** | How many rows were sent. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirectImportResponse.new(
+  applied: null,
+  blocked: null,
+  flagged: null,
+  limit: null,
+  plan_hash: null,
+  rows: null,
+  rule_count: null,
+  total: null
+)
+```
+

data/docs/SfvbRedirectImportRow.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbRedirectImportRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **note** | **String** | Why the rule exists. | [optional] |
+| **source** | **String** | The path to catch. | [optional] |
+| **target** | **String** | Where to send it. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirectImportRow.new(
+  note: null,
+  source: null,
+  target: null
+)
+```
+

data/docs/SfvbRedirectImportRowResult.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbRedirectImportRowResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Findings that block the import. | [optional] |
+| **row** | **Integer** | The row's position, starting at 1. | [optional] |
+| **source** | **String** | The row's source. | [optional] |
+| **target** | **String** | The row's target. | [optional] |
+| **warnings** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Findings that do not block it. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirectImportRowResult.new(
+  errors: null,
+  row: null,
+  source: null,
+  target: null,
+  warnings: null
+)
+```
+

data/docs/SfvbRedirectRequest.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbRedirectRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **note** | **String** | Why the rule exists, up to 500 characters. | [optional] |
+| **over_live_page** | **Boolean** | Allow a source that is a live, visible page or item, which the rule then hides. | [optional] |
+| **source** | **String** | The path to catch, starting with /.  End it with /* to catch everything below. | [optional] |
+| **status** | **String** | Updates only.  301 turns an admin rule into a permanent redirect.  Leave empty to keep the rule's status.  New rules are always 301. | [optional] |
+| **target** | **String** | A path on the storefront, or a URL on one of its own hosts. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirectRequest.new(
+  note: null,
+  over_live_page: null,
+  source: null,
+  status: null,
+  target: null
+)
+```
+

data/docs/SfvbRedirectResolveResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbRedirectResolveResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **final_path** | **String** | Where the shopper ends up.  The storefront sends them straight there in one redirect. | [optional] |
+| **final_status** | **String** | The status the shopper gets, 301, 302, rewrite, or none when no rule matches. | [optional] |
+| **lands_on** | **String** | live_page, hidden_page, item, not_found or other (a file or system path). | [optional] |
+| **path** | **String** | The path asked about. | [optional] |
+| **steps** | [**Array<SfvbRedirectResolveStep>**](SfvbRedirectResolveStep.md) | Each redirect followed, in order.  Empty when no rule matches. | [optional] |
+| **too_long** | **Boolean** | True when the chain is longer than the storefront follows. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirectResolveResponse.new(
+  final_path: null,
+  final_status: null,
+  lands_on: null,
+  path: null,
+  steps: null,
+  too_long: null
+)
+```
+

data/docs/SfvbRedirectResolveStep.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbRedirectResolveStep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **String** | The path requested. | [optional] |
+| **status** | **String** | 301, 302 or rewrite. | [optional] |
+| **to** | **String** | Where the rule sends it. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirectResolveStep.new(
+  from: null,
+  status: null,
+  to: null
+)
+```
+

data/docs/SfvbRedirectResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbRedirectResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **redirect** | [**SfvbRedirect**](SfvbRedirect.md) |  | [optional] |
+| **warnings** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Findings that did not block the write, such as a chain. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirectResponse.new(
+  redirect: null,
+  warnings: null
+)
+```
+

data/docs/SfvbRedirectsResponse.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbRedirectsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** | How many rules the storefront has. | [optional] |
+| **limit** | **Integer** | The most rules a storefront may have through SFVB. | [optional] |
+| **redirects** | [**Array<SfvbRedirect>**](SfvbRedirect.md) | The rules. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirectsResponse.new(
+  count: null,
+  limit: null,
+  redirects: null
+)
+```
+

data/docs/SfvbRenderRequest.md

@@ -15,7 +15,7 @@
 | **context_page_number** | **String** | Page number for paginated elements.  Defaults to 1. | [optional] |
 | **context_upsell_offer_oid** | **Integer** | Upsell offer oid for the rendering context. | [optional] |
 | **edit_mode** | **Boolean** | True renders every branch the way the builder shows it, for styling content a shopper only sometimes sees.  Omitted or false renders what a shopper sees, with conditions, prices and sale state evaluated against the context item. | [optional] |
-| **language_iso_code** | **String** | UltraCart language code such as ESP, enabled on the storefront.  Two-letter codes and English names are accepted.  Defaults to ENG. | [optional] |
+| **language_iso_code** | **String** | Three-letter ISO 639-2 language code in the bibliographic form (GER, FRE, CHI), with UltraCart exceptions such as ESP for Spanish.  Must be enabled on the storefront.  Defaults to ENG. | [optional] |
 | **uri** | **String** | Storefront URI the node would appear on.  Affects rendering of anything page relative. | [optional] |
 
 ## Example