ultracart_api 3.0.74 → 3.1.2

data/lib/ultracart_api/api/storefront_api.rb

@@ -19,6 +19,19 @@ module UltracartClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::StorefrontApi.new(api_client)
+    end
+
     # Add to library
     # @param add_library_request New library item request
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/api/tax_api.rb

@@ -19,6 +19,19 @@ module UltracartClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::TaxApi.new(api_client)
+    end
+
     # Deletes a Self tax provider city
     # Deletes a Self tax provider city. 
     # @param city The city being deleted.

data/lib/ultracart_api/api/user_api.rb

@@ -19,6 +19,19 @@ module UltracartClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::UserApi.new(api_client)
+    end
+
     # Delete a group
     # Delete a group on the UltraCart account. 
     # @param group_oid The group_oid to delete.

data/lib/ultracart_api/api/webhook_api.rb

@@ -19,6 +19,19 @@ module UltracartClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::WebhookApi.new(api_client)
+    end
+
     # Delete a webhook
     # Delete a webhook on the UltraCart account. 
     # @param webhook_oid The webhook oid to delete.

data/lib/ultracart_api/models/coupon_tiered_amount_off_item.rb

@@ -17,7 +17,7 @@ module UltracartClient
     # The item being discounted by this coupon.
     attr_accessor :item
 
-    # The maximum amount of total discount by this coupon.
+    # The maximum number of discounted items.
     attr_accessor :limit
 
     # A list of discount tiers.

data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb

@@ -17,7 +17,7 @@ module UltracartClient
     # A list of items of which at least one must be purchased for coupon to be valid.
     attr_accessor :items
 
-    # The maximum amount of total discount by this coupon.
+    # The (optional) maximum quantity of discounted items.
     attr_accessor :limit
 
     # A list of discount tiers.

data/lib/ultracart_api/models/email_plan.rb

@@ -18,6 +18,8 @@ module UltracartClient
 
     attr_accessor :additional_emails
 
+    attr_accessor :additional_fee
+
     attr_accessor :allow_list_import
 
     attr_accessor :allow_tracking_emails
