klaviyo-api-sdk 18.0.0 → 19.0.0

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

@@ -0,0 +1,238 @@
+=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 FlowActionInsertQueryResourceObjectRelationshipsFlowData
+    attr_accessor :type
+
+    # The flow to insert the first action into when no anchor action is provided.
+    attr_accessor :id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'id' => :'id'
+      }
+    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
+      {
+        :'type' => :'FlowEnum',
+        :'id' => :'String'
+      }
+    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::FlowActionInsertQueryResourceObjectRelationshipsFlowData` 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::FlowActionInsertQueryResourceObjectRelationshipsFlowData`. 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']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id 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 @id.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 &&
+          type == o.type &&
+          id == o.id
+    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
+      [type, id].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/flow_action_update_query_resource_object_attributes_definition.rb

@@ -35,6 +35,7 @@ module KlaviyoAPI
           :'SendSmsAction',
           :'SendWebhookAction',
           :'SendWhatsAppAction',
+          :'SendWhatsAppWithACAction',
           :'TargetDateAction',
           :'TimeDelayAction',
           :'TriggerBranchAction',

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

@@ -34,6 +34,7 @@ module KlaviyoAPI
           :'SendSmsAction',
           :'SendWebhookAction',
           :'SendWhatsAppAction',
+          :'SendWhatsAppWithACAction',
           :'TargetDateAction',
           :'TimeDelayAction',
           :'TriggerBranchAction',

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

@@ -0,0 +1,35 @@
+=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 FlowMessageEnum
+    FLOW_MESSAGE = "flow-message".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 = FlowMessageEnum.constants.select { |c| FlowMessageEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #FlowMessageEnum" if constantValues.empty?
+      value
+    end
+  end
+end

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

@@ -133,7 +133,7 @@ module KlaviyoAPI
         :'conversion_metric_id' => :'String',
         :'smart_sending_enabled' => :'Boolean',
         :'additional_filters' => :'ConditionalBranchActionDataProfileFilter',
-        :'action_buttons' => :'Array<PushActionButton>',
+        :'action_buttons' => :'Array<PushActionButtonV2>',
         :'name' => :'String',
         :'id' => :'String'
       }

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

@@ -22,7 +22,7 @@ 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.
+    # The message hierarchy (fallback chain): exactly one RCS entry followed by one SMS entry, in priority order. Rendering selects the first entry whose format the recipient supports.
     attr_accessor :message_hierarchy
 
     attr_accessor :shorten_links
@@ -89,7 +89,7 @@ module KlaviyoAPI
         :'body' => :'String',
         :'image_id' => :'String',
         :'dynamic_image' => :'String',
-        :'message_hierarchy' => :'Array<Object>',
+        :'message_hierarchy' => :'Array<FlowSmsMessageHierarchyInner>',
         :'shorten_links' => :'Boolean',
         :'include_contact_card' => :'Boolean',
         :'add_org_prefix' => :'Boolean',

data/lib/klaviyo-api-sdk/models/{mobile_push_options_on_open.rb → flow_sms_message_hierarchy_inner.rb}

@@ -13,14 +13,13 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  module MobilePushOptionsOnOpen
+  module FlowSmsMessageHierarchyInner
     class << self
       # List of class defined in oneOf (OpenAPI v3)
       def openapi_one_of
         [
-          :'PushOnOpenApp',
-          :'PushOnOpenDeepLink',
-          :'PushOnOpenWebUrl'
+          :'MessageHierarchyRcsItem',
+          :'MessageHierarchySmsItem'
         ]
       end
 

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

@@ -29,6 +29,10 @@ module KlaviyoAPI
 
     attr_accessor :additional_filters
 
+    attr_accessor :automation_id
+
+    attr_accessor :expiry_hours
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -38,7 +42,9 @@ module KlaviyoAPI
         :'smart_sending_enabled' => :'smart_sending_enabled',
         :'transactional' => :'transactional',
         :'add_tracking_params' => :'add_tracking_params',
-        :'additional_filters' => :'additional_filters'
+        :'additional_filters' => :'additional_filters',
+        :'automation_id' => :'automation_id',
+        :'expiry_hours' => :'expiry_hours'
       }
     end
 
@@ -56,7 +62,9 @@ module KlaviyoAPI
         :'smart_sending_enabled' => :'Boolean',
         :'transactional' => :'Boolean',
         :'add_tracking_params' => :'Boolean',
-        :'additional_filters' => :'ConditionalBranchActionDataProfileFilter'
+        :'additional_filters' => :'ConditionalBranchActionDataProfileFilter',
+        :'automation_id' => :'String',
+        :'expiry_hours' => :'Integer'
       }
     end
 
@@ -66,7 +74,9 @@ module KlaviyoAPI
         :'id',
         :'name',
         :'vendor_id',
-        :'additional_filters'
+        :'additional_filters',
+        :'automation_id',
+        :'expiry_hours'
       ])
     end
 
@@ -118,6 +128,14 @@ module KlaviyoAPI
       if attributes.key?(:'additional_filters')
         self.additional_filters = attributes[:'additional_filters']
       end
