ultracart_api 3.6.19 → 3.6.23

data/lib/ultracart_api/models/experiment_variation_stat.rb

@@ -0,0 +1,285 @@
+=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 ExperimentVariationStat
+    # Total add to cart count for this variation
+    attr_accessor :add_to_cart_count
+
+    # Total bounce count for this variation
+    attr_accessor :bounce_count
+
+    # Total number of seconds spent on the site for this variation
+    attr_accessor :duration_seconds_sum
+
+    # Total event count for this variation
+    attr_accessor :event_count
+
+    # Total initiate checkout count for this variation
+    attr_accessor :initiate_checkout_count
+
+    # Total order count for this variation
+    attr_accessor :order_count
+
+    # Total order item count for this variation
+    attr_accessor :order_item_count
+
+    # Total page view count for this variation
+    attr_accessor :page_view_count
+
+    # Total revenue for this variation
+    attr_accessor :revenue
+
+    # Total sessions for this variation
+    attr_accessor :session_count
+
+    # Date/time that the statistic was created
+    attr_accessor :stat_dts
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'add_to_cart_count' => :'add_to_cart_count',
+        :'bounce_count' => :'bounce_count',
+        :'duration_seconds_sum' => :'duration_seconds_sum',
+        :'event_count' => :'event_count',
+        :'initiate_checkout_count' => :'initiate_checkout_count',
+        :'order_count' => :'order_count',
+        :'order_item_count' => :'order_item_count',
+        :'page_view_count' => :'page_view_count',
+        :'revenue' => :'revenue',
+        :'session_count' => :'session_count',
+        :'stat_dts' => :'stat_dts'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'add_to_cart_count' => :'Integer',
+        :'bounce_count' => :'Integer',
+        :'duration_seconds_sum' => :'Integer',
+        :'event_count' => :'Integer',
+        :'initiate_checkout_count' => :'Integer',
+        :'order_count' => :'Integer',
+        :'order_item_count' => :'Integer',
+        :'page_view_count' => :'Integer',
+        :'revenue' => :'Float',
+        :'session_count' => :'Integer',
+        :'stat_dts' => :'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?(:'add_to_cart_count')
+        self.add_to_cart_count = attributes[:'add_to_cart_count']
+      end
+
+      if attributes.has_key?(:'bounce_count')
+        self.bounce_count = attributes[:'bounce_count']
+      end
+
+      if attributes.has_key?(:'duration_seconds_sum')
+        self.duration_seconds_sum = attributes[:'duration_seconds_sum']
+      end
+
+      if attributes.has_key?(:'event_count')
+        self.event_count = attributes[:'event_count']
+      end
+
+      if attributes.has_key?(:'initiate_checkout_count')
+        self.initiate_checkout_count = attributes[:'initiate_checkout_count']
+      end
+
+      if attributes.has_key?(:'order_count')
+        self.order_count = attributes[:'order_count']
+      end
+
+      if attributes.has_key?(:'order_item_count')
+        self.order_item_count = attributes[:'order_item_count']
+      end
+
+      if attributes.has_key?(:'page_view_count')
+        self.page_view_count = attributes[:'page_view_count']
+      end
+
+      if attributes.has_key?(:'revenue')
+        self.revenue = attributes[:'revenue']
+      end
+
+      if attributes.has_key?(:'session_count')
+        self.session_count = attributes[:'session_count']
+      end
+
+      if attributes.has_key?(:'stat_dts')
+        self.stat_dts = attributes[:'stat_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?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          add_to_cart_count == o.add_to_cart_count &&
+          bounce_count == o.bounce_count &&
+          duration_seconds_sum == o.duration_seconds_sum &&
+          event_count == o.event_count &&
+          initiate_checkout_count == o.initiate_checkout_count &&
+          order_count == o.order_count &&
+          order_item_count == o.order_item_count &&
+          page_view_count == o.page_view_count &&
+          revenue == o.revenue &&
+          session_count == o.session_count &&
+          stat_dts == o.stat_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 [Fixnum] Hash code
+    def hash
+      [add_to_cart_count, bounce_count, duration_seconds_sum, event_count, initiate_checkout_count, order_count, order_item_count, page_view_count, revenue, session_count, stat_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 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/item_auto_order.rb

@@ -32,6 +32,9 @@ module UltracartClient
     # True if the rebill processing of this item is paused
     attr_accessor :auto_order_paused
 
+    # Minimum number of months before expiration for the card.  Overrides the account level setting if higher.  Set to zero to disable.
+    attr_accessor :auto_order_prohibit_expiring_cards
+
     # The user selectable schedules that are available
     attr_accessor :auto_order_schedules
 
@@ -71,6 +74,7 @@ module UltracartClient
         :'auto_order_cancel_item_oid' => :'auto_order_cancel_item_oid',
         :'auto_order_downgrade_items' => :'auto_order_downgrade_items',
         :'auto_order_paused' => :'auto_order_paused',
+        :'auto_order_prohibit_expiring_cards' => :'auto_order_prohibit_expiring_cards',
         :'auto_order_schedules' => :'auto_order_schedules',
         :'auto_order_upgrade_items' => :'auto_order_upgrade_items',
         :'auto_order_upsell' => :'auto_order_upsell',
@@ -93,6 +97,7 @@ module UltracartClient
         :'auto_order_cancel_item_oid' => :'Integer',
         :'auto_order_downgrade_items' => :'Array<String>',
         :'auto_order_paused' => :'BOOLEAN',
+        :'auto_order_prohibit_expiring_cards' => :'Integer',
         :'auto_order_schedules' => :'Array<String>',
         :'auto_order_upgrade_items' => :'Array<String>',
         :'auto_order_upsell' => :'BOOLEAN',
@@ -140,6 +145,10 @@ module UltracartClient
         self.auto_order_paused = attributes[:'auto_order_paused']
       end
 
+      if attributes.has_key?(:'auto_order_prohibit_expiring_cards')
+        self.auto_order_prohibit_expiring_cards = attributes[:'auto_order_prohibit_expiring_cards']
+      end
+
       if attributes.has_key?(:'auto_order_schedules')
         if (value = attributes[:'auto_order_schedules']).is_a?(Array)
           self.auto_order_schedules = value
@@ -226,6 +235,7 @@ module UltracartClient
           auto_order_cancel_item_oid == o.auto_order_cancel_item_oid &&
           auto_order_downgrade_items == o.auto_order_downgrade_items &&
           auto_order_paused == o.auto_order_paused &&
+          auto_order_prohibit_expiring_cards == o.auto_order_prohibit_expiring_cards &&
           auto_order_schedules == o.auto_order_schedules &&
           auto_order_upgrade_items == o.auto_order_upgrade_items &&
           auto_order_upsell == o.auto_order_upsell &&
@@ -247,7 +257,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [auth_future_amount, auth_test_amount, auto_order_cancel_item_id, auto_order_cancel_item_oid, auto_order_downgrade_items, auto_order_paused, auto_order_schedules, auto_order_upgrade_items, auto_order_upsell, auto_order_upsell_no_easy_cancel, auto_order_upsell_one_per_customer, auto_orderable, cancel_other_auto_orders, free_shipping_auto_order, refund_other_auto_orders, steps].hash
+      [auth_future_amount, auth_test_amount, auto_order_cancel_item_id, auto_order_cancel_item_oid, auto_order_downgrade_items, auto_order_paused, auto_order_prohibit_expiring_cards, auto_order_schedules, auto_order_upgrade_items, auto_order_upsell, auto_order_upsell_no_easy_cancel, auto_order_upsell_one_per_customer, auto_orderable, cancel_other_auto_orders, free_shipping_auto_order, refund_other_auto_orders, steps].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/item_auto_order_step.rb

@@ -56,7 +56,7 @@ module UltracartClient
     # Email list identifier to subscribe the customer to when this rebill occurs
     attr_accessor :subscribe_email_list_oid
 
-    # Type of step (item or pause)
+    # Type of step (item, kit only, loop or pause)
     attr_accessor :type
 
     class EnumAttributeValidator
@@ -211,7 +211,7 @@ module UltracartClient
     # @return true if the model is valid
     def valid?
       return false if !@recurring_merchant_item_id.nil? && @recurring_merchant_item_id.to_s.length > 20
-      type_validator = EnumAttributeValidator.new('String', ['item', 'pause'])
+      type_validator = EnumAttributeValidator.new('String', ['item', 'pause', 'loop', 'kit only'])
       return false unless type_validator.valid?(@type)
       true
     end
@@ -229,7 +229,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ['item', 'pause'])
+      validator = EnumAttributeValidator.new('String', ['item', 'pause', 'loop', 'kit only'])
       unless validator.valid?(type)
         fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
       end

data/lib/ultracart_api/models/item_shipping_distribution_center.rb

@@ -23,6 +23,9 @@ module UltracartClient
     # Available to allocate
     attr_accessor :available_to_allocate
 
+    # Cost of goods sold override at the distribution center level
+    attr_accessor :cogs
+
     # Desired inventory level
     attr_accessor :desired_inventory_level
 
@@ -59,6 +62,7 @@ module UltracartClient
         :'allocated_to_placed_orders' => :'allocated_to_placed_orders',
         :'allocated_to_shopping_carts' => :'allocated_to_shopping_carts',
         :'available_to_allocate' => :'available_to_allocate',
+        :'cogs' => :'cogs',
         :'desired_inventory_level' => :'desired_inventory_level',
         :'distribution_center_code' => :'distribution_center_code',
         :'distribution_center_oid' => :'distribution_center_oid',
@@ -78,6 +82,7 @@ module UltracartClient
         :'allocated_to_placed_orders' => :'Float',
         :'allocated_to_shopping_carts' => :'Float',
         :'available_to_allocate' => :'Float',
+        :'cogs' => :'Float',
         :'desired_inventory_level' => :'Float',
         :'distribution_center_code' => :'String',
         :'distribution_center_oid' => :'Integer',
@@ -111,6 +116,10 @@ module UltracartClient
         self.available_to_allocate = attributes[:'available_to_allocate']
       end
 
+      if attributes.has_key?(:'cogs')
+        self.cogs = attributes[:'cogs']
+      end
+
       if attributes.has_key?(:'desired_inventory_level')
         self.desired_inventory_level = attributes[:'desired_inventory_level']
       end
@@ -203,6 +212,7 @@ module UltracartClient
           allocated_to_placed_orders == o.allocated_to_placed_orders &&
           allocated_to_shopping_carts == o.allocated_to_shopping_carts &&
           available_to_allocate == o.available_to_allocate &&
+          cogs == o.cogs &&
           desired_inventory_level == o.desired_inventory_level &&
           distribution_center_code == o.distribution_center_code &&
           distribution_center_oid == o.distribution_center_oid &&
@@ -224,7 +234,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [allocated_to_placed_orders, allocated_to_shopping_carts, available_to_allocate, desired_inventory_level, distribution_center_code, distribution_center_oid, eta, handles, inventory_level, maximum_backorder, reorder_inventory_level, sku, stock_picking_location].hash
+      [allocated_to_placed_orders, allocated_to_shopping_carts, available_to_allocate, cogs, desired_inventory_level, distribution_center_code, distribution_center_oid, eta, handles, inventory_level, maximum_backorder, reorder_inventory_level, sku, stock_picking_location].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_item.rb

@@ -151,9 +151,6 @@ module UltracartClient
 
     attr_accessor :total_refunded
 
-    # Tracking number, if null or missing, use order level tracking number(s). Used if there are multiple shipments for one order
-    attr_accessor :tracking_number
-
     # Date/time that this item was transmitted to the distribution center
     attr_accessor :transmitted_to_distribution_center_dts
 
@@ -218,7 +215,6 @@ module UltracartClient
         :'taxable_cost' => :'taxable_cost',
         :'total_cost_with_discount' => :'total_cost_with_discount',
         :'total_refunded' => :'total_refunded',
-        :'tracking_number' => :'tracking_number',
         :'transmitted_to_distribution_center_dts' => :'transmitted_to_distribution_center_dts',
         :'unit_cost_with_discount' => :'unit_cost_with_discount',
         :'upsell' => :'upsell',
@@ -279,7 +275,6 @@ module UltracartClient
         :'taxable_cost' => :'Currency',
         :'total_cost_with_discount' => :'Currency',
         :'total_refunded' => :'Currency',
-        :'tracking_number' => :'String',
         :'transmitted_to_distribution_center_dts' => :'String',
         :'unit_cost_with_discount' => :'Currency',
         :'upsell' => :'BOOLEAN',
@@ -500,10 +495,6 @@ module UltracartClient
         self.total_refunded = attributes[:'total_refunded']
       end
 
-      if attributes.has_key?(:'tracking_number')
-        self.tracking_number = attributes[:'tracking_number']
-      end
-
       if attributes.has_key?(:'transmitted_to_distribution_center_dts')
         self.transmitted_to_distribution_center_dts = attributes[:'transmitted_to_distribution_center_dts']
       end
@@ -682,7 +673,6 @@ module UltracartClient
           taxable_cost == o.taxable_cost &&
           total_cost_with_discount == o.total_cost_with_discount &&
           total_refunded == o.total_refunded &&
-          tracking_number == o.tracking_number &&
           transmitted_to_distribution_center_dts == o.transmitted_to_distribution_center_dts &&
           unit_cost_with_discount == o.unit_cost_with_discount &&
           upsell == o.upsell &&
@@ -699,7 +689,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [accounting_code, activation_codes, arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, barcode, 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_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, perishable_class, pricing_tier_name, properties, quantity, quantity_refunded, quickbooks_class, ship_separately, shipped_by_user, shipped_dts, special_product_type, tags, tax_free, taxable_cost, total_cost_with_discount, total_refunded, tracking_number, transmitted_to_distribution_center_dts, unit_cost_with_discount, upsell, weight, width].hash
+      [accounting_code, activation_codes, arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, barcode, 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_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, perishable_class, pricing_tier_name, properties, quantity, quantity_refunded, quickbooks_class, ship_separately, shipped_by_user, shipped_dts, special_product_type, tags, tax_free, 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_query.rb

@@ -475,7 +475,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', 'Google Shopping', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer'])
+      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'])
       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
@@ -568,7 +568,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', 'Google Shopping', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer'])
+      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'])
       unless validator.valid?(payment_method)
         fail ArgumentError, 'invalid value for "payment_method", must be one of #{validator.allowable_values}.'
       end