klaviyo-api-sdk 17.0.0 → 18.0.0

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

@@ -0,0 +1,328 @@
+=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 CustomObjectRelationshipSource
+    # Data source ULID ID
+    attr_accessor :source_id
+
+    # String literal for serialization
+    attr_accessor :type
+
+    # 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
+      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
+      {
+        :'source_id' => :'source_id',
+        :'type' => :'type',
+        :'id_path' => :'id_path',
+        :'related_id_path' => :'related_id_path',
+        :'update_strategy' => :'update_strategy'
+      }
+    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
+      {
+        :'source_id' => :'String',
+        :'type' => :'String',
+        :'id_path' => :'String',
+        :'related_id_path' => :'String',
+        :'update_strategy' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'update_strategy'
+      ])
+    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::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::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?(:'source_id')
+        self.source_id = attributes[:'source_id']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      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
+
+    # 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 @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 @source_id.nil?
+      return false if @type.nil?
+      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] type Object to be assigned
+    def type=(type)
+      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 &&
+          source_id == o.source_id &&
+          type == o.type &&
+          id_path == o.id_path &&
+          related_id_path == o.related_id_path &&
+          update_strategy == o.update_strategy
+    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
+      [source_id, type, id_path, related_id_path, update_strategy].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/date_properties.rb

@@ -16,6 +16,8 @@ module KlaviyoAPI
   class DateProperties
     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',
         :'placeholder',
         :'required',
@@ -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
@@ -174,6 +183,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 &&
@@ -192,7 +202,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, property_name, label, show_label, placeholder, required, error_messages, date_format].hash
+      [display_device, classname, property_name, label, show_label, placeholder, required, error_messages, date_format].hash
     end
 
     # Builds the object from hash

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

@@ -21,6 +21,10 @@ module KlaviyoAPI
 
     attr_accessor :visibility
 
+    attr_accessor :layout_type
+
+    attr_accessor :layout_config
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -48,7 +52,9 @@ module KlaviyoAPI
       {
         :'show_on' => :'show_on',
         :'content_repeat' => :'content_repeat',
-        :'visibility' => :'visibility'
+        :'visibility' => :'visibility',
+        :'layout_type' => :'layout_type',
+        :'layout_config' => :'layout_config'
       }
     end
 
@@ -62,7 +68,9 @@ module KlaviyoAPI
       {
         :'show_on' => :'String',
         :'content_repeat' => :'ContentRepeatV1',
-        :'visibility' => :'Visibility'
+        :'visibility' => :'Visibility',
+        :'layout_type' => :'String',
+        :'layout_config' => :'Object'
       }
     end
 
@@ -70,6 +78,8 @@ module KlaviyoAPI
     def self.openapi_nullable
       Set.new([
         :'show_on',
+        :'layout_type',
+        :'layout_config'
       ])
     end
 
@@ -99,6 +109,14 @@ module KlaviyoAPI
       if attributes.key?(:'visibility')
         self.visibility = attributes[:'visibility']
       end
+
+      if attributes.key?(:'layout_type')
+        self.layout_type = attributes[:'layout_type']
+      end
+
+      if attributes.key?(:'layout_config')
+        self.layout_config = attributes[:'layout_config']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -133,7 +151,9 @@ module KlaviyoAPI
       self.class == o.class &&
           show_on == o.show_on &&
           content_repeat == o.content_repeat &&
-          visibility == o.visibility
+          visibility == o.visibility &&
+          layout_type == o.layout_type &&
+          layout_config == o.layout_config
     end
 
     # @see the `==` method
@@ -145,7 +165,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [show_on, content_repeat, visibility].hash
+      [show_on, content_repeat, visibility, layout_type, layout_config].hash
     end
 
     # Builds the object from hash

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

@@ -16,6 +16,8 @@ module KlaviyoAPI
   class DropdownProperties
     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/email_properties.rb

@@ -16,6 +16,8 @@ module KlaviyoAPI
   class EmailProperties
     attr_accessor :display_device
 
+    attr_accessor :classname
+
     attr_accessor :label
 
     attr_accessor :show_label
@@ -54,6 +56,7 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'display_device' => :'display_device',
+        :'classname' => :'classname',
         :'label' => :'label',
         :'show_label' => :'show_label',
         :'placeholder' => :'placeholder',
@@ -72,6 +75,7 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'display_device' => :'Array<String>',
+        :'classname' => :'String',
         :'label' => :'String',
         :'show_label' => :'Boolean',
         :'placeholder' => :'String',
@@ -84,6 +88,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'classname',
         :'label',
         :'placeholder',
         :'required',
@@ -111,6 +116,10 @@ module KlaviyoAPI
         end
       end
 
+      if attributes.key?(:'classname')
+        self.classname = attributes[:'classname']
+      end
+
       if attributes.key?(:'label')
         self.label = attributes[:'label']
       end
@@ -173,6 +182,7 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           display_device == o.display_device &&
+          classname == o.classname &&
           label == o.label &&
           show_label == o.show_label &&
           placeholder == o.placeholder &&
@@ -190,7 +200,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, label, show_label, placeholder, required, error_messages, property_name].hash
+      [display_device, classname, label, show_label, placeholder, required, error_messages, property_name].hash
     end
 
     # Builds the object from hash

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

@@ -16,10 +16,13 @@ module KlaviyoAPI
   class EmailSubscriptionParameters
     attr_accessor :marketing
 
+    attr_accessor :open_tracking
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'marketing' => :'marketing'
+        :'marketing' => :'marketing',
+        :'open_tracking' => :'open_tracking'
       }
     end
 
@@ -31,7 +34,8 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'marketing' => :'SubscriptionParameters'
+        :'marketing' => :'SubscriptionParameters',
+        :'open_tracking' => :'OpenTrackingSubscriptionParameters'
       }
     end
 
@@ -59,23 +63,22 @@ module KlaviyoAPI
       if attributes.key?(:'marketing')
         self.marketing = attributes[:'marketing']
       end
+
+      if attributes.key?(:'open_tracking')
+        self.open_tracking = attributes[:'open_tracking']
+      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 @marketing.nil?
-        invalid_properties.push('invalid value for "marketing", marketing 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 @marketing.nil?
       true
     end
 
@@ -84,7 +87,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          marketing == o.marketing
+          marketing == o.marketing &&
+          open_tracking == o.open_tracking
     end
 
     # @see the `==` method
@@ -96,7 +100,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [marketing].hash
+      [marketing, open_tracking].hash
     end
 
     # Builds the object from hash