ultracart_api 3.1.16 → 3.1.40

data/lib/ultracart_api/models/coupon.rb

@@ -100,6 +100,8 @@ module UltracartClient
 
     attr_accessor :percent_off_items_with_items_purchase
 
+    attr_accessor :percent_off_msrp_items
+
     attr_accessor :percent_off_retail_price_items
 
     attr_accessor :percent_off_shipping
@@ -186,6 +188,7 @@ module UltracartClient
         :'percent_off_items' => :'percent_off_items',
         :'percent_off_items_and_free_shipping' => :'percent_off_items_and_free_shipping',
         :'percent_off_items_with_items_purchase' => :'percent_off_items_with_items_purchase',
+        :'percent_off_msrp_items' => :'percent_off_msrp_items',
         :'percent_off_retail_price_items' => :'percent_off_retail_price_items',
         :'percent_off_shipping' => :'percent_off_shipping',
         :'percent_off_subtotal' => :'percent_off_subtotal',
@@ -249,6 +252,7 @@ module UltracartClient
         :'percent_off_items' => :'CouponPercentOffItems',
         :'percent_off_items_and_free_shipping' => :'CouponPercentOffItemsAndFreeShipping',
         :'percent_off_items_with_items_purchase' => :'CouponPercentOffItemsWithItemsPurchase',
+        :'percent_off_msrp_items' => :'CouponPercentOffMsrpItems',
         :'percent_off_retail_price_items' => :'CouponPercentOffRetailPriceItems',
         :'percent_off_shipping' => :'CouponPercentOffShipping',
         :'percent_off_subtotal' => :'CouponPercentOffSubtotal',
@@ -431,6 +435,10 @@ module UltracartClient
         self.percent_off_items_with_items_purchase = attributes[:'percent_off_items_with_items_purchase']
       end
 
+      if attributes.has_key?(:'percent_off_msrp_items')
+        self.percent_off_msrp_items = attributes[:'percent_off_msrp_items']
+      end
+
       if attributes.has_key?(:'percent_off_retail_price_items')
         self.percent_off_retail_price_items = attributes[:'percent_off_retail_price_items']
       end
@@ -660,6 +668,7 @@ module UltracartClient
           percent_off_items == o.percent_off_items &&
           percent_off_items_and_free_shipping == o.percent_off_items_and_free_shipping &&
           percent_off_items_with_items_purchase == o.percent_off_items_with_items_purchase &&
+          percent_off_msrp_items == o.percent_off_msrp_items &&
           percent_off_retail_price_items == o.percent_off_retail_price_items &&
           percent_off_shipping == o.percent_off_shipping &&
           percent_off_subtotal == o.percent_off_subtotal &&
@@ -690,7 +699,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [affiliate_oid, allow_multiple_one_time_codes, amount_off_items, amount_off_shipping, amount_off_shipping_with_items_purchase, amount_off_subtotal, amount_off_subtotal_and_free_shipping, amount_off_subtotal_and_shipping, amount_off_subtotal_with_block_purchase, amount_off_subtotal_with_items_purchase, amount_off_subtotal_with_purchase, automatically_apply_coupon_codes, buy_one_get_one, calculated_description, can_be_used_with_other_coupons, coupon_oid, coupon_type, description, discount_item_with_item_purchase, discount_items, expiration_dts, free_item_and_shipping_with_subtotal, free_item_with_item_purchase, free_item_with_subtotal, free_items_with_item_purchase, free_items_with_mixmatch_purchase, free_shipping, free_shipping_specific_items, free_shipping_with_items_purchase, free_shipping_with_subtotal, merchant_code, merchant_notes, multiple_amounts_off_items, no_discount, percent_off_item_with_items_quantity_purchase, percent_off_items, percent_off_items_and_free_shipping, percent_off_items_with_items_purchase, percent_off_retail_price_items, percent_off_shipping, percent_off_subtotal, percent_off_subtotal_and_free_shipping, percent_off_subtotal_limit, percent_off_subtotal_with_items_purchase, percent_off_subtotal_with_subtotal, quickbooks_code, restrict_by_postal_codes, restrict_by_screen_branding_theme_codes, restrict_by_storefronts, start_dts, super_coupon, tiered_amount_off_item, tiered_amount_off_subtotal, tiered_percent_off_items, tiered_percent_off_shipping, tiered_percent_off_subtotal, usable_by].hash
+      [affiliate_oid, allow_multiple_one_time_codes, amount_off_items, amount_off_shipping, amount_off_shipping_with_items_purchase, amount_off_subtotal, amount_off_subtotal_and_free_shipping, amount_off_subtotal_and_shipping, amount_off_subtotal_with_block_purchase, amount_off_subtotal_with_items_purchase, amount_off_subtotal_with_purchase, automatically_apply_coupon_codes, buy_one_get_one, calculated_description, can_be_used_with_other_coupons, coupon_oid, coupon_type, description, discount_item_with_item_purchase, discount_items, expiration_dts, free_item_and_shipping_with_subtotal, free_item_with_item_purchase, free_item_with_subtotal, free_items_with_item_purchase, free_items_with_mixmatch_purchase, free_shipping, free_shipping_specific_items, free_shipping_with_items_purchase, free_shipping_with_subtotal, merchant_code, merchant_notes, multiple_amounts_off_items, no_discount, percent_off_item_with_items_quantity_purchase, percent_off_items, percent_off_items_and_free_shipping, percent_off_items_with_items_purchase, percent_off_msrp_items, percent_off_retail_price_items, percent_off_shipping, percent_off_subtotal, percent_off_subtotal_and_free_shipping, percent_off_subtotal_limit, percent_off_subtotal_with_items_purchase, percent_off_subtotal_with_subtotal, quickbooks_code, restrict_by_postal_codes, restrict_by_screen_branding_theme_codes, restrict_by_storefronts, start_dts, super_coupon, tiered_amount_off_item, tiered_amount_off_subtotal, tiered_percent_off_items, tiered_percent_off_shipping, tiered_percent_off_subtotal, usable_by].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb

@@ -0,0 +1,219 @@
+=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 CouponPercentOffMsrpItems
+    # The percentage of subtotal discount
+    attr_accessor :discount_percent
+
+    # A list of items which cannot be discounted.
+    attr_accessor :excluded_items
+
+    # An list of items which will receive a discount.
+    attr_accessor :items
+
+    # The (optional) maximum quantity of discounted items.
+    attr_accessor :limit
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'discount_percent' => :'discount_percent',
+        :'excluded_items' => :'excluded_items',
+        :'items' => :'items',
+        :'limit' => :'limit'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'discount_percent' => :'Float',
+        :'excluded_items' => :'Array<String>',
+        :'items' => :'Array<String>',
+        :'limit' => :'Integer'
+      }
+    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?(:'discount_percent')
+        self.discount_percent = attributes[:'discount_percent']
+      end
+
+      if attributes.has_key?(:'excluded_items')
+        if (value = attributes[:'excluded_items']).is_a?(Array)
+          self.excluded_items = value
+        end
+      end
+
+      if attributes.has_key?(:'items')
+        if (value = attributes[:'items']).is_a?(Array)
+          self.items = value
+        end
+      end
+
+      if attributes.has_key?(:'limit')
+        self.limit = attributes[:'limit']
+      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 &&
+          discount_percent == o.discount_percent &&
+          excluded_items == o.excluded_items &&
+          items == o.items &&
+          limit == o.limit
+    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
+      [discount_percent, excluded_items, items, limit].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/customer_loyalty.rb

@@ -20,6 +20,9 @@ module UltracartClient
     # Ledger entries
     attr_accessor :ledger_entries
 
+    # Pending Points
+    attr_accessor :pending_points
+
     # Redemptions
     attr_accessor :redemptions
 
@@ -28,6 +31,7 @@ module UltracartClient
       {
         :'current_points' => :'current_points',
         :'ledger_entries' => :'ledger_entries',
+        :'pending_points' => :'pending_points',
         :'redemptions' => :'redemptions'
       }
     end
@@ -37,6 +41,7 @@ module UltracartClient
       {
         :'current_points' => :'Integer',
         :'ledger_entries' => :'Array<CustomerLoyaltyLedger>',
+        :'pending_points' => :'Integer',
         :'redemptions' => :'Array<CustomerLoyaltyRedemption>'
       }
     end
@@ -59,6 +64,10 @@ module UltracartClient
         end
       end
 
+      if attributes.has_key?(:'pending_points')
+        self.pending_points = attributes[:'pending_points']
+      end
+
       if attributes.has_key?(:'redemptions')
         if (value = attributes[:'redemptions']).is_a?(Array)
           self.redemptions = value
@@ -86,6 +95,7 @@ module UltracartClient
       self.class == o.class &&
           current_points == o.current_points &&
           ledger_entries == o.ledger_entries &&
