ultracart_api 4.0.112.rc → 4.0.114.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f038e5716ab2e24df8c85440e2f5fbdecb61a8636e6215ce297cd440f526e92
-  data.tar.gz: 101cfafc4ffd74232b24dc787d4efd0603124d1b3aeac5789353ed6d9fd9bd19
+  metadata.gz: 2cbe969b1879e1447f4c5cc480455804560096da75aae25cef839717469265a9
+  data.tar.gz: 295b6db45dc49ccc9ad9cbb17d9bf916e6aba08e28b6f3288da670c2965aac4d
 SHA512:
-  metadata.gz: 5d6b708a6711e0d5f343d2797d6815fcba52e106411d9f62a26b5625cfbcf063d1589eb9a14fbc09d56cc1b6625dfaa7386b1bf1f6b9a0f38b1b7d0a4ef58d68
-  data.tar.gz: fc3d2339f4bcdd8cfc269c0e09ea4c43ede45eced6a17ef5753eff15f2df63a9bc2c8c8b81ccce225c86f0bc48a342ceaee2168f2563b0a856ef498d41fc8e92
+  metadata.gz: a0cc1fbf0b604a4d1a713197578c862ba515a9d8c962afd65be2baa015dc9a9f9e4be594a3b380c360094853967997ab9eb44e2c0cd0e76ec5d78ec869bf2c02
+  data.tar.gz: bf709a9c7d9852c039c9aac1f06bcfdf97aa56b80db729314f52407f7b9c03d29f62bdf20a30a12ab9246028a2a5bb05fe9771b5f79502a4792d521610f31502

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.112.rc
+- Package version: 4.0.114.rc
 - 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.112.rc.gem
+gem install ./ultracart_api-4.0.114.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.112.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.114.rc.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.112.rc'
+    gem 'ultracart_api', '~> 4.0.114.rc'
 
 ### Install from Git
 
@@ -553,6 +553,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CartItemOption](docs/CartItemOption.md)
  - [UltracartClient::CartItemOptionValue](docs/CartItemOptionValue.md)
  - [UltracartClient::CartItemPhysical](docs/CartItemPhysical.md)
+ - [UltracartClient::CartItemProperty](docs/CartItemProperty.md)
  - [UltracartClient::CartItemVariationSelection](docs/CartItemVariationSelection.md)
  - [UltracartClient::CartKitComponentOption](docs/CartKitComponentOption.md)
  - [UltracartClient::CartMarketing](docs/CartMarketing.md)
@@ -1289,6 +1290,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.114-RC | 01/17/2023 | support for checkout item properties |
+| 4.0.113-RC | 01/14/2023 | add external_id to the point of sale location object |
 | 4.0.112-RC | 01/13/2023 | channel - ops to manage ship to prefs |
 | 4.0.111-RC | 01/11/2023 | conversations - adjust search results to return multiple convo summaries |
 | 4.0.110-RC | 01/10/2023 | add method to query integration log record by oid |

data/docs/CartItem.md

@@ -24,6 +24,7 @@
 | **phsyical** | [**CartItemPhysical**](CartItemPhysical.md) |  | [optional] |
 | **position** | **Integer** | Position of the item in the cart | [optional] |
 | **preorder** | **Boolean** | True if this item is on pre-order | [optional] |
+| **properties** | [**Array<CartItemProperty>**](CartItemProperty.md) | Properties associated with the item | [optional] |
 | **quantity** | **Float** | quantity | [optional] |
 | **schedules** | **Array<String>** | Customer selectable auto order schedules | [optional] |
 | **total_cost** | [**Currency**](Currency.md) |  | [optional] |
