ultracart_api 4.0.137 → 4.0.139

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb2ece4a88215f09744be53e9471a638c39a45738797086e3fea56b784b9a084
-  data.tar.gz: 4d5b4e9d3845139767603e0b1e4c324fbac8bc1ec19b3521579cb16d0fcf239f
+  metadata.gz: 0ce7f59685244a28188e13ed6c037ddddbaa28513b898206abb574056a8d9401
+  data.tar.gz: 843646f29e2e51b35e8b740d25046c195e9be1a59328ed76d6555efe0729ae1b
 SHA512:
-  metadata.gz: 141e6e90ab31f05aa6bcbac8e270c015351de7f5a5ca1e3283f95bfd99f9344574f44ab1de0190a26c30bc7648120fcf8e2af705579d710f1329a2dbcaad41a7
-  data.tar.gz: d7fc5d63a840818cf8e93b8cb0f136a84615b0137ce8fde98d34365f33a7966f77168c6f42e695ea3ffe8a7815ecfd52958cf1ae0467e6729b9568309419b754
+  metadata.gz: 3e5d7f095772e2c5f0c0f786f0216c7746ee8479154eed2e6526767cceeaf4bfdda841b034d18a81b1c77db444845f94052c4ce008deab6446f03912425067f4
+  data.tar.gz: 744003a775fb34645b7ffe0fd0855b94dc6bbc0cbae4fcd93637db949ed63d11f869277ad94023f98269683fa5f221cf93192b26e4d857ac94e20821ec9c4b51

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.139
 - 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.139.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.139.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.139'
 
 ### Install from Git
 
@@ -260,6 +260,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
@@ -668,6 +669,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)
@@ -1058,6 +1060,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)
@@ -1311,6 +1315,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.139 | 03/14/2023 | order.getOrderEdiDocuments |
+| 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/docs/OrderApi.md

@@ -17,6 +17,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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 |
@@ -972,6 +973,77 @@ end
 - **Accept**: application/json
 
 
+## 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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+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 "Error when calling OrderApi->get_order_edi_documents: #{e}"
+end
+```
+
+#### Using the get_order_edi_documents_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrderEdiDocumentsResponse>, Integer, Hash)> get_order_edi_documents_with_http_info(order_id)
+
+```ruby
+begin
+  # Retrieve EDI documents associated with this order.
+  data, status_code, headers = api_instance.get_order_edi_documents_with_http_info(order_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrderEdiDocumentsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling OrderApi->get_order_edi_documents_with_http_info: #{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**: Not defined
+- **Accept**: application/json
+
+
 ## get_orders
 
 > <OrdersResponse> get_orders(opts)

data/docs/OrderEdiDocument.md

@@ -0,0 +1,44 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::OrderEdiDocument.new(
+  direction: null,
+  doc_dts: null,
+  document: null,
+  document_type_description: null,
+  document_type_number: null,
+  external_id: null,
+  functional_acknowledgement: null,
+  functional_acknowledgement_dts: null,
+  functional_acknowledgement_pending: null,
+  group_control_number: null,
+  internal_id: null,
+  merchant_id: null,
+  order_id: null,
+  test_mode: null
+)
+```
+

data/docs/OrderEdiDocumentsResponse.md

@@ -0,0 +1,26 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::OrderEdiDocumentsResponse.new(
+  edi_documents: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/lib/ultracart_api/api/order_api.rb

@@ -895,6 +895,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Retrieve EDI documents associated with this order.
+    # Retrieve EDI documents associated with this order. 
+    # @param order_id [String] 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 [String] The order id to retrieve EDI documents for.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderEdiDocumentsResponse, Integer, 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' + '}', CGI.escape(order_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[: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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrderEdiDocumentsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.get_order_edi_documents",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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

@@ -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