ultracart_api 3.10.120 → 3.10.122

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ef6ec55925ec22b01946d3d811289ec70ea0b95acefebd77994dc581e926c35
-  data.tar.gz: a8c0b2a5180143c042b8c852b303c67faa8b50218dccccba209aa3551987c473
+  metadata.gz: 27fd0273e03c2cc30caa02a1cc540813c31cbd8724aabe14ee63c472277758af
+  data.tar.gz: cf3506a5d39c78397701eb152108bab7f2b99934d912b4f90915a32719a77e89
 SHA512:
-  metadata.gz: fd6f21e98f5c59119c9d09762984eadf7876811187a61927a8219d2bd4b9b24b2971d5438fc90d53bfb03d512c6177bf7b4dac4b061e16d14cc9238cb742673b
-  data.tar.gz: 3e2ccec2a7f442ec492b19135aa47b8397a30f52efd59a3084db1e522f8651da645d0a02ae77b7abb9cbda563329522bd48622be33cf911a85ddf99b43e591a5
+  metadata.gz: 4895417eef9c2e3654181f1c52c35b4cdefe3f5c440907067344e1345da2f44d53a729340b4324bd66393c88b26f76e1a4d04afdb3b3684d78c37cfd6ab94bea
+  data.tar.gz: 42c3090e07e4bc214984d3adb53fa687d2b48c00afd5fbe4614eb13e03a0e3260db5a2e97fd57a5e81512d0c0fd2f727d6f4f9ecb64dae06efadf28d7e6f24d5

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.120
+- Package version: 3.10.122
 - 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.120.gem
+gem install ./ultracart_api-3.10.122.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.120.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.122.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.120'
+    gem 'ultracart_api', '~> 3.10.122'
 
 ### Install from Git
 
