klaviyo-api-sdk 17.0.0 → 18.0.0

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

@@ -0,0 +1,252 @@
+=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 SourceMappingPartialUpdateQueryResourceObject
+    attr_accessor :type
+
+    # The ULID ID of the source mapping
+    attr_accessor :id
+
+    attr_accessor :attributes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'id' => :'id',
+        :'attributes' => :'attributes'
+      }
+    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' => :'SourceMappingEnum',
+        :'id' => :'String',
+        :'attributes' => :'SourceMappingCreateQueryResourceObjectAttributes'
+      }
+    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::SourceMappingPartialUpdateQueryResourceObject` 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::SourceMappingPartialUpdateQueryResourceObject`. 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
+
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      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
+
+      if @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes 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?
+      return false if @attributes.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 &&
+          attributes == o.attributes
+    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, attributes].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/spin_to_win_properties.rb

@@ -16,6 +16,8 @@ module KlaviyoAPI
   class SpinToWinProperties
     attr_accessor :display_device
 
+    attr_accessor :classname
+
     attr_accessor :duplicate_slices
 
     attr_accessor :slices
@@ -46,6 +48,7 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'display_device' => :'display_device',
+        :'classname' => :'classname',
         :'duplicate_slices' => :'duplicate_slices',
         :'slices' => :'slices'
       }
@@ -60,6 +63,7 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'display_device' => :'Array<String>',
+        :'classname' => :'String',
         :'duplicate_slices' => :'Boolean',
         :'slices' => :'Array<SpinToWinSliceConfig>'
       }
@@ -68,6 +72,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'classname',
       ])
     end
 
@@ -92,6 +97,10 @@ module KlaviyoAPI
         end
       end
 
+      if attributes.key?(:'classname')
+        self.classname = attributes[:'classname']
+      end
+
       if attributes.key?(:'duplicate_slices')
         self.duplicate_slices = attributes[:'duplicate_slices']
       else
@@ -129,6 +138,7 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           display_device == o.display_device &&
+          classname == o.classname &&
           duplicate_slices == o.duplicate_slices &&
           slices == o.slices
     end
@@ -142,7 +152,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, duplicate_slices, slices].hash
+      [display_device, classname, duplicate_slices, slices].hash
     end
 
     # Builds the object from hash

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

@@ -16,7 +16,7 @@ module KlaviyoAPI
   class StringPhoneOperatorStringArrayFilter
     attr_accessor :type
 
-    # Operators for phone string array filters.  Example condition using this filter:         {
+    # Operators for phone string array filters.  Example condition using this filter:         {             \"type\": \"profile-property\",             \"field\": \"phone\",             \"filter\": {                 \"type\": \"string\",                 \"operator\": \"phone-country-code-in\",                 \"value\": [\"US\", \"GB\"]             }         }
     attr_accessor :operator
 
     attr_accessor :value

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

@@ -45,7 +45,6 @@ module KlaviyoAPI
 
     attr_accessor :cropped_src
 
-    # Aspect ratio options.
     attr_accessor :cropping_aspect_ratio
 
     attr_accessor :cropping_height
@@ -287,8 +286,6 @@ module KlaviyoAPI
       return false unless show_on_validator.valid?(@show_on)
       cell_text_align_validator = EnumAttributeValidator.new('String', ["center", "left", "right"])
       return false unless cell_text_align_validator.valid?(@cell_text_align)
-      cropping_aspect_ratio_validator = EnumAttributeValidator.new('String', ["16:9", "1:1", "2:3", "3:4", "4:3", "circle", "custom", "original"])
-      return false unless cropping_aspect_ratio_validator.valid?(@cropping_aspect_ratio)
       return false if @type.nil?
       type_validator = EnumAttributeValidator.new('String', ["table_fallback_image"])
       return false unless type_validator.valid?(@type)
