ultracart_api 3.10.96 → 3.10.98

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae7c3fe7f3ea18bb1f0700632b841064073ea5ef110ac3b4409d287dbc276850
-  data.tar.gz: 0cfe6137e68dba017705dff6ea2c0eada91c63e483f1aabc05e537a57c23f3b8
+  metadata.gz: fedc1c22bb7bec7b66d25a4b9e1d33186f5aa82d2ba547b4bfe8a6f44c0427f1
+  data.tar.gz: '0183c7610a11bedee3e5c90c801c297db2f47835e809a86e78add70d98e58860'
 SHA512:
-  metadata.gz: 62162ccf7a46134481e0bb4cc56b48945f1c0ad877471d29240b3e28d036b7e5db2a3b908b737d3475eec8a087913c3c9810a7d503288f497f8eacec00f7f125
-  data.tar.gz: f5210050fce783cf5ef95e8b1d1758179479862411353545d8203d926a1f54e23111bcf1e545e1deeffafb6c62e802884d37e3d06db8ace576094d2ced11af5d
+  metadata.gz: d0990f1df61e2a96b8bb2c0599c08a3d2cfa1db6d97af38cdc6bcfc0f4cc6ea7f267a084907371eb524fbcac30d1b7cd8bea440f3a7c61e50efd87dfaf0f7ff8
+  data.tar.gz: 7a9aece746b998c87f69a3383f2558b57db11b37e1f40562274c08c8f945e7bb6ed4420717e72ee39db2c7e21d6c9b6e682b75093b96d6c905f2b66b195599a6

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.10.96
+- Package version: 3.10.98
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.10.96.gem
+gem install ./ultracart_api-3.10.98.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.96.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.98.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', '~> 3.10.96'
+    gem 'ultracart_api', '~> 3.10.98'
 
 ### Install from Git
 
@@ -547,6 +547,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)
@@ -1281,6 +1282,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.98 | 01/17/2023 | changed convo webchat constant |
+| 3.10.97 | 01/17/2023 | support for checkout item properties |
 | 3.10.96 | 01/14/2023 | add external_id to the point of sale location object |
 | 3.10.95 | 01/13/2023 | channel - ops to manage ship to prefs |
 | 3.10.94 | 01/11/2023 | conversations - adjust search results to return multiple convo summaries |

data/docs/CartItem.md

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
 **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] 

data/docs/CartItemProperty.md

@@ -0,0 +1,11 @@
+# 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] 
+
+

data/lib/ultracart_api/models/cart_item.rb

@@ -70,6 +70,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
 
@@ -116,6 +119,7 @@ module UltracartClient
         :'phsyical' => :'phsyical',
         :'position' => :'position',
         :'preorder' => :'preorder',
+        :'properties' => :'properties',
         :'quantity' => :'quantity',
         :'schedules' => :'schedules',
         :'total_cost' => :'total_cost',
@@ -151,6 +155,7 @@ module UltracartClient
         :'phsyical' => :'CartItemPhysical',
         :'position' => :'Integer',
         :'preorder' => :'BOOLEAN',
+        :'properties' => :'Array<CartItemProperty>',
         :'quantity' => :'Float',
         :'schedules' => :'Array<String>',
         :'total_cost' => :'Currency',
@@ -259,6 +264,12 @@ module UltracartClient
         self.preorder = attributes[:'preorder']
       end
 
+      if attributes.has_key?(:'properties')
+        if (value = attributes[:'properties']).is_a?(Array)
+          self.properties = value
+        end
+      end
+
       if attributes.has_key?(:'quantity')
         self.quantity = attributes[:'quantity']
       end
@@ -338,6 +349,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 &&
@@ -358,7 +370,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] 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,245 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+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
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'display' => :'BOOLEAN',
+        :'expiration_dts' => :'String',
+        :'name' => :'String',
+        :'value' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'display')
+        self.display = attributes[:'display']
+      end
+
+      if attributes.has_key?(:'expiration_dts')
+        self.expiration_dts = attributes[:'expiration_dts']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_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 [Fixnum] 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 build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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/conversation_websocket_message.rb

@@ -238,7 +238,7 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      event_type_validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'participant join', 'participant leave', 'read message', 'typing', 'add coupon', 'add item', 'webchat context'])
+      event_type_validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'participant join', 'participant left', 'read message', 'typing', 'add coupon', 'add item', 'webchat context'])
       return false unless event_type_validator.valid?(@event_type)
       type_validator = EnumAttributeValidator.new('String', ['message', 'event', 'ping', 'check queue position'])
       return false unless type_validator.valid?(@type)
@@ -248,7 +248,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] event_type Object to be assigned
     def event_type=(event_type)
-      validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'participant join', 'participant leave', 'read message', 'typing', 'add coupon', 'add item', 'webchat context'])
+      validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'participant join', 'participant left', 'read message', 'typing', 'add coupon', 'add item', 'webchat context'])
       unless validator.valid?(event_type)
         fail ArgumentError, 'invalid value for "event_type", must be one of #{validator.allowable_values}.'
       end

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.10.96'
+  VERSION = '3.10.98'
 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: 3.10.96
+  version: 3.10.98
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-14 00:00:00.000000000 Z
+date: 2023-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -285,6 +285,7 @@ files:
 - docs/CartItemOption.md
 - docs/CartItemOptionValue.md
 - docs/CartItemPhysical.md
+- docs/CartItemProperty.md
 - docs/CartItemVariationSelection.md
 - docs/CartKitComponentOption.md
 - docs/CartMarketing.md
@@ -1052,6 +1053,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