klaviyo-api-sdk 17.0.0 → 18.0.0

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

@@ -16,6 +16,8 @@ module KlaviyoAPI
   class CheckboxesProperties
     attr_accessor :display_device
 
+    attr_accessor :classname
+
     attr_accessor :property_name
 
     attr_accessor :label
@@ -56,6 +58,7 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'display_device' => :'display_device',
+        :'classname' => :'classname',
         :'property_name' => :'property_name',
         :'label' => :'label',
         :'show_label' => :'show_label',
@@ -75,6 +78,7 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'display_device' => :'Array<String>',
+        :'classname' => :'String',
         :'property_name' => :'String',
         :'label' => :'String',
         :'show_label' => :'Boolean',
@@ -88,6 +92,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'classname',
         :'label',
         :'required',
         :'placeholder'
@@ -115,6 +120,10 @@ module KlaviyoAPI
         end
       end
 
+      if attributes.key?(:'classname')
+        self.classname = attributes[:'classname']
+      end
+
       if attributes.key?(:'property_name')
         self.property_name = attributes[:'property_name']
       end
@@ -179,6 +188,7 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           display_device == o.display_device &&
+          classname == o.classname &&
           property_name == o.property_name &&
           label == o.label &&
           show_label == o.show_label &&
@@ -197,7 +207,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, property_name, label, show_label, required, error_messages, options, placeholder].hash
+      [display_device, classname, property_name, label, show_label, required, error_messages, options, placeholder].hash
     end
 
     # Builds the object from hash

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

@@ -21,10 +21,15 @@ module KlaviyoAPI
           :'FlowsProfileMetricCondition',
           :'ProfileHasCustomObjectCondition',
           :'ProfileHasGroupMembershipCondition',
+          :'ProfileHasNotReceivedEmailMessageCondition',
+          :'ProfileHasNotReceivedPushMessageCondition',
+          :'ProfileHasNotReceivedSmsMessageCondition',
           :'ProfileMarketingConsentCondition',
           :'ProfileNoGroupMembershipCondition',
           :'ProfilePermissionsCondition',
           :'ProfilePostalCodeDistanceCondition',
+          :'ProfilePredictiveAnalyticsChannelAffinityPriorityCondition',
+          :'ProfilePredictiveAnalyticsChannelAffinityRankCondition',
           :'ProfilePredictiveAnalyticsDateCondition',
           :'ProfilePredictiveAnalyticsNumericCondition',
           :'ProfilePredictiveAnalyticsStringCondition',

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

@@ -0,0 +1,287 @@
+=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 ConstantPropertyMapping
+    # Property ID. Must be a positive integer.
+    attr_accessor :id
+
+    # String literal for serialization
+    attr_accessor :type
+
+    attr_accessor :value
+
+    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',
+        :'type' => :'type',
+        :'value' => :'value'
+      }
+    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' => :'Integer',
+        :'type' => :'String',
+        :'value' => :'ConstantPropertyMappingValue'
+      }
+    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::ConstantPropertyMapping` 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::ConstantPropertyMapping`. 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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      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
+
+      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 @id.nil?
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["constant"])
+      return false unless type_validator.valid?(@type)
+      return false if @value.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["constant"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = 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 &&
+          type == o.type &&
+          value == o.value
+    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, type, value].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/{price_drop_condition_filter2.rb → constant_property_mapping_value.rb}

@@ -13,26 +13,16 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  module PriceDropConditionFilter2
+  # Constant value assigned to every record
+  module ConstantPropertyMappingValue
     class << self
       # List of class defined in oneOf (OpenAPI v3)
       def openapi_one_of
         [
-          :'AnniversaryDateFilter',
-          :'BooleanFilter',
-          :'CalendarDateFilter',
-          :'ExistenceOperatorExistenceFilter',
-          :'ListContainsOperatorListContainsFilter',
-          :'ListLengthFilter',
-          :'NumericOperatorNumericFilter',
-          :'NumericRangeFilter',
-          :'RelativeAnniversaryDateFilter',
-          :'RelativeDateOperatorBaseRelativeDateFilter',
-          :'RelativeDateRangeFilter',
-          :'StaticDateFilter',
-          :'StaticDateRangeFilter',
-          :'StringArrayOperatorStringArrayFilter',
-          :'StringOperatorStringFilter'
+          :'Boolean',
+          :'Float',
+          :'Integer',
+          :'String'
         ]
       end
 

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