@@ -325,16 +322,6 @@ module KlaviyoAPI
       @cell_text_align = cell_text_align
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] cropping_aspect_ratio Object to be assigned
-    def cropping_aspect_ratio=(cropping_aspect_ratio)
-      validator = EnumAttributeValidator.new('String', ["16:9", "1:1", "2:3", "3:4", "4:3", "circle", "custom", "original"])
-      unless validator.valid?(cropping_aspect_ratio)
-        fail ArgumentError, "invalid value for \"cropping_aspect_ratio\", must be one of #{validator.allowable_values}."
-      end
-      @cropping_aspect_ratio = cropping_aspect_ratio
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)

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

@@ -45,7 +45,6 @@ module KlaviyoAPI
 
     attr_accessor :cropped_src
 
-    # Aspect ratio options.
     attr_accessor :cropping_aspect_ratio
 
     attr_accessor :cropping_height
@@ -287,8 +286,6 @@ module KlaviyoAPI
       return false unless show_on_validator.valid?(@show_on)
       cell_text_align_validator = EnumAttributeValidator.new('String', ["center", "left", "right"])
       return false unless cell_text_align_validator.valid?(@cell_text_align)
-      cropping_aspect_ratio_validator = EnumAttributeValidator.new('String', ["16:9", "1:1", "2:3", "3:4", "4:3", "circle", "custom", "original"])
-      return false unless cropping_aspect_ratio_validator.valid?(@cropping_aspect_ratio)
       return false if @type.nil?
       type_validator = EnumAttributeValidator.new('String', ["table_image"])
       return false unless type_validator.valid?(@type)
@@ -325,16 +322,6 @@ module KlaviyoAPI
       @cell_text_align = cell_text_align
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] cropping_aspect_ratio Object to be assigned
-    def cropping_aspect_ratio=(cropping_aspect_ratio)
-      validator = EnumAttributeValidator.new('String', ["16:9", "1:1", "2:3", "3:4", "4:3", "circle", "custom", "original"])
-      unless validator.valid?(cropping_aspect_ratio)
-        fail ArgumentError, "invalid value for \"cropping_aspect_ratio\", must be one of #{validator.allowable_values}."
-      end
-      @cropping_aspect_ratio = cropping_aspect_ratio
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)

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

@@ -20,6 +20,7 @@ module KlaviyoAPI
 
     attr_accessor :body
 
+    # When present, must contain exactly one of each style type.
     attr_accessor :styles
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -16,6 +16,8 @@ module KlaviyoAPI
   class TextProperties
     attr_accessor :display_device
 
+    attr_accessor :classname
+
     attr_accessor :property_name
 
     attr_accessor :label
@@ -54,6 +56,7 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'display_device' => :'display_device',
+        :'classname' => :'classname',
         :'property_name' => :'property_name',
         :'label' => :'label',
         :'show_label' => :'show_label',
@@ -72,6 +75,7 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'display_device' => :'Array<String>',
+        :'classname' => :'String',
         :'property_name' => :'String',
         :'label' => :'String',
         :'show_label' => :'Boolean',
@@ -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?(:'property_name')
         self.property_name = attributes[:'property_name']
       end
@@ -164,6 +173,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 &&
@@ -181,7 +191,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].hash
+      [display_device, classname, property_name, label, show_label, placeholder, required, error_messages].hash
     end
 
     # Builds the object from hash

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

@@ -44,6 +44,11 @@ module KlaviyoAPI
 
     attr_accessor :specialties
 
+    # Form channel type enumeration.
+    attr_accessor :channel
+
+    attr_accessor :message_priority
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -81,7 +86,9 @@ module KlaviyoAPI
         :'location' => :'location',
         :'status' => :'status',
         :'ab_test' => :'ab_test',
-        :'specialties' => :'specialties'
+        :'specialties' => :'specialties',
+        :'channel' => :'channel',
+        :'message_priority' => :'message_priority'
       }
     end
 
@@ -105,7 +112,9 @@ module KlaviyoAPI
         :'location' => :'String',
         :'status' => :'String',
         :'ab_test' => :'Boolean',
-        :'specialties' => :'Array<String>'
+        :'specialties' => :'Array<String>',
+        :'channel' => :'String',
+        :'message_priority' => :'Integer'
       }
     end
 
