ultracart_api 4.0.120.rc → 4.0.122.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ae53086eb7ba0a277f20bc798ab17e88a4708b60304067563f9db72be707ad3
-  data.tar.gz: b598e8dfe94de3051a5c909fa052cb449171f82d8312b514acd5fe23801c573d
+  metadata.gz: 385862ada6be86537e5545c20c1ed2fa7cc9f6b8ef17efdb6d91a4dde04e4411
+  data.tar.gz: eedee93bde2d0f8b811931d4152b7b7fd5a3b80e709d4f7693c2cde996a24bfa
 SHA512:
-  metadata.gz: 560c8c920a5e7f0c8308ef79f6eaf6ab8d738eb5bdccc051fa44e6ac21404d909fd16a28ebbd2769cda16f74c732dfbb943a9ef86366b612b2afa2fccb6655ce
-  data.tar.gz: 1800c46496b3b689a3715b9bbbed58bc8e7e7b3b86dc1a2cf7aab79008f4f7b0b5b9adde1ed9391e7f84f154a5dc6cf30cfafb453eb126285dc5f28ccff81b2d
+  metadata.gz: afb6cc0c5513f3d5084896dfec3c60f71b4e9b4d959b0024b69895723c4f4822404e4bcb70bbfe7542844957eddab88f2f6a459c6c27b1fd142241a0eeb80677
+  data.tar.gz: b78fd1639bb08d42c6840a057506115dab3adcab00161012a39ce84dd4f94d3ae08c63aba7c6ffe9d37a8fe6006555530fffd92e51f348de878a86e59517b525

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.120.rc
+- Package version: 4.0.122.rc
 - 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.120.rc.gem
+gem install ./ultracart_api-4.0.122.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.120.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.122.rc.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.120.rc'
+    gem 'ultracart_api', '~> 4.0.122.rc'
 
 ### Install from Git
 
