ultracart_api 4.1.183 → 4.1.185

data/docs/SfvbLibraryAiReview.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbLibraryAiReview
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **findings** | **Object** | 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] |
+| **summary** | **String** | One or two sentences explaining the verdict. | [optional] |
+| **verdict** | **String** | approve, block, human or error.  block refuses any publish.  human or error refuses a public publish and is recorded on a shared one. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryAiReview.new(
+  findings: null,
+  prompt_version: null,
+  reviewed_dts: null,
+  screenshot_sha256: null,
+  summary: null,
+  verdict: null
+)
+```
+

data/docs/SfvbLibraryContentManifest.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbLibraryContentManifest
+
+## Properties
+
+| 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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryContentManifest.new(
+  absolute_asset_urls: null,
+  ai_review: null,
+  executable: null,
+  rejected: null,
+  secrets: null
+)
+```
+

data/docs/SfvbLibraryDeleteResult.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbLibraryDeleteResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **library_oid** | **Integer** | The entry. | [optional] |
+| **result** | **String** | deleted when the entry was private and never published or installed, so it is gone.  retired when it had been published or installed, so it was kept for the storefronts that use it and taken out of search. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryDeleteResult.new(
+  library_oid: null,
+  result: null
+)
+```
+

data/docs/SfvbLibraryEntry.md

@@ -6,14 +6,28 @@
 | ---- | ---- | ----------- | ----- |
 | **bookmarked** | **Boolean** | True when the calling user has bookmarked this entry. | [optional] |
 | **cjson** | **String** | The fragment's CJSON.  Omitted from search results to keep them terse; fetch a single entry to get it. | [optional] |
+| **content_manifest** | [**SfvbLibraryContentManifest**](SfvbLibraryContentManifest.md) |  | [optional] |
 | **description** | **String** | What this fragment is for. | [optional] |
+| **hash_sha256** | **String** | Hash of the draft's writable fields.  Send it back as If-Match to update, delete or publish.  Present only for the owner. | [optional] |
+| **last_modified_dts** | **String** | When the draft was last saved, ISO 8601. | [optional] |
 | **library_oid** | **Integer** | Library entry oid. | [optional] |
 | **name** | **String** | Entry name. | [optional] |
 | **owned** | **Boolean** | True when the calling user owns this entry. | [optional] |
+| **parameters** | [**Array<SfvbLibraryParameter>**](SfvbLibraryParameter.md) | Named values the fragment expects the installer to supply. | [optional] |
+| **published_revision_number** | **Integer** | The latest published revision, or null when the entry has never been published. | [optional] |
 | **referenced_files** | **Array<String>** | Storefront file paths this fragment references.  Installing the fragment copies them into the storefront; reading it does not. | [optional] |
+| **retired** | **Boolean** | True when the owner deleted an entry that had been published or installed.  It is kept so existing installs still resolve, and it leaves search. | [optional] |
+| **revision_number** | **Integer** | The revision returned.  For the owner this is the draft, which every save increments.  For anyone else it is the published revision. | [optional] |
+| **screenshot_height** | **Integer** | Screenshot height in pixels. | [optional] |
 | **screenshot_key** | **String** | S3 listing key for the large screenshot, when one has been generated. | [optional] |
+| **screenshot_sha256** | **String** | Hash of the uploaded screenshot. | [optional] |
+| **screenshot_stale** | **Boolean** | True on an update that changed the fragment of an entry with a screenshot.  Retake it and set it again with the library screenshot endpoint. | [optional] |
+| **screenshot_width** | **Integer** | Screenshot width in pixels. | [optional] |
 | **share_with_account** | **Boolean** | True when the entry is shared across the merchant account. | [optional] |
+| **shared_with** | [**Array<SfvbLibraryShareTarget>**](SfvbLibraryShareTarget.md) | Linked accounts the entry is shared with.  Present only for the owner. | [optional] |
+| **taxonomy** | [**SfvbLibraryTaxonomy**](SfvbLibraryTaxonomy.md) |  | [optional] |
 | **thumbnail_key** | **String** | S3 listing key for the medium thumbnail, when one has been generated.  Thumbnails are produced asynchronously and can lag a save by a minute or two. | [optional] |
+| **visibility** | **String** | private, shared or public. | [optional] |
 | **widget_type** | **String** | Element type at the root of the fragment. | [optional] |
 
 ## Example
@@ -24,14 +38,28 @@ require 'ultracart_api'
 instance = UltracartClient::SfvbLibraryEntry.new(
   bookmarked: null,
   cjson: null,
+  content_manifest: null,
   description: null,
+  hash_sha256: null,
+  last_modified_dts: null,
   library_oid: null,
   name: null,
   owned: null,
+  parameters: null,
+  published_revision_number: null,
   referenced_files: null,
+  retired: null,
+  revision_number: null,
+  screenshot_height: null,
   screenshot_key: null,
+  screenshot_sha256: null,
+  screenshot_stale: null,
+  screenshot_width: null,
   share_with_account: null,
+  shared_with: null,
+  taxonomy: null,
   thumbnail_key: null,
+  visibility: null,
   widget_type: null
 )
 ```