@@ -198,6 +207,18 @@ module KlaviyoAPI
           self.specialties = value
         end
       end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      else
+        self.channel = 'WEB'
+      end
+
+      if attributes.key?(:'message_priority')
+        self.message_priority = attributes[:'message_priority']
+      else
+        self.message_priority = 50
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -221,6 +242,8 @@ module KlaviyoAPI
       return false unless location_validator.valid?(@location)
       status_validator = EnumAttributeValidator.new('String', ["draft", "live"])
       return false unless status_validator.valid?(@status)
+      channel_validator = EnumAttributeValidator.new('String', ["IN_APP", "WEB"])
+      return false unless channel_validator.valid?(@channel)
       true
     end
 
@@ -254,6 +277,16 @@ module KlaviyoAPI
       @status = status
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] channel Object to be assigned
+    def channel=(channel)
+      validator = EnumAttributeValidator.new('String', ["IN_APP", "WEB"])
+      unless validator.valid?(channel)
+        fail ArgumentError, "invalid value for \"channel\", must be one of #{validator.allowable_values}."
+      end
+      @channel = channel
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -271,7 +304,9 @@ module KlaviyoAPI
           location == o.location &&
           status == o.status &&
           ab_test == o.ab_test &&
-          specialties == o.specialties
+          specialties == o.specialties &&
+          channel == o.channel &&
+          message_priority == o.message_priority
     end
 
     # @see the `==` method
@@ -283,7 +318,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, steps, triggers, teasers, dynamic_button, name, styles, properties, type, location, status, ab_test, specialties].hash
+      [id, steps, triggers, teasers, dynamic_button, name, styles, properties, type, location, status, ab_test, specialties, channel, message_priority].hash
     end
 
     # Builds the object from hash

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

@@ -25,6 +25,8 @@ module KlaviyoAPI
 
     attr_accessor :show_close_button
 
+    attr_accessor :accessible_name
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -54,7 +56,8 @@ module KlaviyoAPI
         :'click_outside_to_close' => :'click_outside_to_close',
         :'rule_based_trigger_evaluation' => :'rule_based_trigger_evaluation',
         :'record_utm_params_on_submit' => :'record_utm_params_on_submit',
-        :'show_close_button' => :'show_close_button'
+        :'show_close_button' => :'show_close_button',
+        :'accessible_name' => :'accessible_name'
       }
     end
 
@@ -70,7 +73,8 @@ module KlaviyoAPI
         :'click_outside_to_close' => :'Array<String>',
         :'rule_based_trigger_evaluation' => :'String',
         :'record_utm_params_on_submit' => :'Boolean',
-        :'show_close_button' => :'Boolean'
+        :'show_close_button' => :'Boolean',
+        :'accessible_name' => :'String'
       }
     end
 
@@ -79,6 +83,7 @@ module KlaviyoAPI
       Set.new([
         :'click_outside_to_close',
         :'rule_based_trigger_evaluation',
+        :'accessible_name'
       ])
     end
 
@@ -124,6 +129,10 @@ module KlaviyoAPI
       else
         self.show_close_button = true
       end
+
+      if attributes.key?(:'accessible_name')
+        self.accessible_name = attributes[:'accessible_name']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -160,7 +169,8 @@ module KlaviyoAPI
           click_outside_to_close == o.click_outside_to_close &&
           rule_based_trigger_evaluation == o.rule_based_trigger_evaluation &&
           record_utm_params_on_submit == o.record_utm_params_on_submit &&
-          show_close_button == o.show_close_button
+          show_close_button == o.show_close_button &&
+          accessible_name == o.accessible_name
     end
 
     # @see the `==` method
@@ -172,7 +182,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [side_image_settings, click_outside_to_close, rule_based_trigger_evaluation, record_utm_params_on_submit, show_close_button].hash
+      [side_image_settings, click_outside_to_close, rule_based_trigger_evaluation, record_utm_params_on_submit, show_close_button, accessible_name].hash
     end
 
     # Builds the object from hash