@@ -51,6 +53,7 @@ module UltracartClient
       {
         :'additional_customers' => :'additional_customers',
         :'additional_emails' => :'additional_emails',
+        :'additional_fee' => :'additional_fee',
         :'allow_list_import' => :'allow_list_import',
         :'allow_tracking_emails' => :'allow_tracking_emails',
         :'customer_tiers' => :'customer_tiers',
@@ -73,6 +76,7 @@ module UltracartClient
       {
         :'additional_customers' => :'Integer',
         :'additional_emails' => :'Integer',
+        :'additional_fee' => :'Float',
         :'allow_list_import' => :'BOOLEAN',
         :'allow_tracking_emails' => :'BOOLEAN',
         :'customer_tiers' => :'Array<EmailPlanAdditional>',
@@ -106,6 +110,10 @@ module UltracartClient
         self.additional_emails = attributes[:'additional_emails']
       end
 
+      if attributes.has_key?(:'additional_fee')
+        self.additional_fee = attributes[:'additional_fee']
+      end
+
       if attributes.has_key?(:'allow_list_import')
         self.allow_list_import = attributes[:'allow_list_import']
       end
@@ -185,6 +193,7 @@ module UltracartClient
       self.class == o.class &&
           additional_customers == o.additional_customers &&
           additional_emails == o.additional_emails &&
+          additional_fee == o.additional_fee &&
           allow_list_import == o.allow_list_import &&
           allow_tracking_emails == o.allow_tracking_emails &&
           customer_tiers == o.customer_tiers &&
@@ -210,7 +219,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [additional_customers, additional_emails, allow_list_import, allow_tracking_emails, customer_tiers, initial_sending_limits, plan_customers, plan_emails, plan_name, plan_name_formatted, require_order_within_last_days, revenue_percent, spam_percent_limit, total_customers, total_emails, upgrade_to].hash
+      [additional_customers, additional_emails, additional_fee, allow_list_import, allow_tracking_emails, customer_tiers, initial_sending_limits, plan_customers, plan_emails, plan_name, plan_name_formatted, require_order_within_last_days, revenue_percent, spam_percent_limit, total_customers, total_emails, upgrade_to].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/email_plan_additional.rb

@@ -14,12 +14,18 @@ require 'date'
 
 module UltracartClient
   class EmailPlanAdditional
+    attr_accessor :active
+
     attr_accessor :can_downgrade
 
     attr_accessor :can_upgrade
 
     attr_accessor :cost
 
+    attr_accessor :cost_change
+
+    attr_accessor :cost_change_formatted
+
     attr_accessor :cost_formatted
 
     attr_accessor :customers
@@ -29,9 +35,12 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'active' => :'active',
         :'can_downgrade' => :'can_downgrade',
         :'can_upgrade' => :'can_upgrade',
         :'cost' => :'cost',
+        :'cost_change' => :'cost_change',
+        :'cost_change_formatted' => :'cost_change_formatted',
         :'cost_formatted' => :'cost_formatted',
         :'customers' => :'customers',
         :'emails' => :'emails'
@@ -41,9 +50,12 @@ module UltracartClient
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'active' => :'BOOLEAN',
         :'can_downgrade' => :'BOOLEAN',
         :'can_upgrade' => :'BOOLEAN',
         :'cost' => :'Float',
+        :'cost_change' => :'Float',
+        :'cost_change_formatted' => :'String',
         :'cost_formatted' => :'String',
         :'customers' => :'Integer',
         :'emails' => :'Integer'
@@ -58,6 +70,10 @@ 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?(:'active')
+        self.active = attributes[:'active']
+      end
+
       if attributes.has_key?(:'can_downgrade')
         self.can_downgrade = attributes[:'can_downgrade']
       end
@@ -70,6 +86,14 @@ module UltracartClient
         self.cost = attributes[:'cost']
       end
 
+      if attributes.has_key?(:'cost_change')
+        self.cost_change = attributes[:'cost_change']
+      end
+
+      if attributes.has_key?(:'cost_change_formatted')
+        self.cost_change_formatted = attributes[:'cost_change_formatted']
+      end
+
       if attributes.has_key?(:'cost_formatted')
         self.cost_formatted = attributes[:'cost_formatted']
       end
@@ -101,9 +125,12 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          active == o.active &&
           can_downgrade == o.can_downgrade &&
           can_upgrade == o.can_upgrade &&
           cost == o.cost &&
+          cost_change == o.cost_change &&
+          cost_change_formatted == o.cost_change_formatted &&
           cost_formatted == o.cost_formatted &&
           customers == o.customers &&
           emails == o.emails
@@ -118,7 +145,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [can_downgrade, can_upgrade, cost, cost_formatted, customers, emails].hash
+      [active, can_downgrade, can_upgrade, cost, cost_change, cost_change_formatted, cost_formatted, customers, emails].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/email_verify_token_request.rb

@@ -0,0 +1,195 @@
+=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 EmailVerifyTokenRequest
+    # email
+    attr_accessor :email
+
+    # password
+    attr_accessor :password
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'password' => :'password'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'email' => :'String',
+        :'password' => :'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?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'password')
+        self.password = attributes[:'password']
+      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 &&
+          email == o.email &&
+          password == o.password
+    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
+      [email, password].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/email_verify_token_response.rb

@@ -0,0 +1,222 @@
+=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 EmailVerifyTokenResponse
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    # token
+    attr_accessor :token
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'token' => :'token',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'BOOLEAN',
+        :'token' => :'String',
+        :'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?(:'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?(:'token')
+        self.token = attributes[:'token']
+      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 &&
+          error == o.error &&
+          metadata == o.metadata &&
+          success == o.success &&
+          token == o.token &&
+          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
+      [error, metadata, success, token, 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