klaviyo-api-sdk 5.1.0 → 7.0.0

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

@@ -0,0 +1,238 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+The version of the OpenAPI document: 2024-05-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 CustomTimeframe
+    attr_accessor :start
+
+    attr_accessor :_end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'start' => :'start',
+        :'_end' => :'end'
+      }
+    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
+      {
+        :'start' => :'Time',
+        :'_end' => :'Time'
+      }
+    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::CustomTimeframe` 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::CustomTimeframe`. 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?(:'start')
+        self.start = attributes[:'start']
+      end
+
+      if attributes.key?(:'_end')
+        self._end = attributes[:'_end']
+      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 @start.nil?
+        invalid_properties.push('invalid value for "start", start cannot be nil.')
+      end
+
+      if @_end.nil?
+        invalid_properties.push('invalid value for "_end", _end 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 @start.nil?
+      return false if @_end.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 &&
+          start == o.start &&
+          _end == o._end
+    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
+      [start, _end].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/data_privacy_create_deletion_job_query.rb

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -48,6 +48,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'id',
       ])
     end
 

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -45,6 +45,8 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'email',
+        :'phone_number'
       ])
     end
 

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -117,6 +117,18 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'device_id',
+        :'klaviyo_sdk',
+        :'sdk_version',
+        :'device_model',
+        :'os_name',
+        :'os_version',
+        :'manufacturer',
+        :'app_name',
+        :'app_version',
+        :'app_build',
+        :'app_id',
+        :'environment'
       ])
     end
 

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -70,6 +70,13 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'subject',
+        :'preview_text',
+        :'from_email',
+        :'from_label',
+        :'reply_to_email',
+        :'cc_email',
+        :'bcc_email'
       ])
     end
 

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -40,6 +40,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'use_smart_sending'
       ])
     end
 

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -55,6 +55,10 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'is_add_utm',
+        :'utm_params',
+        :'is_tracking_clicks',
+        :'is_tracking_opens'
       ])
     end
 

data/lib/klaviyo-api-sdk/models/event_bulk_create_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: 2024-05-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 EventBulkCreateEnum
+    EVENT_BULK_CREATE = "event-bulk-create".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 = EventBulkCreateEnum.constants.select { |c| EventBulkCreateEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #EventBulkCreateEnum" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/klaviyo-api-sdk/models/event_bulk_create_job_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: 2024-05-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 EventBulkCreateJobEnum
+    EVENT_BULK_CREATE_JOB = "event-bulk-create-job".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 = EventBulkCreateJobEnum.constants.select { |c| EventBulkCreateJobEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #EventBulkCreateJobEnum" if constantValues.empty?
+      value
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -21,9 +21,12 @@ module KlaviyoAPI
     # When this event occurred. By default, the time the request was received will be used. The time is truncated to the second. The time must be after the year 2000 and can only be up to 1 year in the future.
     attr_accessor :time
 
-    # A numeric value to associate with this event. For example, the dollar amount of a purchase.
+    # A numeric, monetary value to associate with this event. For example, the dollar amount of a purchase.
     attr_accessor :value
 
+    # The ISO 4217 currency code of the value associated with the event.
+    attr_accessor :value_currency
+
     # A unique identifier for an event. If the unique_id is repeated for the same profile and metric, only the first processed event will be recorded. If this is not present, this will use the time to the second. Using the default, this limits only one event per profile per second.
     attr_accessor :unique_id
 
@@ -37,6 +40,7 @@ module KlaviyoAPI
         :'properties' => :'properties',
         :'time' => :'time',
         :'value' => :'value',
+        :'value_currency' => :'value_currency',
         :'unique_id' => :'unique_id',
         :'metric' => :'metric',
         :'profile' => :'profile'
@@ -54,6 +58,7 @@ module KlaviyoAPI
         :'properties' => :'Object',
         :'time' => :'Time',
         :'value' => :'Float',
+        :'value_currency' => :'String',
         :'unique_id' => :'String',
         :'metric' => :'EventCreateQueryV2ResourceObjectAttributesMetric',
         :'profile' => :'EventCreateQueryV2ResourceObjectAttributesProfile'
@@ -63,6 +68,10 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'time',
+        :'value',
+        :'value_currency',
+        :'unique_id',
       ])
     end
 
@@ -93,6 +102,10 @@ module KlaviyoAPI
         self.value = attributes[:'value']
       end
 
+      if attributes.key?(:'value_currency')
+        self.value_currency = attributes[:'value_currency']
+      end
+
       if attributes.key?(:'unique_id')
         self.unique_id = attributes[:'unique_id']
       end
@@ -142,6 +155,7 @@ module KlaviyoAPI
           properties == o.properties &&
           time == o.time &&
           value == o.value &&
+          value_currency == o.value_currency &&
           unique_id == o.unique_id &&
           metric == o.metric &&
           profile == o.profile
@@ -156,7 +170,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [properties, time, value, unique_id, metric, profile].hash
+      [properties, time, value, value_currency, unique_id, metric, profile].hash
     end
 
     # Builds the object from hash

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -32,7 +32,7 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'OnsiteProfileCreateQueryResourceObject'
+        :'data' => :'EventProfileCreateQueryResourceObject'
       }
     end
 

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-12-15
+The version of the OpenAPI document: 2024-05-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1