ultracart_api 4.1.185 → 4.1.190

data/docs/SfvbI18nGlossary.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbI18nGlossary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hash_sha256** | **String** | Send back as If-Match when saving.  Empty when none has been saved, and then no If-Match is needed. | [optional] |
+| **markdown** | **String** | The glossary, plain markdown.  Empty when none has been saved. | [optional] |
+| **modified_dts** | **String** | When it was last saved, ISO 8601. | [optional] |
+| **storefront_oid** | **Integer** | The storefront. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbI18nGlossary.new(
+  hash_sha256: null,
+  markdown: null,
+  modified_dts: null,
+  storefront_oid: null
+)
+```
+

data/docs/SfvbI18nGlossaryRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbI18nGlossaryRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **markdown** | **String** | The whole glossary, plain markdown, up to 64 KB.  It replaces what is there. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbI18nGlossaryRequest.new(
+  markdown: null
+)
+```
+

data/docs/SfvbI18nLanguage.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbI18nLanguage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **aliases** | **Array<String>** | Other spellings accepted for this language, the two-letter code and the name. | [optional] |
+| **auto_translate** | **Boolean** | True when text without a hand translation is machine translated.  Enabled languages always auto translate. | [optional] |
+| **code** | **String** | UltraCart's three-letter code, the value language maps and render take, such as ESP for Spanish. | [optional] |
+| **default_language** | **Boolean** | True for the language shoppers start in.  It cannot be disabled here. | [optional] |
+| **enabled** | **Boolean** | True when the storefront serves this language. | [optional] |
+| **name** | **String** | The language's English name. | [optional] |
+| **rtl** | **Boolean** | True for a right to left language, so check direction and alignment when rendering it. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbI18nLanguage.new(
+  aliases: null,
+  auto_translate: null,
+  code: null,
+  default_language: null,
+  enabled: null,
+  name: null,
+  rtl: null
+)
+```
+

data/docs/SfvbI18nLanguageEnableRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbI18nLanguageEnableRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **acknowledge_cost** | **Boolean** | Must be true.  Enabling a language turns on machine translation, which is billed per character. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbI18nLanguageEnableRequest.new(
+  acknowledge_cost: null
+)
+```
+

data/docs/SfvbI18nLanguagesResponse.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbI18nLanguagesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **changed** | **Boolean** | On enable or disable, false when the language was already in that state and nothing was saved. | [optional] |
+| **character_estimate** | **Integer** | About how many characters of storefront text one language translates. | [optional] |
+| **default_language_code** | **String** | The code of the language shoppers start in.  The source of every string is still English. | [optional] |
+| **hash_sha256** | **String** | Send back as If-Match when enabling or disabling a language. | [optional] |
+| **languages** | [**Array<SfvbI18nLanguage>**](SfvbI18nLanguage.md) | Every language the storefront can be translated into, enabled or not, English first. | [optional] |
+| **per_language_cost** | **String** | The estimated machine translation cost of enabling one more language, formatted. | [optional] |
+| **storefront_oid** | **Integer** | The storefront. | [optional] |
+| **supports_i18n** | **Boolean** | False when the active theme takes its languages from locale files.  Language and message writes are refused then. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbI18nLanguagesResponse.new(
+  changed: null,
+  character_estimate: null,
+  default_language_code: null,
+  hash_sha256: null,
+  languages: null,
+  per_language_cost: null,
+  storefront_oid: null,
+  supports_i18n: null
+)
+```
+

data/docs/SfvbI18nMachineTranslationsResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbI18nMachineTranslationsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **english_text** | **String** | The English source text. | [optional] |
+| **key** | **String** | The message key, for a built-in message. | [optional] |
+| **property** | **String** | The setting, for a widget's setting. | [optional] |
+| **theme_oid** | **Integer** | The theme the string belongs to. | [optional] |
+| **translations** | [**Array<SfvbI18nTranslation>**](SfvbI18nTranslation.md) | Each enabled language other than English. | [optional] |
+| **widget_id** | **String** | The widget id, for a widget's setting. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbI18nMachineTranslationsResponse.new(
+  english_text: null,
+  key: null,
+  property: null,
+  theme_oid: null,
+  translations: null,
+  widget_id: null
+)
+```
+

