klaviyo-api-sdk 14.0.1 → 16.0.0

data/lib/klaviyo-api-sdk/models/version_properties.rb

@@ -0,0 +1,299 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  class VersionProperties
+    attr_accessor :side_image_settings
+
+    attr_accessor :click_outside_to_close
+
+    # Side image alignment enumeration.
+    attr_accessor :rule_based_trigger_evaluation
+
+    attr_accessor :record_utm_params_on_submit
+
+    attr_accessor :show_close_button
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'side_image_settings' => :'side_image_settings',
+        :'click_outside_to_close' => :'click_outside_to_close',
+        :'rule_based_trigger_evaluation' => :'rule_based_trigger_evaluation',
+        :'record_utm_params_on_submit' => :'record_utm_params_on_submit',
+        :'show_close_button' => :'show_close_button'
+      }
+    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
+      {
+        :'side_image_settings' => :'SideImageSettings',
+        :'click_outside_to_close' => :'Array<String>',
+        :'rule_based_trigger_evaluation' => :'String',
+        :'record_utm_params_on_submit' => :'Boolean',
+        :'show_close_button' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'click_outside_to_close',
+        :'rule_based_trigger_evaluation',
+      ])
+    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::VersionProperties` 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::VersionProperties`. 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?(:'side_image_settings')
+        self.side_image_settings = attributes[:'side_image_settings']
+      end
+
+      if attributes.key?(:'click_outside_to_close')
+        if (value = attributes[:'click_outside_to_close']).is_a?(Array)
+          self.click_outside_to_close = value
+        end
+      end
+
+      if attributes.key?(:'rule_based_trigger_evaluation')
+        self.rule_based_trigger_evaluation = attributes[:'rule_based_trigger_evaluation']
+      else
+        self.rule_based_trigger_evaluation = 'any'
+      end
+
+      if attributes.key?(:'record_utm_params_on_submit')
+        self.record_utm_params_on_submit = attributes[:'record_utm_params_on_submit']
+      else
+        self.record_utm_params_on_submit = false
+      end
+
+      if attributes.key?(:'show_close_button')
+        self.show_close_button = attributes[:'show_close_button']
+      else
+        self.show_close_button = true
+      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?
+      rule_based_trigger_evaluation_validator = EnumAttributeValidator.new('String', ["all", "any"])
+      return false unless rule_based_trigger_evaluation_validator.valid?(@rule_based_trigger_evaluation)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] rule_based_trigger_evaluation Object to be assigned
+    def rule_based_trigger_evaluation=(rule_based_trigger_evaluation)
+      validator = EnumAttributeValidator.new('String', ["all", "any"])
+      unless validator.valid?(rule_based_trigger_evaluation)
+        fail ArgumentError, "invalid value for \"rule_based_trigger_evaluation\", must be one of #{validator.allowable_values}."
+      end
+      @rule_based_trigger_evaluation = rule_based_trigger_evaluation
+    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 &&
+          side_image_settings == o.side_image_settings &&
+          click_outside_to_close == o.click_outside_to_close &&
+          rule_based_trigger_evaluation == o.rule_based_trigger_evaluation &&
+          record_utm_params_on_submit == o.record_utm_params_on_submit &&
+          show_close_button == o.show_close_button
+    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
+      [side_image_settings, click_outside_to_close, rule_based_trigger_evaluation, record_utm_params_on_submit, show_close_button].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 = 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

data/lib/klaviyo-api-sdk/models/version_styles.rb

