ultracart_api 3.11.4 → 3.11.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0128f0e1e8a52d214a55e7669f94758183456690d6a099d365cbc3be3e36891a'
-  data.tar.gz: 184b12d5264111c222a000389dc6802011ac0a8f51a6318eb0740062b1ba7dab
+  metadata.gz: d4abdc7e5b093e8a1c637244f5dce39a273739cd77ce2a53f986745275cac407
+  data.tar.gz: ba2bdb531687551152f5d84f2c0a288ab9aab1cb1e1b9df263182530285472d4
 SHA512:
-  metadata.gz: 9ea1a2403109802b7f6c632c6ddfbeba2c8f8682437f16bdbd78945429bf23347f560c3bd1b7b54fa7d923b7571b538f8a827a0cce07e043f997a0c14f4101a4
-  data.tar.gz: 95087a8d99a51ffb8550d2a48615bac059f51c3b74ca524c7c88e286ff4e3dfaee0021edbd937c75e3e1935653336fb96163feeee0182a6e210995f95f47df48
+  metadata.gz: ac5fc4ed40a4d1b383bc372e1d25e428fc7406f3bf524da2a008ee7ba42f8af32934057c4109938fc0ee9803937c2f19d6c6d893a564a168964d15f35eb98efd
+  data.tar.gz: f8537f7bc0d77602d8cf12867f21c4155603bf6d32f221a9b608962b69d234147939dd0da2858e9cc013f160d1034ad290ddea7220b8deca3c04a06462d7cebd

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.11.4
+- Package version: 3.11.6
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.11.4.gem
+gem install ./ultracart_api-3.11.6.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.11.4.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.11.6.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.11.4'
+    gem 'ultracart_api', '~> 3.11.6'
 
 ### Install from Git
 
