klaviyo-api-sdk 17.0.0 → 19.0.0

data/lib/klaviyo-api-sdk/models/{spacer_block_v0.rb → custom_object_relationship_source.rb}

@@ -13,12 +13,21 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class SpacerBlockV0
-    attr_accessor :content_type
+  class CustomObjectRelationshipSource
+    # Data source ULID ID
+    attr_accessor :source_id
 
+    # String literal for serialization
     attr_accessor :type
 
-    attr_accessor :data
+    # JSONPath data selector to owning ID
+    attr_accessor :id_path
+
+    # JSONPath data selector to related ID
+    attr_accessor :related_id_path
+
+    # Strategy for updating relationships with each new RawDataRecord ingestion
+    attr_accessor :update_strategy
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -45,9 +54,11 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'content_type' => :'content_type',
+        :'source_id' => :'source_id',
         :'type' => :'type',
-        :'data' => :'data'
+        :'id_path' => :'id_path',
+        :'related_id_path' => :'related_id_path',
+        :'update_strategy' => :'update_strategy'
       }
     end
 
@@ -59,16 +70,18 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'content_type' => :'String',
+        :'source_id' => :'String',
         :'type' => :'String',
-        :'data' => :'Object'
+        :'id_path' => :'String',
+        :'related_id_path' => :'String',
+        :'update_strategy' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'data'
+        :'update_strategy'
       ])
     end
 
@@ -76,27 +89,37 @@ 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::SpacerBlockV0` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::CustomObjectRelationshipSource` 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::SpacerBlockV0`. 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::CustomObjectRelationshipSource`. 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']
+      if attributes.key?(:'source_id')
+        self.source_id = attributes[:'source_id']
       end
 
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
 
-      if attributes.key?(:'data')
-        self.data = attributes[:'data']
+      if attributes.key?(:'id_path')
+        self.id_path = attributes[:'id_path']
+      end
+
+      if attributes.key?(:'related_id_path')
+        self.related_id_path = attributes[:'related_id_path']
+      end
+
+      if attributes.key?(:'update_strategy')
+        self.update_strategy = attributes[:'update_strategy']
+      else
+        self.update_strategy = 'replace_from_origin'
       end
     end
 
@@ -104,57 +127,69 @@ module KlaviyoAPI
     # @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.')
+      if @source_id.nil?
+        invalid_properties.push('invalid value for "source_id", source_id cannot be nil.')
       end
 
       if @type.nil?
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
 
+      if @id_path.nil?
+        invalid_properties.push('invalid value for "id_path", id_path cannot be nil.')
+      end
+
+      if @related_id_path.nil?
+        invalid_properties.push('invalid value for "related_id_path", related_id_path 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?
-      content_type_validator = EnumAttributeValidator.new('String', ["block"])
-      return false unless content_type_validator.valid?(@content_type)
+      return false if @source_id.nil?
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["spacer"])
+      type_validator = EnumAttributeValidator.new('String', ["custom-object"])
       return false unless type_validator.valid?(@type)
+      return false if @id_path.nil?
+      return false if @related_id_path.nil?
+      update_strategy_validator = EnumAttributeValidator.new('String', ["additive", "replace_from_origin"])
+      return false unless update_strategy_validator.valid?(@update_strategy)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] content_type Object to be assigned
-    def content_type=(content_type)
-      validator = EnumAttributeValidator.new('String', ["block"])
-      unless validator.valid?(content_type)
-        fail ArgumentError, "invalid value for \"content_type\", must be one of #{validator.allowable_values}."
-      end
-      @content_type = content_type
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["spacer"])
+      validator = EnumAttributeValidator.new('String', ["custom-object"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
       @type = type
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] update_strategy Object to be assigned
+    def update_strategy=(update_strategy)
+      validator = EnumAttributeValidator.new('String', ["additive", "replace_from_origin"])
+      unless validator.valid?(update_strategy)
+        fail ArgumentError, "invalid value for \"update_strategy\", must be one of #{validator.allowable_values}."
+      end
+      @update_strategy = update_strategy
+    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 &&
+          source_id == o.source_id &&
           type == o.type &&
-          data == o.data
+          id_path == o.id_path &&
+          related_id_path == o.related_id_path &&
+          update_strategy == o.update_strategy
     end
 
     # @see the `==` method
@@ -166,7 +201,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content_type, type, data].hash
+      [source_id, type, id_path, related_id_path, update_strategy].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/{local_static_send.rb → custom_social_link.rb}

@@ -13,12 +13,18 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class LocalStaticSend
-    # Whether the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time.
-    attr_accessor :is_local
+  class CustomSocialLink
+    attr_accessor :link_url
 
-    # Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends.
-    attr_accessor :send_past_recipients_immediately
+    attr_accessor :platform
+
+    attr_accessor :asset_id
+
+    attr_accessor :asset_url
+
+    attr_accessor :width
+
+    attr_accessor :height
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -45,8 +51,12 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'is_local' => :'is_local',
-        :'send_past_recipients_immediately' => :'send_past_recipients_immediately'
+        :'link_url' => :'link_url',
+        :'platform' => :'platform',
+        :'asset_id' => :'asset_id',
+        :'asset_url' => :'asset_url',
+        :'width' => :'width',
+        :'height' => :'height'
       }
     end
 
