klaviyo-api-sdk 17.0.0 → 19.0.0

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

@@ -0,0 +1,273 @@
+=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 RelatedIdPath
+    # Profile identifier type
+    attr_accessor :identifier_type
+
+    # JSONPath data selector to related ID
+    attr_accessor :path
+
+    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
+      {
+        :'identifier_type' => :'identifier_type',
+        :'path' => :'path'
+      }
+    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
+      {
+        :'identifier_type' => :'String',
+        :'path' => :'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::RelatedIdPath` 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::RelatedIdPath`. 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?(:'identifier_type')
+        self.identifier_type = attributes[:'identifier_type']
+      end
+
+      if attributes.key?(:'path')
+        self.path = attributes[:'path']
+      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 @identifier_type.nil?
+        invalid_properties.push('invalid value for "identifier_type", identifier_type cannot be nil.')
+      end
+
+      if @path.nil?
+        invalid_properties.push('invalid value for "path", 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 @identifier_type.nil?
+      identifier_type_validator = EnumAttributeValidator.new('String', ["anonymous", "email", "external-id", "klaviyo-id", "phone"])
+      return false unless identifier_type_validator.valid?(@identifier_type)
+      return false if @path.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] identifier_type Object to be assigned
+    def identifier_type=(identifier_type)
+      validator = EnumAttributeValidator.new('String', ["anonymous", "email", "external-id", "klaviyo-id", "phone"])
+      unless validator.valid?(identifier_type)
+        fail ArgumentError, "invalid value for \"identifier_type\", must be one of #{validator.allowable_values}."
+      end
+      @identifier_type = identifier_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 &&
+          identifier_type == o.identifier_type &&
+          path == o.path
+    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
+      [identifier_type, path].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/review_block_styles.rb

@@ -95,7 +95,6 @@ module KlaviyoAPI
 
     attr_accessor :quote_text_decoration
 
-    # Shadow color.
     attr_accessor :shadow_color
 
     attr_accessor :star_color
@@ -130,6 +129,7 @@ module KlaviyoAPI
 
     attr_accessor :verified_text_decoration
 
+    # Review block verified badge color.
     attr_accessor :verified_badge_color
 
     attr_accessor :verified_badge_size
@@ -604,8 +604,6 @@ module KlaviyoAPI
       return false unless quote_font_style_validator.valid?(@quote_font_style)
       quote_style_validator = EnumAttributeValidator.new('String', ["line", "square", "standard"])
       return false unless quote_style_validator.valid?(@quote_style)
-      shadow_color_validator = EnumAttributeValidator.new('String', ["dark", "light", "medium"])
-      return false unless shadow_color_validator.valid?(@shadow_color)
       star_size_validator = EnumAttributeValidator.new('String', ["large", "medium", "small"])
       return false unless star_size_validator.valid?(@star_size)
       star_rating_shape_validator = EnumAttributeValidator.new('String', ["circle", "heart", "star"])
@@ -614,6 +612,8 @@ module KlaviyoAPI
       return false unless star_alignment_validator.valid?(@star_alignment)
       verified_font_style_validator = EnumAttributeValidator.new('String', ["italic", "normal"])
       return false unless verified_font_style_validator.valid?(@verified_font_style)
+      verified_badge_color_validator = EnumAttributeValidator.new('String', ["dark", "default", "light"])
+      return false unless verified_badge_color_validator.valid?(@verified_badge_color)
       verified_badge_style_validator = EnumAttributeValidator.new('String', ["badge-and-text", "badge-only", "text-only"])
       return false unless verified_badge_style_validator.valid?(@verified_badge_style)
       true
@@ -709,16 +709,6 @@ module KlaviyoAPI
       @quote_style = quote_style
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] shadow_color Object to be assigned
-    def shadow_color=(shadow_color)
-      validator = EnumAttributeValidator.new('String', ["dark", "light", "medium"])
-      unless validator.valid?(shadow_color)
-        fail ArgumentError, "invalid value for \"shadow_color\", must be one of #{validator.allowable_values}."
-      end
-      @shadow_color = shadow_color
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] star_size Object to be assigned
     def star_size=(star_size)
@@ -759,6 +749,16 @@ module KlaviyoAPI
       @verified_font_style = verified_font_style
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] verified_badge_color Object to be assigned
+    def verified_badge_color=(verified_badge_color)
+      validator = EnumAttributeValidator.new('String', ["dark", "default", "light"])
+      unless validator.valid?(verified_badge_color)
+        fail ArgumentError, "invalid value for \"verified_badge_color\", must be one of #{validator.allowable_values}."
+      end
+      @verified_badge_color = verified_badge_color
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] verified_badge_style Object to be assigned
     def verified_badge_style=(verified_badge_style)

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

@@ -16,6 +16,10 @@ module KlaviyoAPI
   class ReviewProperties
     attr_accessor :display_device
 
+    attr_accessor :classname
+
+    attr_accessor :block_animation
+
     attr_accessor :author
 
     attr_accessor :content
@@ -58,6 +62,8 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'display_device' => :'display_device',
+        :'classname' => :'classname',
+        :'block_animation' => :'block_animation',
         :'author' => :'author',
         :'content' => :'content',
         :'rating' => :'rating',
@@ -78,6 +84,8 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'display_device' => :'Array<String>',
+        :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'author' => :'String',
         :'content' => :'String',
         :'rating' => :'Integer',
