ultracart_api 4.1.228 → 4.1.229

data/docs/SfvbRedirectImportRow.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **exclude_from_sitemap** | **Boolean** | True to leave the rule's source out of the generated sitemap.  Left out means false, as in the admin. | [optional] |
 | **note** | **String** | Why the rule exists. | [optional] |
 | **source** | **String** | The path to catch. | [optional] |
 | **target** | **String** | Where to send it. | [optional] |
@@ -14,6 +15,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::SfvbRedirectImportRow.new(
+  exclude_from_sitemap: null,
   note: null,
   source: null,
   target: null

data/docs/SfvbRedirectRequest.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **exclude_from_sitemap** | **Boolean** | True to leave the rule's source out of the generated sitemap.  On a create, left out means false, as in the admin.  On an update, left out keeps the rule's value. | [optional] |
 | **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] |
@@ -16,6 +17,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::SfvbRedirectRequest.new(
+  exclude_from_sitemap: null,
   note: null,
   over_live_page: null,
   source: null,

data/docs/SfvbRedirectResolveBatchRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbRedirectResolveBatchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **paths** | **Array<String>** | 1 to 1,000 paths, each starting with /.  A query string is kept, as on the single resolve. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirectResolveBatchRequest.new(
+  paths: null
+)
+```
+

data/docs/SfvbRedirectResolveBatchResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbRedirectResolveBatchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **not_found** | **Integer** | How many paths end on a 404 (lands_on not_found), the ones to redirect or create. | [optional] |
+| **redirected** | **Integer** | How many paths at least one rule redirects. | [optional] |
+| **results** | [**Array<SfvbRedirectResolveResponse>**](SfvbRedirectResolveResponse.md) | One result per path, in the order sent, the same as the single resolve's answer. | [optional] |
+| **total** | **Integer** | How many paths were resolved. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRedirectResolveBatchResponse.new(
+  not_found: null,
+  redirected: null,
+  results: null,
+  total: null
+)
+```
+

data/docs/SfvbSiteSeo.md

@@ -0,0 +1,40 @@
+# UltracartClient::SfvbSiteSeo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **approval_needed** | **Boolean** | On a change, true when it needs an approved site_seo.change request. | [optional] |
+| **canonical** | **Boolean** | True when pages output canonical links. | [optional] |
+| **changed** | **Boolean** | On a change, true when anything was saved, or would be on a dry run. | [optional] |
+| **changes** | [**Array<SfvbSiteSeoChange>**](SfvbSiteSeoChange.md) | On a change, each switch it changed, or would change on a dry run. | [optional] |
+| **description** | **String** | The default meta description, the storefrontSEODescription site attribute. | [optional] |
+| **dry_run** | **Boolean** | True when nothing was saved because the request was a dry run. | [optional] |
+| **hash_sha256** | **String** | The hash of the three switches.  Send it as If-Match on a change. | [optional] |
+| **keywords** | **String** | The default meta keywords, the storefrontSEOKeywords site attribute. | [optional] |
+| **notes** | **Array<String>** | What a person should know about these settings. | [optional] |
+| **prevent_indexing** | **Boolean** | True when every page tells search engines not to index it.  For a development store only. | [optional] |
+| **schema_org** | **Boolean** | True when pages output Schema.org structured data. | [optional] |
+| **storefront_oid** | **Integer** | The storefront. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSiteSeo.new(
+  approval_needed: null,
+  canonical: null,
+  changed: null,
+  changes: null,
+  description: null,
+  dry_run: null,
+  hash_sha256: null,
+  keywords: null,
+  notes: null,
+  prevent_indexing: null,
+  schema_org: null,
+  storefront_oid: null
+)
+```
+

data/docs/SfvbSiteSeoChange.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbSiteSeoChange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **approval_needed** | **Boolean** | True when this change needs an approved site_seo.change request. | [optional] |
+| **fresh_code** | **Boolean** | True when the approval asks for an authenticator code even inside an open approval session. | [optional] |
+| **from** | **Boolean** | The value before. | [optional] |
+| **setting** | **String** | canonical, schema_org or prevent_indexing. | [optional] |
+| **to** | **Boolean** | The value after. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSiteSeoChange.new(
+  approval_needed: null,
+  fresh_code: null,
+  from: null,
+  setting: null,
+  to: null
+)
+```
+

data/docs/SfvbSiteSeoRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbSiteSeoRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **canonical** | **Boolean** | True to turn Canonical Links on.  Turning them off needs an approved site_seo.change request. | [optional] |
+| **dry_run** | **Boolean** | True to check the change and report it without saving. | [optional] |
+| **prevent_indexing** | **Boolean** | True to tell search engines not to index any page.  Either direction needs an approved site_seo.change request, and turning it on needs a fresh authenticator code. | [optional] |
+| **schema_org** | **Boolean** | True to turn Schema.org structured data on.  Turning it off needs an approved site_seo.change request. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSiteSeoRequest.new(
+  canonical: null,
+  dry_run: null,
+  prevent_indexing: null,
+  schema_org: null
+)
+```
+