data/docs/SfvbLibraryEntryRequest.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbLibraryEntryRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cjson** | **String** | The fragment, one widget and its children.  Not a whole container. | [optional] |
+| **description** | **String** | What the fragment is for, at most 1024 characters. | [optional] |
+| **name** | **String** | Entry name, at most 100 characters. | [optional] |
+| **parameters** | [**Array<SfvbLibraryParameter>**](SfvbLibraryParameter.md) | Named values the fragment expects its installer to supply. | [optional] |
+| **screenshot** | [**SfvbLibraryScreenshotRequest**](SfvbLibraryScreenshotRequest.md) |  | [optional] |
+| **share_with_account** | **Boolean** | True to let the other users on this merchant account see the published revision. | [optional] |
+| **taxonomy** | [**SfvbLibraryTaxonomy**](SfvbLibraryTaxonomy.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryEntryRequest.new(
+  cjson: null,
+  description: null,
+  name: null,
+  parameters: null,
+  screenshot: null,
+  share_with_account: null,
+  taxonomy: null
+)
+```
+

data/docs/SfvbLibraryFacet.md

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **display_name** | **String** | Human readable facet name. | [optional] |
-| **name** | **String** | Facet key.  Pass a chosen option back as facet_{name}={option}. | [optional] |
-| **options** | **Array<String>** | Available values for this facet. | [optional] |
+| **name** | **String** | Facet key, such as facet_purpose.  To select an option, add a query parameter named after the key whose value is the key, a colon and the option. | [optional] |
+| **options** | **Array<String>** | Values present in the results.  A facet with only one value is left out unless it is selected. | [optional] |
 
 ## Example
 

data/docs/SfvbLibraryHistoryEntry.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbLibraryHistoryEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hash_sha256** | **String** | Hash of the published revision. | [optional] |
+| **published_dts** | **String** | When it was published, ISO 8601. | [optional] |
+| **release_notes** | **String** | What changed, as the publisher described it. | [optional] |
+| **revision_number** | **Integer** | The revision that was published. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryHistoryEntry.new(
+  hash_sha256: null,
+  published_dts: null,
+  release_notes: null,
+  revision_number: null
+)
+```
+

data/docs/SfvbLibraryHistoryResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbLibraryHistoryResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **revisions** | [**Array<SfvbLibraryHistoryEntry>**](SfvbLibraryHistoryEntry.md) | The published revisions, newest first. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryHistoryResponse.new(
+  revisions: null
+)
+```
+

data/docs/SfvbLibraryInstallConflict.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbLibraryInstallConflict
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **existing_sha256** | **String** | Hash of the file already at that path. | [optional] |
+| **path** | **String** | The storefront path. | [optional] |
+| **snapshot_sha256** | **String** | Hash of the file the entry would install. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryInstallConflict.new(
+  existing_sha256: null,
+  path: null,
+  snapshot_sha256: null
+)
+```
+

data/docs/SfvbLibraryInstallReceipt.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbLibraryInstallReceipt
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cjson** | **String** | The fragment, with its file paths rewritten to where they were installed.  Ready to place. | [optional] |
+| **conflicts** | [**Array<SfvbLibraryInstallConflict>**](SfvbLibraryInstallConflict.md) | Paths that already held a different file.  With on_conflict fail these refuse the install. | [optional] |
+| **content_manifest** | [**SfvbLibraryContentManifest**](SfvbLibraryContentManifest.md) |  | [optional] |
+| **files_skipped** | **Array<String>** | Paths not written, because an identical or chosen existing file was kept, or the file could not be fetched. | [optional] |
+| **files_written** | **Array<String>** | Storefront paths this install wrote. | [optional] |
+| **library_oid** | **Integer** | The entry. | [optional] |
+| **revision_number** | **Integer** | The revision installed. | [optional] |
+| **unresolved_parameters** | **Array<String>** | Required parameters with no default.  Replace them in the cjson before placing it. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryInstallReceipt.new(
+  cjson: null,
+  conflicts: null,
+  content_manifest: null,
+  files_skipped: null,
+  files_written: null,
+  library_oid: null,
+  revision_number: null,
+  unresolved_parameters: null
+)
+```
+

data/docs/SfvbLibraryInstallRecord.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbLibraryInstallRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **installed_dts** | **String** | When it was installed, ISO 8601. | [optional] |
+| **installed_revision_number** | **Integer** | The revision installed most recently on this storefront. | [optional] |
+| **latest_revision_number** | **Integer** | The latest published revision, or null when it can no longer be read. | [optional] |
+| **library_oid** | **Integer** | The entry. | [optional] |
+| **name** | **String** | The entry name, when the entry is still visible to this account. | [optional] |
+| **retired** | **Boolean** | True when the owner retired the entry.  The installed copy keeps working. | [optional] |
+| **storefront_oid** | **Integer** | The storefront it was installed on. | [optional] |
+| **update_available** | **Boolean** | True when a newer revision has been published.  Nothing updates automatically. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryInstallRecord.new(
+  installed_dts: null,
+  installed_revision_number: null,
+  latest_revision_number: null,
+  library_oid: null,
+  name: null,
+  retired: null,
+  storefront_oid: null,
+  update_available: null
+)
+```
+

data/docs/SfvbLibraryInstallRequest.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbLibraryInstallRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **acknowledge_executable** | **Boolean** | Must be true to install an entry whose content_manifest lists executable content.  Read the manifest first. | [optional] |
+| **on_conflict** | **String** | What to do when a file the entry installs already exists with different content.  fail refuses and writes nothing, skip keeps the existing file, overwrite replaces it. | [optional] |
+| **revision_number** | **Integer** | A published revision to install.  Defaults to the latest one, or the draft for the owner. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryInstallRequest.new(
+  acknowledge_executable: null,
+  on_conflict: null,
+  revision_number: null
+)
+```
+

data/docs/SfvbLibraryInstallsResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbLibraryInstallsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **installs** | [**Array<SfvbLibraryInstallRecord>**](SfvbLibraryInstallRecord.md) | The newest install of each entry on the storefront. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryInstallsResponse.new(
+  installs: null
+)
+```
+

data/docs/SfvbLibraryParameter.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbLibraryParameter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **default** | **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] |
+| **type** | **String** | What kind of value it takes, such as string, url, color or item. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryParameter.new(
+  default: null,
+  description: null,
+  name: null,
+  required: null,
+  type: null
+)
+```
+

data/docs/SfvbLibraryPublishRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbLibraryPublishRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **release_notes** | **String** | What changed in this revision, at most 4000 characters.  Publish only. | [optional] |
+| **visibility** | **String** | On publish, shared or public.  On unpublish, shared or private.  Public needs the library publisher property on the account. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryPublishRequest.new(
+  release_notes: null,
+  visibility: null
+)
+```
+