@@ -58,14 +68,22 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'is_local' => :'Boolean',
-        :'send_past_recipients_immediately' => :'Boolean'
+        :'link_url' => :'String',
+        :'platform' => :'String',
+        :'asset_id' => :'Integer',
+        :'asset_url' => :'String',
+        :'width' => :'Integer',
+        :'height' => :'Integer'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'asset_id',
+        :'asset_url',
+        :'width',
+        :'height'
       ])
     end
 
@@ -73,25 +91,39 @@ 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::LocalStaticSend` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::CustomSocialLink` 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::LocalStaticSend`. 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::CustomSocialLink`. 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?(:'is_local')
-        self.is_local = attributes[:'is_local']
+      if attributes.key?(:'link_url')
+        self.link_url = attributes[:'link_url']
       end
 
-      if attributes.key?(:'send_past_recipients_immediately')
-        self.send_past_recipients_immediately = attributes[:'send_past_recipients_immediately']
-      else
-        self.send_past_recipients_immediately = false
+      if attributes.key?(:'platform')
+        self.platform = attributes[:'platform']
+      end
+
+      if attributes.key?(:'asset_id')
+        self.asset_id = attributes[:'asset_id']
+      end
+
+      if attributes.key?(:'asset_url')
+        self.asset_url = attributes[:'asset_url']
+      end
+
+      if attributes.key?(:'width')
+        self.width = attributes[:'width']
+      end
+
+      if attributes.key?(:'height')
+        self.height = attributes[:'height']
       end
     end
 
@@ -99,8 +131,12 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @is_local.nil?
-        invalid_properties.push('invalid value for "is_local", is_local cannot be nil.')
+      if @link_url.nil?
+        invalid_properties.push('invalid value for "link_url", link_url cannot be nil.')
+      end
+
+      if @platform.nil?
+        invalid_properties.push('invalid value for "platform", platform cannot be nil.')
       end
 
       invalid_properties
@@ -109,20 +145,21 @@ module KlaviyoAPI
     # 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 @is_local.nil?
-      is_local_validator = EnumAttributeValidator.new('Boolean', ["true"])
-      return false unless is_local_validator.valid?(@is_local)
+      return false if @link_url.nil?
+      return false if @platform.nil?
+      platform_validator = EnumAttributeValidator.new('String', ["custom"])
+      return false unless platform_validator.valid?(@platform)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] is_local Object to be assigned
-    def is_local=(is_local)
-      validator = EnumAttributeValidator.new('Boolean', ["true"])
-      unless validator.valid?(is_local)
-        fail ArgumentError, "invalid value for \"is_local\", must be one of #{validator.allowable_values}."
+    # @param [Object] platform Object to be assigned
+    def platform=(platform)
+      validator = EnumAttributeValidator.new('String', ["custom"])
+      unless validator.valid?(platform)
+        fail ArgumentError, "invalid value for \"platform\", must be one of #{validator.allowable_values}."
       end
-      @is_local = is_local
+      @platform = platform
     end
 
     # Checks equality by comparing each attribute.
@@ -130,8 +167,12 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          is_local == o.is_local &&
-          send_past_recipients_immediately == o.send_past_recipients_immediately
+          link_url == o.link_url &&
+          platform == o.platform &&
+          asset_id == o.asset_id &&
+          asset_url == o.asset_url &&
+          width == o.width &&
+          height == o.height
     end
 
     # @see the `==` method
@@ -143,7 +184,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [is_local, send_past_recipients_immediately].hash
+      [link_url, platform, asset_id, asset_url, width, height].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,271 @@
+=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 CustomerHubBlockActionLinkOnly
+    attr_accessor :type
+
+    attr_accessor :links
+
+    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
+      {
+        :'type' => :'type',
+        :'links' => :'links'
+      }
+    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' => :'String',
+        :'links' => :'Link'
+      }
+    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::CustomerHubBlockActionLinkOnly` 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::CustomerHubBlockActionLinkOnly`. 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?(:'links')
+        self.links = attributes[:'links']
+      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 @links.nil?
+        invalid_properties.push('invalid value for "links", links 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?
+      type_validator = EnumAttributeValidator.new('String', ["enroll-customer-hub-block"])
+      return false unless type_validator.valid?(@type)
+      return false if @links.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', ["enroll-customer-hub-block"])
+      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 &&
+          type == o.type &&
+          links == o.links
+    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, links].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_source_record_bulk_create_job_create_query_resource_object.rb

@@ -89,6 +89,10 @@ module KlaviyoAPI
         invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
       end
 
+      if @relationships.nil?
+        invalid_properties.push('invalid value for "relationships", relationships cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -97,6 +101,7 @@ module KlaviyoAPI
     def valid?
       return false if @type.nil?
       return false if @attributes.nil?
+      return false if @relationships.nil?
       true
     end