@@ -147,6 +147,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_conversation_context**](docs/ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
 *UltracartClient::ConversationApi* | [**get_conversation_department_member_list**](docs/ConversationApi.md#get_conversation_department_member_list) | **GET** /conversation/department_members | Retrieve a list of possible department members
 *UltracartClient::ConversationApi* | [**get_conversation_departments**](docs/ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
+*UltracartClient::ConversationApi* | [**get_conversation_engagement**](docs/ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
 *UltracartClient::ConversationApi* | [**get_conversation_engagements**](docs/ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
 *UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
 *UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
@@ -1092,6 +1093,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::OrderTokenResponse](docs/OrderTokenResponse.md)
  - [UltracartClient::OrderTrackingNumberDetail](docs/OrderTrackingNumberDetail.md)
  - [UltracartClient::OrderTrackingNumberDetails](docs/OrderTrackingNumberDetails.md)
+ - [UltracartClient::OrderTransactionalMerchantNote](docs/OrderTransactionalMerchantNote.md)
  - [UltracartClient::OrdersResponse](docs/OrdersResponse.md)
  - [UltracartClient::Permission](docs/Permission.md)
  - [UltracartClient::PointOfSaleLocation](docs/PointOfSaleLocation.md)
@@ -1296,6 +1298,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.122-RC | 01/24/2023 | auto order - cancel minimum and change balance options |
+| 4.0.121-RC | 01/23/2023 | conversation - method to fetch single engagement record |
 | 4.0.120-RC | 01/19/2023 | added skip_on_rebill field to coupon object |
 | 4.0.119-RC | 01/19/2023 | convo - getConversationPermissions added |
 | 4.0.118-RC | 01/18/2023 | conversation get dept member list method added |

data/docs/ConversationApi.md

@@ -14,6 +14,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_conversation_context**](ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context |
 | [**get_conversation_department_member_list**](ConversationApi.md#get_conversation_department_member_list) | **GET** /conversation/department_members | Retrieve a list of possible department members |
 | [**get_conversation_departments**](ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name |
+| [**get_conversation_engagement**](ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement |
 | [**get_conversation_engagements**](ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name |
 | [**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages |
 | [**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL |
@@ -731,6 +732,77 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## get_conversation_engagement
+
+> <ConversationEngagementResponse> get_conversation_engagement(conversation_engagement_oid)
+
+Retrieve an engagement
+
+Retrieve an engagement 
+
+### 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::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+conversation_engagement_oid = 56 # Integer | 
+
+begin
+  # Retrieve an engagement
+  result = api_instance.get_conversation_engagement(conversation_engagement_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation_engagement: #{e}"
+end
+```
+
+#### Using the get_conversation_engagement_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationEngagementResponse>, Integer, Hash)> get_conversation_engagement_with_http_info(conversation_engagement_oid)
+
+```ruby
+begin
+  # Retrieve an engagement
+  data, status_code, headers = api_instance.get_conversation_engagement_with_http_info(conversation_engagement_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationEngagementResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation_engagement_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_engagement_oid** | **Integer** |  |  |
+
+### Return type
+
+[**ConversationEngagementResponse**](ConversationEngagementResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_conversation_engagements
 
 > <ConversationEngagementsResponse> get_conversation_engagements

data/docs/ItemAutoOrder.md

@@ -6,8 +6,11 @@
 | ---- | ---- | ----------- | ----- |
 | **auth_future_amount** | **Float** | Amount to try and authorize for the future rebill | [optional] |
 | **auth_test_amount** | **Float** | Amount to try and test authorize | [optional] |
+| **auto_order_cancel_charge_minimum_balance** | **Boolean** | If true, the cost of the cancel item will be the remaining balance of the minimum rebill or lifetime value | [optional] |
 | **auto_order_cancel_item_id** | **String** | Item id to attempt charging the customer for if they cancel | [optional] |
 | **auto_order_cancel_item_oid** | **Integer** | Item object identifier to attempt charging the customer for if they cancel | [optional] |
+| **auto_order_cancel_minimum_life_time_value** | **Float** | The minimum life time value that must be paid in order to not be charged the cancellation item. | [optional] |
+| **auto_order_cancel_minimum_rebill_value** | **Float** | The minimum rebill value that must be paid in order to not be charged the cancellation item. | [optional] |
 | **auto_order_downgrade_items** | **Array<String>** | List of downgrade items presented to customer service representatives | [optional] |
 | **auto_order_paused** | **Boolean** | True if the rebill processing of this item is paused | [optional] |
 | **auto_order_prohibit_expiring_cards** | **Integer** | Minimum number of months before expiration for the card.  Overrides the account level setting if higher.  Set to zero to disable. | [optional] |
@@ -30,8 +33,11 @@ require 'ultracart_api'
 instance = UltracartClient::ItemAutoOrder.new(
   auth_future_amount: null,
   auth_test_amount: null,
+  auto_order_cancel_charge_minimum_balance: null,
   auto_order_cancel_item_id: null,
   auto_order_cancel_item_oid: null,
+  auto_order_cancel_minimum_life_time_value: null,
+  auto_order_cancel_minimum_rebill_value: null,
   auto_order_downgrade_items: null,
   auto_order_paused: null,
   auto_order_prohibit_expiring_cards: null,

data/docs/OrderInternal.md

@@ -5,10 +5,11 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **exported_to_accounting** | **Boolean** | True if the order has been exported to QuickBooks. If QuickBooks is not configured, then this will already be true | [optional] |
-| **merchant_notes** | **String** | Merchant notes | [optional] |
+| **merchant_notes** | **String** | Merchant notes.  Full notes in non-transactional mode.  Just used to write a new merchant note when transaction merchant notes enabled. | [optional] |
 | **placed_by_user** | **String** | If placed via the BEOE, this is the user that placed the order | [optional] |
 | **refund_by_user** | **String** | User that issued the refund | [optional] |
 | **sales_rep_code** | **String** | Sales rep code associated with the order | [optional] |
+| **transactional_merchant_notes** | [**Array<OrderTransactionalMerchantNote>**](OrderTransactionalMerchantNote.md) | Transactional merchant notes | [optional] |
 
 ## Example
 
@@ -20,7 +21,8 @@ instance = UltracartClient::OrderInternal.new(
   merchant_notes: null,
   placed_by_user: null,
   refund_by_user: null,
-  sales_rep_code: null
+  sales_rep_code: null,
+  transactional_merchant_notes: null
 )
 ```
 

data/docs/OrderTransactionalMerchantNote.md

@@ -0,0 +1,24 @@
+# UltracartClient::OrderTransactionalMerchantNote
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip_address** | **String** | IP Address | [optional] |
+| **note** | **String** | note | [optional] |
+| **note_dts** | **String** | Timestamp when the note was added | [optional] |
+| **user** | **String** | User that wrote the merchant note | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::OrderTransactionalMerchantNote.new(
+  ip_address: null,
+  note: null,
+  note_dts: null,
+  user: null
+)
+```
+

data/lib/ultracart_api/api/conversation_api.rb

@@ -645,6 +645,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Retrieve an engagement
+    # Retrieve an engagement 
+    # @param conversation_engagement_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationEngagementResponse]
+    def get_conversation_engagement(conversation_engagement_oid, opts = {})
+      data, _status_code, _headers = get_conversation_engagement_with_http_info(conversation_engagement_oid, opts)
+      data
+    end
+
+    # Retrieve an engagement
+    # Retrieve an engagement 
+    # @param conversation_engagement_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationEngagementResponse, Integer, Hash)>] ConversationEngagementResponse data, response status code and response headers
+    def get_conversation_engagement_with_http_info(conversation_engagement_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_engagement ...'
+      end
+      # verify the required parameter 'conversation_engagement_oid' is set
+      if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.get_conversation_engagement"
+      end
+      # resource path
+      local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', CGI.escape(conversation_engagement_oid.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] || 'ConversationEngagementResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_conversation_engagement",
+        :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: ConversationApi#get_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve a list of engagements ordered by name
     # Retrieve a list of engagements ordered by name 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/item_auto_order.rb

@@ -21,12 +21,21 @@ module UltracartClient
     # Amount to try and test authorize
     attr_accessor :auth_test_amount
 
+    # If true, the cost of the cancel item will be the remaining balance of the minimum rebill or lifetime value
+    attr_accessor :auto_order_cancel_charge_minimum_balance
+
     # Item id to attempt charging the customer for if they cancel
     attr_accessor :auto_order_cancel_item_id
 
     # Item object identifier to attempt charging the customer for if they cancel
     attr_accessor :auto_order_cancel_item_oid
 
+    # The minimum life time value that must be paid in order to not be charged the cancellation item.
+    attr_accessor :auto_order_cancel_minimum_life_time_value
+
+    # The minimum rebill value that must be paid in order to not be charged the cancellation item.
+    attr_accessor :auto_order_cancel_minimum_rebill_value
+
     # List of downgrade items presented to customer service representatives
     attr_accessor :auto_order_downgrade_items
 
@@ -71,8 +80,11 @@ module UltracartClient
       {
         :'auth_future_amount' => :'auth_future_amount',
         :'auth_test_amount' => :'auth_test_amount',
+        :'auto_order_cancel_charge_minimum_balance' => :'auto_order_cancel_charge_minimum_balance',
         :'auto_order_cancel_item_id' => :'auto_order_cancel_item_id',
         :'auto_order_cancel_item_oid' => :'auto_order_cancel_item_oid',
+        :'auto_order_cancel_minimum_life_time_value' => :'auto_order_cancel_minimum_life_time_value',
+        :'auto_order_cancel_minimum_rebill_value' => :'auto_order_cancel_minimum_rebill_value',
         :'auto_order_downgrade_items' => :'auto_order_downgrade_items',
         :'auto_order_paused' => :'auto_order_paused',
         :'auto_order_prohibit_expiring_cards' => :'auto_order_prohibit_expiring_cards',
@@ -99,8 +111,11 @@ module UltracartClient
       {
         :'auth_future_amount' => :'Float',
         :'auth_test_amount' => :'Float',
+        :'auto_order_cancel_charge_minimum_balance' => :'Boolean',
         :'auto_order_cancel_item_id' => :'String',
         :'auto_order_cancel_item_oid' => :'Integer',
+        :'auto_order_cancel_minimum_life_time_value' => :'Float',
+        :'auto_order_cancel_minimum_rebill_value' => :'Float',
         :'auto_order_downgrade_items' => :'Array<String>',
         :'auto_order_paused' => :'Boolean',
         :'auto_order_prohibit_expiring_cards' => :'Integer',
@@ -146,6 +161,10 @@ module UltracartClient
         self.auth_test_amount = attributes[:'auth_test_amount']
       end
 
+      if attributes.key?(:'auto_order_cancel_charge_minimum_balance')
+        self.auto_order_cancel_charge_minimum_balance = attributes[:'auto_order_cancel_charge_minimum_balance']
+      end
+
       if attributes.key?(:'auto_order_cancel_item_id')
         self.auto_order_cancel_item_id = attributes[:'auto_order_cancel_item_id']
       end
@@ -154,6 +173,14 @@ module UltracartClient
         self.auto_order_cancel_item_oid = attributes[:'auto_order_cancel_item_oid']
       end
 
+      if attributes.key?(:'auto_order_cancel_minimum_life_time_value')
+        self.auto_order_cancel_minimum_life_time_value = attributes[:'auto_order_cancel_minimum_life_time_value']
+      end
+
+      if attributes.key?(:'auto_order_cancel_minimum_rebill_value')
+        self.auto_order_cancel_minimum_rebill_value = attributes[:'auto_order_cancel_minimum_rebill_value']
+      end
+
       if attributes.key?(:'auto_order_downgrade_items')
         if (value = attributes[:'auto_order_downgrade_items']).is_a?(Array)
           self.auto_order_downgrade_items = value
@@ -250,8 +277,11 @@ module UltracartClient
       self.class == o.class &&
           auth_future_amount == o.auth_future_amount &&
           auth_test_amount == o.auth_test_amount &&
+          auto_order_cancel_charge_minimum_balance == o.auto_order_cancel_charge_minimum_balance &&
           auto_order_cancel_item_id == o.auto_order_cancel_item_id &&
           auto_order_cancel_item_oid == o.auto_order_cancel_item_oid &&
+          auto_order_cancel_minimum_life_time_value == o.auto_order_cancel_minimum_life_time_value &&
+          auto_order_cancel_minimum_rebill_value == o.auto_order_cancel_minimum_rebill_value &&
           auto_order_downgrade_items == o.auto_order_downgrade_items &&
           auto_order_paused == o.auto_order_paused &&
           auto_order_prohibit_expiring_cards == o.auto_order_prohibit_expiring_cards &&
@@ -276,7 +306,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [auth_future_amount, auth_test_amount, auto_order_cancel_item_id, auto_order_cancel_item_oid, auto_order_downgrade_items, auto_order_paused, auto_order_prohibit_expiring_cards, auto_order_schedules, auto_order_upgrade_items, auto_order_upsell, auto_order_upsell_no_easy_cancel, auto_order_upsell_one_per_customer, auto_orderable, cancel_other_auto_orders, free_shipping_auto_order, refund_other_auto_orders, steps].hash
+      [auth_future_amount, auth_test_amount, auto_order_cancel_charge_minimum_balance, auto_order_cancel_item_id, auto_order_cancel_item_oid, auto_order_cancel_minimum_life_time_value, auto_order_cancel_minimum_rebill_value, auto_order_downgrade_items, auto_order_paused, auto_order_prohibit_expiring_cards, auto_order_schedules, auto_order_upgrade_items, auto_order_upsell, auto_order_upsell_no_easy_cancel, auto_order_upsell_one_per_customer, auto_orderable, cancel_other_auto_orders, free_shipping_auto_order, refund_other_auto_orders, steps].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_internal.rb

@@ -18,7 +18,7 @@ module UltracartClient
     # True if the order has been exported to QuickBooks. If QuickBooks is not configured, then this will already be true
     attr_accessor :exported_to_accounting
 
-    # Merchant notes
+    # Merchant notes.  Full notes in non-transactional mode.  Just used to write a new merchant note when transaction merchant notes enabled.
     attr_accessor :merchant_notes
 
     # If placed via the BEOE, this is the user that placed the order
@@ -30,6 +30,9 @@ module UltracartClient
     # Sales rep code associated with the order
     attr_accessor :sales_rep_code
 
+    # Transactional merchant notes
+    attr_accessor :transactional_merchant_notes
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -37,7 +40,8 @@ module UltracartClient
         :'merchant_notes' => :'merchant_notes',
         :'placed_by_user' => :'placed_by_user',
         :'refund_by_user' => :'refund_by_user',
-        :'sales_rep_code' => :'sales_rep_code'
+        :'sales_rep_code' => :'sales_rep_code',
+        :'transactional_merchant_notes' => :'transactional_merchant_notes'
       }
     end
 
@@ -53,7 +57,8 @@ module UltracartClient
         :'merchant_notes' => :'String',
         :'placed_by_user' => :'String',
         :'refund_by_user' => :'String',
-        :'sales_rep_code' => :'String'
+        :'sales_rep_code' => :'String',
+        :'transactional_merchant_notes' => :'Array<OrderTransactionalMerchantNote>'
       }
     end
 
@@ -97,6 +102,12 @@ module UltracartClient
       if attributes.key?(:'sales_rep_code')
         self.sales_rep_code = attributes[:'sales_rep_code']
       end
+
+      if attributes.key?(:'transactional_merchant_notes')
+        if (value = attributes[:'transactional_merchant_notes']).is_a?(Array)
+          self.transactional_merchant_notes = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -136,7 +147,8 @@ module UltracartClient
           merchant_notes == o.merchant_notes &&
           placed_by_user == o.placed_by_user &&
           refund_by_user == o.refund_by_user &&
-          sales_rep_code == o.sales_rep_code
+          sales_rep_code == o.sales_rep_code &&
+          transactional_merchant_notes == o.transactional_merchant_notes
     end
 
     # @see the `==` method
@@ -148,7 +160,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [exported_to_accounting, merchant_notes, placed_by_user, refund_by_user, sales_rep_code].hash
+      [exported_to_accounting, merchant_notes, placed_by_user, refund_by_user, sales_rep_code, transactional_merchant_notes].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_transactional_merchant_note.rb

@@ -0,0 +1,250 @@
+=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 OrderTransactionalMerchantNote
+    # IP Address
+    attr_accessor :ip_address
+
+    # note
+    attr_accessor :note
+
+    # Timestamp when the note was added
+    attr_accessor :note_dts
+
+    # User that wrote the merchant note
+    attr_accessor :user
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ip_address' => :'ip_address',
+        :'note' => :'note',
+        :'note_dts' => :'note_dts',
+        :'user' => :'user'
+      }
+    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
+      {
+        :'ip_address' => :'String',
+        :'note' => :'String',
+        :'note_dts' => :'String',
+        :'user' => :'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::OrderTransactionalMerchantNote` 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::OrderTransactionalMerchantNote`. 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?(:'ip_address')
+        self.ip_address = attributes[:'ip_address']
+      end
+
+      if attributes.key?(:'note')
+        self.note = attributes[:'note']
+      end
+
+      if attributes.key?(:'note_dts')
+        self.note_dts = attributes[:'note_dts']
+      end
+
+      if attributes.key?(:'user')
+        self.user = attributes[:'user']
+      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 &&
+          ip_address == o.ip_address &&
+          note == o.note &&
+          note_dts == o.note_dts &&
+          user == o.user
+    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
+      [ip_address, note, note_dts, user].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/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.120.rc'
+  VERSION = '4.0.122.rc'
 end

data/lib/ultracart_api.rb

@@ -616,6 +616,7 @@ require 'ultracart_api/models/order_taxes'
 require 'ultracart_api/models/order_token_response'
 require 'ultracart_api/models/order_tracking_number_detail'
 require 'ultracart_api/models/order_tracking_number_details'
+require 'ultracart_api/models/order_transactional_merchant_note'
 require 'ultracart_api/models/orders_response'
 require 'ultracart_api/models/permission'
 require 'ultracart_api/models/point_of_sale_location'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.120.rc
+  version: 4.0.122.rc
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -674,6 +674,7 @@ files:
 - docs/OrderTokenResponse.md
 - docs/OrderTrackingNumberDetail.md
 - docs/OrderTrackingNumberDetails.md
+- docs/OrderTransactionalMerchantNote.md
 - docs/OrdersResponse.md
 - docs/Permission.md
 - docs/PointOfSaleLocation.md
@@ -1433,6 +1434,7 @@ files:
 - lib/ultracart_api/models/order_token_response.rb
 - lib/ultracart_api/models/order_tracking_number_detail.rb
 - lib/ultracart_api/models/order_tracking_number_details.rb
+- lib/ultracart_api/models/order_transactional_merchant_note.rb
 - lib/ultracart_api/models/orders_response.rb
 - lib/ultracart_api/models/permission.rb
 - lib/ultracart_api/models/point_of_sale_location.rb