+          pending_points == o.pending_points &&
           redemptions == o.redemptions
     end
 
@@ -98,7 +108,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [current_points, ledger_entries, redemptions].hash
+      [current_points, ledger_entries, pending_points, redemptions].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/email_campaign.rb

@@ -29,9 +29,12 @@ module UltracartClient
     # Email communication sequence UUID
     attr_accessor :email_communication_sequence_uuid
 
-    # True if the customer should end the flow once they purchase
+    # True if the customer should end the flow once they purchase from this campaign
     attr_accessor :end_once_customer_purchases
 
+    # True if the customer should end the flow once they purchase from anywhere
+    attr_accessor :end_once_customer_purchases_anywhere
+
     # Campaign folder UUID.  Null for uncategorized
     attr_accessor :esp_campaign_folder_uuid
 
@@ -92,6 +95,7 @@ module UltracartClient
         :'email_campaign_uuid' => :'email_campaign_uuid',
         :'email_communication_sequence_uuid' => :'email_communication_sequence_uuid',
         :'end_once_customer_purchases' => :'end_once_customer_purchases',
+        :'end_once_customer_purchases_anywhere' => :'end_once_customer_purchases_anywhere',
         :'esp_campaign_folder_uuid' => :'esp_campaign_folder_uuid',
         :'esp_domain_user' => :'esp_domain_user',
         :'esp_domain_uuid' => :'esp_domain_uuid',
@@ -121,6 +125,7 @@ module UltracartClient
         :'email_campaign_uuid' => :'String',
         :'email_communication_sequence_uuid' => :'String',
         :'end_once_customer_purchases' => :'BOOLEAN',
+        :'end_once_customer_purchases_anywhere' => :'BOOLEAN',
         :'esp_campaign_folder_uuid' => :'String',
         :'esp_domain_user' => :'String',
         :'esp_domain_uuid' => :'String',
@@ -173,6 +178,10 @@ module UltracartClient
         self.end_once_customer_purchases = attributes[:'end_once_customer_purchases']
       end
 
+      if attributes.has_key?(:'end_once_customer_purchases_anywhere')
+        self.end_once_customer_purchases_anywhere = attributes[:'end_once_customer_purchases_anywhere']
+      end
+
       if attributes.has_key?(:'esp_campaign_folder_uuid')
         self.esp_campaign_folder_uuid = attributes[:'esp_campaign_folder_uuid']
       end
@@ -283,6 +292,7 @@ module UltracartClient
           email_campaign_uuid == o.email_campaign_uuid &&
           email_communication_sequence_uuid == o.email_communication_sequence_uuid &&
           end_once_customer_purchases == o.end_once_customer_purchases &&
+          end_once_customer_purchases_anywhere == o.end_once_customer_purchases_anywhere &&
           esp_campaign_folder_uuid == o.esp_campaign_folder_uuid &&
           esp_domain_user == o.esp_domain_user &&
           esp_domain_uuid == o.esp_domain_uuid &&
@@ -311,7 +321,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [click_rate_formatted, created_dts, deleted, email_campaign_uuid, email_communication_sequence_uuid, end_once_customer_purchases, esp_campaign_folder_uuid, esp_domain_user, esp_domain_uuid, esp_friendly_name, library_item_oid, memberships, merchant_id, name, open_rate_formatted, prevent_sending_due_to_spam, revenue_formatted, revenue_per_customer_formatted, scheduled_dts, screenshot_large_full_url, status, status_dts, storefront_oid].hash
+      [click_rate_formatted, created_dts, deleted, email_campaign_uuid, email_communication_sequence_uuid, end_once_customer_purchases, end_once_customer_purchases_anywhere, esp_campaign_folder_uuid, esp_domain_user, esp_domain_uuid, esp_friendly_name, library_item_oid, memberships, merchant_id, name, open_rate_formatted, prevent_sending_due_to_spam, revenue_formatted, revenue_per_customer_formatted, scheduled_dts, screenshot_large_full_url, status, status_dts, storefront_oid].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/email_flow.rb

@@ -35,9 +35,12 @@ module UltracartClient
     # Email flow UUID
     attr_accessor :email_flow_uuid
 
-    # True if the customer should end the flow once they purchase
+    # True if the customer should end the flow once they purchase from an email on this flow
     attr_accessor :end_once_customer_purchases
 