@@ -254,6 +254,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::OrderApi* | [**get_accounts_receivable_retry_stats**](docs/OrderApi.md#get_accounts_receivable_retry_stats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics
 *UltracartClient::OrderApi* | [**get_order**](docs/OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
 *UltracartClient::OrderApi* | [**get_order_by_token**](docs/OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
+*UltracartClient::OrderApi* | [**get_order_edi_documents**](docs/OrderApi.md#get_order_edi_documents) | **GET** /order/orders/{order_id}/edi | Retrieve EDI documents associated with this order.
 *UltracartClient::OrderApi* | [**get_orders**](docs/OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
 *UltracartClient::OrderApi* | [**get_orders_batch**](docs/OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
 *UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
@@ -663,6 +664,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)
@@ -1053,6 +1055,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::OrderDigitalItem](docs/OrderDigitalItem.md)
  - [UltracartClient::OrderDigitalOrder](docs/OrderDigitalOrder.md)
  - [UltracartClient::OrderEdi](docs/OrderEdi.md)
+ - [UltracartClient::OrderEdiDocument](docs/OrderEdiDocument.md)
+ - [UltracartClient::OrderEdiDocumentsResponse](docs/OrderEdiDocumentsResponse.md)
  - [UltracartClient::OrderFormat](docs/OrderFormat.md)
  - [UltracartClient::OrderFormatResponse](docs/OrderFormatResponse.md)
  - [UltracartClient::OrderFraudScore](docs/OrderFraudScore.md)
@@ -1303,6 +1307,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.122 | 03/14/2023 | order.getOrderEdiDocuments |
+| 3.10.121 | 03/01/2023 | convo - add sentiment record to conversation obj |
 | 3.10.120 | 02/22/2023 | convo - customer initiated flag on engagement |
 | 3.10.119 | 02/20/2023 | refund reasons |
 | 3.10.118 | 02/17/2023 | convo api - smsUnsubscribeConversation method |

data/docs/Conversation.md

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

data/docs/ConversationSentiment.md

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

data/docs/ConversationSummary.md

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

data/docs/OrderApi.md

@@ -17,6 +17,7 @@ Method | HTTP request | Description
 [**get_accounts_receivable_retry_stats**](OrderApi.md#get_accounts_receivable_retry_stats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics
 [**get_order**](OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
 [**get_order_by_token**](OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
+[**get_order_edi_documents**](OrderApi.md#get_order_edi_documents) | **GET** /order/orders/{order_id}/edi | Retrieve EDI documents associated with this order.
 [**get_orders**](OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
 [**get_orders_batch**](OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
 [**get_orders_by_query**](OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
@@ -699,6 +700,56 @@ Name | Type | Description  | Notes
 
 
 
+# **get_order_edi_documents**
+> OrderEdiDocumentsResponse get_order_edi_documents(order_id)
+
+Retrieve EDI documents associated with this order.
+
+Retrieve EDI documents associated with this order. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
+
+
+order_id = 'order_id_example' # String | The order id to retrieve EDI documents for.
+
+
+begin
+  #Retrieve EDI documents associated with this order.
+  result = api_instance.get_order_edi_documents(order_id)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling OrderApi->get_order_edi_documents: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| The order id to retrieve EDI documents for. | 
+
+### Return type
+
+[**OrderEdiDocumentsResponse**](OrderEdiDocumentsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **get_orders**
 > OrdersResponse get_orders(opts)
 

data/docs/OrderEdiDocument.md

@@ -0,0 +1,21 @@
+# UltracartClient::OrderEdiDocument
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**direction** | **String** | Direction the document flowed | [optional] 
+**doc_dts** | **String** | Date/time the document was created/received | [optional] 
+**document** | **String** |  | [optional] 
+**document_type_description** | **String** |  | [optional] 
+**document_type_number** | **Integer** |  | [optional] 
+**external_id** | **String** |  | [optional] 
+**functional_acknowledgement** | **String** |  | [optional] 
+**functional_acknowledgement_dts** | **String** |  | [optional] 
+**functional_acknowledgement_pending** | **BOOLEAN** |  | [optional] 
+**group_control_number** | **Integer** |  | [optional] 
+**internal_id** | **String** |  | [optional] 
+**merchant_id** | **String** |  | [optional] 
+**order_id** | **String** |  | [optional] 
+**test_mode** | **BOOLEAN** |  | [optional] 
+
+

data/docs/OrderEdiDocumentsResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::OrderEdiDocumentsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**edi_documents** | [**Array<OrderEdiDocument>**](OrderEdiDocument.md) | edi_documents | [optional] 
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/lib/ultracart_api/api/order_api.rb

@@ -767,6 +767,61 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Retrieve EDI documents associated with this order.
+    # Retrieve EDI documents associated with this order. 
+    # @param order_id The order id to retrieve EDI documents for.
+    # @param [Hash] opts the optional parameters
+    # @return [OrderEdiDocumentsResponse]
+    def get_order_edi_documents(order_id, opts = {})
+      data, _status_code, _headers = get_order_edi_documents_with_http_info(order_id, opts)
+      data
+    end
+
+    # Retrieve EDI documents associated with this order.
+    # Retrieve EDI documents associated with this order. 
+    # @param order_id The order id to retrieve EDI documents for.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderEdiDocumentsResponse, Fixnum, Hash)>] OrderEdiDocumentsResponse data, response status code and response headers
+    def get_order_edi_documents_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.get_order_edi_documents ...'
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_order_edi_documents"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/edi'.sub('{' + 'order_id' + '}', order_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'OrderEdiDocumentsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrderApi#get_order_edi_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve orders
     # Retrieves a group of orders from the account.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/conversation.rb

@@ -49,6 +49,8 @@ module UltracartClient
 
     attr_accessor :participants
 
+    attr_accessor :sentiment
+
     # Start of the conversation date/time
     attr_accessor :start_dts
 
@@ -96,6 +98,7 @@ module UltracartClient
         :'message_count' => :'message_count',
         :'messages' => :'messages',
         :'participants' => :'participants',
+        :'sentiment' => :'sentiment',
         :'start_dts' => :'start_dts',
         :'unread_messages' => :'unread_messages',
         :'visible' => :'visible'
@@ -120,6 +123,7 @@ module UltracartClient
         :'message_count' => :'Integer',
         :'messages' => :'Array<ConversationMessage>',
         :'participants' => :'Array<ConversationParticipant>',
+        :'sentiment' => :'ConversationSentiment',
         :'start_dts' => :'String',
         :'unread_messages' => :'BOOLEAN',
         :'visible' => :'BOOLEAN'
@@ -198,6 +202,10 @@ module UltracartClient
         end
       end
 
+      if attributes.has_key?(:'sentiment')
+        self.sentiment = attributes[:'sentiment']
+      end
+
       if attributes.has_key?(:'start_dts')
         self.start_dts = attributes[:'start_dts']
       end
@@ -256,6 +264,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
@@ -270,7 +279,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] 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,269 @@
+=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 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
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'last_detect_sentiment' => :'String',
+        :'mixed' => :'Float',
+        :'negative' => :'Float',
+        :'neutral' => :'Float',
+        :'positive' => :'Float',
+        :'sentiment' => :'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?(:'last_detect_sentiment')
+        self.last_detect_sentiment = attributes[:'last_detect_sentiment']
+      end
+
+      if attributes.has_key?(:'mixed')
+        self.mixed = attributes[:'mixed']
+      end
+
+      if attributes.has_key?(:'negative')
+        self.negative = attributes[:'negative']
+      end
+
+      if attributes.has_key?(:'neutral')
+        self.neutral = attributes[:'neutral']
+      end
+
+      if attributes.has_key?(:'positive')
+        self.positive = attributes[:'positive']
+      end
+
+      if attributes.has_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 [Fixnum] 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 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_summary.rb

@@ -44,6 +44,8 @@ module UltracartClient
 
     attr_accessor :participants
 
+    attr_accessor :sentiment
+
     # Start of the conversation date/time
     attr_accessor :start_dts
 
@@ -89,6 +91,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'
@@ -111,6 +114,7 @@ module UltracartClient
         :'merchant_id' => :'String',
         :'message_count' => :'Integer',
         :'participants' => :'Array<ConversationParticipant>',
+        :'sentiment' => :'ConversationSentiment',
         :'start_dts' => :'String',
         :'unread_messages' => :'BOOLEAN',
         :'visible' => :'BOOLEAN'
@@ -179,6 +183,10 @@ module UltracartClient
         end
       end
 
+      if attributes.has_key?(:'sentiment')
+        self.sentiment = attributes[:'sentiment']
+      end
+
       if attributes.has_key?(:'start_dts')
         self.start_dts = attributes[:'start_dts']
       end
@@ -235,6 +243,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
@@ -249,7 +258,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] 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/models/order_edi_document.rb

@@ -0,0 +1,337 @@
+=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 OrderEdiDocument
+    # Direction the document flowed
+    attr_accessor :direction
+
+    # Date/time the document was created/received
+    attr_accessor :doc_dts
+
+    attr_accessor :document
+
+    attr_accessor :document_type_description
+
+    attr_accessor :document_type_number
+
+    attr_accessor :external_id
+
+    attr_accessor :functional_acknowledgement
+
+    attr_accessor :functional_acknowledgement_dts
+
+    attr_accessor :functional_acknowledgement_pending
+
+    attr_accessor :group_control_number
+
+    attr_accessor :internal_id
+
+    attr_accessor :merchant_id
+
+    attr_accessor :order_id
+
+    attr_accessor :test_mode
+
+    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
+      {
+        :'direction' => :'direction',
+        :'doc_dts' => :'doc_dts',
+        :'document' => :'document',
+        :'document_type_description' => :'document_type_description',
+        :'document_type_number' => :'document_type_number',
+        :'external_id' => :'external_id',
+        :'functional_acknowledgement' => :'functional_acknowledgement',
+        :'functional_acknowledgement_dts' => :'functional_acknowledgement_dts',
+        :'functional_acknowledgement_pending' => :'functional_acknowledgement_pending',
+        :'group_control_number' => :'group_control_number',
+        :'internal_id' => :'internal_id',
+        :'merchant_id' => :'merchant_id',
+        :'order_id' => :'order_id',
+        :'test_mode' => :'test_mode'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'direction' => :'String',
+        :'doc_dts' => :'String',
+        :'document' => :'String',
+        :'document_type_description' => :'String',
+        :'document_type_number' => :'Integer',
+        :'external_id' => :'String',
+        :'functional_acknowledgement' => :'String',
+        :'functional_acknowledgement_dts' => :'String',
+        :'functional_acknowledgement_pending' => :'BOOLEAN',
+        :'group_control_number' => :'Integer',
+        :'internal_id' => :'String',
+        :'merchant_id' => :'String',
+        :'order_id' => :'String',
+        :'test_mode' => :'BOOLEAN'
+      }
+    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?(:'direction')
+        self.direction = attributes[:'direction']
+      end
+
+      if attributes.has_key?(:'doc_dts')
+        self.doc_dts = attributes[:'doc_dts']
+      end
+
+      if attributes.has_key?(:'document')
+        self.document = attributes[:'document']
+      end
+
+      if attributes.has_key?(:'document_type_description')
+        self.document_type_description = attributes[:'document_type_description']
+      end
+
+      if attributes.has_key?(:'document_type_number')
+        self.document_type_number = attributes[:'document_type_number']
+      end
+
+      if attributes.has_key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      end
+
+      if attributes.has_key?(:'functional_acknowledgement')
+        self.functional_acknowledgement = attributes[:'functional_acknowledgement']
+      end
+
+      if attributes.has_key?(:'functional_acknowledgement_dts')
+        self.functional_acknowledgement_dts = attributes[:'functional_acknowledgement_dts']
+      end
+
+      if attributes.has_key?(:'functional_acknowledgement_pending')
+        self.functional_acknowledgement_pending = attributes[:'functional_acknowledgement_pending']
+      end
+
+      if attributes.has_key?(:'group_control_number')
+        self.group_control_number = attributes[:'group_control_number']
+      end
+
+      if attributes.has_key?(:'internal_id')
+        self.internal_id = attributes[:'internal_id']
+      end
+
+      if attributes.has_key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.has_key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+
+      if attributes.has_key?(:'test_mode')
+        self.test_mode = attributes[:'test_mode']
+      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?
+      direction_validator = EnumAttributeValidator.new('String', ['inbound', 'outbound'])
+      return false unless direction_validator.valid?(@direction)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] direction Object to be assigned
+    def direction=(direction)
+      validator = EnumAttributeValidator.new('String', ['inbound', 'outbound'])
+      unless validator.valid?(direction)
+        fail ArgumentError, 'invalid value for "direction", must be one of #{validator.allowable_values}.'
+      end
+      @direction = direction
+    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 &&
+          direction == o.direction &&
+          doc_dts == o.doc_dts &&
+          document == o.document &&
+          document_type_description == o.document_type_description &&
+          document_type_number == o.document_type_number &&
+          external_id == o.external_id &&
+          functional_acknowledgement == o.functional_acknowledgement &&
+          functional_acknowledgement_dts == o.functional_acknowledgement_dts &&
+          functional_acknowledgement_pending == o.functional_acknowledgement_pending &&
+          group_control_number == o.group_control_number &&
+          internal_id == o.internal_id &&
+          merchant_id == o.merchant_id &&
+          order_id == o.order_id &&
+          test_mode == o.test_mode
+    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
+      [direction, doc_dts, document, document_type_description, document_type_number, external_id, functional_acknowledgement, functional_acknowledgement_dts, functional_acknowledgement_pending, group_control_number, internal_id, merchant_id, order_id, test_mode].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/order_edi_documents_response.rb

@@ -0,0 +1,224 @@
+=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 OrderEdiDocumentsResponse
+    # edi_documents
+    attr_accessor :edi_documents
+
+    attr_accessor :error
+
+    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
+      {
+        :'edi_documents' => :'ediDocuments',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'edi_documents' => :'Array<OrderEdiDocument>',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'BOOLEAN',
+        :'warning' => :'Warning'
+      }
+    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?(:'ediDocuments')
+        if (value = attributes[:'ediDocuments']).is_a?(Array)
+          self.edi_documents = value
+        end
+      end
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_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 &&
+          edi_documents == o.edi_documents &&
+          error == o.error &&
+          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 [Fixnum] Hash code
+    def hash
+      [edi_documents, error, 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 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/version.rb

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

data/lib/ultracart_api.rb

@@ -187,6 +187,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'
@@ -577,6 +578,8 @@ require 'ultracart_api/models/order_coupon'
 require 'ultracart_api/models/order_digital_item'
 require 'ultracart_api/models/order_digital_order'
 require 'ultracart_api/models/order_edi'
+require 'ultracart_api/models/order_edi_document'
+require 'ultracart_api/models/order_edi_documents_response'
 require 'ultracart_api/models/order_format'
 require 'ultracart_api/models/order_format_response'
 require 'ultracart_api/models/order_fraud_score'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.120
+  version: 3.10.122
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-22 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -397,6 +397,7 @@ files:
 - docs/ConversationResponse.md
 - docs/ConversationSearchRequest.md
 - docs/ConversationSearchResponse.md
+- docs/ConversationSentiment.md
 - docs/ConversationStartRequest.md
 - docs/ConversationStartResponse.md
 - docs/ConversationSummary.md
@@ -795,6 +796,8 @@ files:
 - docs/OrderDigitalItem.md
 - docs/OrderDigitalOrder.md
 - docs/OrderEdi.md
+- docs/OrderEdiDocument.md
+- docs/OrderEdiDocumentsResponse.md
 - docs/OrderFormat.md
 - docs/OrderFormatResponse.md
 - docs/OrderFraudScore.md
@@ -1174,6 +1177,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
@@ -1564,6 +1568,8 @@ files:
 - lib/ultracart_api/models/order_digital_item.rb
 - lib/ultracart_api/models/order_digital_order.rb
 - lib/ultracart_api/models/order_edi.rb
+- lib/ultracart_api/models/order_edi_document.rb
+- lib/ultracart_api/models/order_edi_documents_response.rb
 - lib/ultracart_api/models/order_format.rb
 - lib/ultracart_api/models/order_format_response.rb
 - lib/ultracart_api/models/order_fraud_score.rb