klaviyo-api-sdk 17.0.0 → 18.0.0

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

@@ -0,0 +1,224 @@
+=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
+  # The source mapping to create with this object schema
+  class EmbeddedObjectSchemaResourceObjectAttributesSourceMapping
+    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' => :'SourceMappingCreateQueryResourceObject'
+      }
+    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::EmbeddedObjectSchemaResourceObjectAttributesSourceMapping` 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::EmbeddedObjectSchemaResourceObjectAttributesSourceMapping`. 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/event_create_query_v2_resource_object_attributes.rb

@@ -17,7 +17,7 @@ module KlaviyoAPI
     # 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.
+    # 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 1990 and can only be up to 1 year in the future.
     attr_accessor :time
 
     # A numeric, monetary value to associate with this event. For example, the dollar amount of a purchase.
@@ -29,6 +29,9 @@ module KlaviyoAPI
     # 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
 
+    # When true, the event is recorded but does NOT trigger flows. Use this when backfilling historical events so existing flow definitions do not re-fire on events that already fired in the past.
+    attr_accessor :backfill
+
     attr_accessor :metric
 
     attr_accessor :profile
@@ -41,6 +44,7 @@ module KlaviyoAPI
         :'value' => :'value',
         :'value_currency' => :'value_currency',
         :'unique_id' => :'unique_id',
+        :'backfill' => :'backfill',
         :'metric' => :'metric',
         :'profile' => :'profile'
       }
@@ -59,6 +63,7 @@ module KlaviyoAPI
         :'value' => :'Float',
         :'value_currency' => :'String',
         :'unique_id' => :'String',
+        :'backfill' => :'Boolean',
         :'metric' => :'EventCreateQueryV2ResourceObjectAttributesMetric',
         :'profile' => :'EventCreateQueryV2ResourceObjectAttributesProfile'
       }
@@ -71,6 +76,7 @@ module KlaviyoAPI
         :'value',
         :'value_currency',
         :'unique_id',
+        :'backfill',
       ])
     end
 
@@ -109,6 +115,12 @@ module KlaviyoAPI
         self.unique_id = attributes[:'unique_id']
       end
 
+      if attributes.key?(:'backfill')
+        self.backfill = attributes[:'backfill']
+      else
+        self.backfill = false
+      end
+
       if attributes.key?(:'metric')
         self.metric = attributes[:'metric']
       end
@@ -156,6 +168,7 @@ module KlaviyoAPI
           value == o.value &&
           value_currency == o.value_currency &&
           unique_id == o.unique_id &&
+          backfill == o.backfill &&
           metric == o.metric &&
           profile == o.profile
     end
@@ -169,7 +182,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [properties, time, value, value_currency, unique_id, metric, profile].hash
+      [properties, time, value, value_currency, unique_id, backfill, metric, profile].hash
     end
 
     # Builds the object from hash

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

@@ -14,6 +14,9 @@ require 'time'
 
 module KlaviyoAPI
   class EventsBulkCreateQueryResourceObjectAttributes
+    # When true, the event is recorded but does NOT trigger flows. Use this when backfilling historical events so existing flow definitions do not re-fire on events that already fired in the past.
+    attr_accessor :backfill
+
     attr_accessor :profile
 
     attr_accessor :events
@@ -21,6 +24,7 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'backfill' => :'backfill',
         :'profile' => :'profile',
         :'events' => :'events'
       }
@@ -34,6 +38,7 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'backfill' => :'Boolean',
         :'profile' => :'EventsBulkCreateQueryResourceObjectAttributesProfile',
         :'events' => :'EventsBulkCreateQueryResourceObjectAttributesEvents'
       }
@@ -42,6 +47,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'backfill',
       ])
     end
 
@@ -60,6 +66,12 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'backfill')
+        self.backfill = attributes[:'backfill']
+      else
+        self.backfill = false
+      end
+
       if attributes.key?(:'profile')
         self.profile = attributes[:'profile']
       end
@@ -97,6 +109,7 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          backfill == o.backfill &&
           profile == o.profile &&
           events == o.events
     end
@@ -110,7 +123,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [profile, events].hash
+      [backfill, profile, events].hash
     end
 
     # Builds the object from hash

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

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

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