@@ -0,0 +1,412 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  class VersionStyles
+    attr_accessor :wrap_content
+
+    attr_accessor :border_styles
+
+    attr_accessor :close_button
+
+    attr_accessor :margin
+
+    attr_accessor :padding
+
+    attr_accessor :minimum_height
+
+    # Version width enumeration.
+    attr_accessor :width
+
+    attr_accessor :custom_width
+
+    attr_accessor :background_image
+
+    attr_accessor :background_color
+
+    attr_accessor :input_styles
+
+    attr_accessor :drop_shadow
+
+    attr_accessor :overlay_color
+
+    attr_accessor :rich_text_styles
+
+    attr_accessor :mobile_overlay
+
+    attr_accessor :banner_styles
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'wrap_content' => :'wrap_content',
+        :'border_styles' => :'border_styles',
+        :'close_button' => :'close_button',
+        :'margin' => :'margin',
+        :'padding' => :'padding',
+        :'minimum_height' => :'minimum_height',
+        :'width' => :'width',
+        :'custom_width' => :'custom_width',
+        :'background_image' => :'background_image',
+        :'background_color' => :'background_color',
+        :'input_styles' => :'input_styles',
+        :'drop_shadow' => :'drop_shadow',
+        :'overlay_color' => :'overlay_color',
+        :'rich_text_styles' => :'rich_text_styles',
+        :'mobile_overlay' => :'mobile_overlay',
+        :'banner_styles' => :'banner_styles'
+      }
+    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
+      {
+        :'wrap_content' => :'Boolean',
+        :'border_styles' => :'BorderStyle',
+        :'close_button' => :'CloseButtonStyle',
+        :'margin' => :'Margin',
+        :'padding' => :'Padding',
+        :'minimum_height' => :'Integer',
+        :'width' => :'String',
+        :'custom_width' => :'Integer',
+        :'background_image' => :'BackgroundImage',
+        :'background_color' => :'String',
+        :'input_styles' => :'InputStyles',
+        :'drop_shadow' => :'DropShadow',
+        :'overlay_color' => :'String',
+        :'rich_text_styles' => :'RichTextStyles',
+        :'mobile_overlay' => :'MobileOverlay',
+        :'banner_styles' => :'BannerStyles'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'custom_width',
+        :'background_color',
+      ])
+    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::VersionStyles` 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::VersionStyles`. 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?(:'wrap_content')
+        self.wrap_content = attributes[:'wrap_content']
+      else
+        self.wrap_content = false
+      end
+
+      if attributes.key?(:'border_styles')
+        self.border_styles = attributes[:'border_styles']
+      end
+
+      if attributes.key?(:'close_button')
+        self.close_button = attributes[:'close_button']
+      end
+
+      if attributes.key?(:'margin')
+        self.margin = attributes[:'margin']
+      end
+
+      if attributes.key?(:'padding')
+        self.padding = attributes[:'padding']
+      end
+
+      if attributes.key?(:'minimum_height')
+        self.minimum_height = attributes[:'minimum_height']
+      else
+        self.minimum_height = 250
+      end
+
+      if attributes.key?(:'width')
+        self.width = attributes[:'width']
+      else
+        self.width = 'medium'
+      end
+
+      if attributes.key?(:'custom_width')
+        self.custom_width = attributes[:'custom_width']
+      end
+
+      if attributes.key?(:'background_image')
+        self.background_image = attributes[:'background_image']
+      end
+
+      if attributes.key?(:'background_color')
+        self.background_color = attributes[:'background_color']
+      else
+        self.background_color = '#FFFFFF'
+      end
+
+      if attributes.key?(:'input_styles')
+        self.input_styles = attributes[:'input_styles']
+      end
+
+      if attributes.key?(:'drop_shadow')
+        self.drop_shadow = attributes[:'drop_shadow']
+      end
+
+      if attributes.key?(:'overlay_color')
+        self.overlay_color = attributes[:'overlay_color']
+      else
+        self.overlay_color = 'rgba(20,20,20,0.6)'
+      end
+
+      if attributes.key?(:'rich_text_styles')
+        self.rich_text_styles = attributes[:'rich_text_styles']
+      end
+
+      if attributes.key?(:'mobile_overlay')
+        self.mobile_overlay = attributes[:'mobile_overlay']
+      end
+
+      if attributes.key?(:'banner_styles')
+        self.banner_styles = attributes[:'banner_styles']
+      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?
+      wrap_content_validator = EnumAttributeValidator.new('Boolean', ["false"])
+      return false unless wrap_content_validator.valid?(@wrap_content)
+      width_validator = EnumAttributeValidator.new('String', ["custom", "large", "medium", "small"])
+      return false unless width_validator.valid?(@width)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] wrap_content Object to be assigned
+    def wrap_content=(wrap_content)
+      validator = EnumAttributeValidator.new('Boolean', ["false"])
+      unless validator.valid?(wrap_content)
+        fail ArgumentError, "invalid value for \"wrap_content\", must be one of #{validator.allowable_values}."
+      end
+      @wrap_content = wrap_content
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] width Object to be assigned
+    def width=(width)
+      validator = EnumAttributeValidator.new('String', ["custom", "large", "medium", "small"])
+      unless validator.valid?(width)
+        fail ArgumentError, "invalid value for \"width\", must be one of #{validator.allowable_values}."
+      end
+      @width = width
+    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 &&
+          wrap_content == o.wrap_content &&
+          border_styles == o.border_styles &&
+          close_button == o.close_button &&
+          margin == o.margin &&
+          padding == o.padding &&
+          minimum_height == o.minimum_height &&
+          width == o.width &&
+          custom_width == o.custom_width &&
+          background_image == o.background_image &&
+          background_color == o.background_color &&
+          input_styles == o.input_styles &&
+          drop_shadow == o.drop_shadow &&
+          overlay_color == o.overlay_color &&
+          rich_text_styles == o.rich_text_styles &&
+          mobile_overlay == o.mobile_overlay &&
+          banner_styles == o.banner_styles
+    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
+      [wrap_content, border_styles, close_button, margin, padding, minimum_height, width, custom_width, background_image, background_color, input_styles, drop_shadow, overlay_color, rich_text_styles, mobile_overlay, banner_styles].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 = 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