ultracart_api 4.0.238 → 4.0.241

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.238'
+  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.238
+  version: 4.0.241
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-13 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