klaviyo-api-sdk 14.0.1 → 16.0.0

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

@@ -0,0 +1,405 @@
+=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 Teaser
+    attr_accessor :id
+
+    attr_accessor :content
+
+    # Teaser display order enumeration.
+    attr_accessor :display_order
+
+    # Teaser display order enumeration.
+    attr_accessor :teaser_type
+
+    # Display location enumeration.
+    attr_accessor :location
+
+    # Teaser size enumeration.
+    attr_accessor :size
+
+    attr_accessor :custom_size
+
+    attr_accessor :styles
+
+    attr_accessor :close_button
+
+    # Enumeration for mobile and desktop.
+    attr_accessor :device_type
+
+    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
+      {
+        :'id' => :'id',
+        :'content' => :'content',
+        :'display_order' => :'display_order',
+        :'teaser_type' => :'teaser_type',
+        :'location' => :'location',
+        :'size' => :'size',
+        :'custom_size' => :'custom_size',
+        :'styles' => :'styles',
+        :'close_button' => :'close_button',
+        :'device_type' => :'device_type'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'content' => :'String',
+        :'display_order' => :'String',
+        :'teaser_type' => :'String',
+        :'location' => :'String',
+        :'size' => :'String',
+        :'custom_size' => :'Integer',
+        :'styles' => :'TeaserStyles',
+        :'close_button' => :'Boolean',
+        :'device_type' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'id',
+        :'custom_size',
+      ])
+    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::Teaser` 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::Teaser`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'content')
+        self.content = attributes[:'content']
+      end
+
+      if attributes.key?(:'display_order')
+        self.display_order = attributes[:'display_order']
+      else
+        self.display_order = 'after'
+      end
+
+      if attributes.key?(:'teaser_type')
+        self.teaser_type = attributes[:'teaser_type']
+      else
+        self.teaser_type = 'rectangle'
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      else
+        self.location = 'bottom_left'
+      end
+
+      if attributes.key?(:'size')
+        self.size = attributes[:'size']
+      else
+        self.size = 'small'
+      end
+
+      if attributes.key?(:'custom_size')
+        self.custom_size = attributes[:'custom_size']
+      end
+
+      if attributes.key?(:'styles')
+        self.styles = attributes[:'styles']
+      end
+
+      if attributes.key?(:'close_button')
+        self.close_button = attributes[:'close_button']
+      else
+        self.close_button = true
+      end
+
+      if attributes.key?(:'device_type')
+        self.device_type = attributes[:'device_type']
+      else
+        self.device_type = 'both'
+      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 @content.nil?
+        invalid_properties.push('invalid value for "content", content 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 @content.nil?
+      display_order_validator = EnumAttributeValidator.new('String', ["after", "before", "before_and_after"])
+      return false unless display_order_validator.valid?(@display_order)
+      teaser_type_validator = EnumAttributeValidator.new('String', ["circle", "corner", "rectangle"])
+      return false unless teaser_type_validator.valid?(@teaser_type)
+      location_validator = EnumAttributeValidator.new('String', ["bottom_center", "bottom_left", "bottom_right", "center_left", "center_right", "top_center", "top_left", "top_right"])
+      return false unless location_validator.valid?(@location)
+      size_validator = EnumAttributeValidator.new('String', ["custom", "large", "medium", "small"])
+      return false unless size_validator.valid?(@size)
+      device_type_validator = EnumAttributeValidator.new('String', ["both", "desktop", "mobile"])
+      return false unless device_type_validator.valid?(@device_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] display_order Object to be assigned
+    def display_order=(display_order)
+      validator = EnumAttributeValidator.new('String', ["after", "before", "before_and_after"])
+      unless validator.valid?(display_order)
+        fail ArgumentError, "invalid value for \"display_order\", must be one of #{validator.allowable_values}."
+      end
+      @display_order = display_order
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] teaser_type Object to be assigned
+    def teaser_type=(teaser_type)
+      validator = EnumAttributeValidator.new('String', ["circle", "corner", "rectangle"])
+      unless validator.valid?(teaser_type)
+        fail ArgumentError, "invalid value for \"teaser_type\", must be one of #{validator.allowable_values}."
+      end
+      @teaser_type = teaser_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] location Object to be assigned
+    def location=(location)
+      validator = EnumAttributeValidator.new('String', ["bottom_center", "bottom_left", "bottom_right", "center_left", "center_right", "top_center", "top_left", "top_right"])
+      unless validator.valid?(location)
+        fail ArgumentError, "invalid value for \"location\", must be one of #{validator.allowable_values}."
+      end
+      @location = location
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] size Object to be assigned
+    def size=(size)
+      validator = EnumAttributeValidator.new('String', ["custom", "large", "medium", "small"])
+      unless validator.valid?(size)
+        fail ArgumentError, "invalid value for \"size\", must be one of #{validator.allowable_values}."
+      end
+      @size = size
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] device_type Object to be assigned
+    def device_type=(device_type)
+      validator = EnumAttributeValidator.new('String', ["both", "desktop", "mobile"])
+      unless validator.valid?(device_type)
+        fail ArgumentError, "invalid value for \"device_type\", must be one of #{validator.allowable_values}."
+      end
+      @device_type = device_type
+    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 &&
+          id == o.id &&
+          content == o.content &&
+          display_order == o.display_order &&
+          teaser_type == o.teaser_type &&
+          location == o.location &&
+          size == o.size &&
+          custom_size == o.custom_size &&
+          styles == o.styles &&
+          close_button == o.close_button &&
+          device_type == o.device_type
+    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
+      [id, content, display_order, teaser_type, location, size, custom_size, styles, close_button, device_type].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/teaser_styles.rb

@@ -0,0 +1,267 @@
+=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 TeaserStyles
+    attr_accessor :background_color
+
+    attr_accessor :drop_shadow
+
+    attr_accessor :corner_radius
+
+    attr_accessor :background_image
+
+    attr_accessor :close_button
+
+    attr_accessor :margin
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'background_color' => :'background_color',
+        :'drop_shadow' => :'drop_shadow',
+        :'corner_radius' => :'corner_radius',
+        :'background_image' => :'background_image',
+        :'close_button' => :'close_button',
+        :'margin' => :'margin'
+      }
+    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
+      {
+        :'background_color' => :'String',
+        :'drop_shadow' => :'DropShadow',
+        :'corner_radius' => :'Integer',
+        :'background_image' => :'BackgroundImage',
+        :'close_button' => :'CloseButtonStyle',
+        :'margin' => :'Margin'
+      }
+    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::TeaserStyles` 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::TeaserStyles`. 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?(:'background_color')
+        self.background_color = attributes[:'background_color']
+      else
+        self.background_color = '#FFFFFF'
+      end
+
+      if attributes.key?(:'drop_shadow')
+        self.drop_shadow = attributes[:'drop_shadow']
+      end
+
+      if attributes.key?(:'corner_radius')
+        self.corner_radius = attributes[:'corner_radius']
+      else
+        self.corner_radius = 4
+      end
+
+      if attributes.key?(:'background_image')
+        self.background_image = attributes[:'background_image']
+      end
+
+      if attributes.key?(:'close_button')
+        self.close_button = attributes[:'close_button']
+      end
+
+      if attributes.key?(:'margin')
+        self.margin = attributes[:'margin']
+      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 &&
+          background_color == o.background_color &&
+          drop_shadow == o.drop_shadow &&
+          corner_radius == o.corner_radius &&
+          background_image == o.background_image &&
+          close_button == o.close_button &&
+          margin == o.margin
+    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
+      [background_color, drop_shadow, corner_radius, background_image, close_button, margin].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