ultracart_api 3.9.4 → 3.9.7

data/lib/ultracart_api/models/adjust_internal_certificate_request.rb

@@ -0,0 +1,235 @@
+=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 AdjustInternalCertificateRequest
+    # The adjustment amount
+    attr_accessor :adjustment_amount
+
+    # Description of this adjustment, 50 characters max
+    attr_accessor :description
+
+    # Optional timestamp for the adjustment, defaults to current time
+    attr_accessor :entry_dts
+
+    # Optional expiration days from the entry_dts when these adjustment becomes worthless
+    attr_accessor :expiration_days
+
+    # Optional order id if this adjustment is related to a particular order
+    attr_accessor :order_id
+
+    # Optional days required for this adjustment to vest
+    attr_accessor :vesting_days
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'adjustment_amount' => :'adjustment_amount',
+        :'description' => :'description',
+        :'entry_dts' => :'entry_dts',
+        :'expiration_days' => :'expiration_days',
+        :'order_id' => :'order_id',
+        :'vesting_days' => :'vesting_days'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'adjustment_amount' => :'Float',
+        :'description' => :'String',
+        :'entry_dts' => :'String',
+        :'expiration_days' => :'Integer',
+        :'order_id' => :'String',
+        :'vesting_days' => :'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?(:'adjustment_amount')
+        self.adjustment_amount = attributes[:'adjustment_amount']
+      end
+
+      if attributes.has_key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.has_key?(:'entry_dts')
+        self.entry_dts = attributes[:'entry_dts']
+      end
+
+      if attributes.has_key?(:'expiration_days')
+        self.expiration_days = attributes[:'expiration_days']
+      end
+
+      if attributes.has_key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+
+      if attributes.has_key?(:'vesting_days')
+        self.vesting_days = attributes[:'vesting_days']
+      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 &&
+          adjustment_amount == o.adjustment_amount &&
+          description == o.description &&
+          entry_dts == o.entry_dts &&
+          expiration_days == o.expiration_days &&
+          order_id == o.order_id &&
+          vesting_days == o.vesting_days
+    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
+      [adjustment_amount, description, entry_dts, expiration_days, order_id, vesting_days].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/adjust_internal_certificate_response.rb

@@ -0,0 +1,232 @@
+=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 AdjustInternalCertificateResponse
+    # The adjustment amount
+    attr_accessor :adjustment_amount
+
+    # The balance amount after the adjustment was made
+    attr_accessor :balance_amount
+
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'adjustment_amount' => :'adjustment_amount',
+        :'balance_amount' => :'balance_amount',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'adjustment_amount' => :'Float',
+        :'balance_amount' => :'Float',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'BOOLEAN',
+        :'warning' => :'Warning'
+      }
+    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?(:'adjustment_amount')
+        self.adjustment_amount = attributes[:'adjustment_amount']
+      end
+
+      if attributes.has_key?(:'balance_amount')
+        self.balance_amount = attributes[:'balance_amount']
+      end
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_key?(:'warning')
+        self.warning = attributes[:'warning']
+      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 &&
+          adjustment_amount == o.adjustment_amount &&
+          balance_amount == o.balance_amount &&
+          error == o.error &&
+          metadata == o.metadata &&
+          success == o.success &&
+          warning == o.warning
+    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
+      [adjustment_amount, balance_amount, error, metadata, success, warning].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/auto_order.rb

@@ -26,6 +26,9 @@ module UltracartClient
     # True if the auto order was canceled because the customer purchased a downgrade item
     attr_accessor :cancel_downgrade
 
+    # The reason this auto order was canceled by either merchant or customer
+    attr_accessor :cancel_reason
+
     # True if the auto order was canceled because the customer purchased an upgrade item
     attr_accessor :cancel_upgrade
 
@@ -105,6 +108,7 @@ module UltracartClient
         :'auto_order_oid' => :'auto_order_oid',
         :'cancel_after_next_x_orders' => :'cancel_after_next_x_orders',
         :'cancel_downgrade' => :'cancel_downgrade',
+        :'cancel_reason' => :'cancel_reason',
         :'cancel_upgrade' => :'cancel_upgrade',
         :'canceled_by_user' => :'canceled_by_user',
         :'canceled_dts' => :'canceled_dts',
@@ -132,6 +136,7 @@ module UltracartClient
         :'auto_order_oid' => :'Integer',
         :'cancel_after_next_x_orders' => :'Integer',
         :'cancel_downgrade' => :'BOOLEAN',
+        :'cancel_reason' => :'String',
         :'cancel_upgrade' => :'BOOLEAN',
         :'canceled_by_user' => :'String',
         :'canceled_dts' => :'String',
@@ -176,6 +181,10 @@ module UltracartClient
         self.cancel_downgrade = attributes[:'cancel_downgrade']
       end
 
+      if attributes.has_key?(:'cancel_reason')
+        self.cancel_reason = attributes[:'cancel_reason']
+      end
+
       if attributes.has_key?(:'cancel_upgrade')
         self.cancel_upgrade = attributes[:'cancel_upgrade']
       end
@@ -285,6 +294,7 @@ module UltracartClient
           auto_order_oid == o.auto_order_oid &&
           cancel_after_next_x_orders == o.cancel_after_next_x_orders &&
           cancel_downgrade == o.cancel_downgrade &&
+          cancel_reason == o.cancel_reason &&
           cancel_upgrade == o.cancel_upgrade &&
           canceled_by_user == o.canceled_by_user &&
           canceled_dts == o.canceled_dts &&
