ultracart_api 4.1.84 → 4.1.86

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8728bb3fa0c26246f58c8188529196d268b7dd187c8297f3e85dbdc475ca1e1
-  data.tar.gz: d43769ea615c3bb8167a3f0a5325a24e624f13afe505571ca6b73a8d68e042c9
+  metadata.gz: 87093ad6bef3385e3591780b4b9ef0e7e0f8eab61e072589d3f63580b0d33e31
+  data.tar.gz: 9ca4f31ff6a36fdb271e81fac3ea21b59a08708900ea85fbce12132aa81b4e55
 SHA512:
-  metadata.gz: 66f34f4045d3997e67bd952ced21ab23225a0da708d5bdc6c88d920771745533332c23a37d5cafd23063276cc744880874b3a54c8673c86bc0f143c4cba8bd9a
-  data.tar.gz: c644a2149626b1605e1f2705c86cd2321c4d252d2b0c3ce12b442a79e6accf20fc8f19a9f4a9b3c54a3933a30c7e66bcdff0704bdabbb5698dc0e89495664be3
+  metadata.gz: 00d80e10c6c9822d2eb258459e705aa21c34621a4ef50f5bc706593a9bb4279d7730605b3f7e233df6c84f4f58377cc0964210af61585a3ac814ec2bdc6acf13
+  data.tar.gz: 35331067008eeca96c36462bcb1b4dc5878975fb9c6f464dd07a7e1ffbfabe9561cdc5dd319eb0f3a7c7a004f24b3b2df45fe714f9c7e183f63ee27fd37a1989

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.84
+- Package version: 4.1.86
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.84'
+gem 'ultracart_api', '4.1.86'
 ```
 
 install:
@@ -413,6 +413,8 @@ Class | Method | HTTP request | Description
 *UltracartClient::OrderApi* | [**generate_order_token**](docs/OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
 *UltracartClient::OrderApi* | [**generate_packing_slip_all_dc**](docs/OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers.
 *UltracartClient::OrderApi* | [**generate_packing_slip_specific_dc**](docs/OrderApi.md#generate_packing_slip_specific_dc) | **GET** /order/orders/{order_id}/packing_slip/{distribution_center_code} | Generate a packing slip for this order for the given distribution center.
+*UltracartClient::OrderApi* | [**get_accounts_receivable_detail_value_histogram**](docs/OrderApi.md#get_accounts_receivable_detail_value_histogram) | **GET** /order/accounts_receivable/detail_value_histogram | Retrieve a value histogram for a given AR transaction-detail name
+*UltracartClient::OrderApi* | [**get_accounts_receivable_gateway_detail_names**](docs/OrderApi.md#get_accounts_receivable_gateway_detail_names) | **GET** /order/accounts_receivable/gateway_detail_names | Retrieve gateway / detail-name picker data for the AR filter modal
 *UltracartClient::OrderApi* | [**get_accounts_receivable_retry_config**](docs/OrderApi.md#get_accounts_receivable_retry_config) | **GET** /order/accountsReceivableRetryConfig | Retrieve A/R Retry Configuration
 *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
@@ -1733,6 +1735,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.86 | 05/07/2026 | rest auto order api - additional item cancel request parameter for no orders after dts |
+| 4.1.85 | 05/05/2026 | improved warning object for customer insertCustomer and updateCustomer |
 | 4.1.84 | 05/04/2026 | Order API - add hold stage to allowed values on order query request |
 | 4.1.83 | 04/29/2026 | AO support for item appending on cancel request, order payment method test routing on hold release |
 | 4.1.82 | 04/27/2026 | converation - agent status and availability |

data/docs/AutoOrderItemCancelRequest.md

@@ -7,6 +7,7 @@
 | **append_items** | [**Array<AutoOrderItem>**](AutoOrderItem.md) | Specifying these items allows for an easier immutable item contact.  Validation will occur before any operations take place.  After the end/remove operation is successful, append these additional item(s) to the auto order.  The changes will be available in the response if the expansion includes items. | [optional] |
 | **auto_order_item_oid** | **Integer** | Optional tiebreaker when more than one item on the auto order shares the same original_item_id.  When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check).  Leave unset for the common case of a unique original_item_id.  For reference the order_item.item_reference_oid is the same value as auto_order_item.auto_order_item_oid UNLESS the a manual edit took place AFTER the original order was placed. | [optional] |
 | **mode** | **String** | Cancellation mode.  'end' soft-cancels the item by setting no_order_after_dts to the current time, preserving the row for reporting.  'remove' hard-deletes the item from the auto order.  Defaults to 'end' (the less destructive option) when omitted. | [optional] |
+| **no_orders_after_dts** | **String** | Date/time that will be used in an END mode (optional) | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'ultracart_api'
 instance = UltracartClient::AutoOrderItemCancelRequest.new(
   append_items: null,
   auto_order_item_oid: null,
-  mode: null
+  mode: null,
+  no_orders_after_dts: null
 )
 ```
 