@@ -338,6 +338,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::OrderApi* | [**is_refundable_order**](docs/OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
 *UltracartClient::OrderApi* | [**process_payment**](docs/OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
 *UltracartClient::OrderApi* | [**refund_order**](docs/OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
+*UltracartClient::OrderApi* | [**refund_order_completely**](docs/OrderApi.md#refund_order_completely) | **PUT** /order/orders/{order_id}/refund_completely | Refund an order completely
 *UltracartClient::OrderApi* | [**replacement**](docs/OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
 *UltracartClient::OrderApi* | [**resend_receipt**](docs/OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
 *UltracartClient::OrderApi* | [**resend_shipment_confirmation**](docs/OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
@@ -700,6 +701,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ChannelPartnerOrder](docs/ChannelPartnerOrder.md)
  - [UltracartClient::ChannelPartnerOrderItem](docs/ChannelPartnerOrderItem.md)
  - [UltracartClient::ChannelPartnerOrderItemOption](docs/ChannelPartnerOrderItemOption.md)
+ - [UltracartClient::ChannelPartnerOrderItemProperty](docs/ChannelPartnerOrderItemProperty.md)
  - [UltracartClient::ChannelPartnerOrderTransaction](docs/ChannelPartnerOrderTransaction.md)
  - [UltracartClient::ChannelPartnerOrderTransactionDetail](docs/ChannelPartnerOrderTransactionDetail.md)
  - [UltracartClient::ChannelPartnerShipToPreference](docs/ChannelPartnerShipToPreference.md)
@@ -1518,6 +1520,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.6 | 04/16/2025 | added channel partner order item properties |
+| 3.11.5 | 03/28/2025 | added paypal fastlane constants for payments |
 | 3.11.4 | 03/07/2025 | updated github readme.md |
 | 3.11.3 | 03/07/2025 | updated github readme.md files |
 | 3.11.2 | 03/05/2025 | added ChannelPartnerOrder.use_prior_payment_information_from_order_id |

data/docs/ChannelPartnerOrderItem.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **auto_order_schedule** | **String** | The frequency schedule for this item if this item is part of an auto (recurring) order | [optional] 
 **merchant_item_id** | **String** | Item ID | [optional] 
 **options** | [**Array<ChannelPartnerOrderItemOption>**](ChannelPartnerOrderItemOption.md) | Item options | [optional] 
+**properties** | [**Array<ChannelPartnerOrderItemProperty>**](ChannelPartnerOrderItemProperty.md) | Properties | [optional] 
 **quantity** | **Float** | Quantity | [optional] 
 **upsell** | **BOOLEAN** | True if this item was an upsell item. | [optional] 
 

data/docs/ChannelPartnerOrderItemProperty.md

@@ -0,0 +1,11 @@
+# UltracartClient::ChannelPartnerOrderItemProperty
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display** | **BOOLEAN** | True if this property is displayed to the customer | [optional] 
+**expiration_dts** | **String** | The date/time that the property expires and is deleted | [optional] 
+**name** | **String** | Name | [optional] 
+**value** | **String** | Value | [optional] 
+
+

data/docs/OrderApi.md

@@ -25,6 +25,7 @@ Method | HTTP request | Description
 [**is_refundable_order**](OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
 [**process_payment**](OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
 [**refund_order**](OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
+[**refund_order_completely**](OrderApi.md#refund_order_completely) | **PUT** /order/orders/{order_id}/refund_completely | Refund an order completely
 [**replacement**](OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
 [**resend_receipt**](OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
 [**resend_shipment_confirmation**](OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
@@ -1210,6 +1211,76 @@ Name | Type | Description  | Notes
 
 
 
+# **refund_order_completely**
+> OrderResponse refund_order_completely(order_id, opts)
+
+Refund an order completely
+
+Perform a refund operation on an order and then update the order if successful. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
+
+
+order_id = 'order_id_example' # String | The order id to refund.
+
+opts = { 
+  reject_after_refund: false, # BOOLEAN | Reject order after refund
+  skip_customer_notification: false, # BOOLEAN | Skip customer email notification
+  auto_order_cancel: false, # BOOLEAN | Cancel associated auto orders
+  manual_refund: false, # BOOLEAN | Consider a manual refund done externally
+  reverse_affiliate_transactions: true, # BOOLEAN | Reverse affiliate transactions
+  issue_store_credit: false, # BOOLEAN | Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+  auto_order_cancel_reason: 'auto_order_cancel_reason_example', # String | Reason for auto orders cancellation
+  refund_reason: 'refund_reason_example', # String | Reason for refund
+  reject_reason: 'reject_reason_example' # String | Reason for reject
+}
+
+begin
+  #Refund an order completely
+  result = api_instance.refund_order_completely(order_id, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling OrderApi->refund_order_completely: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| The order id to refund. | 
+ **reject_after_refund** | **BOOLEAN**| Reject order after refund | [optional] [default to false]
+ **skip_customer_notification** | **BOOLEAN**| Skip customer email notification | [optional] [default to false]
+ **auto_order_cancel** | **BOOLEAN**| Cancel associated auto orders | [optional] [default to false]
+ **manual_refund** | **BOOLEAN**| Consider a manual refund done externally | [optional] [default to false]
+ **reverse_affiliate_transactions** | **BOOLEAN**| Reverse affiliate transactions | [optional] [default to true]
+ **issue_store_credit** | **BOOLEAN**| Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account | [optional] [default to false]
+ **auto_order_cancel_reason** | **String**| Reason for auto orders cancellation | [optional] 
+ **refund_reason** | **String**| Reason for refund | [optional] 
+ **reject_reason** | **String**| Reason for reject | [optional] 
+
+### Return type
+
+[**OrderResponse**](OrderResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **replacement**
 > OrderReplacementResponse replacement(order_id, replacement)
 

data/lib/ultracart_api/api/order_api.rb

@@ -1354,6 +1354,88 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Refund an order completely
+    # Perform a refund operation on an order and then update the order if successful. 
+    # @param order_id The order id to refund.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :reject_after_refund Reject order after refund (default to false)
+    # @option opts [BOOLEAN] :skip_customer_notification Skip customer email notification (default to false)
+    # @option opts [BOOLEAN] :auto_order_cancel Cancel associated auto orders (default to false)
+    # @option opts [BOOLEAN] :manual_refund Consider a manual refund done externally (default to false)
+    # @option opts [BOOLEAN] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
+    # @option opts [BOOLEAN] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account (default to false)
+    # @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
+    # @option opts [String] :refund_reason Reason for refund
+    # @option opts [String] :reject_reason Reason for reject
+    # @return [OrderResponse]
+    def refund_order_completely(order_id, opts = {})
+      data, _status_code, _headers = refund_order_completely_with_http_info(order_id, opts)
+      data
+    end
+
+    # Refund an order completely
+    # Perform a refund operation on an order and then update the order if successful. 
+    # @param order_id The order id to refund.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :reject_after_refund Reject order after refund
+    # @option opts [BOOLEAN] :skip_customer_notification Skip customer email notification
+    # @option opts [BOOLEAN] :auto_order_cancel Cancel associated auto orders
+    # @option opts [BOOLEAN] :manual_refund Consider a manual refund done externally
+    # @option opts [BOOLEAN] :reverse_affiliate_transactions Reverse affiliate transactions
+    # @option opts [BOOLEAN] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+    # @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
+    # @option opts [String] :refund_reason Reason for refund
+    # @option opts [String] :reject_reason Reason for reject
+    # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
+    def refund_order_completely_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.refund_order_completely ...'
+      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.refund_order_completely"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/refund_completely'.sub('{' + 'order_id' + '}', order_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'reject_after_refund'] = opts[:'reject_after_refund'] if !opts[:'reject_after_refund'].nil?
+      query_params[:'skip_customer_notification'] = opts[:'skip_customer_notification'] if !opts[:'skip_customer_notification'].nil?
+      query_params[:'auto_order_cancel'] = opts[:'auto_order_cancel'] if !opts[:'auto_order_cancel'].nil?
+      query_params[:'manual_refund'] = opts[:'manual_refund'] if !opts[:'manual_refund'].nil?
+      query_params[:'reverse_affiliate_transactions'] = opts[:'reverse_affiliate_transactions'] if !opts[:'reverse_affiliate_transactions'].nil?
+      query_params[:'issue_store_credit'] = opts[:'issue_store_credit'] if !opts[:'issue_store_credit'].nil?
+      query_params[:'auto_order_cancel_reason'] = opts[:'auto_order_cancel_reason'] if !opts[:'auto_order_cancel_reason'].nil?
+      query_params[:'refund_reason'] = opts[:'refund_reason'] if !opts[:'refund_reason'].nil?
+      query_params[:'reject_reason'] = opts[:'reject_reason'] if !opts[:'reject_reason'].nil?
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'OrderResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrderApi#refund_order_completely\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Replacement order
     # Create a replacement order based upon a previous order 
     # @param order_id The order id to generate a replacement for.

data/lib/ultracart_api/models/channel_partner_order.rb

@@ -1084,7 +1084,7 @@ module UltracartClient
       return false if !@email.nil? && @email.to_s.length > 100
       return false if !@gift_email.nil? && @gift_email.to_s.length > 100
       return false if !@gift_message.nil? && @gift_message.to_s.length > 10000
-      payment_method_validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Check', 'COD', 'Credit Card', 'eCheck', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Wire Transfer'])
+      payment_method_validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Check', 'COD', 'Credit Card', 'eCheck', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Wire Transfer', 'PayPal Fastlane'])
       return false unless payment_method_validator.valid?(@payment_method)
       return false if !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
       return false if !@shipto_address1.nil? && @shipto_address1.to_s.length > 50
@@ -1356,7 +1356,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] payment_method Object to be assigned
     def payment_method=(payment_method)
-      validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Check', 'COD', 'Credit Card', 'eCheck', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Wire Transfer'])
+      validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Check', 'COD', 'Credit Card', 'eCheck', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Wire Transfer', 'PayPal Fastlane'])
       unless validator.valid?(payment_method)
         fail ArgumentError, 'invalid value for "payment_method", must be one of #{validator.allowable_values}.'
       end

data/lib/ultracart_api/models/channel_partner_order_item.rb

@@ -29,6 +29,9 @@ module UltracartClient
     # Item options
     attr_accessor :options
 
+    # Properties
+    attr_accessor :properties
+
     # Quantity
     attr_accessor :quantity
 
@@ -65,6 +68,7 @@ module UltracartClient
         :'auto_order_schedule' => :'auto_order_schedule',
         :'merchant_item_id' => :'merchant_item_id',
         :'options' => :'options',
+        :'properties' => :'properties',
         :'quantity' => :'quantity',
         :'upsell' => :'upsell'
       }
@@ -78,6 +82,7 @@ module UltracartClient
         :'auto_order_schedule' => :'String',
         :'merchant_item_id' => :'String',
         :'options' => :'Array<ChannelPartnerOrderItemOption>',
+        :'properties' => :'Array<ChannelPartnerOrderItemProperty>',
         :'quantity' => :'Float',
         :'upsell' => :'BOOLEAN'
       }
@@ -113,6 +118,12 @@ module UltracartClient
         end
       end
 
+      if attributes.has_key?(:'properties')
+        if (value = attributes[:'properties']).is_a?(Array)
+          self.properties = value
+        end
+      end
+
       if attributes.has_key?(:'quantity')
         self.quantity = attributes[:'quantity']
       end
@@ -172,6 +183,7 @@ module UltracartClient
           auto_order_schedule == o.auto_order_schedule &&
           merchant_item_id == o.merchant_item_id &&
           options == o.options &&
+          properties == o.properties &&
           quantity == o.quantity &&
           upsell == o.upsell
     end
@@ -185,7 +197,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, merchant_item_id, options, quantity, upsell].hash
+      [arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, merchant_item_id, options, properties, quantity, upsell].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/channel_partner_order_item_property.rb

@@ -0,0 +1,245 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class ChannelPartnerOrderItemProperty
+    # True if this property is displayed to the customer
+    attr_accessor :display
+
+    # The date/time that the property expires and is deleted
+    attr_accessor :expiration_dts
+
+    # Name
+    attr_accessor :name
+
+    # Value
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'display' => :'display',
+        :'expiration_dts' => :'expiration_dts',
+        :'name' => :'name',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'display' => :'BOOLEAN',
+        :'expiration_dts' => :'String',
+        :'name' => :'String',
+        :'value' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'display')
+        self.display = attributes[:'display']
+      end
+
+      if attributes.has_key?(:'expiration_dts')
+        self.expiration_dts = attributes[:'expiration_dts']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'value')
+        self.value = attributes[:'value']
+      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
+      if !@name.nil? && @name.to_s.length > 100
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@value.nil? && @value.to_s.length > 3800
+        invalid_properties.push('invalid value for "value", the character length must be smaller than or equal to 3800.')
+      end
+
+      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?
+      return false if !@name.nil? && @name.to_s.length > 100
+      return false if !@value.nil? && @value.to_s.length > 3800
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] value Value to be assigned
+    def value=(value)
+      if !value.nil? && value.to_s.length > 3800
+        fail ArgumentError, 'invalid value for "value", the character length must be smaller than or equal to 3800.'
+      end
+
+      @value = value
+    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 &&
+          display == o.display &&
+          expiration_dts == o.expiration_dts &&
+          name == o.name &&
+          value == o.value
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [display, expiration_dts, name, value].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/models/order_payment.rb

@@ -241,7 +241,7 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      payment_method_validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon Pay', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eBay', 'eCheck', 'Google Shopping', 'Insurance', 'Link', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Walmart', 'Shop.com', 'Sezzle', 'Venmo', 'Apple Pay', 'Google Pay', 'Health Benefit Card'])
+      payment_method_validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon Pay', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eBay', 'eCheck', 'Google Shopping', 'Insurance', 'Link', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Walmart', 'Shop.com', 'Sezzle', 'Venmo', 'Apple Pay', 'Google Pay', 'Health Benefit Card', 'PayPal Fastlane'])
       return false unless payment_method_validator.valid?(@payment_method)
       payment_status_validator = EnumAttributeValidator.new('String', ['Unprocessed', 'Authorized', 'Capture Failed', 'Processed', 'Declined', 'Voided', 'Refunded', 'Skipped'])
       return false unless payment_status_validator.valid?(@payment_status)
@@ -251,7 +251,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] payment_method Object to be assigned
     def payment_method=(payment_method)
-      validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon Pay', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eBay', 'eCheck', 'Google Shopping', 'Insurance', 'Link', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Walmart', 'Shop.com', 'Sezzle', 'Venmo', 'Apple Pay', 'Google Pay', 'Health Benefit Card'])
+      validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon Pay', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eBay', 'eCheck', 'Google Shopping', 'Insurance', 'Link', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Walmart', 'Shop.com', 'Sezzle', 'Venmo', 'Apple Pay', 'Google Pay', 'Health Benefit Card', 'PayPal Fastlane'])
       unless validator.valid?(payment_method)
         fail ArgumentError, 'invalid value for "payment_method", must be one of #{validator.allowable_values}.'
       end