@@ -313,7 +323,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, logs, next_attempt, original_order, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].hash
+      [auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, logs, next_attempt, original_order, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/customer_loyalty.rb

@@ -14,9 +14,11 @@ require 'date'
 
 module UltracartClient
   class CustomerLoyalty
-    # Current Points
+    # Current points
     attr_accessor :current_points
 
+    attr_accessor :internal_gift_certificate
+
     # Loyalty Cashback / Store credit balance (internal gift certificate balance)
     attr_accessor :internal_gift_certificate_balance
 
@@ -36,6 +38,7 @@ module UltracartClient
     def self.attribute_map
       {
         :'current_points' => :'current_points',
+        :'internal_gift_certificate' => :'internal_gift_certificate',
         :'internal_gift_certificate_balance' => :'internal_gift_certificate_balance',
         :'internal_gift_certificate_oid' => :'internal_gift_certificate_oid',
         :'ledger_entries' => :'ledger_entries',
@@ -48,6 +51,7 @@ module UltracartClient
     def self.swagger_types
       {
         :'current_points' => :'Integer',
+        :'internal_gift_certificate' => :'GiftCertificate',
         :'internal_gift_certificate_balance' => :'String',
         :'internal_gift_certificate_oid' => :'Integer',
         :'ledger_entries' => :'Array<CustomerLoyaltyLedger>',
@@ -68,6 +72,10 @@ module UltracartClient
         self.current_points = attributes[:'current_points']
       end
 
+      if attributes.has_key?(:'internal_gift_certificate')
+        self.internal_gift_certificate = attributes[:'internal_gift_certificate']
+      end
+
       if attributes.has_key?(:'internal_gift_certificate_balance')
         self.internal_gift_certificate_balance = attributes[:'internal_gift_certificate_balance']
       end
@@ -112,6 +120,7 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           current_points == o.current_points &&
+          internal_gift_certificate == o.internal_gift_certificate &&
           internal_gift_certificate_balance == o.internal_gift_certificate_balance &&
           internal_gift_certificate_oid == o.internal_gift_certificate_oid &&
           ledger_entries == o.ledger_entries &&
@@ -128,7 +137,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [current_points, internal_gift_certificate_balance, internal_gift_certificate_oid, ledger_entries, pending_points, redemptions].hash
+      [current_points, internal_gift_certificate, internal_gift_certificate_balance, internal_gift_certificate_oid, ledger_entries, pending_points, redemptions].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/email_commseq_email.rb

@@ -44,6 +44,9 @@ module UltracartClient
     # If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before.  This value is used to determine if a library item should be inserted or updated.
     attr_accessor :library_item_oid
 
+    # True if email links should contain magic link tokens to log the customer in automatically
+    attr_accessor :magic_link
+
     # Merchant ID
     attr_accessor :merchant_id
 
@@ -102,6 +105,7 @@ module UltracartClient
         :'filter_profile_equation_json' => :'filter_profile_equation_json',
         :'individually_render' => :'individually_render',
         :'library_item_oid' => :'library_item_oid',
+        :'magic_link' => :'magic_link',
         :'merchant_id' => :'merchant_id',
         :'pending_review' => :'pending_review',
         :'preview_text' => :'preview_text',
@@ -133,6 +137,7 @@ module UltracartClient
         :'filter_profile_equation_json' => :'String',
         :'individually_render' => :'BOOLEAN',
         :'library_item_oid' => :'Integer',
+        :'magic_link' => :'BOOLEAN',
         :'merchant_id' => :'String',
         :'pending_review' => :'BOOLEAN',
         :'preview_text' => :'String',
@@ -199,6 +204,10 @@ module UltracartClient
         self.library_item_oid = attributes[:'library_item_oid']
       end
 
+      if attributes.has_key?(:'magic_link')
+        self.magic_link = attributes[:'magic_link']
+      end
+
       if attributes.has_key?(:'merchant_id')
         self.merchant_id = attributes[:'merchant_id']
       end
@@ -288,6 +297,7 @@ module UltracartClient
           filter_profile_equation_json == o.filter_profile_equation_json &&
           individually_render == o.individually_render &&
           library_item_oid == o.library_item_oid &&
+          magic_link == o.magic_link &&
           merchant_id == o.merchant_id &&
           pending_review == o.pending_review &&
           preview_text == o.preview_text &&
@@ -314,7 +324,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [deleted, edited_by_user, email_communication_sequence_email_uuid, email_communication_sequence_uuid, email_container_cjson, email_container_cjson_last_modified_dts, email_template_vm_path, filter_profile_equation_json, individually_render, library_item_oid, merchant_id, pending_review, preview_text, rejected, requires_review, screenshot_large_full_url, screenshot_large_viewport_url, screenshot_small_full_url, screenshot_small_viewport_url, smart_sending, storefront_oid, subject, suspended_for_spam, transactional_email, version].hash
+      [deleted, edited_by_user, email_communication_sequence_email_uuid, email_communication_sequence_uuid, email_container_cjson, email_container_cjson_last_modified_dts, email_template_vm_path, filter_profile_equation_json, individually_render, library_item_oid, magic_link, merchant_id, pending_review, preview_text, rejected, requires_review, screenshot_large_full_url, screenshot_large_viewport_url, screenshot_small_full_url, screenshot_small_viewport_url, smart_sending, storefront_oid, subject, suspended_for_spam, transactional_email, version].hash
     end
 
     # Builds the object from hash