ultracart_api 4.1.121 → 4.1.124

data/lib/ultracart_api/models/customer_email_suppression_response.rb

@@ -0,0 +1,256 @@
+=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 CustomerEmailSuppressionResponse
+    attr_accessor :email_suppression
+
+    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
+      {
+        :'email_suppression' => :'email_suppression',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    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
+      {
+        :'email_suppression' => :'CustomerEmailSuppressionResult',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'Boolean',
+        :'warning' => :'Warning'
+      }
+    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::CustomerEmailSuppressionResponse` 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::CustomerEmailSuppressionResponse`. 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?(:'email_suppression')
+        self.email_suppression = attributes[:'email_suppression']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.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 &&
+          email_suppression == o.email_suppression &&
+          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 [Integer] Hash code
+    def hash
+      [email_suppression, 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 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/customer_email_suppression_result.rb

@@ -0,0 +1,329 @@
+=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 CustomerEmailSuppressionResult
+    # True only if this call actually removed bounce suppression.  Bounce has no per-customer flag, so there is no corresponding state field.
+    attr_accessor :bounce_cleared
+
+    # The customer profile oid that was operated on
+    attr_accessor :customer_profile_oid
+
+    # The email address that was operated on
+    attr_accessor :email
+
+    # True only if every requested suppression surface was successfully cleared.  When false, see esp_warning -- the profile was still modified.
+    attr_accessor :esp_suppression_removed
+
+    # Human readable explanation when esp_suppression_removed is false.  Suitable for display to a support agent.
+    attr_accessor :esp_warning
+
+    # True only if this call actually changed the global unsubscribe flag.  False if it was already clear.
+    attr_accessor :global_unsubscribe_cleared
+
+    # Global unsubscribe state AFTER this call
+    attr_accessor :global_unsubscribed
+
+    # Global unsubscribe timestamp after this call.  Nulled when cleared; the prior value is retained on the audit record.
+    attr_accessor :global_unsubscribed_dts
+
+    # Spam complaint state AFTER this call
+    attr_accessor :spam_complaint
+
+    # True only if this call actually changed the spam complaint flag.  False if it was already clear.
+    attr_accessor :spam_complaint_cleared
+
+    # Spam complaint timestamp after this call.  Nulled when cleared; the prior value is retained on the audit record.
+    attr_accessor :spam_complaint_dts
+
+    attr_accessor :suppression_surfaces
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'bounce_cleared' => :'bounce_cleared',
+        :'customer_profile_oid' => :'customer_profile_oid',
+        :'email' => :'email',
+        :'esp_suppression_removed' => :'esp_suppression_removed',
+        :'esp_warning' => :'esp_warning',
+        :'global_unsubscribe_cleared' => :'global_unsubscribe_cleared',
+        :'global_unsubscribed' => :'global_unsubscribed',
+        :'global_unsubscribed_dts' => :'global_unsubscribed_dts',
+        :'spam_complaint' => :'spam_complaint',
+        :'spam_complaint_cleared' => :'spam_complaint_cleared',
+        :'spam_complaint_dts' => :'spam_complaint_dts',
+        :'suppression_surfaces' => :'suppression_surfaces'
+      }
+    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
+      {
+        :'bounce_cleared' => :'Boolean',
+        :'customer_profile_oid' => :'Integer',
+        :'email' => :'String',
+        :'esp_suppression_removed' => :'Boolean',
+        :'esp_warning' => :'String',
+        :'global_unsubscribe_cleared' => :'Boolean',
+        :'global_unsubscribed' => :'Boolean',
+        :'global_unsubscribed_dts' => :'String',
+        :'spam_complaint' => :'Boolean',
+        :'spam_complaint_cleared' => :'Boolean',
+        :'spam_complaint_dts' => :'String',
+        :'suppression_surfaces' => :'EmailSuppressionSurfaces'
+      }
+    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::CustomerEmailSuppressionResult` 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::CustomerEmailSuppressionResult`. 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?(:'bounce_cleared')
+        self.bounce_cleared = attributes[:'bounce_cleared']
+      end
+
+      if attributes.key?(:'customer_profile_oid')
+        self.customer_profile_oid = attributes[:'customer_profile_oid']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'esp_suppression_removed')
+        self.esp_suppression_removed = attributes[:'esp_suppression_removed']
+      end
+
+      if attributes.key?(:'esp_warning')
+        self.esp_warning = attributes[:'esp_warning']
+      end
+
+      if attributes.key?(:'global_unsubscribe_cleared')
+        self.global_unsubscribe_cleared = attributes[:'global_unsubscribe_cleared']
+      end
+
+      if attributes.key?(:'global_unsubscribed')
+        self.global_unsubscribed = attributes[:'global_unsubscribed']
+      end
+
+      if attributes.key?(:'global_unsubscribed_dts')
+        self.global_unsubscribed_dts = attributes[:'global_unsubscribed_dts']
+      end
+
+      if attributes.key?(:'spam_complaint')
+        self.spam_complaint = attributes[:'spam_complaint']
+      end
+
+      if attributes.key?(:'spam_complaint_cleared')
+        self.spam_complaint_cleared = attributes[:'spam_complaint_cleared']
+      end
+
+      if attributes.key?(:'spam_complaint_dts')
+        self.spam_complaint_dts = attributes[:'spam_complaint_dts']
+      end
+
+      if attributes.key?(:'suppression_surfaces')
+        self.suppression_surfaces = attributes[:'suppression_surfaces']
+      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 &&
+          bounce_cleared == o.bounce_cleared &&
+          customer_profile_oid == o.customer_profile_oid &&
+          email == o.email &&
+          esp_suppression_removed == o.esp_suppression_removed &&
+          esp_warning == o.esp_warning &&
+          global_unsubscribe_cleared == o.global_unsubscribe_cleared &&
+          global_unsubscribed == o.global_unsubscribed &&
+          global_unsubscribed_dts == o.global_unsubscribed_dts &&
+          spam_complaint == o.spam_complaint &&
+          spam_complaint_cleared == o.spam_complaint_cleared &&
+          spam_complaint_dts == o.spam_complaint_dts &&
+          suppression_surfaces == o.suppression_surfaces
+    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
+      [bounce_cleared, customer_profile_oid, email, esp_suppression_removed, esp_warning, global_unsubscribe_cleared, global_unsubscribed, global_unsubscribed_dts, spam_complaint, spam_complaint_cleared, spam_complaint_dts, suppression_surfaces].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/email_settings.rb

