ultracart_api 4.1.82 → 4.1.84

data/lib/ultracart_api/models/item_gated_codes_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 ItemGatedCodesResponse
+    attr_accessor :error
+
+    # gated_codes
+    attr_accessor :gated_codes
+
+    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',
+        :'gated_codes' => :'gatedCodes',
+        :'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',
+        :'gated_codes' => :'Array<ItemGatedCode>',
+        :'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::ItemGatedCodesResponse` 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::ItemGatedCodesResponse`. 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?(:'gated_codes')
+        if (value = attributes[:'gated_codes']).is_a?(Array)
+          self.gated_codes = 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 &&
+          gated_codes == o.gated_codes &&
+          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, gated_codes, 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/models/{item_inventory_update.rb → item_generate_gated_codes_request.rb}

@@ -14,22 +14,22 @@ require 'date'
 require 'time'
 
 module UltracartClient
-  class ItemInventoryUpdate
-    # Distribution center code
-    attr_accessor :distribution_center_code
+  class ItemGenerateGatedCodesRequest
+    # Optional codes to also dedupe against (e.g. an in-progress draft).
+    attr_accessor :additional_existing_codes
 
-    # Inventory level
-    attr_accessor :inventory_level
+    # Number of codes to generate (1-1000).
+    attr_accessor :count
 
-    # Merchant Item ID
-    attr_accessor :merchant_item_id
+    # Length of each code (8-32).
+    attr_accessor :length
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'distribution_center_code' => :'distribution_center_code',
-        :'inventory_level' => :'inventory_level',
-        :'merchant_item_id' => :'merchant_item_id'
+        :'additional_existing_codes' => :'additionalExistingCodes',
+        :'count' => :'count',
+        :'length' => :'length'
       }
     end
 
@@ -41,9 +41,9 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'distribution_center_code' => :'String',
-        :'inventory_level' => :'Float',
-        :'merchant_item_id' => :'String'
+        :'additional_existing_codes' => :'Array<String>',
+        :'count' => :'Integer',
+        :'length' => :'Integer'
       }
     end
 
@@ -57,27 +57,29 @@ module UltracartClient
     # @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::ItemInventoryUpdate` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ItemGenerateGatedCodesRequest` 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::ItemInventoryUpdate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ItemGenerateGatedCodesRequest`. 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?(:'distribution_center_code')
-        self.distribution_center_code = attributes[:'distribution_center_code']
+      if attributes.key?(:'additional_existing_codes')
+        if (value = attributes[:'additional_existing_codes']).is_a?(Array)
+          self.additional_existing_codes = value
+        end
       end
 
-      if attributes.key?(:'inventory_level')
-        self.inventory_level = attributes[:'inventory_level']
+      if attributes.key?(:'count')
+        self.count = attributes[:'count']
       end
 
-      if attributes.key?(:'merchant_item_id')
-        self.merchant_item_id = attributes[:'merchant_item_id']
+      if attributes.key?(:'length')
+        self.length = attributes[:'length']
       end
     end
 
@@ -99,9 +101,9 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          distribution_center_code == o.distribution_center_code &&
-          inventory_level == o.inventory_level &&
-          merchant_item_id == o.merchant_item_id
+          additional_existing_codes == o.additional_existing_codes &&
+          count == o.count &&
+          length == o.length
     end
 
     # @see the `==` method
@@ -113,7 +115,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [distribution_center_code, inventory_level, merchant_item_id].hash
+      [additional_existing_codes, count, length].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_query.rb

@@ -525,7 +525,7 @@ module UltracartClient
       return false if !@city.nil? && @city.to_s.length > 32
       return false if !@company.nil? && @company.to_s.length > 50
       return false if !@country_code.nil? && @country_code.to_s.length > 2
-      current_stage_validator = EnumAttributeValidator.new('String', ["Accounts Receivable", "Pending Clearance", "Fraud Review", "Rejected", "Shipping Department", "Completed Order", "Quote Request", "Quote Sent", "Least Cost Routing", "Unknown"])
+      current_stage_validator = EnumAttributeValidator.new('String', ["Accounts Receivable", "Pending Clearance", "Fraud Review", "Rejected", "Shipping Department", "Completed Order", "Quote Request", "Quote Sent", "Least Cost Routing", "Unknown", "Hold"])
       return false unless current_stage_validator.valid?(@current_stage)
       return false if !@email.nil? && @email.to_s.length > 100
       return false if !@first_name.nil? && @first_name.to_s.length > 30
@@ -585,7 +585,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] current_stage Object to be assigned
     def current_stage=(current_stage)
-      validator = EnumAttributeValidator.new('String', ["Accounts Receivable", "Pending Clearance", "Fraud Review", "Rejected", "Shipping Department", "Completed Order", "Quote Request", "Quote Sent", "Least Cost Routing", "Unknown"])
+      validator = EnumAttributeValidator.new('String', ["Accounts Receivable", "Pending Clearance", "Fraud Review", "Rejected", "Shipping Department", "Completed Order", "Quote Request", "Quote Sent", "Least Cost Routing", "Unknown", "Hold"])
       unless validator.valid?(current_stage)
         fail ArgumentError, "invalid value for \"current_stage\", must be one of #{validator.allowable_values}."
       end

data/lib/ultracart_api/version.rb

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

data/lib/ultracart_api.rb

@@ -657,6 +657,11 @@ require 'ultracart_api/models/item_ebay_market_place_analysis'
 require 'ultracart_api/models/item_email_notifications'
 require 'ultracart_api/models/item_enrollment123'
 require 'ultracart_api/models/item_fulfillment_addon'
