ultracart_api 3.10.65 → 3.10.66

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c40eeee0e52a4048d5da0be9aa0bf8e3ed8081125900ef7c548e1f3b7f85a76d
-  data.tar.gz: 13968b964e8cbbca5846a9aacda47607c4d2fde6d2b84885686275fb480bdaa8
+  metadata.gz: 60981a1ada3a2572ddef5170f97d2eb4cba62c7c723bcefe2c324cdc986409a5
+  data.tar.gz: 78f0b8ba85a5ac42899979ebd71ae15d1b61a18a1a70a0c90acb452c7cc69af1
 SHA512:
-  metadata.gz: a1d8a223749f59285baef7781831359d02247c9d29fcf08b66698658c61be51c52da8b66ff8444108c823ee52b0d0aa460d2993c27b0529bfe1eb4fd07ac3ffd
-  data.tar.gz: 347be067a1bab1af80f91b120e5f7c9e569170643458b66e5b8661c629096e772d91676f3d3b9ae574ef6d12b60369d0458cca3e4c3c82c6a48bfff2773b077f
+  metadata.gz: 062ac7a2c505c0ec5e5ecef15b1463e9753ac5c04ee13e66126a24a8b975eb8e5ef51db49d47a43c6058513ac0501ee27f3793bad12f04328566c9e52c76fc07
+  data.tar.gz: 5b324d7ed16ee78766af15e8711bac5ddf088983199bf6b5816d9013a40a4e04f4bf60f55b0ca9719351546d532855de2b98f0e42521c520d8f445a25f08235c

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.65
+- Package version: 3.10.66
 - 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.65.gem
+gem install ./ultracart_api-3.10.66.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.65.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.66.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.65'
+    gem 'ultracart_api', '~> 3.10.66'
 
 ### Install from Git
 
