ultracart_api 4.1.152 → 4.1.154

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0ea0de2841710ce3dec7e18831851afe0ed6050c7032c7fb438545e70dfd728
-  data.tar.gz: fdd7b997d12a5ad7e6e554fba251212dc8385dc0f33ab34d8994613dd8edb224
+  metadata.gz: 37ac39f21f4d4926dc445c05679cf88a52c25751ae967e68d2a04ce2db104c86
+  data.tar.gz: 97a320a75abbf442e767bbc17d549e1f980687e2db385229f6d75dbe11d4482c
 SHA512:
-  metadata.gz: 07e8aa7717a139f16a11934a5935d4c373fc14ad444ceb8ee9d239aec4ba0b14e60a5144027001c41db199316ac082ffc0c8228672050bd47efb8d1ee3777bd2
-  data.tar.gz: 36700814e5460576a8233647604a6a7fcfa744079b364b81ad0ef0785eef69183fcf3db282a7ada0a060baf0ae1b165cc287e938fac601d24c85a6a788777225
+  metadata.gz: de44ec246f9b2af49724ae1bb120ce8d2b79a9a68db06e98ffb734fa51c7bc9599f57f2232d63f5a7eae3ad174af5523fd46d6ef0a14c303f00b114a5136dfdf
+  data.tar.gz: 0f6a6d5026cd0175acb8da55d748ce4d0a6f6f1ae4ca5ec12052d477e994ef633fbc6d94da1faf3abdd6133df8577d372b79c405f3d75fa023d34a166282b8e6

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.152
+- Package version: 4.1.154
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.152'
+gem 'ultracart_api', '4.1.154'
 ```
 
 install:
@@ -475,16 +475,18 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**compile_sfvb_cjson**](docs/SfvbApi.md#compile_sfvb_cjson) | **POST** /sfvb/cjson/compile | Compile CJSON to Velocity
 *UltracartClient::SfvbApi* | [**create_sfvb_preview_session**](docs/SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session
 *UltracartClient::SfvbApi* | [**delete_sfvb_file**](docs/SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file
+*UltracartClient::SfvbApi* | [**delete_sfvb_page_multimedia**](docs/SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page
 *UltracartClient::SfvbApi* | [**delete_sfvb_preview_session**](docs/SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session
 *UltracartClient::SfvbApi* | [**download_sfvb_file**](docs/SfvbApi.md#download_sfvb_file) | **GET** /sfvb/storefronts/{storefront_oid}/files/download | Read a storefront file's raw bytes
 *UltracartClient::SfvbApi* | [**duplicate_sfvb_theme**](docs/SfvbApi.md#duplicate_sfvb_theme) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/duplicate | Duplicate a theme
 *UltracartClient::SfvbApi* | [**get_sfvb_cjson_used_elements**](docs/SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container
 *UltracartClient::SfvbApi* | [**get_sfvb_container**](docs/SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system
 *UltracartClient::SfvbApi* | [**get_sfvb_container_version**](docs/SfvbApi.md#get_sfvb_container_version) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions/{container_history_oid} | Read the CJSON stored in one container history entry
-*UltracartClient::SfvbApi* | [**get_sfvb_element**](docs/SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema for one element type
+*UltracartClient::SfvbApi* | [**get_sfvb_element**](docs/SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type
 *UltracartClient::SfvbApi* | [**get_sfvb_file_content**](docs/SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file
 *UltracartClient::SfvbApi* | [**get_sfvb_file_upload_url**](docs/SfvbApi.md#get_sfvb_file_upload_url) | **GET** /sfvb/storefronts/{storefront_oid}/files/upload_url/{extension} | Get a URL to upload a binary asset to
 *UltracartClient::SfvbApi* | [**get_sfvb_library_entry**](docs/SfvbApi.md#get_sfvb_library_entry) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Read one library entry including its CJSON
+*UltracartClient::SfvbApi* | [**get_sfvb_page**](docs/SfvbApi.md#get_sfvb_page) | **GET** /sfvb/storefronts/{storefront_oid}/pages | Read a page's attributes and images
 *UltracartClient::SfvbApi* | [**get_sfvb_preview_url**](docs/SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session
 *UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
 *UltracartClient::SfvbApi* | [**get_sfvb_theme_attributes**](docs/SfvbApi.md#get_sfvb_theme_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Read a theme's colors, fonts and settings
@@ -501,6 +503,8 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**list_sfvb_upsell_offers**](docs/SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers
 *UltracartClient::SfvbApi* | [**put_sfvb_container**](docs/SfvbApi.md#put_sfvb_container) | **PUT** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Write a container stored outside the file system
 *UltracartClient::SfvbApi* | [**put_sfvb_file_content**](docs/SfvbApi.md#put_sfvb_file_content) | **PUT** /sfvb/storefronts/{storefront_oid}/files/content | Write a storefront file
+*UltracartClient::SfvbApi* | [**put_sfvb_page_attributes**](docs/SfvbApi.md#put_sfvb_page_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/attributes | Change a page's attributes
+*UltracartClient::SfvbApi* | [**put_sfvb_page_multimedia**](docs/SfvbApi.md#put_sfvb_page_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Attach an image to a page
 *UltracartClient::SfvbApi* | [**put_sfvb_preview_session**](docs/SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session
 *UltracartClient::SfvbApi* | [**put_sfvb_theme_attributes**](docs/SfvbApi.md#put_sfvb_theme_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Change a theme's colors, fonts and settings
 *UltracartClient::SfvbApi* | [**render_sfvb_widgets**](docs/SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML
@@ -1754,6 +1758,12 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbLibraryEntry](docs/SfvbLibraryEntry.md)
  - [UltracartClient::SfvbLibraryFacet](docs/SfvbLibraryFacet.md)
  - [UltracartClient::SfvbLibraryResponse](docs/SfvbLibraryResponse.md)
+ - [UltracartClient::SfvbPageAttribute](docs/SfvbPageAttribute.md)
+ - [UltracartClient::SfvbPageAttributeUpdate](docs/SfvbPageAttributeUpdate.md)
+ - [UltracartClient::SfvbPageAttributeUpdateRequest](docs/SfvbPageAttributeUpdateRequest.md)
+ - [UltracartClient::SfvbPageMultimedia](docs/SfvbPageMultimedia.md)
+ - [UltracartClient::SfvbPageMultimediaRequest](docs/SfvbPageMultimediaRequest.md)
+ - [UltracartClient::SfvbPageResponse](docs/SfvbPageResponse.md)
  - [UltracartClient::SfvbPreviewSessionRequest](docs/SfvbPreviewSessionRequest.md)
  - [UltracartClient::SfvbPreviewSessionResponse](docs/SfvbPreviewSessionResponse.md)
  - [UltracartClient::SfvbPreviewUrlResponse](docs/SfvbPreviewUrlResponse.md)
@@ -1942,6 +1952,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.154 | 09/14/2026 | sfvb internal testing |
+| 4.1.153 | 09/14/2026 | sfvb internal testing |
 | 4.1.152 | 09/09/2026 | sfvb - internal testing |
 | 4.1.151 | 09/04/2026 | conversations - added ai agent capabilities |
 | 4.1.150 | 09/04/2026 | conversations - add ai agent capabilities |

data/docs/SfvbApi.md

@@ -7,16 +7,18 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**compile_sfvb_cjson**](SfvbApi.md#compile_sfvb_cjson) | **POST** /sfvb/cjson/compile | Compile CJSON to Velocity |
 | [**create_sfvb_preview_session**](SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session |
 | [**delete_sfvb_file**](SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file |
+| [**delete_sfvb_page_multimedia**](SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page |
 | [**delete_sfvb_preview_session**](SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session |
 | [**download_sfvb_file**](SfvbApi.md#download_sfvb_file) | **GET** /sfvb/storefronts/{storefront_oid}/files/download | Read a storefront file's raw bytes |
 | [**duplicate_sfvb_theme**](SfvbApi.md#duplicate_sfvb_theme) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/duplicate | Duplicate a theme |
 | [**get_sfvb_cjson_used_elements**](SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container |
 | [**get_sfvb_container**](SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system |
 | [**get_sfvb_container_version**](SfvbApi.md#get_sfvb_container_version) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions/{container_history_oid} | Read the CJSON stored in one container history entry |
-| [**get_sfvb_element**](SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema for one element type |
+| [**get_sfvb_element**](SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type |
 | [**get_sfvb_file_content**](SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file |
 | [**get_sfvb_file_upload_url**](SfvbApi.md#get_sfvb_file_upload_url) | **GET** /sfvb/storefronts/{storefront_oid}/files/upload_url/{extension} | Get a URL to upload a binary asset to |
 | [**get_sfvb_library_entry**](SfvbApi.md#get_sfvb_library_entry) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Read one library entry including its CJSON |
+| [**get_sfvb_page**](SfvbApi.md#get_sfvb_page) | **GET** /sfvb/storefronts/{storefront_oid}/pages | Read a page's attributes and images |
 | [**get_sfvb_preview_url**](SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session |
 | [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
 | [**get_sfvb_theme_attributes**](SfvbApi.md#get_sfvb_theme_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Read a theme's colors, fonts and settings |
@@ -33,6 +35,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**list_sfvb_upsell_offers**](SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers |
 | [**put_sfvb_container**](SfvbApi.md#put_sfvb_container) | **PUT** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Write a container stored outside the file system |
 | [**put_sfvb_file_content**](SfvbApi.md#put_sfvb_file_content) | **PUT** /sfvb/storefronts/{storefront_oid}/files/content | Write a storefront file |
+| [**put_sfvb_page_attributes**](SfvbApi.md#put_sfvb_page_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/attributes | Change a page's attributes |
+| [**put_sfvb_page_multimedia**](SfvbApi.md#put_sfvb_page_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Attach an image to a page |
 | [**put_sfvb_preview_session**](SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session |
 | [**put_sfvb_theme_attributes**](SfvbApi.md#put_sfvb_theme_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Change a theme's colors, fonts and settings |
 | [**render_sfvb_widgets**](SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML |
@@ -207,6 +211,62 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## delete_sfvb_page_multimedia
+
+> <SfvbPageResponse> delete_sfvb_page_multimedia(storefront_oid, path, opts)
+
+Detach an image from a page
+
+Name exactly one of code or default.  Removes the page's copy of the image; the source file in the page folder is left alone.  Always needs sfvb_publish. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the delete_sfvb_page_multimedia_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbPageResponse>, Integer, Hash)> delete_sfvb_page_multimedia_with_http_info(storefront_oid, path, opts)
+
+```ruby
+begin
+  # Detach an image from a page
+  data, status_code, headers = api_instance.delete_sfvb_page_multimedia_with_http_info(storefront_oid, path, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbPageResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->delete_sfvb_page_multimedia_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **path** | **String** | Page path, for example /catalog/dispensers/ |  |
+| **code** | **String** | Image code to detach | [optional] |
+| **default** | **Boolean** | True to detach the default image | [optional] |
+
+### Return type
+
+[**SfvbPageResponse**](SfvbPageResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## delete_sfvb_preview_session
 
 > delete_sfvb_preview_session(storefront_oid, preview_session_id)
@@ -538,7 +598,9 @@ end
 
 > <SfvbElementSchemaResponse> get_sfvb_element(element_type)
 
-Configuration schema for one element type
+Configuration schema and field card for one element type
+
+schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here. 
 
 
 ### Examples
@@ -555,7 +617,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Configuration schema for one element type
+  # Configuration schema and field card for one element type
   data, status_code, headers = api_instance.get_sfvb_element_with_http_info(element_type)
   p status_code # => 2xx
   p headers # => { ... }
@@ -748,6 +810,60 @@ end
 - **Accept**: application/json
 
 
+## get_sfvb_page
+
+> <SfvbPageResponse> get_sfvb_page(storefront_oid, path)
+
+Read a page's attributes and images
+
+What the pageattribute and pageimage elements render for this page.  These are not in any file, which is why a page folder can be empty and its elements still render something.  Attributes and image codes a template declares but nothing has set are included, so the response describes what the page can show rather than only what has been saved. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_page_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbPageResponse>, Integer, Hash)> get_sfvb_page_with_http_info(storefront_oid, path)
+
+```ruby
+begin
+  # Read a page's attributes and images
+  data, status_code, headers = api_instance.get_sfvb_page_with_http_info(storefront_oid, path)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbPageResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_page_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **path** | **String** | Page path, for example /catalog/dispensers/ |  |
+
+### Return type
+
+[**SfvbPageResponse**](SfvbPageResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_sfvb_preview_url
 
 > <SfvbPreviewUrlResponse> get_sfvb_preview_url(storefront_oid, preview_session_id, opts)
@@ -1604,6 +1720,116 @@ end
 - **Accept**: application/json
 
 
+## put_sfvb_page_attributes
+
+> <SfvbPageResponse> put_sfvb_page_attributes(storefront_oid, path, page_attribute_update_request)
+
+Change a page's attributes
+
+A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, slider, item set, page collection and video list attributes are refused - edit those in the page editor.  Always needs sfvb_publish, because a page's attributes are shared by every theme and there is no dormant copy to change instead. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the put_sfvb_page_attributes_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbPageResponse>, Integer, Hash)> put_sfvb_page_attributes_with_http_info(storefront_oid, path, page_attribute_update_request)
+
+```ruby
+begin
+  # Change a page's attributes
+  data, status_code, headers = api_instance.put_sfvb_page_attributes_with_http_info(storefront_oid, path, page_attribute_update_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbPageResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->put_sfvb_page_attributes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **path** | **String** | Page path, for example /catalog/dispensers/ |  |
+| **page_attribute_update_request** | [**SfvbPageAttributeUpdateRequest**](SfvbPageAttributeUpdateRequest.md) | Attributes to change |  |
+
+### Return type
+
+[**SfvbPageResponse**](SfvbPageResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## put_sfvb_page_multimedia
+
+> <SfvbPageResponse> put_sfvb_page_multimedia(storefront_oid, path, page_multimedia_request)
+
+Attach an image to a page
+
+Upload the image with files/upload to the page path followed by a filename first, then name that filename here as either the default image or an image code.  The default image is what a pageimage element with no pageImageCode renders, and what a subgroup tile shows.  Replaces whatever that slot held.  Always needs sfvb_publish. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the put_sfvb_page_multimedia_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbPageResponse>, Integer, Hash)> put_sfvb_page_multimedia_with_http_info(storefront_oid, path, page_multimedia_request)
+
+```ruby
+begin
+  # Attach an image to a page
+  data, status_code, headers = api_instance.put_sfvb_page_multimedia_with_http_info(storefront_oid, path, page_multimedia_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbPageResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->put_sfvb_page_multimedia_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **path** | **String** | Page path, for example /catalog/dispensers/ |  |
+| **page_multimedia_request** | [**SfvbPageMultimediaRequest**](SfvbPageMultimediaRequest.md) | Image to attach |  |
+
+### Return type
+
+[**SfvbPageResponse**](SfvbPageResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## put_sfvb_preview_session
 
 > <SfvbPreviewSessionResponse> put_sfvb_preview_session(storefront_oid, preview_session_id, preview_session, opts)

data/docs/SfvbElement.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **doc_available** | **Boolean** | True when a markdown field card for this element is available from elements/{element_type}. | [optional] |
 | **schema_available** | **Boolean** | True when a per element configuration schema is available from elements/{element_type}. | [optional] |
 | **type** | **String** | The element type as it appears in the type property of a CJSON node. | [optional] |
 
@@ -13,6 +14,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::SfvbElement.new(
+  doc_available: null,
   schema_available: null,
   type: null
 )

data/docs/SfvbElementSchemaResponse.md

@@ -4,7 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **schema** | **String** | JSON schema for this element's config object, as a JSON string.  Null when no schema has been published for this element yet. | [optional] |
+| **doc** | **String** | Markdown field card for this element, as a string.  Omitted when no field card has been published for this element. | [optional] |
+| **schema** | **String** | Draft-07 JSON schema for this element's config object, as a JSON string.  Omitted when no schema has been published for this element. | [optional] |
 | **type** | **String** | The element type. | [optional] |
 
 ## Example
@@ -13,6 +14,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::SfvbElementSchemaResponse.new(
+  doc: null,
   schema: null,
   type: null
 )

data/docs/SfvbPageAttribute.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbPageAttribute
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deprecated** | **Boolean** | True when the active theme marks this attribute as on its way out.  Prefer not to build on it. | [optional] |
+| **name** | **String** | Attribute name, as the template's uc page-attribute directive spells it.  Compare case insensitively.  This is the value pageAttributeName refers to. | [optional] |
+| **type** | **String** | What kind of attribute this is, taken from the template that declares it rather than from the stored row.  orphan means no template declares it.  reserved covers the page SEO fields. | [optional] |
+| **undeclared** | **Boolean** | True when no template references this name.  Writing such a name is allowed, but if you did not mean to create one this is a misspelling and nothing on the page will show it. | [optional] |
+| **used_by** | **String** | The other themes that declare this attribute, when the active theme does not. | [optional] |
+| **used_by_current_theme** | **Boolean** | True when a template in the active theme declares this attribute. | [optional] |
+| **value** | **String** | The stored value.  Empty when a template declares the attribute and nothing has set it. | [optional] |
+| **writable** | **Boolean** | True when this API will change the value.  List, slider, item set, page collection and video list values are structured documents carrying their own translation references and derived data, so they are shown here but must be edited in the page editor. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageAttribute.new(
+  deprecated: null,
+  name: null,
+  type: null,
+  undeclared: null,
+  used_by: null,
+  used_by_current_theme: null,
+  value: null,
+  writable: null
+)
+```
+

data/docs/SfvbPageAttributeUpdate.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbPageAttributeUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Attribute name.  Matched without regard to case against what the page already has, so you do not have to reproduce the exact casing.  A name nothing matches creates a new attribute. | [optional] |
+| **type** | **String** | Only consulted when creating an attribute no template declares.  For a declared attribute the template's type always wins, because the templates decide it and not the caller. | [optional] |
+| **value** | **String** | The value to store.  An empty string clears it.  For html the markup is stored as given and rendered as given.  For boolean send the text true or false. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageAttributeUpdate.new(
+  name: null,
+  type: null,
+  value: null
+)
+```
+

data/docs/SfvbPageAttributeUpdateRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbPageAttributeUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attributes** | [**Array<SfvbPageAttributeUpdate>**](SfvbPageAttributeUpdate.md) | The attributes to change.  Every entry is checked before any is written, so a request naming one attribute this API will not change writes nothing rather than part of what it asked for. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageAttributeUpdateRequest.new(
+  attributes: null
+)
+```
+

data/docs/SfvbPageMultimedia.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbPageMultimedia
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The image code, which is what pageImageCode refers to.  Empty for the default image. | [optional] |
+| **declared** | **Boolean** | True when a template declares this code.  An attached image whose code nothing declares renders nowhere unless a pageimage element names it. | [optional] |
+| **default** | **Boolean** | True for the page's default image, which a pageimage element with no pageImageCode renders.  This is the thumbnail a subgroup tile shows. | [optional] |
+| **description** | **String** | What the slot is for, as the declaring template describes it, otherwise the description stored with the image.  Rendered as the alt text. | [optional] |
+| **dimensions** | **String** | Width x height in pixels, when the attached file is an image. | [optional] |
+| **filename** | **String** | The attached file's name within the page's folder.  Empty when nothing is attached. | [optional] |
+| **public_url** | **String** | Where the source file is served on the storefront.  Absent when nothing is attached. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageMultimedia.new(
+  code: null,
+  declared: null,
+  default: null,
+  description: null,
+  dimensions: null,
+  filename: null,
+  public_url: null
+)
+```
+

data/docs/SfvbPageMultimediaRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbPageMultimediaRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Attach under this image code, the value a pageimage element's pageImageCode names. | [optional] |
+| **default** | **Boolean** | True to make this the page's default image, which a pageimage element with no pageImageCode renders and a subgroup tile shows.  Replaces any existing default. | [optional] |
+| **description** | **String** | Stored with the image and rendered as its alt text.  Optional. | [optional] |
+| **filename** | **String** | Name of a raster image already stored directly in the page's folder, for example thumb.png for a file uploaded to the page path followed by thumb.png. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageMultimediaRequest.new(
+  code: null,
+  default: null,
+  description: null,
+  filename: null
+)
+```
+

data/docs/SfvbPageResponse.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbPageResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attributes** | [**Array<SfvbPageAttribute>**](SfvbPageAttribute.md) | Every attribute this page has, including ones a template declares but nothing has set yet.  These are what the pageattribute element renders.  Sorted by name. | [optional] |
+| **multimedia** | [**Array<SfvbPageMultimedia>**](SfvbPageMultimedia.md) | The page's images, including codes a template declares but nothing has attached yet.  These are what the pageimage element renders - the default image when pageImageCode is empty, otherwise the image with that code.  The default image comes first. | [optional] |
+| **path** | **String** | The page path, normalized to begin and end with a slash. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageResponse.new(
+  attributes: null,
+  multimedia: null,
+  path: null
+)
+```
+

data/docs/SfvbThemeJobResponse.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **complete** | **Boolean** | True once the job has stopped, whether it succeeded or failed. | [optional] |
 | **description** | **String** | Human readable description of the job. | [optional] |
-| **error_message** | **String** | Failure detail.  Populated only when status is error. | [optional] |
+| **error_message** | **String** | What to do next when the job did not produce a theme.  The internal cause is not returned; it is recorded against the job id in the server log. | [optional] |
 | **finished_dts** | **String** | When the job stopped.  Null until it does. | [optional] |
 | **job_id** | **Integer** | Job handle.  Poll getSfvbThemeJob with this. | [optional] |
 | **progress** | **Integer** | Percent complete, 0-100. | [optional] |