@@ -18,6 +18,7 @@ module KlaviyoAPI
       # List of class defined in oneOf (OpenAPI v3)
       def openapi_one_of
         [
+          :'CustomObjectDateTrigger',
           :'ListTrigger',
           :'LowInventoryTrigger',
           :'MetricTrigger',

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

@@ -86,7 +86,7 @@ module KlaviyoAPI
         :'transactional' => :'Boolean',
         :'add_tracking_params' => :'Boolean',
         :'custom_tracking_params' => :'Array<UtmParam>',
-        :'additional_filters' => :'FlowEmailAdditionalFilters',
+        :'additional_filters' => :'ConditionalBranchActionDataProfileFilter',
         :'name' => :'String',
         :'id' => :'String'
       }

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

@@ -40,6 +40,8 @@ module KlaviyoAPI
 
     attr_accessor :android_link
 
+    attr_accessor :web_url
+
     # The type of push notification to send.
     attr_accessor :push_type
 
@@ -94,6 +96,7 @@ module KlaviyoAPI
         :'on_open' => :'on_open',
         :'ios_link' => :'ios_link',
         :'android_link' => :'android_link',
+        :'web_url' => :'web_url',
         :'push_type' => :'push_type',
         :'kv_pairs' => :'kv_pairs',
         :'conversion_metric_id' => :'conversion_metric_id',
@@ -124,11 +127,12 @@ module KlaviyoAPI
         :'on_open' => :'String',
         :'ios_link' => :'String',
         :'android_link' => :'String',
+        :'web_url' => :'String',
         :'push_type' => :'String',
         :'kv_pairs' => :'Object',
         :'conversion_metric_id' => :'String',
         :'smart_sending_enabled' => :'Boolean',
-        :'additional_filters' => :'FlowPushNotificationAdditionalFilters',
+        :'additional_filters' => :'ConditionalBranchActionDataProfileFilter',
         :'action_buttons' => :'Array<PushActionButton>',
         :'name' => :'String',
         :'id' => :'String'
@@ -144,6 +148,7 @@ module KlaviyoAPI
         :'video_asset_id',
         :'ios_link',
         :'android_link',
+        :'web_url',
         :'push_type',
         :'kv_pairs',
         :'conversion_metric_id',
@@ -219,6 +224,10 @@ module KlaviyoAPI
         self.android_link = attributes[:'android_link']
       end
 
+      if attributes.key?(:'web_url')
+        self.web_url = attributes[:'web_url']
+      end
+
       if attributes.key?(:'push_type')
         self.push_type = attributes[:'push_type']
       end
@@ -271,7 +280,7 @@ module KlaviyoAPI
     # @return true if the model is valid
     def valid?
       return false if @body.nil?
-      on_open_validator = EnumAttributeValidator.new('String', ["home", "link"])
+      on_open_validator = EnumAttributeValidator.new('String', ["home", "link", "open_url"])
       return false unless on_open_validator.valid?(@on_open)
       push_type_validator = EnumAttributeValidator.new('String', ["silent", "standard"])
       return false unless push_type_validator.valid?(@push_type)
@@ -281,7 +290,7 @@ module KlaviyoAPI
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] on_open Object to be assigned
     def on_open=(on_open)
-      validator = EnumAttributeValidator.new('String', ["home", "link"])
+      validator = EnumAttributeValidator.new('String', ["home", "link", "open_url"])
       unless validator.valid?(on_open)
         fail ArgumentError, "invalid value for \"on_open\", must be one of #{validator.allowable_values}."
       end
@@ -314,6 +323,7 @@ module KlaviyoAPI
           on_open == o.on_open &&
           ios_link == o.ios_link &&
           android_link == o.android_link &&
+          web_url == o.web_url &&
           push_type == o.push_type &&
           kv_pairs == o.kv_pairs &&
           conversion_metric_id == o.conversion_metric_id &&
@@ -333,7 +343,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, body, sound, badge, badge_options, image_id, dynamic_image, video_asset_id, on_open, ios_link, android_link, push_type, kv_pairs, conversion_metric_id, smart_sending_enabled, additional_filters, action_buttons, name, id].hash
+      [title, body, sound, badge, badge_options, image_id, dynamic_image, video_asset_id, on_open, ios_link, android_link, web_url, push_type, kv_pairs, conversion_metric_id, smart_sending_enabled, additional_filters, action_buttons, name, id].hash
     end
 
     # Builds the object from hash

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

@@ -22,6 +22,9 @@ module KlaviyoAPI
     # A dynamic image asset to include in the SMS message.
     attr_accessor :dynamic_image
 
+    # The RCS/SMS message hierarchy (fallback chain). Each item contains a message_format ('RCS' or 'SMS'), message body, and optional rich content.
+    attr_accessor :message_hierarchy
+
     attr_accessor :shorten_links
 
     attr_accessor :include_contact_card