@@ -60,6 +61,7 @@ instance = UltracartClient::CartItem.new(
   phsyical: null,
   position: null,
   preorder: null,
+  properties: null,
   quantity: null,
   schedules: null,
   total_cost: null,

data/docs/CartItemProperty.md

@@ -0,0 +1,24 @@
+# UltracartClient::CartItemProperty
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **display** | **Boolean** | True if this property is displayed to the customer | [optional] |
+| **expiration_dts** | **String** | The date/time that the property expires and is deleted | [optional] |
+| **name** | **String** | Name | [optional] |
+| **value** | **String** | Value | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CartItemProperty.new(
+  display: null,
+  expiration_dts: null,
+  name: null,
+  value: null
+)
+```
+

data/docs/PointOfSaleLocation.md

@@ -9,6 +9,7 @@
 | **city** | **String** | City | [optional] |
 | **country** | **String** | Country | [optional] |
 | **distribution_center_code** | **String** | The distribution center code where inventory is reduced from for this sale. | [optional] |
+| **external_id** | **String** | External Id useful for syncing with a remote filesystem, this may be an MD5 hash or whatever suits your needs. | [optional] |
 | **merchant_id** | **String** | Merchant ID that owns this location | [optional] |
 | **pos_location_oid** | **Integer** | Object identifier of the point of sale location. | [optional] |
 | **postal_code** | **String** | Postal code | [optional] |
@@ -25,6 +26,7 @@ instance = UltracartClient::PointOfSaleLocation.new(
   city: null,
   country: null,
   distribution_center_code: null,
+  external_id: null,
   merchant_id: null,
   pos_location_oid: null,
   postal_code: null,

data/lib/ultracart_api/models/cart_item.rb

@@ -71,6 +71,9 @@ module UltracartClient
     # True if this item is on pre-order
     attr_accessor :preorder
 
+    # Properties associated with the item
+    attr_accessor :properties
+
     # quantity
     attr_accessor :quantity
 
@@ -117,6 +120,7 @@ module UltracartClient
         :'phsyical' => :'phsyical',
         :'position' => :'position',
         :'preorder' => :'preorder',
+        :'properties' => :'properties',
         :'quantity' => :'quantity',
         :'schedules' => :'schedules',
         :'total_cost' => :'total_cost',
@@ -157,6 +161,7 @@ module UltracartClient
         :'phsyical' => :'CartItemPhysical',
         :'position' => :'Integer',
         :'preorder' => :'Boolean',
+        :'properties' => :'Array<CartItemProperty>',
         :'quantity' => :'Float',
         :'schedules' => :'Array<String>',
         :'total_cost' => :'Currency',
@@ -278,6 +283,12 @@ module UltracartClient
         self.preorder = attributes[:'preorder']
       end
 
+      if attributes.key?(:'properties')
+        if (value = attributes[:'properties']).is_a?(Array)
+          self.properties = value
+        end
+      end
+
       if attributes.key?(:'quantity')
         self.quantity = attributes[:'quantity']
       end
@@ -357,6 +368,7 @@ module UltracartClient
           phsyical == o.phsyical &&
           position == o.position &&
           preorder == o.preorder &&
+          properties == o.properties &&
           quantity == o.quantity &&
           schedules == o.schedules &&
           total_cost == o.total_cost &&
@@ -377,7 +389,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [arbitrary_unit_cost, attributes, auto_order_schedule, default_image_url, default_thumbnail_url, description, discount, extended_description, item_id, item_oid, kit, kit_component_options, manufacturer_suggested_retail_price, maximum_quantity, minimum_quantity, multimedia, options, phsyical, position, preorder, quantity, schedules, total_cost, total_cost_with_discount, unit_cost, unit_cost_with_discount, upsell, variations, view_url].hash
+      [arbitrary_unit_cost, attributes, auto_order_schedule, default_image_url, default_thumbnail_url, description, discount, extended_description, item_id, item_oid, kit, kit_component_options, manufacturer_suggested_retail_price, maximum_quantity, minimum_quantity, multimedia, options, phsyical, position, preorder, properties, quantity, schedules, total_cost, total_cost_with_discount, unit_cost, unit_cost_with_discount, upsell, variations, view_url].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/cart_item_property.rb

@@ -0,0 +1,280 @@
+=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 CartItemProperty
+    # True if this property is displayed to the customer
+    attr_accessor :display
+
+    # The date/time that the property expires and is deleted
+    attr_accessor :expiration_dts
+
+    # Name
+    attr_accessor :name
+
+    # Value
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'display' => :'display',
+        :'expiration_dts' => :'expiration_dts',
+        :'name' => :'name',
+        :'value' => :'value'
+      }
+    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
+      {
+        :'display' => :'Boolean',
+        :'expiration_dts' => :'String',
+        :'name' => :'String',
+        :'value' => :'String'
+      }
+    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::CartItemProperty` 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::CartItemProperty`. 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?(:'display')
+        self.display = attributes[:'display']
+      end
+
+      if attributes.key?(:'expiration_dts')
+        self.expiration_dts = attributes[:'expiration_dts']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      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
+      if !@name.nil? && @name.to_s.length > 100
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@value.nil? && @value.to_s.length > 3800
+        invalid_properties.push('invalid value for "value", the character length must be smaller than or equal to 3800.')
+      end
+
+      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?
+      return false if !@name.nil? && @name.to_s.length > 100
+      return false if !@value.nil? && @value.to_s.length > 3800
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] value Value to be assigned
+    def value=(value)
+      if !value.nil? && value.to_s.length > 3800
+        fail ArgumentError, 'invalid value for "value", the character length must be smaller than or equal to 3800.'
+      end
+
+      @value = value
+    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 &&
+          display == o.display &&
+          expiration_dts == o.expiration_dts &&
+          name == o.name &&
+          value == o.value
+    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
+      [display, expiration_dts, name, value].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/point_of_sale_location.rb

@@ -30,6 +30,9 @@ module UltracartClient
     # The distribution center code where inventory is reduced from for this sale.
     attr_accessor :distribution_center_code
 
+    # External Id useful for syncing with a remote filesystem, this may be an MD5 hash or whatever suits your needs.
+    attr_accessor :external_id
+
     # Merchant ID that owns this location
     attr_accessor :merchant_id
 
@@ -50,6 +53,7 @@ module UltracartClient
         :'city' => :'city',
         :'country' => :'country',
         :'distribution_center_code' => :'distribution_center_code',
+        :'external_id' => :'external_id',
         :'merchant_id' => :'merchant_id',
         :'pos_location_oid' => :'pos_location_oid',
         :'postal_code' => :'postal_code',
@@ -70,6 +74,7 @@ module UltracartClient
         :'city' => :'String',
         :'country' => :'String',
         :'distribution_center_code' => :'String',
+        :'external_id' => :'String',
         :'merchant_id' => :'String',
         :'pos_location_oid' => :'Integer',
         :'postal_code' => :'String',
@@ -118,6 +123,10 @@ module UltracartClient
         self.distribution_center_code = attributes[:'distribution_center_code']
       end
 
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      end
+
       if attributes.key?(:'merchant_id')
         self.merchant_id = attributes[:'merchant_id']
       end
@@ -139,15 +148,30 @@ module UltracartClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@external_id.nil? && @external_id.to_s.length > 100
+        invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 100.')
+      end
+
       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?
+      return false if !@external_id.nil? && @external_id.to_s.length > 100
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] external_id Value to be assigned
+    def external_id=(external_id)
+      if !external_id.nil? && external_id.to_s.length > 100
+        fail ArgumentError, 'invalid value for "external_id", the character length must be smaller than or equal to 100.'
+      end
+
+      @external_id = external_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -158,6 +182,7 @@ module UltracartClient
           city == o.city &&
           country == o.country &&
           distribution_center_code == o.distribution_center_code &&
+          external_id == o.external_id &&
           merchant_id == o.merchant_id &&
           pos_location_oid == o.pos_location_oid &&
           postal_code == o.postal_code &&
@@ -173,7 +198,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [adddress2, address1, city, country, distribution_center_code, merchant_id, pos_location_oid, postal_code, state_province].hash
+      [adddress2, address1, city, country, distribution_center_code, external_id, merchant_id, pos_location_oid, postal_code, state_province].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.112.rc'
+  VERSION = '4.0.114.rc'
 end

data/lib/ultracart_api.rb

@@ -79,6 +79,7 @@ require 'ultracart_api/models/cart_item_multimedia_thumbnail'
 require 'ultracart_api/models/cart_item_option'
 require 'ultracart_api/models/cart_item_option_value'
 require 'ultracart_api/models/cart_item_physical'
+require 'ultracart_api/models/cart_item_property'
 require 'ultracart_api/models/cart_item_variation_selection'
 require 'ultracart_api/models/cart_kit_component_option'
 require 'ultracart_api/models/cart_marketing'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.112.rc
+  version: 4.0.114.rc
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-13 00:00:00.000000000 Z
+date: 2023-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -125,6 +125,7 @@ files:
 - docs/CartItemOption.md
 - docs/CartItemOptionValue.md
 - docs/CartItemPhysical.md
+- docs/CartItemProperty.md
 - docs/CartItemVariationSelection.md
 - docs/CartKitComponentOption.md
 - docs/CartMarketing.md
@@ -891,6 +892,7 @@ files:
 - lib/ultracart_api/models/cart_item_option.rb
 - lib/ultracart_api/models/cart_item_option_value.rb
 - lib/ultracart_api/models/cart_item_physical.rb
+- lib/ultracart_api/models/cart_item_property.rb
 - lib/ultracart_api/models/cart_item_variation_selection.rb
 - lib/ultracart_api/models/cart_kit_component_option.rb
 - lib/ultracart_api/models/cart_marketing.rb