+    # True if the customer should end the flow once they purchase from any source
+    attr_accessor :end_once_customer_purchases_anywhere
+
     # Number of enrolled customers.
     attr_accessor :enrolled_customers
 
@@ -106,6 +109,7 @@ module UltracartClient
         :'email_communication_sequence_uuid' => :'email_communication_sequence_uuid',
         :'email_flow_uuid' => :'email_flow_uuid',
         :'end_once_customer_purchases' => :'end_once_customer_purchases',
+        :'end_once_customer_purchases_anywhere' => :'end_once_customer_purchases_anywhere',
         :'enrolled_customers' => :'enrolled_customers',
         :'esp_domain_user' => :'esp_domain_user',
         :'esp_domain_uuid' => :'esp_domain_uuid',
@@ -139,6 +143,7 @@ module UltracartClient
         :'email_communication_sequence_uuid' => :'String',
         :'email_flow_uuid' => :'String',
         :'end_once_customer_purchases' => :'BOOLEAN',
+        :'end_once_customer_purchases_anywhere' => :'BOOLEAN',
         :'enrolled_customers' => :'Integer',
         :'esp_domain_user' => :'String',
         :'esp_domain_uuid' => :'String',
@@ -201,6 +206,10 @@ module UltracartClient
         self.end_once_customer_purchases = attributes[:'end_once_customer_purchases']
       end
 
+      if attributes.has_key?(:'end_once_customer_purchases_anywhere')
+        self.end_once_customer_purchases_anywhere = attributes[:'end_once_customer_purchases_anywhere']
+      end
+
       if attributes.has_key?(:'enrolled_customers')
         self.enrolled_customers = attributes[:'enrolled_customers']
       end
@@ -319,6 +328,7 @@ module UltracartClient
           email_communication_sequence_uuid == o.email_communication_sequence_uuid &&
           email_flow_uuid == o.email_flow_uuid &&
           end_once_customer_purchases == o.end_once_customer_purchases &&
+          end_once_customer_purchases_anywhere == o.end_once_customer_purchases_anywhere &&
           enrolled_customers == o.enrolled_customers &&
           esp_domain_user == o.esp_domain_user &&
           esp_domain_uuid == o.esp_domain_uuid &&
@@ -349,7 +359,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [allow_multiple_concurrent_enrollments, back_populating, click_rate_formatted, created_dts, deleted, email_communication_sequence_uuid, email_flow_uuid, end_once_customer_purchases, enrolled_customers, esp_domain_user, esp_domain_uuid, esp_flow_folder_uuid, esp_friendly_name, filter_profile_equation_json, library_item_oid, merchant_id, name, open_rate_formatted, revenue_formatted, revenue_per_customer_formatted, screenshot_large_full_url, status, status_dts, storefront_oid, trigger_parameter, trigger_parameter_name, trigger_type].hash
+      [allow_multiple_concurrent_enrollments, back_populating, click_rate_formatted, created_dts, deleted, email_communication_sequence_uuid, email_flow_uuid, end_once_customer_purchases, end_once_customer_purchases_anywhere, enrolled_customers, esp_domain_user, esp_domain_uuid, esp_flow_folder_uuid, esp_friendly_name, filter_profile_equation_json, library_item_oid, merchant_id, name, open_rate_formatted, revenue_formatted, revenue_per_customer_formatted, screenshot_large_full_url, status, status_dts, storefront_oid, trigger_parameter, trigger_parameter_name, trigger_type].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/library_item_attribute.rb

@@ -14,8 +14,6 @@ require 'date'
 
 module UltracartClient
   class LibraryItemAttribute
-    attr_accessor :library_item_oid
-
     attr_accessor :name
 
     attr_accessor :value
@@ -23,7 +21,6 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'library_item_oid' => :'libraryItemOid',
         :'name' => :'name',
         :'value' => :'value'
       }
@@ -32,7 +29,6 @@ module UltracartClient
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'library_item_oid' => :'Integer',
         :'name' => :'String',
         :'value' => :'String'
       }
@@ -46,10 +42,6 @@ module UltracartClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'libraryItemOid')
-        self.library_item_oid = attributes[:'libraryItemOid']
-      end
-
       if attributes.has_key?(:'name')
         self.name = attributes[:'name']
       end
@@ -77,7 +69,6 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          library_item_oid == o.library_item_oid &&
           name == o.name &&
           value == o.value
     end
@@ -91,7 +82,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [library_item_oid, name, value].hash
+      [name, value].hash
     end
 
     # Builds the object from hash