+require 'ultracart_api/models/item_gated_code'
+require 'ultracart_api/models/item_gated_code_response'
+require 'ultracart_api/models/item_gated_codes_request'
+require 'ultracart_api/models/item_gated_codes_response'
+require 'ultracart_api/models/item_generate_gated_codes_request'
 require 'ultracart_api/models/item_gift_certificate'
 require 'ultracart_api/models/item_google_product_search'
 require 'ultracart_api/models/item_identifiers'
@@ -666,8 +671,6 @@ 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_inventory_update'
-require 'ultracart_api/models/item_inventory_update_request'
 require 'ultracart_api/models/item_kit_component'
 require 'ultracart_api/models/item_kit_definition'
 require 'ultracart_api/models/item_option'
@@ -699,7 +702,6 @@ require 'ultracart_api/models/item_shipping_case'
 require 'ultracart_api/models/item_shipping_destination_markup'
 require 'ultracart_api/models/item_shipping_destination_restriction'
 require 'ultracart_api/models/item_shipping_distribution_center'
-require 'ultracart_api/models/item_shipping_distribution_center_response'
 require 'ultracart_api/models/item_shipping_method'
 require 'ultracart_api/models/item_shipping_package_requirement'
 require 'ultracart_api/models/item_tag'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.82
+  version: 4.1.84
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-27 00:00:00.000000000 Z
+date: 2026-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -714,6 +714,11 @@ files:
 - docs/ItemEmailNotifications.md
 - docs/ItemEnrollment123.md
 - docs/ItemFulfillmentAddon.md
+- docs/ItemGatedCode.md
+- docs/ItemGatedCodeResponse.md
+- docs/ItemGatedCodesRequest.md
+- docs/ItemGatedCodesResponse.md
+- docs/ItemGenerateGatedCodesRequest.md
 - docs/ItemGiftCertificate.md
 - docs/ItemGoogleProductSearch.md
 - docs/ItemIdentifiers.md
@@ -723,8 +728,6 @@ files:
 - docs/ItemInventorySnapshot.md
 - docs/ItemInventorySnapshotDistributionCenter.md
 - docs/ItemInventorySnapshotResponse.md
-- docs/ItemInventoryUpdate.md
-- docs/ItemInventoryUpdateRequest.md
 - docs/ItemKitComponent.md
 - docs/ItemKitDefinition.md
 - docs/ItemOption.md
@@ -756,7 +759,6 @@ files:
 - docs/ItemShippingDestinationMarkup.md
 - docs/ItemShippingDestinationRestriction.md
 - docs/ItemShippingDistributionCenter.md
-- docs/ItemShippingDistributionCenterResponse.md
 - docs/ItemShippingMethod.md
 - docs/ItemShippingPackageRequirement.md
 - docs/ItemTag.md
@@ -1722,6 +1724,11 @@ files:
 - lib/ultracart_api/models/item_email_notifications.rb
 - lib/ultracart_api/models/item_enrollment123.rb
 - lib/ultracart_api/models/item_fulfillment_addon.rb
+- lib/ultracart_api/models/item_gated_code.rb
+- lib/ultracart_api/models/item_gated_code_response.rb
+- lib/ultracart_api/models/item_gated_codes_request.rb
+- lib/ultracart_api/models/item_gated_codes_response.rb
+- lib/ultracart_api/models/item_generate_gated_codes_request.rb
 - lib/ultracart_api/models/item_gift_certificate.rb
 - lib/ultracart_api/models/item_google_product_search.rb
 - lib/ultracart_api/models/item_identifiers.rb
@@ -1731,8 +1738,6 @@ files:
 - 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_inventory_update.rb
-- lib/ultracart_api/models/item_inventory_update_request.rb
 - lib/ultracart_api/models/item_kit_component.rb
 - lib/ultracart_api/models/item_kit_definition.rb
 - lib/ultracart_api/models/item_option.rb
@@ -1764,7 +1769,6 @@ files:
 - lib/ultracart_api/models/item_shipping_destination_markup.rb
 - lib/ultracart_api/models/item_shipping_destination_restriction.rb
 - lib/ultracart_api/models/item_shipping_distribution_center.rb
-- lib/ultracart_api/models/item_shipping_distribution_center_response.rb
 - lib/ultracart_api/models/item_shipping_method.rb
 - lib/ultracart_api/models/item_shipping_package_requirement.rb
 - lib/ultracart_api/models/item_tag.rb

data/docs/ItemInventoryUpdate.md

@@ -1,22 +0,0 @@
-# UltracartClient::ItemInventoryUpdate
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **distribution_center_code** | **String** | Distribution center code | [optional] |
-| **inventory_level** | **Float** | Inventory level | [optional] |
-| **merchant_item_id** | **String** | Merchant Item ID | [optional] |
-
-## Example
-
-```ruby
-require 'ultracart_api'
-
-instance = UltracartClient::ItemInventoryUpdate.new(
-  distribution_center_code: null,
-  inventory_level: null,
-  merchant_item_id: null
-)
-```
-

data/docs/ItemInventoryUpdateRequest.md

@@ -1,18 +0,0 @@
-# UltracartClient::ItemInventoryUpdateRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **inventory_updates** | [**Array<ItemInventoryUpdate>**](ItemInventoryUpdate.md) | Inventory updates array | [optional] |
-
-## Example
-
-```ruby
-require 'ultracart_api'
-
-instance = UltracartClient::ItemInventoryUpdateRequest.new(
-  inventory_updates: null
-)
-```
-