data/docs/SfvbI18nMessage.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbI18nMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **edited** | **Boolean** | True when the English was changed from the template's text. | [optional] |
+| **english_text** | **String** | The English text, the source every other language is translated from. | [optional] |
+| **hash_sha256** | **String** | Send back as If-Match when setting or resetting this message. | [optional] |
+| **imported** | **Boolean** | True when the message came from an older theme's locale file.  It cannot be reset. | [optional] |
+| **key** | **String** | The message key. | [optional] |
+| **theme_oid** | **Integer** | The theme the message belongs to.  Messages are kept per storefront and theme. | [optional] |
+| **translations** | [**Array<SfvbI18nTranslation>**](SfvbI18nTranslation.md) | Each enabled language other than English, with its text and where it comes from. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbI18nMessage.new(
+  edited: null,
+  english_text: null,
+  hash_sha256: null,
+  imported: null,
+  key: null,
+  theme_oid: null,
+  translations: null
+)
+```
+

data/docs/SfvbI18nMessageValue.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbI18nMessageValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **language** | **String** | The language code.  ENG changes the English source, which clears its machine translations. | [optional] |
+| **text** | **String** | The new text.  Empty text is refused; reset the message instead. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbI18nMessageValue.new(
+  language: null,
+  text: null
+)
+```
+

data/docs/SfvbI18nMessageWriteRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbI18nMessageWriteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **values** | [**Array<SfvbI18nMessageValue>**](SfvbI18nMessageValue.md) | The languages to change.  Languages not named are left alone. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbI18nMessageWriteRequest.new(
+  values: null
+)
+```
+

data/docs/SfvbI18nMessagesResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbI18nMessagesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | The page size. | [optional] |
+| **messages** | [**Array<SfvbI18nMessage>**](SfvbI18nMessage.md) | The messages on this page, ordered by key. | [optional] |
+| **offset** | **Integer** | The index of the first message on this page. | [optional] |
+| **storefront_oid** | **Integer** | The storefront. | [optional] |
+| **theme_oid** | **Integer** | The theme the messages belong to. | [optional] |
+| **total** | **Integer** | How many messages match, across every page. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbI18nMessagesResponse.new(
+  limit: null,
+  messages: null,
+  offset: null,
+  storefront_oid: null,
+  theme_oid: null,
+  total: null
+)
+```
+

data/docs/SfvbI18nResetResponse.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbI18nResetResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The message key. | [optional] |
+| **note** | **String** | What happens next. | [optional] |
+| **theme_oid** | **Integer** | The theme the message belongs to. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbI18nResetResponse.new(
+  key: null,
+  note: null,
+  theme_oid: null
+)
+```
+

data/docs/SfvbI18nTranslation.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbI18nTranslation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **language** | **String** | The three-letter language code. | [optional] |
+| **source** | **String** | hand for a translation someone wrote, machine for a machine translation, pending when one is queued, none when nothing exists yet (it is made the first time the text renders in that language). | [optional] |
+| **text** | **String** | The text a shopper sees in that language.  Absent when source is none or pending. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbI18nTranslation.new(
+  language: null,
+  source: null,
+  text: null
+)
+```
+

data/docs/SfvbLibraryAiReview.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **findings** | **Object** | What the reviewers found.  detail is the category followed by the quoted evidence. | [optional] |
+| **findings** | [**Array<SfvbLibraryManifestFinding>**](SfvbLibraryManifestFinding.md) | What the reviewers found.  detail is the category followed by the quoted evidence. | [optional] |
 | **prompt_version** | **String** | Version of the review policy that produced this verdict. | [optional] |
 | **reviewed_dts** | **String** | When the review ran, ISO 8601. | [optional] |
 | **screenshot_sha256** | **String** | The screenshot the review looked at, or absent when there was none. | [optional] |

data/docs/SfvbLibraryContentManifest.md

