klaviyo-api-sdk 18.0.0 → 19.0.0

data/lib/klaviyo-api-sdk/models/{text_block_v0.rb → message_hierarchy_rcs_item.rb}

@@ -13,12 +13,19 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class TextBlockV0
-    attr_accessor :content_type
+  class MessageHierarchyRcsItem
+    # The plain text message content. Often empty for RCS when rich_content is used.
+    attr_accessor :message
 
-    attr_accessor :type
+    # The format of this message (always 'RCS' for RCS entries).
+    attr_accessor :message_format
 
-    attr_accessor :data
+    attr_accessor :rich_content
+
+    # Additional metadata for RCS messages. Legacy placement. This is typically used in rich_content.cards.extra.
+    attr_accessor :extra
+
+    attr_accessor :image
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -45,9 +52,11 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'content_type' => :'content_type',
-        :'type' => :'type',
-        :'data' => :'data'
+        :'message' => :'message',
+        :'message_format' => :'message_format',
+        :'rich_content' => :'rich_content',
+        :'extra' => :'extra',
+        :'image' => :'image'
       }
     end
 
@@ -59,15 +68,18 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'content_type' => :'String',
-        :'type' => :'String',
-        :'data' => :'TextBlockDataV0'
+        :'message' => :'String',
+        :'message_format' => :'String',
+        :'rich_content' => :'RCSRichContent',
+        :'extra' => :'Object',
+        :'image' => :'SlimImageReference'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'extra',
       ])
     end
 
@@ -75,27 +87,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::TextBlockV0` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::MessageHierarchyRcsItem` 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::TextBlockV0`. 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::MessageHierarchyRcsItem`. 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?(:'message')
+        self.message = attributes[:'message']
+      else
+        self.message = ''
       end
 
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
+      if attributes.key?(:'message_format')
+        self.message_format = attributes[:'message_format']
+      else
+        self.message_format = 'RCS'
       end
 
-      if attributes.key?(:'data')
-        self.data = attributes[:'data']
+      if attributes.key?(:'rich_content')
+        self.rich_content = attributes[:'rich_content']
+      end
+
+      if attributes.key?(:'extra')
+        self.extra = attributes[:'extra']
+      end
+
+      if attributes.key?(:'image')
+        self.image = attributes[:'image']
       end
     end
 
@@ -103,52 +127,25 @@ 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.')
-      end
-
-      if @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
-      end
-
-      if @data.nil?
-        invalid_properties.push('invalid value for "data", data 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 @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["text"])
-      return false unless type_validator.valid?(@type)
-      return false if @data.nil?
+      message_format_validator = EnumAttributeValidator.new('String', ["RCS"])
+      return false unless message_format_validator.valid?(@message_format)
       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', ["text"])
-      unless validator.valid?(type)
-        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+    # @param [Object] message_format Object to be assigned
+    def message_format=(message_format)
+      validator = EnumAttributeValidator.new('String', ["RCS"])
+      unless validator.valid?(message_format)
+        fail ArgumentError, "invalid value for \"message_format\", must be one of #{validator.allowable_values}."
       end
-      @type = type
+      @message_format = message_format
     end
 
     # Checks equality by comparing each attribute.
@@ -156,9 +153,11 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          content_type == o.content_type &&
-          type == o.type &&
-          data == o.data
+          message == o.message &&
+          message_format == o.message_format &&
+          rich_content == o.rich_content &&
+          extra == o.extra &&
+          image == o.image
     end
 
     # @see the `==` method
@@ -170,7 +169,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content_type, type, data].hash
+      [message, message_format, rich_content, extra, image].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,301 @@
+=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 MessageHierarchySmsItem
+    # The plain text SMS message content.
+    attr_accessor :message
+
+    # The format of this message (always 'SMS' for SMS entries).
+    attr_accessor :message_format
+
+    # Additional metadata for SMS messages (e.g., should_use_same_content flag).
+    attr_accessor :extra
+
+    attr_accessor :image
+
+    attr_accessor :media
+
+    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
+      {
+        :'message' => :'message',
+        :'message_format' => :'message_format',
+        :'extra' => :'extra',
+        :'image' => :'image',
+        :'media' => :'media'
+      }
+    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
+      {
+        :'message' => :'String',
+        :'message_format' => :'String',
+        :'extra' => :'Object',
+        :'image' => :'MessageHierarchySmsItemImage',
+        :'media' => :'MessageHierarchySmsItemMedia'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'extra',
+        :'image',
+        :'media'
+      ])
+    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::MessageHierarchySmsItem` 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::MessageHierarchySmsItem`. 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?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'message_format')
+        self.message_format = attributes[:'message_format']
+      else
+        self.message_format = 'SMS'
+      end
+
+      if attributes.key?(:'extra')
+        self.extra = attributes[:'extra']
+      end
+
+      if attributes.key?(:'image')
+        self.image = attributes[:'image']
+      end
+
+      if attributes.key?(:'media')
+        self.media = attributes[:'media']
+      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 @message.nil?
+        invalid_properties.push('invalid value for "message", message 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 @message.nil?
+      message_format_validator = EnumAttributeValidator.new('String', ["SMS"])
+      return false unless message_format_validator.valid?(@message_format)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] message_format Object to be assigned
+    def message_format=(message_format)
+      validator = EnumAttributeValidator.new('String', ["SMS"])
+      unless validator.valid?(message_format)
+        fail ArgumentError, "invalid value for \"message_format\", must be one of #{validator.allowable_values}."
+      end
+      @message_format = message_format
+    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 &&
+          message == o.message &&
+          message_format == o.message_format &&
+          extra == o.extra &&
+          image == o.image &&
+          media == o.media
+    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
+      [message, message_format, extra, image, media].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/message_hierarchy_sms_item_image.rb

@@ -0,0 +1,105 @@
+=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
+  # Image reference for MMS messages. Mutually exclusive with media.
+  module MessageHierarchySmsItemImage
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'DynamicSMSImage',
+          :'StaticSMSImage'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.parse(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = KlaviyoAPI.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise unless (data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model && model.valid?
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_tracking_options.rb → message_hierarchy_sms_item_media.rb}

@@ -13,14 +13,14 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  # The tracking options associated with the campaign
-  module CampaignCreateQueryResourceObjectAttributesTrackingOptions
+  # Video media for MMS messages as either a hydrated MediaAsset or a reference-style payload. Mutually exclusive with image.
+  module MessageHierarchySmsItemMedia
     class << self
       # List of class defined in oneOf (OpenAPI v3)
       def openapi_one_of
         [
-          :'CampaignsEmailTrackingOptions',
-          :'CampaignsSMSTrackingOptions'
+          :'MediaAsset',
+          :'MediaAssetReference'
         ]
       end