ultracart_api 4.0.169 → 4.0.170

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41df96fb972e8f73e2f7ef46f74a761ce41ed0e01275f834ae726ba94c583d9c
-  data.tar.gz: b9e653a4f7ff4fb8673ffcf4fbe6b8b13effb00dd01e81dd4a3380c93e92182b
+  metadata.gz: 76a33947e5bbde6082f7f06278ba13a5c6b416a87cd3f7911fd110cef96c4de2
+  data.tar.gz: 631b119358cbfa47dec4a36c3081b6c9d83c5cfe06d2361f3984b62356bd42c4
 SHA512:
-  metadata.gz: 3f2a2b7511a9e29ec22cc87f69a07a949760d6e359dd24c47565654f170931031944b42472b209c1e6f19a6bf49f7b08725e4774ac54b56dfe89d387fdb482e0
-  data.tar.gz: 0fbf5b489ac0b8252e820fca40719e0f473bc5c3093facb3660d28b57027e169070201f54223b793c6d431bf0ea301fe7a67cc74fcdcc17927ed4f58bdaeb3ab
+  metadata.gz: 8ea3e533397ec735346bceac15c6af08b983a83e3d3b72c8b3a8a3efdd058f0e6f740312af66ec06756a8b590d7bef7089a275dd3c1731ada5abf0f7635c867f
+  data.tar.gz: 89f0cff54845504a25c4a8898897abab5725feb5a0f18edd05d79b7741a1f048f3e99672610f4316d0a7106a7e9c8adfe7c47f596c4c81e6f57bba72eaf92228

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.169
+- Package version: 4.0.170
 - 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.169.gem
+gem install ./ultracart_api-4.0.170.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.169.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.170.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.169'
+    gem 'ultracart_api', '~> 4.0.170'
 
 ### Install from Git
 
