klaviyo-api-sdk 13.0.1 → 14.0.1

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

@@ -87,7 +87,9 @@ module KlaviyoAPI
       Set.new([
         :'id',
         :'name',
+        :'allocations',
         :'started',
+        :'winner_metric',
       ])
     end
 
@@ -145,18 +147,6 @@ module KlaviyoAPI
         invalid_properties.push('invalid value for "variations", variations cannot be nil.')
       end
 
-      if @allocations.nil?
-        invalid_properties.push('invalid value for "allocations", allocations cannot be nil.')
-      end
-
-      if @winner_metric.nil?
-        invalid_properties.push('invalid value for "winner_metric", winner_metric cannot be nil.')
-      end
-
-      if @automatic_winner_selection_settings.nil?
-        invalid_properties.push('invalid value for "automatic_winner_selection_settings", automatic_winner_selection_settings cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -164,11 +154,8 @@ module KlaviyoAPI
     # @return true if the model is valid
     def valid?
       return false if @variations.nil?
-      return false if @allocations.nil?
-      return false if @winner_metric.nil?
       winner_metric_validator = EnumAttributeValidator.new('String', ["submission", "unique-clicks", "unique-opens", "unique-placed-orders"])
       return false unless winner_metric_validator.valid?(@winner_metric)
-      return false if @automatic_winner_selection_settings.nil?
       true
     end
 

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

@@ -14,7 +14,7 @@ require 'time'
 
 module KlaviyoAPI
   class BaseEventCreateQueryBulkEntryResourceObjectAttributes
-    # Properties of this event. Any top level property (that are not objects) can be used to create segments. The $extra property is a special property. This records any non-segmentable values that can be referenced later. For example, HTML templates are useful on a segment but are not used to create a segment. There are limits placed onto the size of the data present. This must not exceed 5 MB. This must not exceed 300 event properties. A single string cannot be larger than 100 KB. The maximum allowed sum of profile strings is 100KB. Each array must not exceed 4000 elements. The properties cannot contain more than 10 nested levels.
+    # Properties of this event (must not exceed 400 properties). The size of the event payload must not exceed 5 MB, and each string cannot be larger than 100 KB. For a full list of data limits on event payloads, see [Limitations](https://developers.klaviyo.com/en/reference/events_api_overview#limitations).  Note any top-level property that is not an object can be used to create segments. The `$extra` property records any non-segmentable values that can be referenced later, e.g., HTML templates are useful on a segment but are not used to create a segment.
     attr_accessor :properties
 
     # 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.

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

@@ -0,0 +1,247 @@
+=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 ButtonBlock
+    attr_accessor :content_type
+
+    attr_accessor :type
+
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'content_type' => :'content_type',
+        :'type' => :'type',
+        :'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
+      {
+        :'content_type' => :'BlockEnum',
+        :'type' => :'ButtonEnum',
+        :'data' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'data'
+      ])
+    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::ButtonBlock` 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::ButtonBlock`. 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?(:'content_type')
+        self.content_type = attributes[:'content_type']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      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 @content_type.nil?
+        invalid_properties.push('invalid value for "content_type", content_type cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type 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_type.nil?
+      return false if @type.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 &&
+          content_type == o.content_type &&
+          type == o.type &&
+          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
+      [content_type, type, 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/{custom_object_property_enum.rb → button_enum.rb}

@@ -13,8 +13,8 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class CustomObjectPropertyEnum
-    CUSTOM_OBJECT_PROPERTY = "custom-object-property".freeze
+  class ButtonEnum
+    BUTTON = "button".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string
@@ -27,8 +27,8 @@ module KlaviyoAPI
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      constantValues = CustomObjectPropertyEnum.constants.select { |c| CustomObjectPropertyEnum::const_get(c) == value }
-      raise "Invalid ENUM value #{value} for class #CustomObjectPropertyEnum" if constantValues.empty?
+      constantValues = ButtonEnum.constants.select { |c| ButtonEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #ButtonEnum" if constantValues.empty?
       value
     end
   end

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

@@ -13,7 +13,7 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  # The timeframe to query for data within. The max length a timeframe can be is 1 year
+  # The time frame to pull data from (Max length: 1 year). See [available time frames](https://developers.klaviyo.com/en/reference/reporting_api_overview#available-time-frames).
   module CampaignValuesRequestDTOResourceObjectAttributesTimeframe
     class << self
       # List of class defined in oneOf (OpenAPI v3)

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

@@ -22,6 +22,9 @@ module KlaviyoAPI
           :'ProfileMarketingConsentCondition',
           :'ProfileNoGroupMembershipCondition',
           :'ProfilePostalCodeDistanceCondition',
+          :'ProfilePredictiveAnalyticsChannelAffinityPriorityCondition',
+          :'ProfilePredictiveAnalyticsChannelAffinityRankCondition',
+          :'ProfilePredictiveAnalyticsDateCondition',
           :'ProfilePredictiveAnalyticsNumericCondition',
           :'ProfilePredictiveAnalyticsStringCondition',
           :'ProfilePropertyCondition',

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

@@ -23,6 +23,7 @@ module KlaviyoAPI
           :'ProfileMarketingConsentCondition',
           :'ProfileNoGroupMembershipCondition',
           :'ProfilePostalCodeDistanceCondition',
+          :'ProfilePredictiveAnalyticsDateCondition',
           :'ProfilePredictiveAnalyticsNumericCondition',
           :'ProfilePredictiveAnalyticsStringCondition',
           :'ProfilePropertyCondition',

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

@@ -20,11 +20,15 @@ module KlaviyoAPI
     # A description of the coupon.
     attr_accessor :description
 
+    # The monitor configuration for the coupon.
+    attr_accessor :monitor_configuration
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'external_id' => :'external_id',
-        :'description' => :'description'
+        :'description' => :'description',
+        :'monitor_configuration' => :'monitor_configuration'
       }
     end
 
@@ -37,14 +41,16 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'external_id' => :'String',
-        :'description' => :'String'
+        :'description' => :'String',
+        :'monitor_configuration' => :'Object'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'description'
+        :'description',
+        :'monitor_configuration'
       ])
     end
 