@@ -4,11 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **absolute_asset_urls** | **Object** | Images, fonts, stylesheets, scripts or media loaded from an absolute URL.  A shared or public entry must use relative paths so it never pulls files from another storefront or site. | [optional] |
+| **absolute_asset_urls** | [**Array<SfvbLibraryManifestFinding>**](SfvbLibraryManifestFinding.md) | Images, fonts, stylesheets, scripts or media loaded from an absolute URL.  A shared or public entry must use relative paths so it never pulls files from another storefront or site. | [optional] |
 | **ai_review** | [**SfvbLibraryAiReview**](SfvbLibraryAiReview.md) |  | [optional] |
-| **executable** | **Object** | Content that runs in a shopper's browser or on the server.  Script, html, embed, css and velocity elements, script in markup, Velocity, script bearing CSS and unsafe URL schemes.  An entry with any of these cannot be made public, and installing it needs an explicit acknowledgement. | [optional] |
-| **rejected** | **Object** | Card skimming and obfuscation signals.  An entry with any is refused outright, whoever owns it. | [optional] |
-| **secrets** | **Object** | Strings shaped like credentials, by kind only.  An entry with any cannot be shared or made public. | [optional] |
+| **executable** | [**Array<SfvbLibraryManifestFinding>**](SfvbLibraryManifestFinding.md) | Content that runs in a shopper's browser or on the server.  Script, html, embed, css and velocity elements, script in markup, Velocity, script bearing CSS and unsafe URL schemes.  An entry with any of these cannot be made public, and installing it needs an explicit acknowledgement. | [optional] |
+| **rejected** | [**Array<SfvbLibraryManifestFinding>**](SfvbLibraryManifestFinding.md) | Card skimming and obfuscation signals.  An entry with any is refused outright, whoever owns it. | [optional] |
+| **secrets** | [**Array<SfvbLibraryManifestFinding>**](SfvbLibraryManifestFinding.md) | Strings shaped like credentials, by kind only.  An entry with any cannot be shared or made public. | [optional] |
 
 ## Example
 

data/docs/SfvbLibraryManifestFinding.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbLibraryManifestFinding
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **detail** | **String** | What was found.  For an absolute asset URL this is the URL.  For a credential it is only the kind of credential, never its value. | [optional] |
+| **widget_id** | **String** | Id of the widget the finding is in. | [optional] |
+| **widget_type** | **String** | Element type of that widget. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryManifestFinding.new(
+  detail: null,
+  widget_id: null,
+  widget_type: null
+)
+```
+

data/docs/SfvbLibraryParameter.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **default** | **String** | The value used when none is supplied. | [optional] |
+| **default_value** | **String** | The value used when none is supplied. | [optional] |
 | **description** | **String** | What the value is used for. | [optional] |
 | **name** | **String** | Parameter name, letters, digits, hyphens and underscores. | [optional] |
 | **required** | **Boolean** | True when the fragment cannot be used without it. | [optional] |
@@ -16,7 +16,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::SfvbLibraryParameter.new(
-  default: null,
+  default_value: null,
   description: null,
   name: null,
   required: null,

data/docs/SfvbLibraryTaxonomyCatalog.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **dimensions** | **Object** | purpose, section, industry and style, each with its allowed tags. | [optional] |
+| **dimensions** | [**Array<SfvbLibraryTaxonomyDimension>**](SfvbLibraryTaxonomyDimension.md) | purpose, section, industry and style, each with its allowed tags. | [optional] |
 
 ## Example
 

data/docs/SfvbLibraryTaxonomyDimension.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbLibraryTaxonomyDimension
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | What the dimension describes. | [optional] |
+| **name** | **String** | The taxonomy field this list applies to. | [optional] |
+| **tags** | [**Array<SfvbLibraryTaxonomyTag>**](SfvbLibraryTaxonomyTag.md) | The allowed tags, in display order. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryTaxonomyDimension.new(
+  description: null,
+  name: null,
+  tags: null
+)
+```
+

data/docs/SfvbLibraryTaxonomyTag.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbLibraryTaxonomyTag
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | When to use it. | [optional] |
+| **slug** | **String** | The value to send in the entry's taxonomy. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryTaxonomyTag.new(
+  description: null,
+  slug: null
+)
+```
+