+
+      if attributes.key?(:'automation_id')
+        self.automation_id = attributes[:'automation_id']
+      end
+
+      if attributes.key?(:'expiry_hours')
+        self.expiry_hours = attributes[:'expiry_hours']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -144,7 +162,9 @@ module KlaviyoAPI
           smart_sending_enabled == o.smart_sending_enabled &&
           transactional == o.transactional &&
           add_tracking_params == o.add_tracking_params &&
-          additional_filters == o.additional_filters
+          additional_filters == o.additional_filters &&
+          automation_id == o.automation_id &&
+          expiry_hours == o.expiry_hours
     end
 
     # @see the `==` method
@@ -156,7 +176,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, vendor_id, smart_sending_enabled, transactional, add_tracking_params, additional_filters].hash
+      [id, name, vendor_id, smart_sending_enabled, transactional, add_tracking_params, additional_filters, automation_id, expiry_hours].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/{campaigns_sms_tracking_options.rb → flow_whats_app_with_ac.rb}

@@ -13,18 +13,38 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class CampaignsSMSTrackingOptions
-    # Whether the campaign needs custom tracking parameters. If set to False, tracking params will not be used.
+  class FlowWhatsAppWithAC
+    # Not allowed on create.
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :vendor_id
+
+    attr_accessor :smart_sending_enabled
+
+    attr_accessor :transactional
+
     attr_accessor :add_tracking_params
 
-    # A list of custom tracking parameters. If an empty list is given and add_tracking_params is True, uses company defaults.
-    attr_accessor :custom_tracking_params
+    attr_accessor :additional_filters
+
+    attr_accessor :automation_id
+
+    attr_accessor :expiry_hours
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'vendor_id' => :'vendor_id',
+        :'smart_sending_enabled' => :'smart_sending_enabled',
+        :'transactional' => :'transactional',
         :'add_tracking_params' => :'add_tracking_params',
-        :'custom_tracking_params' => :'custom_tracking_params'
+        :'additional_filters' => :'additional_filters',
+        :'automation_id' => :'automation_id',
+        :'expiry_hours' => :'expiry_hours'
       }
     end
 
@@ -36,16 +56,27 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'vendor_id' => :'String',
+        :'smart_sending_enabled' => :'Boolean',
+        :'transactional' => :'Boolean',
         :'add_tracking_params' => :'Boolean',
-        :'custom_tracking_params' => :'Array<CampaignsEmailTrackingOptionsCustomTrackingParamsInner>'
+        :'additional_filters' => :'ConditionalBranchActionDataProfileFilter',
+        :'automation_id' => :'String',
+        :'expiry_hours' => :'Integer'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'add_tracking_params',
-        :'custom_tracking_params'
+        :'id',
+        :'name',
+        :'vendor_id',
+        :'additional_filters',
+        :'automation_id',
+        :'expiry_hours'
       ])
     end
 
@@ -53,25 +84,57 @@ 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::CampaignsSMSTrackingOptions` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::FlowWhatsAppWithAC` 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::CampaignsSMSTrackingOptions`. 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::FlowWhatsAppWithAC`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'vendor_id')
+        self.vendor_id = attributes[:'vendor_id']
+      end
+
+      if attributes.key?(:'smart_sending_enabled')
+        self.smart_sending_enabled = attributes[:'smart_sending_enabled']
+      else
+        self.smart_sending_enabled = true
+      end
+
+      if attributes.key?(:'transactional')
+        self.transactional = attributes[:'transactional']
+      else
+        self.transactional = false
+      end
+
       if attributes.key?(:'add_tracking_params')
         self.add_tracking_params = attributes[:'add_tracking_params']
+      else
+        self.add_tracking_params = false
       end
 
-      if attributes.key?(:'custom_tracking_params')
-        if (value = attributes[:'custom_tracking_params']).is_a?(Array)
-          self.custom_tracking_params = value
-        end
+      if attributes.key?(:'additional_filters')
+        self.additional_filters = attributes[:'additional_filters']
+      end
+
+      if attributes.key?(:'automation_id')
+        self.automation_id = attributes[:'automation_id']
+      end
+
+      if attributes.key?(:'expiry_hours')
+        self.expiry_hours = attributes[:'expiry_hours']
       end
     end
 
@@ -93,8 +156,15 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          id == o.id &&
+          name == o.name &&
+          vendor_id == o.vendor_id &&
+          smart_sending_enabled == o.smart_sending_enabled &&
+          transactional == o.transactional &&
           add_tracking_params == o.add_tracking_params &&
-          custom_tracking_params == o.custom_tracking_params
+          additional_filters == o.additional_filters &&
+          automation_id == o.automation_id &&
+          expiry_hours == o.expiry_hours
     end
 
     # @see the `==` method
@@ -106,7 +176,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [add_tracking_params, custom_tracking_params].hash
+      [id, name, vendor_id, smart_sending_enabled, transactional, add_tracking_params, additional_filters, automation_id, expiry_hours].hash
     end
 
     # Builds the object from hash