klaviyo-api-sdk 11.1.0 → 12.0.0

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

@@ -0,0 +1,269 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+The version of the OpenAPI document: 2025-01-15
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  class ListUpdateAction
+    # The real ID of an action.
+    attr_accessor :id
+
+    # A temporary ID to use only during a create operation. Existing actions should use the id field.
+    attr_accessor :temporary_id
+
+    attr_accessor :type
+
+    attr_accessor :links
+
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'temporary_id' => :'temporary_id',
+        :'type' => :'type',
+        :'links' => :'links',
+        :'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
+      {
+        :'id' => :'String',
+        :'temporary_id' => :'String',
+        :'type' => :'ListUpdateEnum',
+        :'links' => :'Link',
+        :'data' => :'ListUpdateActionData'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'id',
+        :'temporary_id',
+      ])
+    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::ListUpdateAction` 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::ListUpdateAction`. 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?(:'temporary_id')
+        self.temporary_id = attributes[:'temporary_id']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'links')
+        self.links = attributes[:'links']
+      end
+
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      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 @type.nil?
+      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 &&
+          id == o.id &&
+          temporary_id == o.temporary_id &&
+          type == o.type &&
+          links == o.links &&
+          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
+      [id, temporary_id, type, links, 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/{dynamic_tracking_param.rb → list_update_action_data.rb}

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2024-10-15
+The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -14,14 +14,13 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class DynamicTrackingParam
-    attr_accessor :type
+  class ListUpdateActionData
+    attr_accessor :name
 
-    # The value of the tracking parameter
-    attr_accessor :value
+    # The enum for whether the action will add/remove from the list in the List Update Action.
+    attr_accessor :on_execution
 
-    # Name of the tracking param
-    attr_accessor :name
+    attr_accessor :list_id
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -48,9 +47,9 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'type' => :'type',
-        :'value' => :'value',
-        :'name' => :'name'
+        :'name' => :'name',
+        :'on_execution' => :'on_execution',
+        :'list_id' => :'list_id'
       }
     end
 
@@ -62,15 +61,17 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'type' => :'DynamicEnum',
-        :'value' => :'String',
-        :'name' => :'String'
+        :'name' => :'String',
+        :'on_execution' => :'Boolean',
+        :'list_id' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'on_execution',
+        :'list_id'
       ])
     end
 
@@ -78,27 +79,27 @@ 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::ListUpdateActionData` 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::ListUpdateActionData`. 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']
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
 
-      if attributes.key?(:'value')
-        self.value = attributes[:'value']
+      if attributes.key?(:'on_execution')
+        self.on_execution = attributes[:'on_execution']
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'list_id')
+        self.list_id = attributes[:'list_id']
       end
     end
 
@@ -106,14 +107,6 @@ 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
@@ -124,22 +117,20 @@ module KlaviyoAPI
     # 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?
-      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?
+      on_execution_validator = EnumAttributeValidator.new('Boolean', ["false", "true"])
+      return false unless on_execution_validator.valid?(@on_execution)
       true
     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] on_execution Object to be assigned
+    def on_execution=(on_execution)
+      validator = EnumAttributeValidator.new('Boolean', ["false", "true"])
+      unless validator.valid?(on_execution)
+        fail ArgumentError, "invalid value for \"on_execution\", must be one of #{validator.allowable_values}."
       end
-      @value = value
+      @on_execution = on_execution
     end
 
     # Checks equality by comparing each attribute.
@@ -147,9 +138,9 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          type == o.type &&
-          value == o.value &&
-          name == o.name
+          name == o.name &&
+          on_execution == o.on_execution &&
+          list_id == o.list_id
     end
 
     # @see the `==` method
@@ -161,7 +152,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, value, name].hash
+      [name, on_execution, list_id].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,36 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+The version of the OpenAPI document: 2025-01-15
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  class ListUpdateEnum
+    LIST_UPDATE = "list-update".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = ListUpdateEnum.constants.select { |c| ListUpdateEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #ListUpdateEnum" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/klaviyo-api-sdk/models/{static_schedule_options.rb → local_static_send.rb}

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2024-10-15
+The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -14,20 +14,38 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class StaticScheduleOptions
-    # The time to send at
-    attr_accessor :datetime
-
-    # If the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time. Defaults to False.
+  class LocalStaticSend
+    # Whether the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time.
     attr_accessor :is_local
 
-    # Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends. Defaults to False.
+    # Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends.
     attr_accessor :send_past_recipients_immediately
 
+    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
       {
-        :'datetime' => :'datetime',
         :'is_local' => :'is_local',
         :'send_past_recipients_immediately' => :'send_past_recipients_immediately'
       }
@@ -41,7 +59,6 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'datetime' => :'Time',
         :'is_local' => :'Boolean',
         :'send_past_recipients_immediately' => :'Boolean'
       }
@@ -50,8 +67,6 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'is_local',
-        :'send_past_recipients_immediately'
       ])
     end
 
@@ -59,27 +74,25 @@ 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::StaticScheduleOptions` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::LocalStaticSend` 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::StaticScheduleOptions`. 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::LocalStaticSend`. 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?(:'datetime')
-        self.datetime = attributes[:'datetime']
-      end
-
       if attributes.key?(:'is_local')
         self.is_local = attributes[:'is_local']
       end
 
       if attributes.key?(:'send_past_recipients_immediately')
         self.send_past_recipients_immediately = attributes[:'send_past_recipients_immediately']
+      else
+        self.send_past_recipients_immediately = false
       end
     end
 
@@ -87,8 +100,8 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @datetime.nil?
-        invalid_properties.push('invalid value for "datetime", datetime cannot be nil.')
+      if @is_local.nil?
+        invalid_properties.push('invalid value for "is_local", is_local cannot be nil.')
       end
 
       invalid_properties
@@ -97,16 +110,27 @@ module KlaviyoAPI
     # 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 @datetime.nil?
+      return false if @is_local.nil?
+      is_local_validator = EnumAttributeValidator.new('Boolean', ["true"])
+      return false unless is_local_validator.valid?(@is_local)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] is_local Object to be assigned
+    def is_local=(is_local)
+      validator = EnumAttributeValidator.new('Boolean', ["true"])
+      unless validator.valid?(is_local)
+        fail ArgumentError, "invalid value for \"is_local\", must be one of #{validator.allowable_values}."
+      end
+      @is_local = is_local
+    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 &&
-          datetime == o.datetime &&
           is_local == o.is_local &&
           send_past_recipients_immediately == o.send_past_recipients_immediately
     end
@@ -120,7 +144,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [datetime, is_local, send_past_recipients_immediately].hash
+      [is_local, send_past_recipients_immediately].hash
     end
 
     # Builds the object from hash