@@ -582,6 +582,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::Conversation](docs/Conversation.md)
  - [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
+ - [UltracartClient::ConversationEventAddCoupon](docs/ConversationEventAddCoupon.md)
+ - [UltracartClient::ConversationEventAddItem](docs/ConversationEventAddItem.md)
  - [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
  - [UltracartClient::ConversationEventRRWeb](docs/ConversationEventRRWeb.md)
  - [UltracartClient::ConversationEventReadMessage](docs/ConversationEventReadMessage.md)
@@ -1215,6 +1217,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.66 | 11/15/2022 | conversations - enw events for add coupon and items |
 | 3.10.65 | 11/15/2022 | order api new method is order refundable |
 | 3.10.64 | 11/15/2022 | increase order property length to 10k char |
 | 3.10.63 | 11/14/2022 | conversations - add allowed values for update agent status |

data/docs/ConversationEventAddCoupon.md

@@ -0,0 +1,8 @@
+# UltracartClient::ConversationEventAddCoupon
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**coupon_code** | **String** |  | [optional] 
+
+

data/docs/ConversationEventAddItem.md

@@ -0,0 +1,8 @@
+# UltracartClient::ConversationEventAddItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_id** | **String** |  | [optional] 
+
+

data/docs/ConversationWebsocketMessage.md

@@ -4,6 +4,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **conversation_uuid** | **String** | Conversation UUID if the websocket message is tied to a specific conversation | [optional] 
+**event_add_coupon** | [**ConversationEventAddCoupon**](ConversationEventAddCoupon.md) |  | [optional] 
+**event_add_item** | [**ConversationEventAddItem**](ConversationEventAddItem.md) |  | [optional] 
 **event_conversation_closed** | [**ConversationSummary**](ConversationSummary.md) |  | [optional] 
 **event_new_conversation** | [**ConversationSummary**](ConversationSummary.md) |  | [optional] 
 **event_new_message** | [**ConversationSummary**](ConversationSummary.md) |  | [optional] 

data/docs/OrderRefundableResponse.md

@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **error** | [**Error**](Error.md) |  | [optional] 
 **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
-**refundable** | **BOOLEAN** | Whether the order is refundable or not. | [optional] 
+**refundable** | **BOOLEAN** | Whether the order is refundable or not.  Null should be interpreted as false. | [optional] 
 **success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
 **warning** | [**Warning**](Warning.md) |  | [optional] 
 

data/lib/ultracart_api/models/conversation_event_add_coupon.rb

@@ -0,0 +1,184 @@
+=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 ConversationEventAddCoupon
+    attr_accessor :coupon_code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'coupon_code' => :'coupon_code'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'coupon_code' => :'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?(:'coupon_code')
+        self.coupon_code = attributes[:'coupon_code']
+      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 &&
+          coupon_code == o.coupon_code
+    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
+      [coupon_code].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_event_add_item.rb

@@ -0,0 +1,184 @@
+=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 ConversationEventAddItem
+    attr_accessor :item_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'item_id' => :'item_id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'item_id' => :'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?(:'item_id')
+        self.item_id = attributes[:'item_id']
+      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 &&
+          item_id == o.item_id
+    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
+      [item_id].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

@@ -17,6 +17,10 @@ module UltracartClient
     # Conversation UUID if the websocket message is tied to a specific conversation
     attr_accessor :conversation_uuid
 
+    attr_accessor :event_add_coupon
+
+    attr_accessor :event_add_item
+
     attr_accessor :event_conversation_closed
 
     attr_accessor :event_new_conversation
@@ -71,6 +75,8 @@ module UltracartClient
     def self.attribute_map
       {
         :'conversation_uuid' => :'conversation_uuid',
+        :'event_add_coupon' => :'event_add_coupon',
+        :'event_add_item' => :'event_add_item',
         :'event_conversation_closed' => :'event_conversation_closed',
         :'event_new_conversation' => :'event_new_conversation',
         :'event_new_message' => :'event_new_message',
@@ -91,6 +97,8 @@ module UltracartClient
     def self.swagger_types
       {
         :'conversation_uuid' => :'String',
+        :'event_add_coupon' => :'ConversationEventAddCoupon',
+        :'event_add_item' => :'ConversationEventAddItem',
         :'event_conversation_closed' => :'ConversationSummary',
         :'event_new_conversation' => :'ConversationSummary',
         :'event_new_message' => :'ConversationSummary',
@@ -119,6 +127,14 @@ module UltracartClient
         self.conversation_uuid = attributes[:'conversation_uuid']
       end
 
+      if attributes.has_key?(:'event_add_coupon')
+        self.event_add_coupon = attributes[:'event_add_coupon']
+      end
+
+      if attributes.has_key?(:'event_add_item')
+        self.event_add_item = attributes[:'event_add_item']
+      end
+
       if attributes.has_key?(:'event_conversation_closed')
         self.event_conversation_closed = attributes[:'event_conversation_closed']
       end
@@ -182,7 +198,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', 'read message', 'typing'])
+      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', 'read message', 'typing', 'add coupon', 'add item'])
       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)
@@ -192,7 +208,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', 'read message', 'typing'])
+      validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing', 'add coupon', 'add item'])
       unless validator.valid?(event_type)
         fail ArgumentError, 'invalid value for "event_type", must be one of #{validator.allowable_values}.'
       end
@@ -215,6 +231,8 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           conversation_uuid == o.conversation_uuid &&
+          event_add_coupon == o.event_add_coupon &&
+          event_add_item == o.event_add_item &&
           event_conversation_closed == o.event_conversation_closed &&
           event_new_conversation == o.event_new_conversation &&
           event_new_message == o.event_new_message &&
@@ -239,7 +257,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [conversation_uuid, event_conversation_closed, event_new_conversation, event_new_message, event_participant_update, event_queue_position, event_queue_status_update, event_read_message, event_rrweb, event_type, event_typing, event_updated_message, message, type].hash
+      [conversation_uuid, event_add_coupon, event_add_item, event_conversation_closed, event_new_conversation, event_new_message, event_participant_update, event_queue_position, event_queue_status_update, event_read_message, event_rrweb, event_type, event_typing, event_updated_message, message, type].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_refundable_response.rb

@@ -18,7 +18,7 @@ module UltracartClient
 
     attr_accessor :metadata
 
-    # Whether the order is refundable or not.
+    # Whether the order is refundable or not.  Null should be interpreted as false.
     attr_accessor :refundable
 
     # Indicates if API call was successful

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.10.65'
+  VERSION = '3.10.66'
 end

data/lib/ultracart_api.rb

@@ -137,6 +137,8 @@ require 'ultracart_api/models/city_state_zip'
 require 'ultracart_api/models/conversation'
 require 'ultracart_api/models/conversation_agent_auth'
 require 'ultracart_api/models/conversation_agent_auth_response'
+require 'ultracart_api/models/conversation_event_add_coupon'
+require 'ultracart_api/models/conversation_event_add_item'
 require 'ultracart_api/models/conversation_event_queue_position'
 require 'ultracart_api/models/conversation_event_rr_web'
 require 'ultracart_api/models/conversation_event_read_message'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.65
+  version: 3.10.66
 platform: ruby
 authors:
 - UltraCart
@@ -347,6 +347,8 @@ files:
 - docs/ConversationAgentAuth.md
 - docs/ConversationAgentAuthResponse.md
 - docs/ConversationApi.md
+- docs/ConversationEventAddCoupon.md
+- docs/ConversationEventAddItem.md
 - docs/ConversationEventQueuePosition.md
 - docs/ConversationEventRRWeb.md
 - docs/ConversationEventReadMessage.md
@@ -1067,6 +1069,8 @@ files:
 - lib/ultracart_api/models/conversation.rb
 - lib/ultracart_api/models/conversation_agent_auth.rb
 - lib/ultracart_api/models/conversation_agent_auth_response.rb
+- lib/ultracart_api/models/conversation_event_add_coupon.rb
+- lib/ultracart_api/models/conversation_event_add_item.rb
 - lib/ultracart_api/models/conversation_event_queue_position.rb
 - lib/ultracart_api/models/conversation_event_read_message.rb
 - lib/ultracart_api/models/conversation_event_rr_web.rb