ultracart_api 4.0.137 → 4.0.138

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb2ece4a88215f09744be53e9471a638c39a45738797086e3fea56b784b9a084
-  data.tar.gz: 4d5b4e9d3845139767603e0b1e4c324fbac8bc1ec19b3521579cb16d0fcf239f
+  metadata.gz: fa5f2374106efb08b3ea023776ff2022f925d0d4af3cc8e0d5953fbae8c9d781
+  data.tar.gz: 5f7f8723cb8fa2ad2ce67f25d91bc37a603a943a40c7ed3476ceb8080498adb5
 SHA512:
-  metadata.gz: 141e6e90ab31f05aa6bcbac8e270c015351de7f5a5ca1e3283f95bfd99f9344574f44ab1de0190a26c30bc7648120fcf8e2af705579d710f1329a2dbcaad41a7
-  data.tar.gz: d7fc5d63a840818cf8e93b8cb0f136a84615b0137ce8fde98d34365f33a7966f77168c6f42e695ea3ffe8a7815ecfd52958cf1ae0467e6729b9568309419b754
+  metadata.gz: 3c0d2a2f0c601e33fbb12872613b1d4b0fa0d9781d2e828aff746f415a93f5606006f1905b9f2b1ee58dc12aaafdca0ba04a1a1dcc6b1c5e24a9f1f29cb84aa4
+  data.tar.gz: f2b70b07493cd04ebc39d5d7215274e1488a1e1b26503daf499d7a3b30a6b68e7be4021b7590e15379f557e0f33750ed8a43acaeffc8978e078b9133491e7a6a

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.137
+- Package version: 4.0.138
 - 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.137.gem
+gem install ./ultracart_api-4.0.138.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.137.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.138.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.137'
+    gem 'ultracart_api', '~> 4.0.138'
 
 ### Install from Git
 
@@ -668,6 +668,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationResponse](docs/ConversationResponse.md)
  - [UltracartClient::ConversationSearchRequest](docs/ConversationSearchRequest.md)
  - [UltracartClient::ConversationSearchResponse](docs/ConversationSearchResponse.md)