@@ -71,7 +71,7 @@ module KlaviyoAPI
         :'temporary_id' => :'String',
         :'type' => :'String',
         :'links' => :'Link',
-        :'data' => :'SendPushNotificationActionContentExperimentActionData'
+        :'data' => :'ContentExperimentActionData'
       }
     end
 

data/lib/klaviyo-api-sdk/models/{send_push_notification_action_content_experiment_action_data.rb → content_experiment_action_data.rb}

@@ -13,7 +13,7 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class SendPushNotificationActionContentExperimentActionData
+  class ContentExperimentActionData
     # Flow action status.
     attr_accessor :status
 
@@ -66,8 +66,8 @@ module KlaviyoAPI
       {
         :'status' => :'String',
         :'experiment_status' => :'String',
-        :'main_action' => :'SendPushNotificationAction',
-        :'current_experiment' => :'SendPushNotificationActionCurrentExperiment'
+        :'main_action' => :'ContentExperimentActionDataMainAction',
+        :'current_experiment' => :'ContentExperimentActionDataCurrentExperiment'
       }
     end
 
@@ -75,6 +75,7 @@ module KlaviyoAPI
     def self.openapi_nullable
       Set.new([
         :'experiment_status',
+        :'current_experiment'
       ])
     end
 
@@ -82,13 +83,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::SendPushNotificationActionContentExperimentActionData` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::ContentExperimentActionData` 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::SendPushNotificationActionContentExperimentActionData`. 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::ContentExperimentActionData`. 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
       }

data/lib/klaviyo-api-sdk/models/{send_push_notification_action_current_experiment.rb → content_experiment_action_data_current_experiment.rb}

@@ -13,7 +13,7 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class SendPushNotificationActionCurrentExperiment
+  class ContentExperimentActionDataCurrentExperiment
     # Not allowed on create.
     attr_accessor :id
 
@@ -72,7 +72,7 @@ module KlaviyoAPI
       {
         :'id' => :'String',
         :'name' => :'String',
-        :'variations' => :'Array<SendPushNotificationAction>',
+        :'variations' => :'Array<ContentExperimentActionDataMainAction>',
         :'allocations' => :'Object',
         :'started' => :'Time',
         :'winner_metric' => :'String'
@@ -94,13 +94,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::SendPushNotificationActionCurrentExperiment` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::ContentExperimentActionDataCurrentExperiment` 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::SendPushNotificationActionCurrentExperiment`. 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::ContentExperimentActionDataCurrentExperiment`. 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
       }
@@ -147,7 +147,7 @@ module KlaviyoAPI
     # @return true if the model is valid
     def valid?
       return false if @variations.nil?
-      winner_metric_validator = EnumAttributeValidator.new('String', ["open-rate"])
+      winner_metric_validator = EnumAttributeValidator.new('String', ["click-rate", "open-rate"])
       return false unless winner_metric_validator.valid?(@winner_metric)
       true
     end
@@ -155,7 +155,7 @@ module KlaviyoAPI
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] winner_metric Object to be assigned
     def winner_metric=(winner_metric)
-      validator = EnumAttributeValidator.new('String', ["open-rate"])
+      validator = EnumAttributeValidator.new('String', ["click-rate", "open-rate"])
       unless validator.valid?(winner_metric)
         fail ArgumentError, "invalid value for \"winner_metric\", must be one of #{validator.allowable_values}."
       end