data/docs/OrderApi.md

@@ -15,6 +15,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**generate_order_token**](OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id |
 | [**generate_packing_slip_all_dc**](OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers. |
 | [**generate_packing_slip_specific_dc**](OrderApi.md#generate_packing_slip_specific_dc) | **GET** /order/orders/{order_id}/packing_slip/{distribution_center_code} | Generate a packing slip for this order for the given distribution center. |
+| [**get_accounts_receivable_detail_value_histogram**](OrderApi.md#get_accounts_receivable_detail_value_histogram) | **GET** /order/accounts_receivable/detail_value_histogram | Retrieve a value histogram for a given AR transaction-detail name |
+| [**get_accounts_receivable_gateway_detail_names**](OrderApi.md#get_accounts_receivable_gateway_detail_names) | **GET** /order/accounts_receivable/gateway_detail_names | Retrieve gateway / detail-name picker data for the AR filter modal |
 | [**get_accounts_receivable_retry_config**](OrderApi.md#get_accounts_receivable_retry_config) | **GET** /order/accountsReceivableRetryConfig | Retrieve A/R Retry Configuration |
 | [**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 |
@@ -860,6 +862,111 @@ end
 - **Accept**: application/json
 
 
+## get_accounts_receivable_detail_value_histogram
+
+> get_accounts_receivable_detail_value_histogram(detail, opts)
+
+Retrieve a value histogram for a given AR transaction-detail name
+
+For the calling merchant's Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal's autocomplete on the detail-value input. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_accounts_receivable_detail_value_histogram_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> get_accounts_receivable_detail_value_histogram_with_http_info(detail, opts)
+
+```ruby
+begin
+  # Retrieve a value histogram for a given AR transaction-detail name
+  data, status_code, headers = api_instance.get_accounts_receivable_detail_value_histogram_with_http_info(detail, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling OrderApi->get_accounts_receivable_detail_value_histogram_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **detail** | **String** | The transaction-detail name to histogram. |  |
+| **gateway** | **String** | The gateway name to scope to (optional). | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_accounts_receivable_gateway_detail_names
+
+> get_accounts_receivable_gateway_detail_names
+
+Retrieve gateway / detail-name picker data for the AR filter modal
+
+For the calling merchant's Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_accounts_receivable_gateway_detail_names_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> get_accounts_receivable_gateway_detail_names_with_http_info
+
+```ruby
+begin
+  # Retrieve gateway / detail-name picker data for the AR filter modal
+  data, status_code, headers = api_instance.get_accounts_receivable_gateway_detail_names_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling OrderApi->get_accounts_receivable_gateway_detail_names_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_accounts_receivable_retry_config
 
 > <AccountsReceivableRetryConfigResponse> get_accounts_receivable_retry_config

data/docs/Warning.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **more_info** | **String** | Additional information often a link to additional documentation | [optional] |
+| **warning_code** | **String** | A stable machine-readable code identifying the warning. See API docs for known values. | [optional] |
 | **warning_message** | **String** | A technical message meant to be read by a developer | [optional] |
 
 ## Example
@@ -14,6 +15,7 @@ require 'ultracart_api'
 
 instance = UltracartClient::Warning.new(
   more_info: null,
+  warning_code: null,
   warning_message: null
 )
 ```

data/lib/ultracart_api/api/order_api.rb

@@ -785,6 +785,132 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Retrieve a value histogram for a given AR transaction-detail name
+    # For the calling merchant's Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal's autocomplete on the detail-value input. 
+    # @param detail [String] The transaction-detail name to histogram.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :gateway The gateway name to scope to (optional).
+    # @return [nil]
+    def get_accounts_receivable_detail_value_histogram(detail, opts = {})
+      get_accounts_receivable_detail_value_histogram_with_http_info(detail, opts)
+      nil
+    end
+
+    # Retrieve a value histogram for a given AR transaction-detail name
+    # For the calling merchant's Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal's autocomplete on the detail-value input. 
+    # @param detail [String] The transaction-detail name to histogram.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :gateway The gateway name to scope to (optional).
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_accounts_receivable_detail_value_histogram_with_http_info(detail, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.get_accounts_receivable_detail_value_histogram ...'
+      end
+      # verify the required parameter 'detail' is set
+      if @api_client.config.client_side_validation && detail.nil?
+        fail ArgumentError, "Missing the required parameter 'detail' when calling OrderApi.get_accounts_receivable_detail_value_histogram"
+      end
+      # resource path
+      local_var_path = '/order/accounts_receivable/detail_value_histogram'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'detail'] = detail
+      query_params[:'gateway'] = opts[:'gateway'] if !opts[:'gateway'].nil?
+
+      # 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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.get_accounts_receivable_detail_value_histogram",
+        :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_accounts_receivable_detail_value_histogram\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve gateway / detail-name picker data for the AR filter modal
+    # For the calling merchant's Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal. 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_accounts_receivable_gateway_detail_names(opts = {})
+      get_accounts_receivable_gateway_detail_names_with_http_info(opts)
+      nil
+    end
+
+    # Retrieve gateway / detail-name picker data for the AR filter modal
+    # For the calling merchant&#39;s Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_accounts_receivable_gateway_detail_names_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.get_accounts_receivable_gateway_detail_names ...'
+      end
+      # resource path
+      local_var_path = '/order/accounts_receivable/gateway_detail_names'
+
+      # 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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.get_accounts_receivable_gateway_detail_names",
+        :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_accounts_receivable_gateway_detail_names\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve A/R Retry Configuration
     # Retrieve A/R Retry Configuration. This is primarily an internal API call.  It is doubtful you would ever need to use it. 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/auto_order_item_cancel_request.rb

@@ -24,6 +24,9 @@ module UltracartClient
     # Cancellation mode.  'end' soft-cancels the item by setting no_order_after_dts to the current time, preserving the row for reporting.  'remove' hard-deletes the item from the auto order.  Defaults to 'end' (the less destructive option) when omitted.
     attr_accessor :mode
 
+    # Date/time that will be used in an END mode (optional)
+    attr_accessor :no_orders_after_dts
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -51,7 +54,8 @@ module UltracartClient
       {
         :'append_items' => :'append_items',
         :'auto_order_item_oid' => :'auto_order_item_oid',
-        :'mode' => :'mode'
+        :'mode' => :'mode',
+        :'no_orders_after_dts' => :'no_orders_after_dts'
       }
     end
 
@@ -65,7 +69,8 @@ module UltracartClient
       {
         :'append_items' => :'Array<AutoOrderItem>',
         :'auto_order_item_oid' => :'Integer',
-        :'mode' => :'String'
+        :'mode' => :'String',
+        :'no_orders_after_dts' => :'String'
       }
     end
 
@@ -103,6 +108,10 @@ module UltracartClient
       if attributes.key?(:'mode')
         self.mode = attributes[:'mode']
       end
+
+      if attributes.key?(:'no_orders_after_dts')
+        self.no_orders_after_dts = attributes[:'no_orders_after_dts']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -137,7 +146,8 @@ module UltracartClient
       self.class == o.class &&
           append_items == o.append_items &&
           auto_order_item_oid == o.auto_order_item_oid &&
-          mode == o.mode
+          mode == o.mode &&
+          no_orders_after_dts == o.no_orders_after_dts
     end
 
     # @see the `==` method
@@ -149,7 +159,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [append_items, auto_order_item_oid, mode].hash
+      [append_items, auto_order_item_oid, mode, no_orders_after_dts].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/warning.rb

@@ -18,6 +18,9 @@ module UltracartClient
     # Additional information often a link to additional documentation
     attr_accessor :more_info
 
+    # A stable machine-readable code identifying the warning. See API docs for known values.
+    attr_accessor :warning_code
+
     # A technical message meant to be read by a developer
     attr_accessor :warning_message
 
@@ -25,6 +28,7 @@ module UltracartClient
     def self.attribute_map
       {
         :'more_info' => :'more_info',
+        :'warning_code' => :'warning_code',
         :'warning_message' => :'warning_message'
       }
     end
@@ -38,6 +42,7 @@ module UltracartClient
     def self.openapi_types
       {
         :'more_info' => :'String',
+        :'warning_code' => :'String',
         :'warning_message' => :'String'
       }
     end
@@ -67,6 +72,10 @@ module UltracartClient
         self.more_info = attributes[:'more_info']
       end
 
+      if attributes.key?(:'warning_code')
+        self.warning_code = attributes[:'warning_code']
+      end
+
       if attributes.key?(:'warning_message')
         self.warning_message = attributes[:'warning_message']
       end
@@ -91,6 +100,7 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           more_info == o.more_info &&
+          warning_code == o.warning_code &&
           warning_message == o.warning_message
     end
 
@@ -103,7 +113,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [more_info, warning_message].hash
+      [more_info, warning_code, warning_message].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.84'
+  VERSION = '4.1.86'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.84
+  version: 4.1.86
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-04 00:00:00.000000000 Z
+date: 2026-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus