klaviyo-api-sdk 18.0.0 → 19.0.0

data/lib/klaviyo-api-sdk/models/{dynamic_tracking_param.rb → animation.rb}

@@ -13,15 +13,18 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class DynamicTrackingParam
-    # The type of the tracking parameter
+  class Animation
+    # Enumeration for component entrance animation types.
     attr_accessor :type
 
-    # The value of the tracking parameter
-    attr_accessor :value
+    attr_accessor :duration
 
-    # Name of the tracking param
-    attr_accessor :name
+    attr_accessor :delay
+
+    # Enumeration for component animation easing functions.
+    attr_accessor :easing
+
+    attr_accessor :repeat
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -49,8 +52,10 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'type' => :'type',
-        :'value' => :'value',
-        :'name' => :'name'
+        :'duration' => :'duration',
+        :'delay' => :'delay',
+        :'easing' => :'easing',
+        :'repeat' => :'repeat'
       }
     end
 
@@ -63,8 +68,10 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'type' => :'String',
-        :'value' => :'String',
-        :'name' => :'String'
+        :'duration' => :'Integer',
+        :'delay' => :'Integer',
+        :'easing' => :'String',
+        :'repeat' => :'Boolean'
       }
     end
 
@@ -78,27 +85,45 @@ module KlaviyoAPI
     # @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::DynamicTrackingParam` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::Animation` 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::DynamicTrackingParam`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::Animation`. 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?(:'type')
         self.type = attributes[:'type']
+      else
+        self.type = 'none'
       end
 
-      if attributes.key?(:'value')
-        self.value = attributes[:'value']
+      if attributes.key?(:'duration')
+        self.duration = attributes[:'duration']
+      else
+        self.duration = 600
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'delay')
+        self.delay = attributes[:'delay']
+      else
+        self.delay = 0
+      end
+
+      if attributes.key?(:'easing')
+        self.easing = attributes[:'easing']
+      else
+        self.easing = 'ease-out'
+      end
+
+      if attributes.key?(:'repeat')
+        self.repeat = attributes[:'repeat']
+      else
+        self.repeat = false
       end
     end
 
@@ -106,38 +131,23 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
-      end
-
-      if @value.nil?
-        invalid_properties.push('invalid value for "value", value cannot be nil.')
-      end
-
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name 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 @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["dynamic"])
+      type_validator = EnumAttributeValidator.new('String', ["fadeIn", "fadeInUp", "none", "pulse", "slideInDown", "slideInLeft", "slideInRight", "slideInUp", "zoomIn"])
       return false unless type_validator.valid?(@type)
-      return false if @value.nil?
-      value_validator = EnumAttributeValidator.new('String', ["campaign_id", "campaign_name", "campaign_name_id", "campaign_name_send_day", "email_subject", "group_id", "group_name", "group_name_id", "link_alt_text", "message_type", "profile_external_id", "profile_id"])
-      return false unless value_validator.valid?(@value)
-      return false if @name.nil?
+      easing_validator = EnumAttributeValidator.new('String', ["ease", "ease-in", "ease-in-out", "ease-out", "linear"])
+      return false unless easing_validator.valid?(@easing)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["dynamic"])
+      validator = EnumAttributeValidator.new('String', ["fadeIn", "fadeInUp", "none", "pulse", "slideInDown", "slideInLeft", "slideInRight", "slideInUp", "zoomIn"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
@@ -145,13 +155,13 @@ module KlaviyoAPI
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] value Object to be assigned
-    def value=(value)
-      validator = EnumAttributeValidator.new('String', ["campaign_id", "campaign_name", "campaign_name_id", "campaign_name_send_day", "email_subject", "group_id", "group_name", "group_name_id", "link_alt_text", "message_type", "profile_external_id", "profile_id"])
-      unless validator.valid?(value)
-        fail ArgumentError, "invalid value for \"value\", must be one of #{validator.allowable_values}."
+    # @param [Object] easing Object to be assigned
+    def easing=(easing)
+      validator = EnumAttributeValidator.new('String', ["ease", "ease-in", "ease-in-out", "ease-out", "linear"])
+      unless validator.valid?(easing)
+        fail ArgumentError, "invalid value for \"easing\", must be one of #{validator.allowable_values}."
       end
-      @value = value
+      @easing = easing
     end
 
     # Checks equality by comparing each attribute.
@@ -160,8 +170,10 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           type == o.type &&
-          value == o.value &&
-          name == o.name
+          duration == o.duration &&
+          delay == o.delay &&
+          easing == o.easing &&
+          repeat == o.repeat
     end
 
     # @see the `==` method
@@ -173,7 +185,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, value, name].hash
+      [type, duration, delay, easing, repeat].hash
     end
 
     # Builds the object from hash

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

@@ -139,7 +139,7 @@ module KlaviyoAPI
       return false if @id.nil?
       return false if @name.nil?
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["boolean", "float", "int", "string", "timestamp"])
+      type_validator = EnumAttributeValidator.new('String', ["boolean", "float", "int", "list_str", "string", "timestamp"])
       return false unless type_validator.valid?(@type)
       true
     end
@@ -147,7 +147,7 @@ module KlaviyoAPI
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["boolean", "float", "int", "string", "timestamp"])
+      validator = EnumAttributeValidator.new('String', ["boolean", "float", "int", "list_str", "string", "timestamp"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

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

@@ -0,0 +1,223 @@
+=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 AudienceCloneQuery
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    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
+      {
+        :'data' => :'AudienceCloneQueryResourceObject'
+      }
+    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::AudienceCloneQuery` 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::AudienceCloneQuery`. 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?(:'data')
+        self.data = attributes[:'data']
+      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 @data.nil?
+        invalid_properties.push('invalid value for "data", data 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 @data.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 &&
+          data == o.data
+    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
+      [data].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/{campaign_message_partial_update_query_resource_object.rb → audience_clone_query_resource_object.rb}

@@ -13,10 +13,10 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class CampaignMessagePartialUpdateQueryResourceObject
+  class AudienceCloneQueryResourceObject
     attr_accessor :type
 
-    # The message ID to be retrieved
+    # The ID of the audience
     attr_accessor :id
 
     attr_accessor :attributes
@@ -41,10 +41,10 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'type' => :'CampaignMessageEnum',
+        :'type' => :'CampaignAudienceCloneEnum',
         :'id' => :'String',
-        :'attributes' => :'CampaignMessagePartialUpdateQueryResourceObjectAttributes',
-        :'relationships' => :'CampaignMessageCreateQueryResourceObjectRelationships'
+        :'attributes' => :'AudienceCloneQueryResourceObjectAttributes',
+        :'relationships' => :'AudienceCloneQueryResourceObjectRelationships'
       }
     end
 
@@ -58,13 +58,13 @@ module KlaviyoAPI
     # @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::CampaignMessagePartialUpdateQueryResourceObject` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::AudienceCloneQueryResourceObject` 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::CampaignMessagePartialUpdateQueryResourceObject`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::AudienceCloneQueryResourceObject`. 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
       }