data/lib/klaviyo-api-sdk/models/{low_inventory_condition_filter2.rb → content_experiment_action_data_main_action.rb}

@@ -13,26 +13,13 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  module LowInventoryConditionFilter2
+  module ContentExperimentActionDataMainAction
     class << self
       # List of class defined in oneOf (OpenAPI v3)
       def openapi_one_of
         [
-          :'AnniversaryDateFilter',
-          :'BooleanFilter',
-          :'CalendarDateFilter',
-          :'ExistenceOperatorExistenceFilter',
-          :'ListContainsOperatorListContainsFilter',
-          :'ListLengthFilter',
-          :'NumericOperatorNumericFilter',
-          :'NumericRangeFilter',
-          :'RelativeAnniversaryDateFilter',
-          :'RelativeDateOperatorBaseRelativeDateFilter',
-          :'RelativeDateRangeFilter',
-          :'StaticDateFilter',
-          :'StaticDateRangeFilter',
-          :'StringArrayOperatorStringArrayFilter',
-          :'StringOperatorStringFilter'
+          :'SendPushNotificationAction',
+          :'SendWhatsAppAction'
         ]
       end
 

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

@@ -16,6 +16,8 @@ module KlaviyoAPI
   class CountdownTimerProperties
     attr_accessor :display_device
 
+    attr_accessor :classname
+
     # Options for displaying a timer.
     attr_accessor :clock_face
 
@@ -50,6 +52,7 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'display_device' => :'display_device',
+        :'classname' => :'classname',
         :'clock_face' => :'clock_face',
         :'animation' => :'animation',
         :'configuration' => :'configuration'
@@ -65,6 +68,7 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'display_device' => :'Array<String>',
+        :'classname' => :'String',
         :'clock_face' => :'String',
         :'animation' => :'String',
         :'configuration' => :'CountdownTimerPropertiesConfiguration'
@@ -74,6 +78,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'classname',
         :'animation',
       ])
     end
@@ -99,6 +104,10 @@ module KlaviyoAPI
         end
       end
 
+      if attributes.key?(:'classname')
+        self.classname = attributes[:'classname']
+      end
+
       if attributes.key?(:'clock_face')
         self.clock_face = attributes[:'clock_face']
       else
@@ -164,6 +173,7 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           display_device == o.display_device &&
+          classname == o.classname &&
           clock_face == o.clock_face &&
           animation == o.animation &&
           configuration == o.configuration
@@ -178,7 +188,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, clock_face, animation, configuration].hash
+      [display_device, classname, clock_face, animation, configuration].hash
     end
 
     # Builds the object from hash

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

@@ -16,6 +16,8 @@ module KlaviyoAPI
   class CouponProperties
     attr_accessor :display_device
 
+    attr_accessor :classname
+
     attr_accessor :coupon
 
     attr_accessor :success_message
@@ -46,6 +48,7 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'display_device' => :'display_device',
+        :'classname' => :'classname',
         :'coupon' => :'coupon',
         :'success_message' => :'success_message'
       }
@@ -60,6 +63,7 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'display_device' => :'Array<String>',
+        :'classname' => :'String',
         :'coupon' => :'CouponPropertiesCoupon',
         :'success_message' => :'String'
       }
@@ -68,6 +72,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'classname',
         :'success_message'
       ])
     end
@@ -93,6 +98,10 @@ module KlaviyoAPI
         end
       end
 
+      if attributes.key?(:'classname')
+        self.classname = attributes[:'classname']
+      end
+
       if attributes.key?(:'coupon')
         self.coupon = attributes[:'coupon']
       end
@@ -126,6 +135,7 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           display_device == o.display_device &&
+          classname == o.classname &&
           coupon == o.coupon &&
           success_message == o.success_message
     end
@@ -139,7 +149,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, coupon, success_message].hash
+      [display_device, classname, coupon, success_message].hash
     end
 
     # Builds the object from hash