@@ -70,6 +76,10 @@ module KlaviyoAPI
       if attributes.key?(:'description')
         self.description = attributes[:'description']
       end
+
+      if attributes.key?(:'monitor_configuration')
+        self.monitor_configuration = attributes[:'monitor_configuration']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -96,7 +106,8 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           external_id == o.external_id &&
-          description == o.description
+          description == o.description &&
+          monitor_configuration == o.monitor_configuration
     end
 
     # @see the `==` method
@@ -108,7 +119,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [external_id, description].hash
+      [external_id, description, monitor_configuration].hash
     end
 
     # Builds the object from hash

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

@@ -17,10 +17,14 @@ module KlaviyoAPI
     # A description of the coupon.
     attr_accessor :description
 
+    # The monitor configuration for the coupon.
+    attr_accessor :monitor_configuration
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'description' => :'description'
+        :'description' => :'description',
+        :'monitor_configuration' => :'monitor_configuration'
       }
     end
 
@@ -32,14 +36,16 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'description' => :'String'
+        :'description' => :'String',
+        :'monitor_configuration' => :'Object'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'description'
+        :'description',
+        :'monitor_configuration'
       ])
     end
 
@@ -61,6 +67,10 @@ module KlaviyoAPI
       if attributes.key?(:'description')
         self.description = attributes[:'description']
       end
+
+      if attributes.key?(:'monitor_configuration')
+        self.monitor_configuration = attributes[:'monitor_configuration']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -81,7 +91,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          description == o.description
+          description == o.description &&
+          monitor_configuration == o.monitor_configuration
     end
 
     # @see the `==` method
@@ -93,7 +104,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [description].hash
+      [description, monitor_configuration].hash
     end
 
     # Builds the object from hash

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

@@ -14,8 +14,10 @@ require 'time'
 
 module KlaviyoAPI
   class CustomTimeframe
+    # A datetime that represents the start of a custom time frame. Offset is ignored and the company timezone is used.
     attr_accessor :start
 
+    # A datetime that represents the end of a custom time frame. Offset is ignored and the company timezone is used.
     attr_accessor :_end
 
     # Attribute mapping from ruby-style variable name to JSON key.