data/docs/SfvbLibraryScreenshotRequest.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbLibraryScreenshotRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The staging key files/upload_url/png returned, after the PNG was PUT to its URL.  Redeemed once. | [optional] |
+| **sha256** | **String** | SHA-256 of the PNG bytes uploaded, lower case hex.  The upload is refused if it does not match. | [optional] |
+| **source** | **String** | Where the image came from.  own for a screenshot you took, licensed or stock otherwise.  Needed before the entry can be made public. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryScreenshotRequest.new(
+  key: null,
+  sha256: null,
+  source: null
+)
+```
+

data/docs/SfvbLibraryShareRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbLibraryShareRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchant_id** | **String** | One of the merchant ids share_targets lists. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryShareRequest.new(
+  merchant_id: null
+)
+```
+

data/docs/SfvbLibraryShareTarget.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbLibraryShareTarget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company** | **String** | The linked account's company name. | [optional] |
+| **merchant_id** | **String** | The linked account's merchant id. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryShareTarget.new(
+  company: null,
+  merchant_id: null
+)
+```
+

data/docs/SfvbLibraryShareTargetsResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbLibraryShareTargetsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **share_targets** | [**Array<SfvbLibraryShareTarget>**](SfvbLibraryShareTarget.md) | The calling account's linked accounts, each with its merchant id and company. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryShareTargetsResponse.new(
+  share_targets: null
+)
+```
+