@@ -24,6 +24,9 @@ module UltracartClient
     # Emails per month allowed
     attr_accessor :emails_per_month
 
+    # If machine open should be ignored
+    attr_accessor :machine_open_ignore
+
     attr_accessor :marketing_esp_domain_user
 
     attr_accessor :marketing_esp_domain_uuid
@@ -64,6 +67,7 @@ module UltracartClient
         :'emails_per_day' => :'emails_per_day',
         :'emails_per_hour' => :'emails_per_hour',
         :'emails_per_month' => :'emails_per_month',
+        :'machine_open_ignore' => :'machine_open_ignore',
         :'marketing_esp_domain_user' => :'marketing_esp_domain_user',
         :'marketing_esp_domain_uuid' => :'marketing_esp_domain_uuid',
         :'marketing_esp_friendly_name' => :'marketing_esp_friendly_name',
@@ -94,6 +98,7 @@ module UltracartClient
         :'emails_per_day' => :'Integer',
         :'emails_per_hour' => :'Integer',
         :'emails_per_month' => :'Integer',
+        :'machine_open_ignore' => :'Boolean',
         :'marketing_esp_domain_user' => :'String',
         :'marketing_esp_domain_uuid' => :'String',
         :'marketing_esp_friendly_name' => :'String',
@@ -146,6 +151,10 @@ module UltracartClient
         self.emails_per_month = attributes[:'emails_per_month']
       end
 
+      if attributes.key?(:'machine_open_ignore')
+        self.machine_open_ignore = attributes[:'machine_open_ignore']
+      end
+
       if attributes.key?(:'marketing_esp_domain_user')
         self.marketing_esp_domain_user = attributes[:'marketing_esp_domain_user']
       end
@@ -232,6 +241,7 @@ module UltracartClient
           emails_per_day == o.emails_per_day &&
           emails_per_hour == o.emails_per_hour &&
           emails_per_month == o.emails_per_month &&
+          machine_open_ignore == o.machine_open_ignore &&
           marketing_esp_domain_user == o.marketing_esp_domain_user &&
           marketing_esp_domain_uuid == o.marketing_esp_domain_uuid &&
           marketing_esp_friendly_name == o.marketing_esp_friendly_name &&
@@ -259,7 +269,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [emails_per_day, emails_per_hour, emails_per_month, marketing_esp_domain_user, marketing_esp_domain_uuid, marketing_esp_friendly_name, postcard_from_address1, postcard_from_address2, postcard_from_city, postcard_from_name, postcard_from_postal_code, postcard_from_state, require_order_within_last, reviews_io_configured, sms_esp_twilio_uuid, sms_phone_number, transactional_esp_domain_user, transactional_esp_domain_uuid, transactional_esp_friendly_name].hash
+      [emails_per_day, emails_per_hour, emails_per_month, machine_open_ignore, marketing_esp_domain_user, marketing_esp_domain_uuid, marketing_esp_friendly_name, postcard_from_address1, postcard_from_address2, postcard_from_city, postcard_from_name, postcard_from_postal_code, postcard_from_state, require_order_within_last, reviews_io_configured, sms_esp_twilio_uuid, sms_phone_number, transactional_esp_domain_user, transactional_esp_domain_uuid, transactional_esp_friendly_name].hash
     end
 
     # Builds the object from hash