ultracart_api 4.0.225 → 4.0.226

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f648152f0c9f7594b722e3fa59baff17ea85ad19e7cd62d5418163e8941dd1c
-  data.tar.gz: 8b0198d93e3fbb463f2e0c4927cdc75c1a8a475da05622f774aedb066e25ad82
+  metadata.gz: a04688dd66fd6c770680e8aea005e0f0bd6fe584c632a72aea4e9aea51b6ff04
+  data.tar.gz: 67d6838c5141f29a579323cbfb6fd26097cef6a70f29733b9e9a2f4a9b4962eb
 SHA512:
-  metadata.gz: fc82dcdf2c098e1191709aa24ad86ce2a6e452c0f558a8b6c7320a3707466c1dbf51de76f0a000959bdb7c37f34d5520f7265177ced61777f4130089f2894ad6
-  data.tar.gz: 27a5b9ca9a920080cc1c1630d2c04457a362b5e7b1e565ff069fc8b96302566d1278767eb7a7d52a5260f47f188cd027e9ed53748ff9b373971ae6292d10597d
+  metadata.gz: f90479911baeee644673103d6b0b1ff2085d2ed4b012083be51f2512ae1abf13901a11eee4f667235eada4cf542331b1c3a88b90fd70f5cc31f6ed3ad0652aee
+  data.tar.gz: f1e74794241f8817f4c2175343b499223373f353fb79938fcc4e3ce835946595f340877f5a9a799bd153e9e891fc091482c5a4d8b89924c7f49c0a9de6c4e721

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.225
+- Package version: 4.0.226
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.225.gem
+gem install ./ultracart_api-4.0.226.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.225.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.226.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 4.0.225'
+    gem 'ultracart_api', '~> 4.0.226'
 
 ### Install from Git
 