@@ -57,6 +60,7 @@ module KlaviyoAPI
         :'body' => :'body',
         :'image_id' => :'image_id',
         :'dynamic_image' => :'dynamic_image',
+        :'message_hierarchy' => :'message_hierarchy',
         :'shorten_links' => :'shorten_links',
         :'include_contact_card' => :'include_contact_card',
         :'add_org_prefix' => :'add_org_prefix',
@@ -85,6 +89,7 @@ module KlaviyoAPI
         :'body' => :'String',
         :'image_id' => :'String',
         :'dynamic_image' => :'String',
+        :'message_hierarchy' => :'Array<Object>',
         :'shorten_links' => :'Boolean',
         :'include_contact_card' => :'Boolean',
         :'add_org_prefix' => :'Boolean',
@@ -96,7 +101,7 @@ module KlaviyoAPI
         :'add_tracking_params' => :'Boolean',
         :'custom_tracking_params' => :'Array<UtmParam>',
         :'template_id' => :'String',
-        :'additional_filters' => :'FlowSmsAdditionalFilters',
+        :'additional_filters' => :'ConditionalBranchActionDataProfileFilter',
         :'name' => :'String',
         :'id' => :'String'
       }
@@ -107,6 +112,7 @@ module KlaviyoAPI
       Set.new([
         :'image_id',
         :'dynamic_image',
+        :'message_hierarchy',
         :'custom_tracking_params',
         :'template_id',
         :'additional_filters',
@@ -142,6 +148,12 @@ module KlaviyoAPI
         self.dynamic_image = attributes[:'dynamic_image']
       end
 
+      if attributes.key?(:'message_hierarchy')
+        if (value = attributes[:'message_hierarchy']).is_a?(Array)
+          self.message_hierarchy = value
+        end
+      end
+
       if attributes.key?(:'shorten_links')
         self.shorten_links = attributes[:'shorten_links']
       else
@@ -245,6 +257,7 @@ module KlaviyoAPI
           body == o.body &&
           image_id == o.image_id &&
           dynamic_image == o.dynamic_image &&
+          message_hierarchy == o.message_hierarchy &&
           shorten_links == o.shorten_links &&
           include_contact_card == o.include_contact_card &&
           add_org_prefix == o.add_org_prefix &&
@@ -270,7 +283,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [body, image_id, dynamic_image, shorten_links, include_contact_card, add_org_prefix, add_info_link, add_opt_out_language, smart_sending_enabled, sms_quiet_hours_enabled, transactional, add_tracking_params, custom_tracking_params, template_id, additional_filters, name, id].hash
+      [body, image_id, dynamic_image, message_hierarchy, shorten_links, include_contact_card, add_org_prefix, add_info_link, add_opt_out_language, smart_sending_enabled, sms_quiet_hours_enabled, transactional, add_tracking_params, custom_tracking_params, template_id, additional_filters, name, id].hash
     end
 
     # Builds the object from hash

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

@@ -138,7 +138,7 @@ module KlaviyoAPI
     def valid?
       return false if @definition.nil?
       return false if @status.nil?
-      status_validator = EnumAttributeValidator.new('String', ["draft", "live"])
+      status_validator = EnumAttributeValidator.new('String', ["draft"])
       return false unless status_validator.valid?(@status)
       return false if @ab_test.nil?
       return false if @name.nil?
@@ -148,7 +148,7 @@ module KlaviyoAPI
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["draft", "live"])
+      validator = EnumAttributeValidator.new('String', ["draft"])
       unless validator.valid?(status)
         fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end

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

@@ -16,6 +16,8 @@ module KlaviyoAPI
   class HTMLTextProperties
     attr_accessor :display_device
 
+    attr_accessor :classname
+
     attr_accessor :content
 
     class EnumAttributeValidator
@@ -44,6 +46,7 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'display_device' => :'display_device',
+        :'classname' => :'classname',
         :'content' => :'content'
       }
     end
@@ -57,6 +60,7 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'display_device' => :'Array<String>',
+        :'classname' => :'String',
         :'content' => :'String'
       }
     end
@@ -64,6 +68,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'classname',
       ])
     end
 
@@ -88,6 +93,10 @@ module KlaviyoAPI
         end
       end
 
+      if attributes.key?(:'classname')
+        self.classname = attributes[:'classname']
+      end
+
       if attributes.key?(:'content')
         self.content = attributes[:'content']
       else
@@ -114,6 +123,7 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           display_device == o.display_device &&
+          classname == o.classname &&
           content == o.content
     end
 
@@ -126,7 +136,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, content].hash
+      [display_device, classname, content].hash
     end
 
     # Builds the object from hash