ultracart_api 4.1.201 → 4.1.202

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eb0f77a073bc3b2d2b66f254190227539e919cfcae97ee88d4844a410922d84
-  data.tar.gz: 936959c530a9c85860e0c5e45d2a7ab24e85a101580f77dbd957ec0806923ccf
+  metadata.gz: c8e2a0df2a48694c297eccac324214153614a364647f403482a52863732a8d42
+  data.tar.gz: 6391ca2c7f7f14054a3c351fb22165e8e8f793c0685af64e4deefd5c33dd3928
 SHA512:
-  metadata.gz: 492a6776f33223e9f198c4c8185a67b60f67ce0b13d3557b0d4d82b3c8aad2b36994799103b5026676701fbde6703284558280e42aa1ea47cf745fbf0788e62d
-  data.tar.gz: 5bcb498157c133ff90e73a6df2cbfe3d3ee2cd508a374df95d2322d21266477df836b3d6957a12c4b13993f7aad4cb119e0a49295488b4adaef669be521bb45b
+  metadata.gz: d2f086140b99df10e1fc950f74e5bb323b83289356a330c6ea78499c271c73a5a1b1085ae108a30d1a089c622ed65cde9fbf170521c97a91cbd2ee853f5e6ac3
+  data.tar.gz: 53ec4581fefb66a0b5021744599a789c9e4e634b9b017b4dd1980e118ee46fabaf7f31272e815ca39e06fd7369eadd8f2df00acd0b861f59fb84c9898bb51d25

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.201
+- Package version: 4.1.202
 - 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.201'
+gem 'ultracart_api', '4.1.202'
 ```
 
 install:
@@ -599,6 +599,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**put_sfvb_item_attributes**](docs/SfvbApi.md#put_sfvb_item_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/items/attributes | Change some of an item's attributes
 *UltracartClient::SfvbApi* | [**put_sfvb_item_content**](docs/SfvbApi.md#put_sfvb_item_content) | **PUT** /sfvb/storefronts/{storefront_oid}/items/content | Change an item's title or long description
 *UltracartClient::SfvbApi* | [**put_sfvb_item_multimedia**](docs/SfvbApi.md#put_sfvb_item_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia | Attach an image to an item
+*UltracartClient::SfvbApi* | [**put_sfvb_item_multimedia_description**](docs/SfvbApi.md#put_sfvb_item_multimedia_description) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia/description | Change an item image's description
 *UltracartClient::SfvbApi* | [**put_sfvb_item_pricing**](docs/SfvbApi.md#put_sfvb_item_pricing) | **PUT** /sfvb/storefronts/{storefront_oid}/items/pricing | Change what an item charges
 *UltracartClient::SfvbApi* | [**put_sfvb_item_related**](docs/SfvbApi.md#put_sfvb_item_related) | **PUT** /sfvb/storefronts/{storefront_oid}/items/related | Replace an item's related items
 *UltracartClient::SfvbApi* | [**put_sfvb_item_seo**](docs/SfvbApi.md#put_sfvb_item_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/items/seo | Change an item's search metadata
@@ -1937,6 +1938,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbItemContainersResponse](docs/SfvbItemContainersResponse.md)
  - [UltracartClient::SfvbItemContentRequest](docs/SfvbItemContentRequest.md)
  - [UltracartClient::SfvbItemMultimedia](docs/SfvbItemMultimedia.md)
+ - [UltracartClient::SfvbItemMultimediaDescriptionRequest](docs/SfvbItemMultimediaDescriptionRequest.md)
  - [UltracartClient::SfvbItemMultimediaRequest](docs/SfvbItemMultimediaRequest.md)
  - [UltracartClient::SfvbItemPricing](docs/SfvbItemPricing.md)
  - [UltracartClient::SfvbItemPricingRequest](docs/SfvbItemPricingRequest.md)
@@ -2250,6 +2252,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.202 | 10/13/2026 | sfvb internal testing |
 | 4.1.201 | 10/12/2026 | sfvb internal testing |
 | 4.1.200 | 10/09/2026 | sfvb internal testing |
 | 4.1.199 | 10/08/2026 | sfvb internal testing |

data/docs/OauthApi.md

@@ -294,7 +294,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **client_id** | **String** | The OAuth application client_id. |  |
-| **token** | **String** | The OAuth access token that is to be revoked.. |  |
+| **token** | **String** | The OAuth access token or refresh token that is to be revoked. |  |
 
 ### Return type
 

data/docs/SfvbApi.md

@@ -127,6 +127,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**put_sfvb_item_attributes**](SfvbApi.md#put_sfvb_item_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/items/attributes | Change some of an item's attributes |
 | [**put_sfvb_item_content**](SfvbApi.md#put_sfvb_item_content) | **PUT** /sfvb/storefronts/{storefront_oid}/items/content | Change an item's title or long description |
 | [**put_sfvb_item_multimedia**](SfvbApi.md#put_sfvb_item_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia | Attach an image to an item |
+| [**put_sfvb_item_multimedia_description**](SfvbApi.md#put_sfvb_item_multimedia_description) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia/description | Change an item image's description |
 | [**put_sfvb_item_pricing**](SfvbApi.md#put_sfvb_item_pricing) | **PUT** /sfvb/storefronts/{storefront_oid}/items/pricing | Change what an item charges |
 | [**put_sfvb_item_related**](SfvbApi.md#put_sfvb_item_related) | **PUT** /sfvb/storefronts/{storefront_oid}/items/related | Replace an item's related items |
 | [**put_sfvb_item_seo**](SfvbApi.md#put_sfvb_item_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/items/seo | Change an item's search metadata |
@@ -6894,6 +6895,62 @@ end
 - **Accept**: application/json
 
 
+## put_sfvb_item_multimedia_description
+
+> <SfvbItemResponse> put_sfvb_item_multimedia_description(storefront_oid, item_multimedia_description_request, opts)
+
+Change an item image's description
+
+Changes the description (alt text) of one image already attached to the item, in place.  The image is not touched.  Name it by merchant_item_multimedia_oid, or by exactly one of code or default; gallery images often have no code.  An empty description clears it, so the render falls back again.  Send the description_sha256 you read as current_sha256 so a change made since is not overwritten.  A description written here takes the place of the machine description, and image recognition never overwrites it. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the put_sfvb_item_multimedia_description_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbItemResponse>, Integer, Hash)> put_sfvb_item_multimedia_description_with_http_info(storefront_oid, item_multimedia_description_request, opts)
+
+```ruby
+begin
+  # Change an item image's description
+  data, status_code, headers = api_instance.put_sfvb_item_multimedia_description_with_http_info(storefront_oid, item_multimedia_description_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbItemResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->put_sfvb_item_multimedia_description_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **item_multimedia_description_request** | [**SfvbItemMultimediaDescriptionRequest**](SfvbItemMultimediaDescriptionRequest.md) | The image and its new description |  |
+| **merchant_item_id** | **String** |  | [optional] |
+| **merchant_item_oid** | **Integer** |  | [optional] |
+
+### Return type
+
+[**SfvbItemResponse**](SfvbItemResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## put_sfvb_item_pricing
 
 > <SfvbItemPricing> put_sfvb_item_pricing(storefront_oid, if_match, item_pricing_request, opts)

data/docs/SfvbItemMultimedia.md

@@ -7,10 +7,14 @@
 | **code** | **String** | The image code, which is what an itemimage element's itemImageCode refers to.  Empty for the default image. | [optional] |
 | **declared** | **Boolean** | True when a template declares this code.  A slot that is attached but not declared is an image nothing on the page is asking for. | [optional] |
 | **default** | **Boolean** | True for the image an itemimage element with no code renders.  Default is per media type, so an item may have one default image and one default PDF at the same time. | [optional] |
-| **description** | **String** | Stored with the image and rendered as its alt text.  When it is empty the render falls back to the item's own description, so an empty value here is not an empty alt attribute. | [optional] |
+| **description** | **String** | The merchant's description, stored with the image and rendered as its alt text.  When it is empty the render falls back to rekognition_description or to text built from the item's title, depending on the element, so an empty value here is not an empty alt attribute. | [optional] |
+| **description_sha256** | **String** | SHA-256 of description (empty when there is none).  Send it as current_sha256 when changing the description so a change made since you read it is not overwritten. | [optional] |
+| **description_source** | **String** | Where the alt text comes from now.  merchant when description is set, rekognition when only rekognition_description is, none otherwise. | [optional] |
 | **dimensions** | **String** | Width x height in pixels, when the storage measured the file. | [optional] |
 | **exclude_from_gallery** | **Boolean** | True when the storage marks this image as kept out of the item gallery. | [optional] |
 | **filename** | **String** | The stored file's name.  Empty when the slot is declared and nothing is attached. | [optional] |
+| **merchant_item_multimedia_oid** | **Integer** | The stored image's id.  Name it to change this image's description when it has no code. | [optional] |
+| **rekognition_description** | **String** | The machine description image recognition produced for the stored image, if any.  It is used only while description is empty, and a description written here or in the admin always takes its place. | [optional] |
 | **type** | **String** | The media type the storage recorded. | [optional] |
 | **view_url** | **String** | Where the stored image is served.  Absent when nothing is attached to the slot. | [optional] |
 
@@ -24,9 +28,13 @@ instance = UltracartClient::SfvbItemMultimedia.new(
   declared: null,
   default: null,
   description: null,
+  description_sha256: null,
+  description_source: null,
   dimensions: null,
   exclude_from_gallery: null,
   filename: null,
+  merchant_item_multimedia_oid: null,
+  rekognition_description: null,
   type: null,
   view_url: null
 )

data/docs/SfvbItemMultimediaDescriptionRequest.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbItemMultimediaDescriptionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The image code, the value an itemimage element's itemImageCode names. | [optional] |
+| **current_sha256** | **String** | The description_sha256 you read.  When it is sent and the description has changed since, nothing is written and the call fails with a version conflict. | [optional] |
+| **default** | **Boolean** | The item's default image, which an itemimage element with no code renders. | [optional] |
+| **description** | **String** | The new description, rendered as the image's alt text.  An empty string clears it, so the image falls back to the machine description or the element's own fallback.  Longer text is cut to 500 characters. | [optional] |
+| **merchant_item_multimedia_oid** | **Integer** | The stored image's id, as an item read reports it.  Name this, or one of code or default. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbItemMultimediaDescriptionRequest.new(
+  code: null,
+  current_sha256: null,
+  default: null,
+  description: null,
+  merchant_item_multimedia_oid: null
+)
+```
+

data/lib/ultracart_api/api/oauth_api.rb

@@ -259,7 +259,7 @@ module UltracartClient
     # Revoke this OAuth application.
     # Revokes the OAuth application associated with the specified client_id and token. 
     # @param client_id [String] The OAuth application client_id.
-    # @param token [String] The OAuth access token that is to be revoked..
+    # @param token [String] The OAuth access token or refresh token that is to be revoked.
     # @param [Hash] opts the optional parameters
     # @return [OauthRevokeSuccessResponse]
     def oauth_revoke(client_id, token, opts = {})
@@ -270,7 +270,7 @@ module UltracartClient
     # Revoke this OAuth application.
     # Revokes the OAuth application associated with the specified client_id and token. 
     # @param client_id [String] The OAuth application client_id.
-    # @param token [String] The OAuth access token that is to be revoked..
+    # @param token [String] The OAuth access token or refresh token that is to be revoked.
     # @param [Hash] opts the optional parameters
     # @return [Array<(OauthRevokeSuccessResponse, Integer, Hash)>] OauthRevokeSuccessResponse data, response status code and response headers
     def oauth_revoke_with_http_info(client_id, token, opts = {})

data/lib/ultracart_api/api/sfvb_api.rb

@@ -9020,6 +9020,87 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Change an item image's description
+    # Changes the description (alt text) of one image already attached to the item, in place.  The image is not touched.  Name it by merchant_item_multimedia_oid, or by exactly one of code or default; gallery images often have no code.  An empty description clears it, so the render falls back again.  Send the description_sha256 you read as current_sha256 so a change made since is not overwritten.  A description written here takes the place of the machine description, and image recognition never overwrites it. 
+    # @param storefront_oid [Integer] 
+    # @param item_multimedia_description_request [SfvbItemMultimediaDescriptionRequest] The image and its new description
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :merchant_item_id 
+    # @option opts [Integer] :merchant_item_oid 
+    # @return [SfvbItemResponse]
+    def put_sfvb_item_multimedia_description(storefront_oid, item_multimedia_description_request, opts = {})
+      data, _status_code, _headers = put_sfvb_item_multimedia_description_with_http_info(storefront_oid, item_multimedia_description_request, opts)
+      data
+    end
+
+    # Change an item image's description
+    # Changes the description (alt text) of one image already attached to the item, in place.  The image is not touched.  Name it by merchant_item_multimedia_oid, or by exactly one of code or default; gallery images often have no code.  An empty description clears it, so the render falls back again.  Send the description_sha256 you read as current_sha256 so a change made since is not overwritten.  A description written here takes the place of the machine description, and image recognition never overwrites it. 
+    # @param storefront_oid [Integer] 
+    # @param item_multimedia_description_request [SfvbItemMultimediaDescriptionRequest] The image and its new description
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :merchant_item_id 
+    # @option opts [Integer] :merchant_item_oid 
+    # @return [Array<(SfvbItemResponse, Integer, Hash)>] SfvbItemResponse data, response status code and response headers
+    def put_sfvb_item_multimedia_description_with_http_info(storefront_oid, item_multimedia_description_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.put_sfvb_item_multimedia_description ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.put_sfvb_item_multimedia_description"
+      end
+      # verify the required parameter 'item_multimedia_description_request' is set
+      if @api_client.config.client_side_validation && item_multimedia_description_request.nil?
+        fail ArgumentError, "Missing the required parameter 'item_multimedia_description_request' when calling SfvbApi.put_sfvb_item_multimedia_description"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/items/multimedia/description'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'merchant_item_id'] = opts[:'merchant_item_id'] if !opts[:'merchant_item_id'].nil?
+      query_params[:'merchant_item_oid'] = opts[:'merchant_item_oid'] if !opts[:'merchant_item_oid'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(item_multimedia_description_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbItemResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.put_sfvb_item_multimedia_description",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#put_sfvb_item_multimedia_description\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Change what an item charges
     # Partial - a field left out is untouched.  A sale needs sale_cost, sale_start and sale_end together, the end after the start; clear_sale removes it.  msrp must be more than 0 (0 only when the price is 0); clear_msrp removes it.  volume_discounts replaces the retail quantity breaks.  Shoppers pay the new price at once, so this needs sfvb_publish, If-Match with the pricing hash_sha256, and the approval of the person who signed in the CLI - an approved item.pricing request for this item and exactly this change.  A change that sets every field to what it already is returns the pricing unchanged and uses no approval. 
     # @param storefront_oid [Integer] 

data/lib/ultracart_api/models/sfvb_item_multimedia.rb

@@ -24,9 +24,15 @@ module UltracartClient
     # True for the image an itemimage element with no code renders.  Default is per media type, so an item may have one default image and one default PDF at the same time.
     attr_accessor :default
 
-    # Stored with the image and rendered as its alt text.  When it is empty the render falls back to the item's own description, so an empty value here is not an empty alt attribute.
+    # The merchant's description, stored with the image and rendered as its alt text.  When it is empty the render falls back to rekognition_description or to text built from the item's title, depending on the element, so an empty value here is not an empty alt attribute.
     attr_accessor :description
 
+    # SHA-256 of description (empty when there is none).  Send it as current_sha256 when changing the description so a change made since you read it is not overwritten.
+    attr_accessor :description_sha256
+
+    # Where the alt text comes from now.  merchant when description is set, rekognition when only rekognition_description is, none otherwise.
+    attr_accessor :description_source
+
     # Width x height in pixels, when the storage measured the file.
     attr_accessor :dimensions
 
@@ -36,6 +42,12 @@ module UltracartClient
     # The stored file's name.  Empty when the slot is declared and nothing is attached.
     attr_accessor :filename
 
+    # The stored image's id.  Name it to change this image's description when it has no code.
+    attr_accessor :merchant_item_multimedia_oid
+
+    # The machine description image recognition produced for the stored image, if any.  It is used only while description is empty, and a description written here or in the admin always takes its place.
+    attr_accessor :rekognition_description
+
     # The media type the storage recorded.
     attr_accessor :type
 
@@ -71,9 +83,13 @@ module UltracartClient
         :'declared' => :'declared',
         :'default' => :'default',
         :'description' => :'description',
+        :'description_sha256' => :'description_sha256',
+        :'description_source' => :'description_source',
         :'dimensions' => :'dimensions',
         :'exclude_from_gallery' => :'exclude_from_gallery',
         :'filename' => :'filename',
+        :'merchant_item_multimedia_oid' => :'merchant_item_multimedia_oid',
+        :'rekognition_description' => :'rekognition_description',
         :'type' => :'type',
         :'view_url' => :'view_url'
       }
@@ -91,9 +107,13 @@ module UltracartClient
         :'declared' => :'Boolean',
         :'default' => :'Boolean',
         :'description' => :'String',
+        :'description_sha256' => :'String',
+        :'description_source' => :'String',
         :'dimensions' => :'String',
         :'exclude_from_gallery' => :'Boolean',
         :'filename' => :'String',
+        :'merchant_item_multimedia_oid' => :'Integer',
+        :'rekognition_description' => :'String',
         :'type' => :'String',
         :'view_url' => :'String'
       }
@@ -136,6 +156,14 @@ module UltracartClient
         self.description = attributes[:'description']
       end
 
+      if attributes.key?(:'description_sha256')
+        self.description_sha256 = attributes[:'description_sha256']
+      end
+
+      if attributes.key?(:'description_source')
+        self.description_source = attributes[:'description_source']
+      end
+
       if attributes.key?(:'dimensions')
         self.dimensions = attributes[:'dimensions']
       end
@@ -148,6 +176,14 @@ module UltracartClient
         self.filename = attributes[:'filename']
       end
 
+      if attributes.key?(:'merchant_item_multimedia_oid')
+        self.merchant_item_multimedia_oid = attributes[:'merchant_item_multimedia_oid']
+      end
+
+      if attributes.key?(:'rekognition_description')
+        self.rekognition_description = attributes[:'rekognition_description']
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
@@ -167,11 +203,23 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      description_source_validator = EnumAttributeValidator.new('String', ["merchant", "rekognition", "none"])
+      return false unless description_source_validator.valid?(@description_source)
       type_validator = EnumAttributeValidator.new('String', ["Image", "Video", "PDF", "Text", "Unknown"])
       return false unless type_validator.valid?(@type)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] description_source Object to be assigned
+    def description_source=(description_source)
+      validator = EnumAttributeValidator.new('String', ["merchant", "rekognition", "none"])
+      unless validator.valid?(description_source)
+        fail ArgumentError, "invalid value for \"description_source\", must be one of #{validator.allowable_values}."
+      end
+      @description_source = description_source
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
@@ -191,9 +239,13 @@ module UltracartClient
           declared == o.declared &&
           default == o.default &&
           description == o.description &&
+          description_sha256 == o.description_sha256 &&
+          description_source == o.description_source &&
           dimensions == o.dimensions &&
           exclude_from_gallery == o.exclude_from_gallery &&
           filename == o.filename &&
+          merchant_item_multimedia_oid == o.merchant_item_multimedia_oid &&
+          rekognition_description == o.rekognition_description &&
           type == o.type &&
           view_url == o.view_url
     end
@@ -207,7 +259,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [code, declared, default, description, dimensions, exclude_from_gallery, filename, type, view_url].hash
+      [code, declared, default, description, description_sha256, description_source, dimensions, exclude_from_gallery, filename, merchant_item_multimedia_oid, rekognition_description, type, view_url].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_item_multimedia_description_request.rb

@@ -0,0 +1,260 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class SfvbItemMultimediaDescriptionRequest
+    # The image code, the value an itemimage element's itemImageCode names.
+    attr_accessor :code
+
+    # The description_sha256 you read.  When it is sent and the description has changed since, nothing is written and the call fails with a version conflict.
+    attr_accessor :current_sha256
+
+    # The item's default image, which an itemimage element with no code renders.
+    attr_accessor :default
+
+    # The new description, rendered as the image's alt text.  An empty string clears it, so the image falls back to the machine description or the element's own fallback.  Longer text is cut to 500 characters.
+    attr_accessor :description
+
+    # The stored image's id, as an item read reports it.  Name this, or one of code or default.
+    attr_accessor :merchant_item_multimedia_oid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'code' => :'code',
+        :'current_sha256' => :'current_sha256',
+        :'default' => :'default',
+        :'description' => :'description',
+        :'merchant_item_multimedia_oid' => :'merchant_item_multimedia_oid'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'code' => :'String',
+        :'current_sha256' => :'String',
+        :'default' => :'Boolean',
+        :'description' => :'String',
+        :'merchant_item_multimedia_oid' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbItemMultimediaDescriptionRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbItemMultimediaDescriptionRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'current_sha256')
+        self.current_sha256 = attributes[:'current_sha256']
+      end
+
+      if attributes.key?(:'default')
+        self.default = attributes[:'default']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'merchant_item_multimedia_oid')
+        self.merchant_item_multimedia_oid = attributes[:'merchant_item_multimedia_oid']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          code == o.code &&
+          current_sha256 == o.current_sha256 &&
+          default == o.default &&
+          description == o.description &&
+          merchant_item_multimedia_oid == o.merchant_item_multimedia_oid
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [code, current_sha256, default, description, merchant_item_multimedia_oid].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.201'
+  VERSION = '4.1.202'
 end

data/lib/ultracart_api.rb

@@ -1054,6 +1054,7 @@ require 'ultracart_api/models/sfvb_item_container'
 require 'ultracart_api/models/sfvb_item_containers_response'
 require 'ultracart_api/models/sfvb_item_content_request'
 require 'ultracart_api/models/sfvb_item_multimedia'
+require 'ultracart_api/models/sfvb_item_multimedia_description_request'
 require 'ultracart_api/models/sfvb_item_multimedia_request'
 require 'ultracart_api/models/sfvb_item_pricing'
 require 'ultracart_api/models/sfvb_item_pricing_request'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.201
+  version: 4.1.202
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-12 00:00:00.000000000 Z
+date: 2026-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1116,6 +1116,7 @@ files:
 - docs/SfvbItemContainersResponse.md
 - docs/SfvbItemContentRequest.md
 - docs/SfvbItemMultimedia.md
+- docs/SfvbItemMultimediaDescriptionRequest.md
 - docs/SfvbItemMultimediaRequest.md
 - docs/SfvbItemPricing.md
 - docs/SfvbItemPricingRequest.md
@@ -2424,6 +2425,7 @@ files:
 - lib/ultracart_api/models/sfvb_item_containers_response.rb
 - lib/ultracart_api/models/sfvb_item_content_request.rb
 - lib/ultracart_api/models/sfvb_item_multimedia.rb
+- lib/ultracart_api/models/sfvb_item_multimedia_description_request.rb
 - lib/ultracart_api/models/sfvb_item_multimedia_request.rb
 - lib/ultracart_api/models/sfvb_item_pricing.rb
 - lib/ultracart_api/models/sfvb_item_pricing_request.rb