klaviyo-api-sdk 17.0.0 → 19.0.0

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

@@ -0,0 +1,330 @@
+=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 ProfileRelationshipSource
+    # 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
+
+    # List of profile identifier mappings to JSONPath data selectors
+    attr_accessor :related_id_paths
+
+    # 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_paths' => :'related_id_paths',
+        :'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_paths' => :'Array<RelatedIdPath>',
+        :'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::ProfileRelationshipSource` 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::ProfileRelationshipSource`. 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_paths')
+        if (value = attributes[:'related_id_paths']).is_a?(Array)
+          self.related_id_paths = value
+        end
+      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_paths.nil?
+        invalid_properties.push('invalid value for "related_id_paths", related_id_paths 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', ["profile"])
+      return false unless type_validator.valid?(@type)
+      return false if @id_path.nil?
+      return false if @related_id_paths.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', ["profile"])
+      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_paths == o.related_id_paths &&
+          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_paths, 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/{sms_send_options.rb → property_filter.rb}

@@ -13,14 +13,16 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class SMSSendOptions
-    # Use smart sending.
-    attr_accessor :use_smart_sending
+  class PropertyFilter
+    attr_accessor :property
+
+    attr_accessor :value
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'use_smart_sending' => :'use_smart_sending'
+        :'property' => :'property',
+        :'value' => :'value'
       }
     end
 
@@ -32,14 +34,14 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'use_smart_sending' => :'Boolean'
+        :'property' => :'String',
+        :'value' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'use_smart_sending'
       ])
     end
 
@@ -47,21 +49,23 @@ 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::SMSSendOptions` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::PropertyFilter` 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::SMSSendOptions`. 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::PropertyFilter`. 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?(:'use_smart_sending')
-        self.use_smart_sending = attributes[:'use_smart_sending']
-      else
-        self.use_smart_sending = true
+      if attributes.key?(:'property')
+        self.property = attributes[:'property']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
       end
     end
 
@@ -69,12 +73,22 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @property.nil?
+        invalid_properties.push('invalid value for "property", property 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 @property.nil?
+      return false if @value.nil?
       true
     end
 
@@ -83,7 +97,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          use_smart_sending == o.use_smart_sending
+          property == o.property &&
+          value == o.value
     end
 
     # @see the `==` method
@@ -95,7 +110,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [use_smart_sending].hash
+      [property, value].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/{text_block_data_v0.rb → property_source.rb}

@@ -13,19 +13,22 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class TextBlockDataV0
-    attr_accessor :content
+  class PropertySource
+    # Data source ULID ID
+    attr_accessor :source_id
 
-    attr_accessor :display_options
+    # JSONPath ID selector
+    attr_accessor :id_path
 
-    attr_accessor :styles
+    # JSONPath data selector
+    attr_accessor :data_path
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'content' => :'content',
-        :'display_options' => :'display_options',
-        :'styles' => :'styles'
+        :'source_id' => :'source_id',
+        :'id_path' => :'id_path',
+        :'data_path' => :'data_path'
       }
     end
 
@@ -37,9 +40,9 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'content' => :'String',
-        :'display_options' => :'BlockDisplayOptions',
-        :'styles' => :'TextBlockStylesV0'
+        :'source_id' => :'String',
+        :'id_path' => :'String',
+        :'data_path' => :'String'
       }
     end
 
@@ -53,27 +56,27 @@ 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::TextBlockDataV0` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::PropertySource` 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::TextBlockDataV0`. 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::PropertySource`. 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')
-        self.content = attributes[:'content']
+      if attributes.key?(:'source_id')
+        self.source_id = attributes[:'source_id']
       end
 
-      if attributes.key?(:'display_options')
-        self.display_options = attributes[:'display_options']
+      if attributes.key?(:'id_path')
+        self.id_path = attributes[:'id_path']
       end
 
-      if attributes.key?(:'styles')
-        self.styles = attributes[:'styles']
+      if attributes.key?(:'data_path')
+        self.data_path = attributes[:'data_path']
       end
     end
 
@@ -81,16 +84,16 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @content.nil?
-        invalid_properties.push('invalid value for "content", content cannot be nil.')
+      if @source_id.nil?
+        invalid_properties.push('invalid value for "source_id", source_id cannot be nil.')
       end
 
-      if @display_options.nil?
-        invalid_properties.push('invalid value for "display_options", display_options cannot be nil.')
+      if @id_path.nil?
+        invalid_properties.push('invalid value for "id_path", id_path cannot be nil.')
       end
 
-      if @styles.nil?
-        invalid_properties.push('invalid value for "styles", styles cannot be nil.')
+      if @data_path.nil?
+        invalid_properties.push('invalid value for "data_path", data_path cannot be nil.')
       end
 
       invalid_properties
@@ -99,9 +102,9 @@ 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 @content.nil?
-      return false if @display_options.nil?
-      return false if @styles.nil?
+      return false if @source_id.nil?
+      return false if @id_path.nil?
+      return false if @data_path.nil?
       true
     end
 
@@ -110,9 +113,9 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          content == o.content &&
-          display_options == o.display_options &&
-          styles == o.styles
+          source_id == o.source_id &&
+          id_path == o.id_path &&
+          data_path == o.data_path
     end
 
     # @see the `==` method
@@ -124,7 +127,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content, display_options, styles].hash
+      [source_id, id_path, data_path].hash
     end
 
     # Builds the object from hash