@@ -92,6 +100,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'classname',
         :'author',
         :'content',
         :'review_id',
@@ -119,6 +128,14 @@ module KlaviyoAPI
         end
       end
 
+      if attributes.key?(:'classname')
+        self.classname = attributes[:'classname']
+      end
+
+      if attributes.key?(:'block_animation')
+        self.block_animation = attributes[:'block_animation']
+      end
+
       if attributes.key?(:'author')
         self.author = attributes[:'author']
       end
@@ -181,6 +198,8 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           display_device == o.display_device &&
+          classname == o.classname &&
+          block_animation == o.block_animation &&
           author == o.author &&
           content == o.content &&
           rating == o.rating &&
@@ -200,7 +219,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, author, content, rating, verified, review_id, show_rating, show_author, show_verified].hash
+      [display_device, classname, block_animation, author, content, rating, verified, review_id, show_rating, show_author, show_verified].hash
     end
 
     # Builds the object from hash

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

@@ -24,6 +24,8 @@ module KlaviyoAPI
 
     attr_accessor :reviewer_name_style
 
+    attr_accessor :verified_badge_style
+
     attr_accessor :block_background_color
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -34,6 +36,7 @@ module KlaviyoAPI
         :'rating_style' => :'rating_style',
         :'quote_style' => :'quote_style',
         :'reviewer_name_style' => :'reviewer_name_style',
+        :'verified_badge_style' => :'verified_badge_style',
         :'block_background_color' => :'block_background_color'
       }
     end
@@ -51,6 +54,7 @@ module KlaviyoAPI
         :'rating_style' => :'RatingStyle',
         :'quote_style' => :'QuoteStyle',
         :'reviewer_name_style' => :'ReviewerNameStyle',
+        :'verified_badge_style' => :'VerifiedBadgeStyle',
         :'block_background_color' => :'String'
       }
     end
@@ -97,6 +101,10 @@ module KlaviyoAPI
         self.reviewer_name_style = attributes[:'reviewer_name_style']
       end
 
+      if attributes.key?(:'verified_badge_style')
+        self.verified_badge_style = attributes[:'verified_badge_style']
+      end
+
       if attributes.key?(:'block_background_color')
         self.block_background_color = attributes[:'block_background_color']
       else
@@ -127,6 +135,7 @@ module KlaviyoAPI
           rating_style == o.rating_style &&
           quote_style == o.quote_style &&
           reviewer_name_style == o.reviewer_name_style &&
+          verified_badge_style == o.verified_badge_style &&
           block_background_color == o.block_background_color
     end
 
@@ -139,7 +148,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [padding, background_color, rating_style, quote_style, reviewer_name_style, block_background_color].hash
+      [padding, background_color, rating_style, quote_style, reviewer_name_style, verified_badge_style, block_background_color].hash
     end
 
     # Builds the object from hash

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

@@ -27,6 +27,10 @@ module KlaviyoAPI
 
     attr_accessor :font_weight
 
+    attr_accessor :font_style
+
+    attr_accessor :text_decoration
+
     # Horizontal alignment enumeration.
     attr_accessor :alignment
 
@@ -63,6 +67,8 @@ module KlaviyoAPI
         :'text_color' => :'text_color',
         :'character_spacing' => :'character_spacing',
         :'font_weight' => :'font_weight',
+        :'font_style' => :'font_style',
+        :'text_decoration' => :'text_decoration',
         :'alignment' => :'alignment',
         :'line_height' => :'line_height'
       }
@@ -82,6 +88,8 @@ module KlaviyoAPI
         :'text_color' => :'String',
         :'character_spacing' => :'Integer',
         :'font_weight' => :'Integer',
+        :'font_style' => :'String',
+        :'text_decoration' => :'String',
         :'alignment' => :'String',
         :'line_height' => :'Float'
       }
@@ -90,6 +98,8 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'font_style',
+        :'text_decoration',
       ])
     end
 
@@ -144,6 +154,14 @@ module KlaviyoAPI
         self.font_weight = 400
       end
 
+      if attributes.key?(:'font_style')
+        self.font_style = attributes[:'font_style']
+      end
+
+      if attributes.key?(:'text_decoration')
+        self.text_decoration = attributes[:'text_decoration']
+      end
+
       if attributes.key?(:'alignment')
         self.alignment = attributes[:'alignment']
       else
@@ -205,6 +223,8 @@ module KlaviyoAPI
           text_color == o.text_color &&
           character_spacing == o.character_spacing &&
           font_weight == o.font_weight &&
+          font_style == o.font_style &&
+          text_decoration == o.text_decoration &&
           alignment == o.alignment &&
           line_height == o.line_height
     end
@@ -218,7 +238,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [layout, font_family, font_size, text_color, character_spacing, font_weight, alignment, line_height].hash
+      [layout, font_family, font_size, text_color, character_spacing, font_weight, font_style, text_decoration, alignment, line_height].hash
     end
 
     # Builds the object from hash

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

@@ -22,13 +22,16 @@ module KlaviyoAPI
           :'BackInStockEmailConsentCheckbox',
           :'Button',
           :'Checkboxes',
+          :'ContinueWithShop',
           :'CountdownTimer',
           :'Coupon',
+          :'CustomHTML',
           :'Date',
           :'Dropdown',
           :'Email',
           :'HTMLText',
           :'Image',
+          :'MarketingTrackingConsentCheckbox',
           :'OptInCode',
           :'PhoneNumber',
           :'RadioButtons',