ultracart_api 4.0.240 → 4.0.241

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7055287bb92af14ebdac856bfb87c93d98a966210c215a4fb086709978b2097
-  data.tar.gz: 0d5b4e3f35092ab78c2232cf0af2daa554ee5e9aac0e8e5aa906cdef1408cded
+  metadata.gz: 7bd728cffe0756062860c32b59d2c27fc8bc8e0e168ad83c352af07503299a57
+  data.tar.gz: e2f1a97b285f756bbc878a77038b6fe495d177316974dad8d68897bc5432f27d
 SHA512:
-  metadata.gz: 9b2154411d3b54a8614d3d5d6cc5b2df34d4d7ac18b3b6bb69a0533595b685a93f80940619c947a1eab311f466b51f03c0f118f70c44ed3581063b186cad8f92
-  data.tar.gz: 3c05b656603ba51354816fc5e263fd59641dcd8341c72909aa3a3a1a9e5a48d623d8ee65cc15462e2a5b3f84af3d2a522f7018bae75df44ed10e5854d28d7cae
+  metadata.gz: 6c71747f764534df88e9537a6e2fbb841d335991978355fa699d74a6cadc4ffbce0d860257b604a9c57eeb10931a9c06c209f2d7e6d5fbf9439c1faf8c23bf37
+  data.tar.gz: 425748a8c96690e4d14b11243daf704348a54260efbafe8ada682d01cc28a7c23b2727ccfd0a047405db1f9b6ca1c13988b62499109a01fb891026cfea1f29b3

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.240
+- Package version: 4.0.241
 - 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.240.gem
+gem install ./ultracart_api-4.0.241.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.240.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.241.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.240'
+    gem 'ultracart_api', '~> 4.0.241'
 
 ### Install from Git
 
@@ -1211,6 +1211,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::OrderChannelPartner](docs/OrderChannelPartner.md)
  - [UltracartClient::OrderCheckout](docs/OrderCheckout.md)
  - [UltracartClient::OrderCoupon](docs/OrderCoupon.md)
+ - [UltracartClient::OrderCurrentStageHistory](docs/OrderCurrentStageHistory.md)
  - [UltracartClient::OrderDigitalItem](docs/OrderDigitalItem.md)
  - [UltracartClient::OrderDigitalOrder](docs/OrderDigitalOrder.md)
  - [UltracartClient::OrderEdi](docs/OrderEdi.md)
@@ -1523,6 +1524,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.241 | 02/06/2025 | added storefront_host_name to channel partner order object |
 | 4.0.240 | 01/09/2025 | fix for broken 4.0.39 due to incorrect query sig on getCustomers |
 | 4.0.239 | 01/09/2025 | added emails parameter to customer queries, refundOrder added to Channel partner |
 | 4.0.238 | 12/13/2024 | added user and group ids to conversation agent auth object |

data/docs/ChannelPartnerOrder.md

@@ -91,6 +91,7 @@
 | **special_instructions** | **String** | Special instructions from the customer regarding shipping | [optional] |
 | **store_completed** | **Boolean** | If true the order bypasses shipping and is marked completed | [optional] |
 | **store_if_payment_declines** | **Boolean** | If true any failed payments are placed into Accounts Receivable.  If false any failed payments result in a rejected order resulting in errors thrown during the insert routine | [optional] |
+| **storefront_host_name** | **String** | StoreFront host name associated with the order | [optional] |
 | **tax_county** | **String** | The optional shipping county used to determine exact taxes | [optional] |
 | **tax_exempt** | **Boolean** | If true this order is marked as being tax exempt | [optional] |
 | **transaction** | [**ChannelPartnerOrderTransaction**](ChannelPartnerOrderTransaction.md) |  | [optional] |
