=begin #Klaviyo API #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. The version of the OpenAPI document: 2023-02-22 Contact: developers@klaviyo.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.2.1 =end require 'date' require 'time' module KlaviyoAPI class EmailMarketing # The consent status for email marketing. attr_accessor :consent # The timestamp when consent record or updated for email marketing, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). attr_accessor :timestamp # The method by which the profile was subscribed to email marketing. attr_accessor :method # Additional details about the method by which the profile was subscribed to SMS marketing. This may be empty if no details were provided. attr_accessor :method_detail # Additional detail provided by the caller when the profile was subscribed. This may be empty if no details were provided. attr_accessor :custom_method_detail # Whether the profile was subscribed to email marketing using a double opt-in. attr_accessor :double_optin attr_accessor :suppressions attr_accessor :list_suppressions # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'consent' => :'consent', :'timestamp' => :'timestamp', :'method' => :'method', :'method_detail' => :'method_detail', :'custom_method_detail' => :'custom_method_detail', :'double_optin' => :'double_optin', :'suppressions' => :'suppressions', :'list_suppressions' => :'list_suppressions' } 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 { :'consent' => :'String', :'timestamp' => :'Time', :'method' => :'String', :'method_detail' => :'String', :'custom_method_detail' => :'String', :'double_optin' => :'Boolean', :'suppressions' => :'EmailMarketingSuppression', :'list_suppressions' => :'EmailMarketingListSuppression' } 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 `KlaviyoAPI::EmailMarketing` 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 `KlaviyoAPI::EmailMarketing`. 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?(:'consent') self.consent = attributes[:'consent'] end if attributes.key?(:'timestamp') self.timestamp = attributes[:'timestamp'] end if attributes.key?(:'method') self.method = attributes[:'method'] end if attributes.key?(:'method_detail') self.method_detail = attributes[:'method_detail'] end if attributes.key?(:'custom_method_detail') self.custom_method_detail = attributes[:'custom_method_detail'] end if attributes.key?(:'double_optin') self.double_optin = attributes[:'double_optin'] end if attributes.key?(:'suppressions') self.suppressions = attributes[:'suppressions'] end if attributes.key?(:'list_suppressions') self.list_suppressions = attributes[:'list_suppressions'] 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 if @consent.nil? invalid_properties.push('invalid value for "consent", consent cannot be nil.') end if @method.nil? invalid_properties.push('invalid value for "method", method cannot be nil.') end 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? return false if @consent.nil? return false if @method.nil? 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 && consent == o.consent && timestamp == o.timestamp && method == o.method && method_detail == o.method_detail && custom_method_detail == o.custom_method_detail && double_optin == o.double_optin && suppressions == o.suppressions && list_suppressions == o.list_suppressions 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 [consent, timestamp, method, method_detail, custom_method_detail, double_optin, suppressions, list_suppressions].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<(?.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?.+?), (?.+)>\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 = KlaviyoAPI.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