@@ -289,6 +289,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::OrderApi* | [**resend_shipment_confirmation**](docs/OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
 *UltracartClient::OrderApi* | [**update_accounts_receivable_retry_config**](docs/OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
 *UltracartClient::OrderApi* | [**update_order**](docs/OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order
+*UltracartClient::OrderApi* | [**validate_order**](docs/OrderApi.md#validate_order) | **POST** /order/validate | Validate
 *UltracartClient::SsoApi* | [**get_sso_session_user**](docs/SsoApi.md#get_sso_session_user) | **GET** /sso/session/user | Get single sign on session user
 *UltracartClient::SsoApi* | [**sso_authorize**](docs/SsoApi.md#sso_authorize) | **PUT** /sso/authorize | Authorize a single sign on session
 *UltracartClient::SsoApi* | [**sso_session_revoke**](docs/SsoApi.md#sso_session_revoke) | **DELETE** /sso/session/revoke | Revoke single sign on session
@@ -1134,6 +1135,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::OrderTrackingNumberDetails](docs/OrderTrackingNumberDetails.md)
  - [UltracartClient::OrderTransactionalMerchantNote](docs/OrderTransactionalMerchantNote.md)
  - [UltracartClient::OrderUtm](docs/OrderUtm.md)
+ - [UltracartClient::OrderValidationRequest](docs/OrderValidationRequest.md)
+ - [UltracartClient::OrderValidationResponse](docs/OrderValidationResponse.md)
  - [UltracartClient::OrdersResponse](docs/OrdersResponse.md)
  - [UltracartClient::Permission](docs/Permission.md)
  - [UltracartClient::PointOfSaleLocation](docs/PointOfSaleLocation.md)
@@ -1365,6 +1368,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.170 | 08/14/2023 | esp - expose rate limiter values in settings object |
 | 4.0.169 | 07/27/2023 | dw bi - add settings to the report and page objects |
 | 4.0.168 | 07/19/2023 | dw bi - add data_source_uuid to filter connection obj |
 | 4.0.167 | 07/19/2023 | dw bi - add data_source_uuid to page visualization obj |

data/docs/EmailSettings.md

@@ -4,6 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **emails_per_day** | **Integer** | Emails per day allowed | [optional] |
+| **emails_per_hour** | **Integer** | Emails per hour allowed | [optional] |
+| **emails_per_month** | **Integer** | Emails per month allowed | [optional] |
 | **marketing_esp_domain_user** | **String** |  | [optional] |
 | **marketing_esp_domain_uuid** | **String** |  | [optional] |
 | **marketing_esp_friendly_name** | **String** |  | [optional] |
@@ -26,6 +29,9 @@
 require 'ultracart_api'
 
 instance = UltracartClient::EmailSettings.new(
+  emails_per_day: null,
+  emails_per_hour: null,
+  emails_per_month: null,
   marketing_esp_domain_user: null,
   marketing_esp_domain_uuid: null,
   marketing_esp_friendly_name: null,

data/docs/OrderApi.md

@@ -30,6 +30,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**resend_shipment_confirmation**](OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation |
 | [**update_accounts_receivable_retry_config**](OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration |
 | [**update_order**](OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order |
+| [**validate_order**](OrderApi.md#validate_order) | **POST** /order/validate | Validate |
 
 
 ## adjust_order_total
@@ -2009,3 +2010,74 @@ end
 - **Content-Type**: application/json; charset=UTF-8
 - **Accept**: application/json
 
+
+## validate_order
+
+> <OrderValidationResponse> validate_order(validation_request)
+
+Validate
+
+Validate the order for errors.  Specific checks can be passed to fine tune what is validated. Read and write permissions are required because the validate method may fix obvious address issues automatically which require update permission.This rest call makes use of the built-in translation of rest objects to UltraCart internal objects which also contains a multitude of validation checks that cannot be trapped.  Therefore any time this call is made, you should also trap api exceptions and examine their content because it may contain validation issues.  So check the response object and trap any exceptions. 
+
+### 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)
+validation_request = UltracartClient::OrderValidationRequest.new # OrderValidationRequest | Validation request
+
+begin
+  # Validate
+  result = api_instance.validate_order(validation_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling OrderApi->validate_order: #{e}"
+end
+```
+
+#### Using the validate_order_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrderValidationResponse>, Integer, Hash)> validate_order_with_http_info(validation_request)
+
+```ruby
+begin
+  # Validate
+  data, status_code, headers = api_instance.validate_order_with_http_info(validation_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrderValidationResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling OrderApi->validate_order_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **validation_request** | [**OrderValidationRequest**](OrderValidationRequest.md) | Validation request |  |
+
+### Return type
+
+[**OrderValidationResponse**](OrderValidationResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/OrderValidationRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::OrderValidationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **checks** | **Array<String>** | Checks to perform | [optional] |
+| **order** | [**Order**](Order.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::OrderValidationRequest.new(
+  checks: null,
+  order: null
+)
+```
+

data/docs/OrderValidationResponse.md

@@ -0,0 +1,22 @@
+# UltracartClient::OrderValidationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | **Array<String>** | Errors to display to the merchant if they failed any of the validations checked | [optional] |
+| **messages** | **Array<String>** | Informational messages | [optional] |
+| **order_was_updated** | **Boolean** | If true, this order was updated during the validation call.  This may happen during address standardization fixes. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::OrderValidationResponse.new(
+  errors: null,
+  messages: null,
+  order_was_updated: null
+)
+```
+

data/lib/ultracart_api/api/order_api.rb

@@ -1925,5 +1925,74 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+
+    # Validate
+    # Validate the order for errors.  Specific checks can be passed to fine tune what is validated. Read and write permissions are required because the validate method may fix obvious address issues automatically which require update permission.This rest call makes use of the built-in translation of rest objects to UltraCart internal objects which also contains a multitude of validation checks that cannot be trapped.  Therefore any time this call is made, you should also trap api exceptions and examine their content because it may contain validation issues.  So check the response object and trap any exceptions. 
+    # @param validation_request [OrderValidationRequest] Validation request
+    # @param [Hash] opts the optional parameters
+    # @return [OrderValidationResponse]
+    def validate_order(validation_request, opts = {})
+      data, _status_code, _headers = validate_order_with_http_info(validation_request, opts)
+      data
+    end
+
+    # Validate
+    # Validate the order for errors.  Specific checks can be passed to fine tune what is validated. Read and write permissions are required because the validate method may fix obvious address issues automatically which require update permission.This rest call makes use of the built-in translation of rest objects to UltraCart internal objects which also contains a multitude of validation checks that cannot be trapped.  Therefore any time this call is made, you should also trap api exceptions and examine their content because it may contain validation issues.  So check the response object and trap any exceptions. 
+    # @param validation_request [OrderValidationRequest] Validation request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderValidationResponse, Integer, Hash)>] OrderValidationResponse data, response status code and response headers
+    def validate_order_with_http_info(validation_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.validate_order ...'
+      end
+      # verify the required parameter 'validation_request' is set
+      if @api_client.config.client_side_validation && validation_request.nil?
+        fail ArgumentError, "Missing the required parameter 'validation_request' when calling OrderApi.validate_order"
+      end
+      # resource path
+      local_var_path = '/order/validate'
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(validation_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrderValidationResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.validate_order",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrderApi#validate_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/ultracart_api/models/email_settings.rb

@@ -15,6 +15,15 @@ require 'time'
 
 module UltracartClient
   class EmailSettings
+    # Emails per day allowed
+    attr_accessor :emails_per_day
+
+    # Emails per hour allowed
+    attr_accessor :emails_per_hour
+
+    # Emails per month allowed
+    attr_accessor :emails_per_month
+
     attr_accessor :marketing_esp_domain_user
 
     attr_accessor :marketing_esp_domain_uuid
@@ -49,6 +58,9 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'emails_per_day' => :'emails_per_day',
+        :'emails_per_hour' => :'emails_per_hour',
+        :'emails_per_month' => :'emails_per_month',
         :'marketing_esp_domain_user' => :'marketing_esp_domain_user',
         :'marketing_esp_domain_uuid' => :'marketing_esp_domain_uuid',
         :'marketing_esp_friendly_name' => :'marketing_esp_friendly_name',
@@ -75,6 +87,9 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'emails_per_day' => :'Integer',
+        :'emails_per_hour' => :'Integer',
+        :'emails_per_month' => :'Integer',
         :'marketing_esp_domain_user' => :'String',
         :'marketing_esp_domain_uuid' => :'String',
         :'marketing_esp_friendly_name' => :'String',
@@ -114,6 +129,18 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'emails_per_day')
+        self.emails_per_day = attributes[:'emails_per_day']
+      end
+
+      if attributes.key?(:'emails_per_hour')
+        self.emails_per_hour = attributes[:'emails_per_hour']
+      end
+
+      if attributes.key?(:'emails_per_month')
+        self.emails_per_month = attributes[:'emails_per_month']
+      end
+
       if attributes.key?(:'marketing_esp_domain_user')
         self.marketing_esp_domain_user = attributes[:'marketing_esp_domain_user']
       end
@@ -193,6 +220,9 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          emails_per_day == o.emails_per_day &&
+          emails_per_hour == o.emails_per_hour &&
+          emails_per_month == o.emails_per_month &&
           marketing_esp_domain_user == o.marketing_esp_domain_user &&
           marketing_esp_domain_uuid == o.marketing_esp_domain_uuid &&
           marketing_esp_friendly_name == o.marketing_esp_friendly_name &&
@@ -219,7 +249,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [marketing_esp_domain_user, marketing_esp_domain_uuid, marketing_esp_friendly_name, postcard_from_address1, postcard_from_address2, postcard_from_city, postcard_from_name, postcard_from_postal_code, postcard_from_state, reviews_io_configured, sms_esp_twilio_uuid, sms_phone_number, transactional_esp_domain_user, transactional_esp_domain_uuid, transactional_esp_friendly_name].hash
+      [emails_per_day, emails_per_hour, emails_per_month, marketing_esp_domain_user, marketing_esp_domain_uuid, marketing_esp_friendly_name, postcard_from_address1, postcard_from_address2, postcard_from_city, postcard_from_name, postcard_from_postal_code, postcard_from_state, reviews_io_configured, sms_esp_twilio_uuid, sms_phone_number, transactional_esp_domain_user, transactional_esp_domain_uuid, transactional_esp_friendly_name].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_validation_request.rb

@@ -0,0 +1,231 @@
+=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 OrderValidationRequest
+    # Checks to perform
+    attr_accessor :checks
+
+    attr_accessor :order
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'checks' => :'checks',
+        :'order' => :'order'
+      }
+    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
+      {
+        :'checks' => :'Array<String>',
+        :'order' => :'Order'
+      }
+    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::OrderValidationRequest` 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::OrderValidationRequest`. 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?(:'checks')
+        if (value = attributes[:'checks']).is_a?(Array)
+          self.checks = value
+        end
+      end
+
+      if attributes.key?(:'order')
+        self.order = attributes[:'order']
+      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 &&
+          checks == o.checks &&
+          order == o.order
+    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
+      [checks, order].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ultracart_api/models/order_validation_response.rb

@@ -0,0 +1,244 @@
+=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 OrderValidationResponse
+    # Errors to display to the merchant if they failed any of the validations checked
+    attr_accessor :errors
+
+    # Informational messages
+    attr_accessor :messages
+
+    # If true, this order was updated during the validation call.  This may happen during address standardization fixes.
+    attr_accessor :order_was_updated
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'errors' => :'errors',
+        :'messages' => :'messages',
+        :'order_was_updated' => :'order_was_updated'
+      }
+    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
+      {
+        :'errors' => :'Array<String>',
+        :'messages' => :'Array<String>',
+        :'order_was_updated' => :'Boolean'
+      }
+    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::OrderValidationResponse` 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::OrderValidationResponse`. 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?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Array)
+          self.errors = value
+        end
+      end
+
+      if attributes.key?(:'messages')
+        if (value = attributes[:'messages']).is_a?(Array)
+          self.messages = value
+        end
+      end
+
+      if attributes.key?(:'order_was_updated')
+        self.order_was_updated = attributes[:'order_was_updated']
+      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 &&
+          errors == o.errors &&
+          messages == o.messages &&
+          order_was_updated == o.order_was_updated
+    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
+      [errors, messages, order_was_updated].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.169'
+  VERSION = '4.0.170'
 end

data/lib/ultracart_api.rb

@@ -635,6 +635,8 @@ 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/order_utm'
+require 'ultracart_api/models/order_validation_request'
+require 'ultracart_api/models/order_validation_response'
 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.169
+  version: 4.0.170
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-27 00:00:00.000000000 Z
+date: 2023-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -694,6 +694,8 @@ files:
 - docs/OrderTrackingNumberDetails.md
 - docs/OrderTransactionalMerchantNote.md
 - docs/OrderUtm.md
+- docs/OrderValidationRequest.md
+- docs/OrderValidationResponse.md
 - docs/OrdersResponse.md
 - docs/Permission.md
 - docs/PointOfSaleLocation.md
@@ -1500,6 +1502,8 @@ files:
 - lib/ultracart_api/models/order_tracking_number_details.rb
 - lib/ultracart_api/models/order_transactional_merchant_note.rb
 - lib/ultracart_api/models/order_utm.rb
+- lib/ultracart_api/models/order_validation_request.rb
+- lib/ultracart_api/models/order_validation_response.rb
 - lib/ultracart_api/models/orders_response.rb
 - lib/ultracart_api/models/permission.rb
 - lib/ultracart_api/models/point_of_sale_location.rb