@@ -189,6 +190,7 @@ instance = UltracartClient::ChannelPartnerOrder.new(
   special_instructions: null,
   store_completed: null,
   store_if_payment_declines: null,
+  storefront_host_name: null,
   tax_county: null,
   tax_exempt: null,
   transaction: null,

data/docs/CustomerAttachment.md

@@ -7,7 +7,7 @@
 | **customer_profile_attachment_oid** | **Integer** | Attachment identifier | [optional] |
 | **description** | **String** | Description | [optional] |
 | **file_name** | **String** | File name | [optional] |
-| **mime_type** | **String** | Mime typoe | [optional] |
+| **mime_type** | **String** | Mime type | [optional] |
 | **upload_dts** | **String** | Upload date/time | [optional] |
 
 ## Example

data/docs/ItemReview.md

@@ -8,6 +8,7 @@
 | **featured** | **Boolean** |  | [optional] |
 | **helperful_no_votes** | **Integer** |  | [optional] |
 | **helpful_yes_votes** | **Integer** |  | [optional] |
+| **merchant_reply** | **String** | Merchant Reply (set to an empty string to remove) | [optional] |
 | **order_id** | **String** |  | [optional] |
 | **overall** | **Float** |  | [optional] |
 | **rating_name1** | **String** | Rating Name 1 | [optional] |
@@ -52,6 +53,7 @@ instance = UltracartClient::ItemReview.new(
   featured: null,
   helperful_no_votes: null,
   helpful_yes_votes: null,
+  merchant_reply: null,
   order_id: null,
   overall: null,
   rating_name1: null,

data/docs/Order.md

@@ -14,6 +14,7 @@
 | **creation_dts** | **String** | Date/time that the order was created | [optional] |
 | **currency_code** | **String** | Currency code that the customer used if different than the merchant's base currency code | [optional] |
 | **current_stage** | **String** | Current stage that the order is in. | [optional] |
+| **current_stage_histories** | [**Array<OrderCurrentStageHistory>**](OrderCurrentStageHistory.md) | History of the changes to the current_stage field | [optional] |
 | **customer_profile** | [**Customer**](Customer.md) |  | [optional] |
 | **digital_order** | [**OrderDigitalOrder**](OrderDigitalOrder.md) |  | [optional] |
 | **edi** | [**OrderEdi**](OrderEdi.md) |  | [optional] |
@@ -59,6 +60,7 @@ instance = UltracartClient::Order.new(
   creation_dts: null,
   currency_code: null,
   current_stage: null,
+  current_stage_histories: null,
   customer_profile: null,
   digital_order: null,
   edi: null,

data/docs/OrderCurrentStageHistory.md

@@ -0,0 +1,22 @@
+# UltracartClient::OrderCurrentStageHistory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **after_stage** | **String** | New stage that the order is in. | [optional] |
+| **before_stage** | **String** | Previous stage that the order was in. | [optional] |
+| **transition_dts** | **String** | Date/time that the stage transitioned | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::OrderCurrentStageHistory.new(
+  after_stage: null,
+  before_stage: null,
+  transition_dts: null
+)
+```
+

data/docs/OrderItem.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **accounting_code** | **String** | QuickBooks code | [optional] |
 | **activation_codes** | **Array<String>** | Activation codes assigned to this item | [optional] |
+| **actual_cogs** | [**Currency**](Currency.md) |  | [optional] |
 | **arbitrary_unit_cost** | [**Currency**](Currency.md) |  | [optional] |
 | **auto_order_last_rebill_dts** | **String** | Date/time of the last rebill, used only during order insert to help project future rebills | [optional] |
 | **auto_order_schedule** | **String** | Auto order schedule, used only during inserts supplying the recurring schedule | [optional] |
@@ -78,6 +79,7 @@ require 'ultracart_api'
 instance = UltracartClient::OrderItem.new(
   accounting_code: null,
   activation_codes: null,
+  actual_cogs: null,
   arbitrary_unit_cost: null,
   auto_order_last_rebill_dts: null,
   auto_order_schedule: null,

data/docs/OrderSummary.md

@@ -5,7 +5,11 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **actual_fulfillment** | [**Currency**](Currency.md) |  | [optional] |
+| **actual_other_cost** | [**Currency**](Currency.md) |  | [optional] |
 | **actual_payment_processing** | [**Currency**](Currency.md) |  | [optional] |
+| **actual_profit** | [**Currency**](Currency.md) |  | [optional] |
+| **actual_profit_analyzed** | **Boolean** | Actual profit has been analyzed | [optional] |
+| **actual_profit_review** | **Boolean** | Actual profit needs review | [optional] |
 | **actual_shipping** | [**Currency**](Currency.md) |  | [optional] |
 | **arbitrary_shipping_handling_total** | [**Currency**](Currency.md) |  | [optional] |
 | **health_benefit_card_amount** | [**Currency**](Currency.md) |  | [optional] |
@@ -34,7 +38,11 @@ require 'ultracart_api'
 
 instance = UltracartClient::OrderSummary.new(
   actual_fulfillment: null,
+  actual_other_cost: null,
   actual_payment_processing: null,
+  actual_profit: null,
+  actual_profit_analyzed: null,
+  actual_profit_review: null,
   actual_shipping: null,
   arbitrary_shipping_handling_total: null,
   health_benefit_card_amount: null,

data/lib/ultracart_api/models/channel_partner_order.rb

@@ -276,6 +276,9 @@ module UltracartClient
     # If true any failed payments are placed into Accounts Receivable.  If false any failed payments result in a rejected order resulting in errors thrown during the insert routine
     attr_accessor :store_if_payment_declines
 
+    # StoreFront host name associated with the order
+    attr_accessor :storefront_host_name
+
     # The optional shipping county used to determine exact taxes
     attr_accessor :tax_county
 
@@ -399,6 +402,7 @@ module UltracartClient
         :'special_instructions' => :'special_instructions',
         :'store_completed' => :'store_completed',
         :'store_if_payment_declines' => :'store_if_payment_declines',
+        :'storefront_host_name' => :'storefront_host_name',
         :'tax_county' => :'tax_county',
         :'tax_exempt' => :'tax_exempt',
         :'transaction' => :'transaction',
@@ -501,6 +505,7 @@ module UltracartClient
         :'special_instructions' => :'String',
         :'store_completed' => :'Boolean',
         :'store_if_payment_declines' => :'Boolean',
+        :'storefront_host_name' => :'String',
         :'tax_county' => :'String',
         :'tax_exempt' => :'Boolean',
         :'transaction' => :'ChannelPartnerOrderTransaction',
@@ -883,6 +888,10 @@ module UltracartClient
         self.store_if_payment_declines = attributes[:'store_if_payment_declines']
       end
 
+      if attributes.key?(:'storefront_host_name')
+        self.storefront_host_name = attributes[:'storefront_host_name']
+      end
+
       if attributes.key?(:'tax_county')
         self.tax_county = attributes[:'tax_county']
       end
@@ -1596,6 +1605,7 @@ module UltracartClient
           special_instructions == o.special_instructions &&
           store_completed == o.store_completed &&
           store_if_payment_declines == o.store_if_payment_declines &&
+          storefront_host_name == o.storefront_host_name &&
           tax_county == o.tax_county &&
           tax_exempt == o.tax_exempt &&
           transaction == o.transaction &&
@@ -1611,7 +1621,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [advertising_source, affiliate_id, affiliate_sub_id, arbitrary_shipping_handling_total, arbitrary_tax, arbitrary_tax_rate, arbitrary_taxable_subtotal, associate_with_customer_profile_if_present, auto_approve_purchase_order, billto_address1, billto_address2, billto_city, billto_company, billto_country_code, billto_day_phone, billto_evening_phone, billto_first_name, billto_last_name, billto_postal_code, billto_state_region, billto_title, cc_email, channel_partner_order_id, consider_recurring, coupons, credit_card_authorization_amount, credit_card_authorization_dts, credit_card_authorization_number, credit_card_expiration_month, credit_card_expiration_year, credit_card_type, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, delivery_date, echeck_bank_aba_code, echeck_bank_account_name, echeck_bank_account_number, echeck_bank_account_type, echeck_bank_name, echeck_bank_owner_type, echeck_customer_tax_id, echeck_drivers_license_dob, echeck_drivers_license_number, echeck_drivers_license_state, email, gift, gift_email, gift_message, hosted_fields_card_token, hosted_fields_cvv_token, insurance_application_id, insurance_claim_id, ip_address, items, least_cost_route, least_cost_route_shipping_methods, mailing_list_opt_in, no_realtime_payment_processing, payment_method, purchase_order_number, rotating_transaction_gateway_code, sales_rep_code, screen_branding_theme_code, ship_on_date, ship_to_residential, shipping_method, shipto_address1, shipto_address2, shipto_city, shipto_company, shipto_country_code, shipto_day_phone, shipto_evening_phone, shipto_first_name, shipto_last_name, shipto_postal_code, shipto_state_region, shipto_title, skip_payment_processing, special_instructions, store_completed, store_if_payment_declines, tax_county, tax_exempt, transaction, treat_warnings_as_errors].hash
+      [advertising_source, affiliate_id, affiliate_sub_id, arbitrary_shipping_handling_total, arbitrary_tax, arbitrary_tax_rate, arbitrary_taxable_subtotal, associate_with_customer_profile_if_present, auto_approve_purchase_order, billto_address1, billto_address2, billto_city, billto_company, billto_country_code, billto_day_phone, billto_evening_phone, billto_first_name, billto_last_name, billto_postal_code, billto_state_region, billto_title, cc_email, channel_partner_order_id, consider_recurring, coupons, credit_card_authorization_amount, credit_card_authorization_dts, credit_card_authorization_number, credit_card_expiration_month, credit_card_expiration_year, credit_card_type, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, delivery_date, echeck_bank_aba_code, echeck_bank_account_name, echeck_bank_account_number, echeck_bank_account_type, echeck_bank_name, echeck_bank_owner_type, echeck_customer_tax_id, echeck_drivers_license_dob, echeck_drivers_license_number, echeck_drivers_license_state, email, gift, gift_email, gift_message, hosted_fields_card_token, hosted_fields_cvv_token, insurance_application_id, insurance_claim_id, ip_address, items, least_cost_route, least_cost_route_shipping_methods, mailing_list_opt_in, no_realtime_payment_processing, payment_method, purchase_order_number, rotating_transaction_gateway_code, sales_rep_code, screen_branding_theme_code, ship_on_date, ship_to_residential, shipping_method, shipto_address1, shipto_address2, shipto_city, shipto_company, shipto_country_code, shipto_day_phone, shipto_evening_phone, shipto_first_name, shipto_last_name, shipto_postal_code, shipto_state_region, shipto_title, skip_payment_processing, special_instructions, store_completed, store_if_payment_declines, storefront_host_name, tax_county, tax_exempt, transaction, treat_warnings_as_errors].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/customer_attachment.rb

@@ -24,7 +24,7 @@ module UltracartClient
     # File name
     attr_accessor :file_name
 
-    # Mime typoe
+    # Mime type
     attr_accessor :mime_type
 
     # Upload date/time

data/lib/ultracart_api/models/item_review.rb

@@ -24,6 +24,9 @@ module UltracartClient
 
     attr_accessor :helpful_yes_votes
 
+    # Merchant Reply (set to an empty string to remove)
+    attr_accessor :merchant_reply
+
     attr_accessor :order_id
 
     attr_accessor :overall
@@ -137,6 +140,7 @@ module UltracartClient
         :'featured' => :'featured',
         :'helperful_no_votes' => :'helperful_no_votes',
         :'helpful_yes_votes' => :'helpful_yes_votes',
+        :'merchant_reply' => :'merchant_reply',
         :'order_id' => :'order_id',
         :'overall' => :'overall',
         :'rating_name1' => :'rating_name1',
@@ -185,6 +189,7 @@ module UltracartClient
         :'featured' => :'Boolean',
         :'helperful_no_votes' => :'Integer',
         :'helpful_yes_votes' => :'Integer',
+        :'merchant_reply' => :'String',
         :'order_id' => :'String',
         :'overall' => :'Float',
         :'rating_name1' => :'String',
@@ -258,6 +263,10 @@ module UltracartClient
         self.helpful_yes_votes = attributes[:'helpful_yes_votes']
       end
 
+      if attributes.key?(:'merchant_reply')
+        self.merchant_reply = attributes[:'merchant_reply']
+      end
+
       if attributes.key?(:'order_id')
         self.order_id = attributes[:'order_id']
       end
@@ -395,6 +404,10 @@ module UltracartClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@merchant_reply.nil? && @merchant_reply.to_s.length > 10000
+        invalid_properties.push('invalid value for "merchant_reply", the character length must be smaller than or equal to 10000.')
+      end
+
       if !@rating_name1.nil? && @rating_name1.to_s.length > 100
         invalid_properties.push('invalid value for "rating_name1", the character length must be smaller than or equal to 100.')
       end
@@ -465,6 +478,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?
+      return false if !@merchant_reply.nil? && @merchant_reply.to_s.length > 10000
       return false if !@rating_name1.nil? && @rating_name1.to_s.length > 100
       return false if !@rating_name10.nil? && @rating_name10.to_s.length > 100
       return false if !@rating_name2.nil? && @rating_name2.to_s.length > 100
@@ -486,6 +500,16 @@ module UltracartClient
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] merchant_reply Value to be assigned
+    def merchant_reply=(merchant_reply)
+      if !merchant_reply.nil? && merchant_reply.to_s.length > 10000
+        fail ArgumentError, 'invalid value for "merchant_reply", the character length must be smaller than or equal to 10000.'
+      end
+
+      @merchant_reply = merchant_reply
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] rating_name1 Value to be assigned
     def rating_name1=(rating_name1)
@@ -665,6 +689,7 @@ module UltracartClient
           featured == o.featured &&
           helperful_no_votes == o.helperful_no_votes &&
           helpful_yes_votes == o.helpful_yes_votes &&
+          merchant_reply == o.merchant_reply &&
           order_id == o.order_id &&
           overall == o.overall &&
           rating_name1 == o.rating_name1 &&
@@ -709,7 +734,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [customer_profile_oid, featured, helperful_no_votes, helpful_yes_votes, order_id, overall, rating_name1, rating_name10, rating_name2, rating_name3, rating_name4, rating_name5, rating_name6, rating_name7, rating_name8, rating_name9, rating_score1, rating_score10, rating_score2, rating_score3, rating_score4, rating_score5, rating_score6, rating_score7, rating_score8, rating_score9, recommend_store_to_friend, recommend_to_friend, review, review_oid, reviewed_nickname, reviewer_email, reviewer_location, status, store_feedback, submitted_dts, title].hash
+      [customer_profile_oid, featured, helperful_no_votes, helpful_yes_votes, merchant_reply, order_id, overall, rating_name1, rating_name10, rating_name2, rating_name3, rating_name4, rating_name5, rating_name6, rating_name7, rating_name8, rating_name9, rating_score1, rating_score10, rating_score2, rating_score3, rating_score4, rating_score5, rating_score6, rating_score7, rating_score8, rating_score9, recommend_store_to_friend, recommend_to_friend, review, review_oid, reviewed_nickname, reviewer_email, reviewer_location, status, store_feedback, submitted_dts, title].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order.rb

@@ -40,6 +40,9 @@ module UltracartClient
     # Current stage that the order is in.
     attr_accessor :current_stage
 
+    # History of the changes to the current_stage field
+    attr_accessor :current_stage_histories
+
     attr_accessor :customer_profile
 
     attr_accessor :digital_order
@@ -143,6 +146,7 @@ module UltracartClient
         :'creation_dts' => :'creation_dts',
         :'currency_code' => :'currency_code',
         :'current_stage' => :'current_stage',
+        :'current_stage_histories' => :'current_stage_histories',
         :'customer_profile' => :'customer_profile',
         :'digital_order' => :'digital_order',
         :'edi' => :'edi',
@@ -192,6 +196,7 @@ module UltracartClient
         :'creation_dts' => :'String',
         :'currency_code' => :'String',
         :'current_stage' => :'String',
+        :'current_stage_histories' => :'Array<OrderCurrentStageHistory>',
         :'customer_profile' => :'Customer',
         :'digital_order' => :'OrderDigitalOrder',
         :'edi' => :'OrderEdi',
@@ -288,6 +293,12 @@ module UltracartClient
         self.current_stage = attributes[:'current_stage']
       end
 
+      if attributes.key?(:'current_stage_histories')
+        if (value = attributes[:'current_stage_histories']).is_a?(Array)
+          self.current_stage_histories = value
+        end
+      end
+
       if attributes.key?(:'customer_profile')
         self.customer_profile = attributes[:'customer_profile']
       end
@@ -479,6 +490,7 @@ module UltracartClient
           creation_dts == o.creation_dts &&
           currency_code == o.currency_code &&
           current_stage == o.current_stage &&
+          current_stage_histories == o.current_stage_histories &&
           customer_profile == o.customer_profile &&
           digital_order == o.digital_order &&
           edi == o.edi &&
@@ -518,7 +530,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [affiliates, auto_order, billing, buysafe, channel_partner, checkout, coupons, creation_dts, currency_code, current_stage, customer_profile, digital_order, edi, exchange_rate, fraud_score, gift, gift_certificate, internal, items, language_iso_code, linked_shipment, marketing, merchant_id, order_id, payment, point_of_sale, properties, quote, refund_dts, refund_reason, reject_dts, reject_reason, salesforce, shipping, summary, tags, taxes, utms].hash
+      [affiliates, auto_order, billing, buysafe, channel_partner, checkout, coupons, creation_dts, currency_code, current_stage, current_stage_histories, customer_profile, digital_order, edi, exchange_rate, fraud_score, gift, gift_certificate, internal, items, language_iso_code, linked_shipment, marketing, merchant_id, order_id, payment, point_of_sale, properties, quote, refund_dts, refund_reason, reject_dts, reject_reason, salesforce, shipping, summary, tags, taxes, utms].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_current_stage_history.rb

@@ -0,0 +1,286 @@
+=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 OrderCurrentStageHistory
+    # New stage that the order is in.
+    attr_accessor :after_stage
+
+    # Previous stage that the order was in.
+    attr_accessor :before_stage
+
+    # Date/time that the stage transitioned
+    attr_accessor :transition_dts
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'after_stage' => :'after_stage',
+        :'before_stage' => :'before_stage',
+        :'transition_dts' => :'transition_dts'
+      }
+    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
+      {
+        :'after_stage' => :'String',
+        :'before_stage' => :'String',
+        :'transition_dts' => :'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::OrderCurrentStageHistory` 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::OrderCurrentStageHistory`. 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?(:'after_stage')
+        self.after_stage = attributes[:'after_stage']
+      end
+
+      if attributes.key?(:'before_stage')
+        self.before_stage = attributes[:'before_stage']
+      end
+
+      if attributes.key?(:'transition_dts')
+        self.transition_dts = attributes[:'transition_dts']
+      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?
+      after_stage_validator = EnumAttributeValidator.new('String', ["Accounts Receivable", "Pending Clearance", "Fraud Review", "Rejected", "Shipping Department", "Completed Order", "Quote Request", "Quote Sent", "Least Cost Routing", "Unknown", "Pre-ordered", "Advanced Order Routing", "Hold"])
+      return false unless after_stage_validator.valid?(@after_stage)
+      before_stage_validator = EnumAttributeValidator.new('String', ["Accounts Receivable", "Pending Clearance", "Fraud Review", "Rejected", "Shipping Department", "Completed Order", "Quote Request", "Quote Sent", "Least Cost Routing", "Unknown", "Pre-ordered", "Advanced Order Routing", "Hold"])
+      return false unless before_stage_validator.valid?(@before_stage)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] after_stage Object to be assigned
+    def after_stage=(after_stage)
+      validator = EnumAttributeValidator.new('String', ["Accounts Receivable", "Pending Clearance", "Fraud Review", "Rejected", "Shipping Department", "Completed Order", "Quote Request", "Quote Sent", "Least Cost Routing", "Unknown", "Pre-ordered", "Advanced Order Routing", "Hold"])
+      unless validator.valid?(after_stage)
+        fail ArgumentError, "invalid value for \"after_stage\", must be one of #{validator.allowable_values}."
+      end
+      @after_stage = after_stage
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] before_stage Object to be assigned
+    def before_stage=(before_stage)
+      validator = EnumAttributeValidator.new('String', ["Accounts Receivable", "Pending Clearance", "Fraud Review", "Rejected", "Shipping Department", "Completed Order", "Quote Request", "Quote Sent", "Least Cost Routing", "Unknown", "Pre-ordered", "Advanced Order Routing", "Hold"])
+      unless validator.valid?(before_stage)
+        fail ArgumentError, "invalid value for \"before_stage\", must be one of #{validator.allowable_values}."
+      end
+      @before_stage = before_stage
+    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 &&
+          after_stage == o.after_stage &&
+          before_stage == o.before_stage &&
+          transition_dts == o.transition_dts
+    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
+      [after_stage, before_stage, transition_dts].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_item.rb

@@ -21,6 +21,8 @@ module UltracartClient
     # Activation codes assigned to this item
     attr_accessor :activation_codes
 
+    attr_accessor :actual_cogs
+
     attr_accessor :arbitrary_unit_cost
 
     # Date/time of the last rebill, used only during order insert to help project future rebills
@@ -224,6 +226,7 @@ module UltracartClient
       {
         :'accounting_code' => :'accounting_code',
         :'activation_codes' => :'activation_codes',
+        :'actual_cogs' => :'actual_cogs',
         :'arbitrary_unit_cost' => :'arbitrary_unit_cost',
         :'auto_order_last_rebill_dts' => :'auto_order_last_rebill_dts',
         :'auto_order_schedule' => :'auto_order_schedule',
@@ -300,6 +303,7 @@ module UltracartClient
       {
         :'accounting_code' => :'String',
         :'activation_codes' => :'Array<String>',
+        :'actual_cogs' => :'Currency',
         :'arbitrary_unit_cost' => :'Currency',
         :'auto_order_last_rebill_dts' => :'String',
         :'auto_order_schedule' => :'String',
@@ -397,6 +401,10 @@ module UltracartClient
         end
       end
 
+      if attributes.key?(:'actual_cogs')
+        self.actual_cogs = attributes[:'actual_cogs']
+      end
+
       if attributes.key?(:'arbitrary_unit_cost')
         self.arbitrary_unit_cost = attributes[:'arbitrary_unit_cost']
       end
@@ -853,6 +861,7 @@ module UltracartClient
       self.class == o.class &&
           accounting_code == o.accounting_code &&
           activation_codes == o.activation_codes &&
+          actual_cogs == o.actual_cogs &&
           arbitrary_unit_cost == o.arbitrary_unit_cost &&
           auto_order_last_rebill_dts == o.auto_order_last_rebill_dts &&
           auto_order_schedule == o.auto_order_schedule &&
@@ -927,7 +936,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [accounting_code, activation_codes, arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, barcode, barcode_gtin12, barcode_gtin14, barcode_upc11, barcode_upc12, channel_partner_item_id, cogs, component_unit_value, cost, country_code_of_origin, customs_description, description, discount, discount_quantity, discount_shipping_weight, distribution_center_code, edi, exclude_coupon, free_shipping, hazmat, height, item_index, item_reference_oid, kit, kit_component, length, manufacturer_sku, max_days_time_in_transit, merchant_item_id, mix_and_match_group_name, mix_and_match_group_oid, no_shipping_discount, options, packed_by_user, parent_item_index, parent_merchant_item_id, perishable_class, pricing_tier_name, properties, quantity, quantity_refunded, quickbooks_class, refund_reason, return_reason, ship_separately, shipped_by_user, shipped_dts, shipping_status, special_product_type, tags, tax_free, tax_product_type, taxable_cost, total_cost_with_discount, total_refunded, transmitted_to_distribution_center_dts, unit_cost_with_discount, upsell, weight, width].hash
+      [accounting_code, activation_codes, actual_cogs, arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, barcode, barcode_gtin12, barcode_gtin14, barcode_upc11, barcode_upc12, channel_partner_item_id, cogs, component_unit_value, cost, country_code_of_origin, customs_description, description, discount, discount_quantity, discount_shipping_weight, distribution_center_code, edi, exclude_coupon, free_shipping, hazmat, height, item_index, item_reference_oid, kit, kit_component, length, manufacturer_sku, max_days_time_in_transit, merchant_item_id, mix_and_match_group_name, mix_and_match_group_oid, no_shipping_discount, options, packed_by_user, parent_item_index, parent_merchant_item_id, perishable_class, pricing_tier_name, properties, quantity, quantity_refunded, quickbooks_class, refund_reason, return_reason, ship_separately, shipped_by_user, shipped_dts, shipping_status, special_product_type, tags, tax_free, tax_product_type, taxable_cost, total_cost_with_discount, total_refunded, transmitted_to_distribution_center_dts, unit_cost_with_discount, upsell, weight, width].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_summary.rb

@@ -17,8 +17,18 @@ module UltracartClient
   class OrderSummary
     attr_accessor :actual_fulfillment
 
+    attr_accessor :actual_other_cost
+
     attr_accessor :actual_payment_processing
 
+    attr_accessor :actual_profit
+
+    # Actual profit has been analyzed
+    attr_accessor :actual_profit_analyzed
+
+    # Actual profit needs review
+    attr_accessor :actual_profit_review
+
     attr_accessor :actual_shipping
 
     attr_accessor :arbitrary_shipping_handling_total
@@ -63,7 +73,11 @@ module UltracartClient
     def self.attribute_map
       {
         :'actual_fulfillment' => :'actual_fulfillment',
+        :'actual_other_cost' => :'actual_other_cost',
         :'actual_payment_processing' => :'actual_payment_processing',
+        :'actual_profit' => :'actual_profit',
+        :'actual_profit_analyzed' => :'actual_profit_analyzed',
+        :'actual_profit_review' => :'actual_profit_review',
         :'actual_shipping' => :'actual_shipping',
         :'arbitrary_shipping_handling_total' => :'arbitrary_shipping_handling_total',
         :'health_benefit_card_amount' => :'health_benefit_card_amount',
@@ -96,7 +110,11 @@ module UltracartClient
     def self.openapi_types
       {
         :'actual_fulfillment' => :'Currency',
+        :'actual_other_cost' => :'Currency',
         :'actual_payment_processing' => :'Currency',
+        :'actual_profit' => :'Currency',
+        :'actual_profit_analyzed' => :'Boolean',
+        :'actual_profit_review' => :'Boolean',
         :'actual_shipping' => :'Currency',
         :'arbitrary_shipping_handling_total' => :'Currency',
         :'health_benefit_card_amount' => :'Currency',
@@ -145,10 +163,26 @@ module UltracartClient
         self.actual_fulfillment = attributes[:'actual_fulfillment']
       end
 
+      if attributes.key?(:'actual_other_cost')
+        self.actual_other_cost = attributes[:'actual_other_cost']
+      end
+
       if attributes.key?(:'actual_payment_processing')
         self.actual_payment_processing = attributes[:'actual_payment_processing']
       end
 
+      if attributes.key?(:'actual_profit')
+        self.actual_profit = attributes[:'actual_profit']
+      end
+
+      if attributes.key?(:'actual_profit_analyzed')
+        self.actual_profit_analyzed = attributes[:'actual_profit_analyzed']
+      end
+
+      if attributes.key?(:'actual_profit_review')
+        self.actual_profit_review = attributes[:'actual_profit_review']
+      end
+
       if attributes.key?(:'actual_shipping')
         self.actual_shipping = attributes[:'actual_shipping']
       end
@@ -249,7 +283,11 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           actual_fulfillment == o.actual_fulfillment &&
+          actual_other_cost == o.actual_other_cost &&
           actual_payment_processing == o.actual_payment_processing &&
+          actual_profit == o.actual_profit &&
+          actual_profit_analyzed == o.actual_profit_analyzed &&
+          actual_profit_review == o.actual_profit_review &&
           actual_shipping == o.actual_shipping &&
           arbitrary_shipping_handling_total == o.arbitrary_shipping_handling_total &&
           health_benefit_card_amount == o.health_benefit_card_amount &&
@@ -281,7 +319,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [actual_fulfillment, actual_payment_processing, actual_shipping, arbitrary_shipping_handling_total, health_benefit_card_amount, health_benefit_card_refunded, internal_gift_certificate_amount, internal_gift_certificate_refunded, other_refunded, shipping_handling_refunded, shipping_handling_total, shipping_handling_total_discount, subtotal, subtotal_discount, subtotal_discount_refunded, subtotal_refunded, tax, tax_refunded, taxable_subtotal, taxable_subtotal_discount, total, total_refunded].hash
+      [actual_fulfillment, actual_other_cost, actual_payment_processing, actual_profit, actual_profit_analyzed, actual_profit_review, actual_shipping, arbitrary_shipping_handling_total, health_benefit_card_amount, health_benefit_card_refunded, internal_gift_certificate_amount, internal_gift_certificate_refunded, other_refunded, shipping_handling_refunded, shipping_handling_total, shipping_handling_total_discount, subtotal, subtotal_discount, subtotal_discount_refunded, subtotal_refunded, tax, tax_refunded, taxable_subtotal, taxable_subtotal_discount, total, total_refunded].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.0.240'
+  VERSION = '4.0.241'
 end

data/lib/ultracart_api.rb

@@ -634,6 +634,7 @@ require 'ultracart_api/models/order_by_token_query'
 require 'ultracart_api/models/order_channel_partner'
 require 'ultracart_api/models/order_checkout'
 require 'ultracart_api/models/order_coupon'
+require 'ultracart_api/models/order_current_stage_history'
 require 'ultracart_api/models/order_digital_item'
 require 'ultracart_api/models/order_digital_order'
 require 'ultracart_api/models/order_edi'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.240
+  version: 4.0.241
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-09 00:00:00.000000000 Z
+date: 2025-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -693,6 +693,7 @@ files:
 - docs/OrderChannelPartner.md
 - docs/OrderCheckout.md
 - docs/OrderCoupon.md
+- docs/OrderCurrentStageHistory.md
 - docs/OrderDigitalItem.md
 - docs/OrderDigitalOrder.md
 - docs/OrderEdi.md
@@ -1579,6 +1580,7 @@ files:
 - lib/ultracart_api/models/order_channel_partner.rb
 - lib/ultracart_api/models/order_checkout.rb
 - lib/ultracart_api/models/order_coupon.rb
+- lib/ultracart_api/models/order_current_stage_history.rb
 - lib/ultracart_api/models/order_digital_item.rb
 - lib/ultracart_api/models/order_digital_order.rb
 - lib/ultracart_api/models/order_edi.rb