@@ -311,6 +311,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
 *UltracartClient::ItemApi* | [**insert_review**](docs/ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
 *UltracartClient::ItemApi* | [**insert_update_item_content_attribute**](docs/ItemApi.md#insert_update_item_content_attribute) | **POST** /item/items/{merchant_item_oid}/content/attributes | Upsert an item content attribute
+*UltracartClient::ItemApi* | [**rest_item_inventory_snapshot_response**](docs/ItemApi.md#rest_item_inventory_snapshot_response) | **GET** /item/items/inventory_snapshot | Retrieve a list of item inventories
 *UltracartClient::ItemApi* | [**update_digital_item**](docs/ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
 *UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
 *UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
@@ -1125,6 +1126,9 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ItemInstantPaymentNotification](docs/ItemInstantPaymentNotification.md)
  - [UltracartClient::ItemInstantPaymentNotifications](docs/ItemInstantPaymentNotifications.md)
  - [UltracartClient::ItemInternal](docs/ItemInternal.md)
+ - [UltracartClient::ItemInventorySnapshot](docs/ItemInventorySnapshot.md)
+ - [UltracartClient::ItemInventorySnapshotDistributionCenter](docs/ItemInventorySnapshotDistributionCenter.md)
+ - [UltracartClient::ItemInventorySnapshotResponse](docs/ItemInventorySnapshotResponse.md)
  - [UltracartClient::ItemKitComponent](docs/ItemKitComponent.md)
  - [UltracartClient::ItemKitDefinition](docs/ItemKitDefinition.md)
  - [UltracartClient::ItemOption](docs/ItemOption.md)
@@ -1513,6 +1517,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.226 | 05/31/2024 | ItemApi.getInventorySnapshot method |
 | 4.0.225 | 05/30/2024 | add adult sig req. to the merchant item destination markup for items |
 | 4.0.224 | 05/29/2024 | added methods getEmailCommseqRateLimiters, resetEmailCommseqRateLimiters |
 | 4.0.223 | 05/28/2024 | added property to OrderQuery object to allow querying from cache |

data/docs/ItemApi.md

@@ -21,6 +21,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item |
 | [**insert_review**](ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review |
 | [**insert_update_item_content_attribute**](ItemApi.md#insert_update_item_content_attribute) | **POST** /item/items/{merchant_item_oid}/content/attributes | Upsert an item content attribute |
+| [**rest_item_inventory_snapshot_response**](ItemApi.md#rest_item_inventory_snapshot_response) | **GET** /item/items/inventory_snapshot | Retrieve a list of item inventories |
 | [**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library |
 | [**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item |
 | [**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items |
@@ -1299,6 +1300,74 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## rest_item_inventory_snapshot_response
+
+> <ItemInventorySnapshotResponse> rest_item_inventory_snapshot_response
+
+Retrieve a list of item inventories
+
+Retrieves a list of item inventories. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+begin
+  # Retrieve a list of item inventories
+  result = api_instance.rest_item_inventory_snapshot_response
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ItemApi->rest_item_inventory_snapshot_response: #{e}"
+end
+```
+
+#### Using the rest_item_inventory_snapshot_response_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ItemInventorySnapshotResponse>, Integer, Hash)> rest_item_inventory_snapshot_response_with_http_info
+
+```ruby
+begin
+  # Retrieve a list of item inventories
+  data, status_code, headers = api_instance.rest_item_inventory_snapshot_response_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ItemInventorySnapshotResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ItemApi->rest_item_inventory_snapshot_response_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ItemInventorySnapshotResponse**](ItemInventorySnapshotResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## update_digital_item
 
 > <ItemDigitalItemResponse> update_digital_item(digital_item_oid, digital_item)

data/docs/ItemInventorySnapshot.md

@@ -0,0 +1,28 @@
+# UltracartClient::ItemInventorySnapshot
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allocated_to_placed_orders** | **Integer** |  | [optional] |
+| **allocated_to_shopping_carts** | **Integer** |  | [optional] |
+| **available_to_allocate** | **Integer** |  | [optional] |
+| **distribution_centers** | [**Array<ItemInventorySnapshotDistributionCenter>**](ItemInventorySnapshotDistributionCenter.md) |  | [optional] |
+| **merchant_item_id** | **String** |  | [optional] |
+| **quantity** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ItemInventorySnapshot.new(
+  allocated_to_placed_orders: null,
+  allocated_to_shopping_carts: null,
+  available_to_allocate: null,
+  distribution_centers: null,
+  merchant_item_id: null,
+  quantity: null
+)
+```
+

data/docs/ItemInventorySnapshotDistributionCenter.md

@@ -0,0 +1,26 @@
+# UltracartClient::ItemInventorySnapshotDistributionCenter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allocated_to_placed_orders** | **Integer** |  | [optional] |
+| **allocated_to_shopping_carts** | **Integer** |  | [optional] |
+| **available_to_allocate** | **Integer** |  | [optional] |
+| **code** | **String** |  | [optional] |
+| **quantity** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ItemInventorySnapshotDistributionCenter.new(
+  allocated_to_placed_orders: null,
+  allocated_to_shopping_carts: null,
+  available_to_allocate: null,
+  code: null,
+  quantity: null
+)
+```
+

data/docs/ItemInventorySnapshotResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ItemInventorySnapshotResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **inventories** | [**Array<ItemInventorySnapshot>**](ItemInventorySnapshot.md) | inventories | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ItemInventorySnapshotResponse.new(
+  error: null,
+  inventories: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/lib/ultracart_api/api/item_api.rb

@@ -1221,6 +1221,64 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Retrieve a list of item inventories
+    # Retrieves a list of item inventories. 
+    # @param [Hash] opts the optional parameters
+    # @return [ItemInventorySnapshotResponse]
+    def rest_item_inventory_snapshot_response(opts = {})
+      data, _status_code, _headers = rest_item_inventory_snapshot_response_with_http_info(opts)
+      data
+    end
+
+    # Retrieve a list of item inventories
+    # Retrieves a list of item inventories. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ItemInventorySnapshotResponse, Integer, Hash)>] ItemInventorySnapshotResponse data, response status code and response headers
+    def rest_item_inventory_snapshot_response_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.rest_item_inventory_snapshot_response ...'
+      end
+      # resource path
+      local_var_path = '/item/items/inventory_snapshot'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ItemInventorySnapshotResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ItemApi.rest_item_inventory_snapshot_response",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#rest_item_inventory_snapshot_response\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Updates a file within the digital library
     # Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item. 
     # @param digital_item_oid [Integer] The digital item oid to update.

data/lib/ultracart_api/models/item_inventory_snapshot.rb

@@ -0,0 +1,266 @@
+=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 ItemInventorySnapshot
+    attr_accessor :allocated_to_placed_orders
+
+    attr_accessor :allocated_to_shopping_carts
+
+    attr_accessor :available_to_allocate
+
+    attr_accessor :distribution_centers
+
+    attr_accessor :merchant_item_id
+
+    attr_accessor :quantity
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'allocated_to_placed_orders' => :'allocated_to_placed_orders',
+        :'allocated_to_shopping_carts' => :'allocated_to_shopping_carts',
+        :'available_to_allocate' => :'available_to_allocate',
+        :'distribution_centers' => :'distribution_centers',
+        :'merchant_item_id' => :'merchant_item_id',
+        :'quantity' => :'quantity'
+      }
+    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
+      {
+        :'allocated_to_placed_orders' => :'Integer',
+        :'allocated_to_shopping_carts' => :'Integer',
+        :'available_to_allocate' => :'Integer',
+        :'distribution_centers' => :'Array<ItemInventorySnapshotDistributionCenter>',
+        :'merchant_item_id' => :'String',
+        :'quantity' => :'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::ItemInventorySnapshot` 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::ItemInventorySnapshot`. 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?(:'allocated_to_placed_orders')
+        self.allocated_to_placed_orders = attributes[:'allocated_to_placed_orders']
+      end
+
+      if attributes.key?(:'allocated_to_shopping_carts')
+        self.allocated_to_shopping_carts = attributes[:'allocated_to_shopping_carts']
+      end
+
+      if attributes.key?(:'available_to_allocate')
+        self.available_to_allocate = attributes[:'available_to_allocate']
+      end
+
+      if attributes.key?(:'distribution_centers')
+        if (value = attributes[:'distribution_centers']).is_a?(Array)
+          self.distribution_centers = value
+        end
+      end
+
+      if attributes.key?(:'merchant_item_id')
+        self.merchant_item_id = attributes[:'merchant_item_id']
+      end
+
+      if attributes.key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      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 &&
+          allocated_to_placed_orders == o.allocated_to_placed_orders &&
+          allocated_to_shopping_carts == o.allocated_to_shopping_carts &&
+          available_to_allocate == o.available_to_allocate &&
+          distribution_centers == o.distribution_centers &&
+          merchant_item_id == o.merchant_item_id &&
+          quantity == o.quantity
+    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
+      [allocated_to_placed_orders, allocated_to_shopping_carts, available_to_allocate, distribution_centers, merchant_item_id, quantity].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/models/item_inventory_snapshot_distribution_center.rb

@@ -0,0 +1,255 @@
+=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 ItemInventorySnapshotDistributionCenter
+    attr_accessor :allocated_to_placed_orders
+
+    attr_accessor :allocated_to_shopping_carts
+
+    attr_accessor :available_to_allocate
+
+    attr_accessor :code
+
+    attr_accessor :quantity
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'allocated_to_placed_orders' => :'allocated_to_placed_orders',
+        :'allocated_to_shopping_carts' => :'allocated_to_shopping_carts',
+        :'available_to_allocate' => :'available_to_allocate',
+        :'code' => :'code',
+        :'quantity' => :'quantity'
+      }
+    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
+      {
+        :'allocated_to_placed_orders' => :'Integer',
+        :'allocated_to_shopping_carts' => :'Integer',
+        :'available_to_allocate' => :'Integer',
+        :'code' => :'String',
+        :'quantity' => :'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::ItemInventorySnapshotDistributionCenter` 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::ItemInventorySnapshotDistributionCenter`. 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?(:'allocated_to_placed_orders')
+        self.allocated_to_placed_orders = attributes[:'allocated_to_placed_orders']
+      end
+
+      if attributes.key?(:'allocated_to_shopping_carts')
+        self.allocated_to_shopping_carts = attributes[:'allocated_to_shopping_carts']
+      end
+
+      if attributes.key?(:'available_to_allocate')
+        self.available_to_allocate = attributes[:'available_to_allocate']
+      end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      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 &&
+          allocated_to_placed_orders == o.allocated_to_placed_orders &&
+          allocated_to_shopping_carts == o.allocated_to_shopping_carts &&
+          available_to_allocate == o.available_to_allocate &&
+          code == o.code &&
+          quantity == o.quantity
+    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
+      [allocated_to_placed_orders, allocated_to_shopping_carts, available_to_allocate, code, quantity].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/models/item_inventory_snapshot_response.rb

@@ -0,0 +1,259 @@
+=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 ItemInventorySnapshotResponse
+    attr_accessor :error
+
+    # inventories
+    attr_accessor :inventories
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'inventories' => :'inventories',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    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
+      {
+        :'error' => :'Error',
+        :'inventories' => :'Array<ItemInventorySnapshot>',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'Boolean',
+        :'warning' => :'Warning'
+      }
+    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::ItemInventorySnapshotResponse` 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::ItemInventorySnapshotResponse`. 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?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'inventories')
+        if (value = attributes[:'inventories']).is_a?(Array)
+          self.inventories = value
+        end
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
+      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 &&
+          error == o.error &&
+          inventories == o.inventories &&
+          metadata == o.metadata &&
+          success == o.success &&
+          warning == o.warning
+    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
+      [error, inventories, metadata, success, warning].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.0.225'
+  VERSION = '4.0.226'
 end

data/lib/ultracart_api.rb

@@ -554,6 +554,9 @@ require 'ultracart_api/models/item_identifiers'
 require 'ultracart_api/models/item_instant_payment_notification'
 require 'ultracart_api/models/item_instant_payment_notifications'
 require 'ultracart_api/models/item_internal'
+require 'ultracart_api/models/item_inventory_snapshot'
+require 'ultracart_api/models/item_inventory_snapshot_distribution_center'
+require 'ultracart_api/models/item_inventory_snapshot_response'
 require 'ultracart_api/models/item_kit_component'
 require 'ultracart_api/models/item_kit_definition'
 require 'ultracart_api/models/item_option'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.225
+  version: 4.0.226
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-30 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -611,6 +611,9 @@ files:
 - docs/ItemInstantPaymentNotification.md
 - docs/ItemInstantPaymentNotifications.md
 - docs/ItemInternal.md
+- docs/ItemInventorySnapshot.md
+- docs/ItemInventorySnapshotDistributionCenter.md
+- docs/ItemInventorySnapshotResponse.md
 - docs/ItemKitComponent.md
 - docs/ItemKitDefinition.md
 - docs/ItemOption.md
@@ -1495,6 +1498,9 @@ files:
 - lib/ultracart_api/models/item_instant_payment_notification.rb
 - lib/ultracart_api/models/item_instant_payment_notifications.rb
 - lib/ultracart_api/models/item_internal.rb
+- lib/ultracart_api/models/item_inventory_snapshot.rb
+- lib/ultracart_api/models/item_inventory_snapshot_distribution_center.rb
+- lib/ultracart_api/models/item_inventory_snapshot_response.rb
 - lib/ultracart_api/models/item_kit_component.rb
 - lib/ultracart_api/models/item_kit_definition.rb
 - lib/ultracart_api/models/item_option.rb