data/docs/SfvbLibraryTaxonomy.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbLibraryTaxonomy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **industry** | **Array<String>** | Industries the fragment suits. | [optional] |
+| **purpose** | **Array<String>** | What the fragment is for, such as hero, social-proof or faq.  At least one is required. | [optional] |
+| **section** | **Array<String>** | Where the fragment goes, such as header, footer or product-detail. | [optional] |
+| **style** | **Array<String>** | Visual styles the fragment has. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryTaxonomy.new(
+  industry: null,
+  purpose: null,
+  section: null,
+  style: null
+)
+```
+

data/docs/SfvbLibraryTaxonomyCatalog.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbLibraryTaxonomyCatalog
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dimensions** | **Object** | purpose, section, industry and style, each with its allowed tags. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryTaxonomyCatalog.new(
+  dimensions: null
+)
+```
+

data/docs/SfvbLibraryUnshareResult.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbLibraryUnshareResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **existing_installs** | [**Array<SfvbLibraryInstallRecord>**](SfvbLibraryInstallRecord.md) | That account's installs, which keep their copies.  Unsharing never reaches into a storefront. | [optional] |
+| **library_oid** | **Integer** | The entry. | [optional] |
+| **merchant_id** | **String** | The account the entry is no longer shared with. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryUnshareResult.new(
+  existing_installs: null,
+  library_oid: null,
+  merchant_id: null
+)
+```
+

data/docs/SfvbWhoamiResponse.md

@@ -8,6 +8,7 @@
 | **application_name** | **String** | Description of the application this credential belongs to. | [optional] |
 | **authentication_type** | **String** | How this token authenticated - Oauth2, Simple Key, Public/Private Key or Browser Key. | [optional] |
 | **can_publish** | **Boolean** | True when this token may write a target that is currently live - an active upsell offer, an email on a delivering flow, the active theme, the storefront root.  Never infer this; it is the difference between a draft edit and a shopper visible change. | [optional] |
+| **can_publish_public** | **Boolean** | True when this account may publish library entries to the public library.  Set by UltraCart staff only. | [optional] |
 | **can_read** | **Boolean** | True when this token may read.  Do not infer this from the requested scope name. | [optional] |
 | **can_write** | **Boolean** | True when this token may write.  Writing a target that is not currently live needs only this. | [optional] |
 | **device_scope** | **String** | Device scope name, when this is a device flow token. | [optional] |
@@ -28,6 +29,7 @@ instance = UltracartClient::SfvbWhoamiResponse.new(
   application_name: null,
   authentication_type: null,
   can_publish: null,
+  can_publish_public: null,
   can_read: null,
   can_write: null,
   device_scope: null,