+ - [UltracartClient::ConversationSentiment](docs/ConversationSentiment.md)
  - [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
  - [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
  - [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
@@ -1311,6 +1312,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.138 | 03/01/2023 | convo - add sentiment record to conversation obj |
 | 4.0.137 | 02/22/2023 | convo - customer initiated flag on engagement |
 | 4.0.136 | 02/20/2023 | refund reasons |
 | 4.0.135 | 02/17/2023 | convo api - smsUnsubscribeConversation method |

data/docs/Conversation.md

@@ -19,6 +19,7 @@
 | **message_count** | **Integer** |  | [optional] |
 | **messages** | [**Array<ConversationMessage>**](ConversationMessage.md) |  | [optional] |
 | **participants** | [**Array<ConversationParticipant>**](ConversationParticipant.md) |  | [optional] |
+| **sentiment** | [**ConversationSentiment**](ConversationSentiment.md) |  | [optional] |
 | **start_dts** | **String** | Start of the conversation date/time | [optional] |
 | **unread_messages** | **Boolean** |  | [optional] |
 | **visible** | **Boolean** |  | [optional] |
@@ -44,6 +45,7 @@ instance = UltracartClient::Conversation.new(
   message_count: null,
   messages: null,
   participants: null,
+  sentiment: null,
   start_dts: null,
   unread_messages: null,
   visible: null

data/docs/ConversationSentiment.md

@@ -0,0 +1,28 @@
+# UltracartClient::ConversationSentiment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **last_detect_sentiment** | **String** | The last time the detect sentiment was run on this conversation | [optional] |
+| **mixed** | **Float** | The mixed score | [optional] |
+| **negative** | **Float** | The negative score | [optional] |
+| **neutral** | **Float** | The neutral score | [optional] |
+| **positive** | **Float** | The positive score | [optional] |
+| **sentiment** | **String** | The overall sentiment | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationSentiment.new(
+  last_detect_sentiment: null,
+  mixed: null,
+  negative: null,
+  neutral: null,
+  positive: null,
+  sentiment: null
+)
+```
+

data/docs/ConversationSummary.md

@@ -17,6 +17,7 @@
 | **merchant_id** | **String** |  | [optional] |
 | **message_count** | **Integer** |  | [optional] |
 | **participants** | [**Array<ConversationParticipant>**](ConversationParticipant.md) |  | [optional] |
+| **sentiment** | [**ConversationSentiment**](ConversationSentiment.md) |  | [optional] |
 | **start_dts** | **String** | Start of the conversation date/time | [optional] |
 | **unread_messages** | **Boolean** |  | [optional] |
 | **visible** | **Boolean** |  | [optional] |
@@ -40,6 +41,7 @@ instance = UltracartClient::ConversationSummary.new(
   merchant_id: null,
   message_count: null,
   participants: null,
+  sentiment: null,
   start_dts: null,
   unread_messages: null,
   visible: null

data/lib/ultracart_api/models/conversation.rb

@@ -50,6 +50,8 @@ module UltracartClient
 
     attr_accessor :participants
 
+    attr_accessor :sentiment
+
     # Start of the conversation date/time
     attr_accessor :start_dts
 
@@ -97,6 +99,7 @@ module UltracartClient
         :'message_count' => :'message_count',
         :'messages' => :'messages',
         :'participants' => :'participants',
+        :'sentiment' => :'sentiment',
         :'start_dts' => :'start_dts',
         :'unread_messages' => :'unread_messages',
         :'visible' => :'visible'
@@ -126,6 +129,7 @@ module UltracartClient
         :'message_count' => :'Integer',
         :'messages' => :'Array<ConversationMessage>',
         :'participants' => :'Array<ConversationParticipant>',
+        :'sentiment' => :'ConversationSentiment',
         :'start_dts' => :'String',
         :'unread_messages' => :'Boolean',
         :'visible' => :'Boolean'
@@ -217,6 +221,10 @@ module UltracartClient
         end
       end
 
+      if attributes.key?(:'sentiment')
+        self.sentiment = attributes[:'sentiment']
+      end
+
       if attributes.key?(:'start_dts')
         self.start_dts = attributes[:'start_dts']
       end
@@ -275,6 +283,7 @@ module UltracartClient
           message_count == o.message_count &&
           messages == o.messages &&
           participants == o.participants &&
+          sentiment == o.sentiment &&
           start_dts == o.start_dts &&
           unread_messages == o.unread_messages &&
           visible == o.visible
@@ -289,7 +298,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [base_language_iso_code, closed, conversation_arn, conversation_uuid, customer_first_message_unresponded_to_dts, last_conversation_message_body, last_conversation_participant_arn, last_conversation_participant_name, last_interactive_message_dts, last_message_dts, medium, merchant_id, message_count, messages, participants, start_dts, unread_messages, visible].hash
+      [base_language_iso_code, closed, conversation_arn, conversation_uuid, customer_first_message_unresponded_to_dts, last_conversation_message_body, last_conversation_participant_arn, last_conversation_participant_name, last_interactive_message_dts, last_message_dts, medium, merchant_id, message_count, messages, participants, sentiment, start_dts, unread_messages, visible].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_sentiment.rb

@@ -0,0 +1,304 @@
+=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 ConversationSentiment
+    # The last time the detect sentiment was run on this conversation
+    attr_accessor :last_detect_sentiment
+
+    # The mixed score
+    attr_accessor :mixed
+
+    # The negative score
+    attr_accessor :negative
+
+    # The neutral score
+    attr_accessor :neutral
+
+    # The positive score
+    attr_accessor :positive
+
+    # The overall sentiment
+    attr_accessor :sentiment
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'last_detect_sentiment' => :'last_detect_sentiment',
+        :'mixed' => :'mixed',
+        :'negative' => :'negative',
+        :'neutral' => :'neutral',
+        :'positive' => :'positive',
+        :'sentiment' => :'sentiment'
+      }
+    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
+      {
+        :'last_detect_sentiment' => :'String',
+        :'mixed' => :'Float',
+        :'negative' => :'Float',
+        :'neutral' => :'Float',
+        :'positive' => :'Float',
+        :'sentiment' => :'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::ConversationSentiment` 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::ConversationSentiment`. 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?(:'last_detect_sentiment')
+        self.last_detect_sentiment = attributes[:'last_detect_sentiment']
+      end
+
+      if attributes.key?(:'mixed')
+        self.mixed = attributes[:'mixed']
+      end
+
+      if attributes.key?(:'negative')
+        self.negative = attributes[:'negative']
+      end
+
+      if attributes.key?(:'neutral')
+        self.neutral = attributes[:'neutral']
+      end
+
+      if attributes.key?(:'positive')
+        self.positive = attributes[:'positive']
+      end
+
+      if attributes.key?(:'sentiment')
+        self.sentiment = attributes[:'sentiment']
+      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?
+      sentiment_validator = EnumAttributeValidator.new('String', ["POSITIVE", "NEUTRAL", "NEGATIVE", "MIXED"])
+      return false unless sentiment_validator.valid?(@sentiment)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] sentiment Object to be assigned
+    def sentiment=(sentiment)
+      validator = EnumAttributeValidator.new('String', ["POSITIVE", "NEUTRAL", "NEGATIVE", "MIXED"])
+      unless validator.valid?(sentiment)
+        fail ArgumentError, "invalid value for \"sentiment\", must be one of #{validator.allowable_values}."
+      end
+      @sentiment = sentiment
+    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 &&
+          last_detect_sentiment == o.last_detect_sentiment &&
+          mixed == o.mixed &&
+          negative == o.negative &&
+          neutral == o.neutral &&
+          positive == o.positive &&
+          sentiment == o.sentiment
+    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
+      [last_detect_sentiment, mixed, negative, neutral, positive, sentiment].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/conversation_summary.rb

@@ -45,6 +45,8 @@ module UltracartClient
 
     attr_accessor :participants
 
+    attr_accessor :sentiment
+
     # Start of the conversation date/time
     attr_accessor :start_dts
 
@@ -90,6 +92,7 @@ module UltracartClient
         :'merchant_id' => :'merchant_id',
         :'message_count' => :'message_count',
         :'participants' => :'participants',
+        :'sentiment' => :'sentiment',
         :'start_dts' => :'start_dts',
         :'unread_messages' => :'unread_messages',
         :'visible' => :'visible'
@@ -117,6 +120,7 @@ module UltracartClient
         :'merchant_id' => :'String',
         :'message_count' => :'Integer',
         :'participants' => :'Array<ConversationParticipant>',
+        :'sentiment' => :'ConversationSentiment',
         :'start_dts' => :'String',
         :'unread_messages' => :'Boolean',
         :'visible' => :'Boolean'
@@ -198,6 +202,10 @@ module UltracartClient
         end
       end
 
+      if attributes.key?(:'sentiment')
+        self.sentiment = attributes[:'sentiment']
+      end
+
       if attributes.key?(:'start_dts')
         self.start_dts = attributes[:'start_dts']
       end
@@ -254,6 +262,7 @@ module UltracartClient
           merchant_id == o.merchant_id &&
           message_count == o.message_count &&
           participants == o.participants &&
+          sentiment == o.sentiment &&
           start_dts == o.start_dts &&
           unread_messages == o.unread_messages &&
           visible == o.visible
@@ -268,7 +277,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [closed, conversation_arn, conversation_uuid, customer_first_message_unresponded_to_dts, last_conversation_message_body, last_conversation_participant_arn, last_conversation_participant_name, last_interactive_message_dts, last_message_dts, medium, merchant_id, message_count, participants, start_dts, unread_messages, visible].hash
+      [closed, conversation_arn, conversation_uuid, customer_first_message_unresponded_to_dts, last_conversation_message_body, last_conversation_participant_arn, last_conversation_participant_name, last_interactive_message_dts, last_message_dts, medium, merchant_id, message_count, participants, sentiment, start_dts, unread_messages, visible].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.137'
+  VERSION = '4.0.138'
 end

data/lib/ultracart_api.rb

@@ -186,6 +186,7 @@ require 'ultracart_api/models/conversation_permissions_response'
 require 'ultracart_api/models/conversation_response'
 require 'ultracart_api/models/conversation_search_request'
 require 'ultracart_api/models/conversation_search_response'
+require 'ultracart_api/models/conversation_sentiment'
 require 'ultracart_api/models/conversation_start_request'
 require 'ultracart_api/models/conversation_start_response'
 require 'ultracart_api/models/conversation_summary'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.137
+  version: 4.0.138
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-22 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -236,6 +236,7 @@ files:
 - docs/ConversationResponse.md
 - docs/ConversationSearchRequest.md
 - docs/ConversationSearchResponse.md
+- docs/ConversationSentiment.md
 - docs/ConversationStartRequest.md
 - docs/ConversationStartResponse.md
 - docs/ConversationSummary.md
@@ -1012,6 +1013,7 @@ files:
 - lib/ultracart_api/models/conversation_response.rb
 - lib/ultracart_api/models/conversation_search_request.rb
 - lib/ultracart_api/models/conversation_search_response.rb
+- lib/ultracart_api/models/conversation_sentiment.rb
 - lib/ultracart_api/models/conversation_start_request.rb
 - lib/ultracart_api/models/conversation_start_response.rb
 - lib/ultracart_api/models/conversation_summary.rb