data/lib/ultracart_api/models/order_query.rb

@@ -511,7 +511,7 @@ module UltracartClient
       return false if !@email.nil? && @email.to_s.length > 100
       return false if !@first_name.nil? && @first_name.to_s.length > 30
       return false if !@last_name.nil? && @last_name.to_s.length > 30
-      payment_method_validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eCheck', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Venmo', 'Apple Pay', ' Google Pay'])
+      payment_method_validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eCheck', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Venmo', 'Apple Pay', ' Google Pay', 'PayPal Fastlane'])
       return false unless payment_method_validator.valid?(@payment_method)
       return false if !@phone.nil? && @phone.to_s.length > 25
       return false if !@postal_code.nil? && @postal_code.to_s.length > 20
@@ -606,7 +606,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] payment_method Object to be assigned
     def payment_method=(payment_method)
-      validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eCheck', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Venmo', 'Apple Pay', ' Google Pay'])
+      validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eCheck', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Venmo', 'Apple Pay', ' Google Pay', 'PayPal Fastlane'])
       unless validator.valid?(payment_method)
         fail ArgumentError, 'invalid value for "payment_method", must be one of #{validator.allowable_values}.'
       end

data/lib/ultracart_api/version.rb

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

data/lib/ultracart_api.rb

@@ -128,6 +128,7 @@ require 'ultracart_api/models/channel_partner_import_response'
 require 'ultracart_api/models/channel_partner_order'
 require 'ultracart_api/models/channel_partner_order_item'
 require 'ultracart_api/models/channel_partner_order_item_option'
+require 'ultracart_api/models/channel_partner_order_item_property'
 require 'ultracart_api/models/channel_partner_order_transaction'
 require 'ultracart_api/models/channel_partner_order_transaction_detail'
 require 'ultracart_api/models/channel_partner_ship_to_preference'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.11.4
+  version: 3.11.6
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-07 00:00:00.000000000 Z
+date: 2025-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -335,6 +335,7 @@ files:
 - docs/ChannelPartnerOrder.md
 - docs/ChannelPartnerOrderItem.md
 - docs/ChannelPartnerOrderItemOption.md
+- docs/ChannelPartnerOrderItemProperty.md
 - docs/ChannelPartnerOrderTransaction.md
 - docs/ChannelPartnerOrderTransactionDetail.md
 - docs/ChannelPartnerShipToPreference.md
@@ -1236,6 +1237,7 @@ files:
 - lib/ultracart_api/models/channel_partner_order.rb
 - lib/ultracart_api/models/channel_partner_order_item.rb
 - lib/ultracart_api/models/channel_partner_order_item_option.rb
+- lib/ultracart_api/models/channel_partner_order_item_property.rb
 - lib/ultracart_api/models/channel_partner_order_transaction.rb
 - lib/ultracart_api/models/channel_partner_order_transaction_detail.rb
 - lib/ultracart_api/models/channel_partner_ship_to_preference.rb