klaviyo-api-sdk 18.0.0 → 19.0.0

data/lib/klaviyo-api-sdk/models/{campaign_message_static_count.rb → marketing_tracking_consent_configuration.rb}

@@ -13,10 +13,11 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class CampaignMessageStaticCount
-    attr_accessor :badge_config
+  class MarketingTrackingConsentConfiguration
+    # Supported marketing and email-tracking consent models.
+    attr_accessor :selected_model
 
-    attr_accessor :value
+    attr_accessor :content_by_model
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -43,8 +44,8 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'badge_config' => :'badge_config',
-        :'value' => :'value'
+        :'selected_model' => :'selected_model',
+        :'content_by_model' => :'content_by_model'
       }
     end
 
@@ -56,8 +57,8 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'badge_config' => :'String',
-        :'value' => :'String'
+        :'selected_model' => :'String',
+        :'content_by_model' => :'Object'
       }
     end
 
@@ -71,23 +72,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::CampaignMessageStaticCount` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::MarketingTrackingConsentConfiguration` 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::CampaignMessageStaticCount`. 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::MarketingTrackingConsentConfiguration`. 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?(:'badge_config')
-        self.badge_config = attributes[:'badge_config']
+      if attributes.key?(:'selected_model')
+        self.selected_model = attributes[:'selected_model']
       end
 
-      if attributes.key?(:'value')
-        self.value = attributes[:'value']
+      if attributes.key?(:'content_by_model')
+        self.content_by_model = attributes[:'content_by_model']
       end
     end
 
@@ -95,12 +96,12 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @badge_config.nil?
-        invalid_properties.push('invalid value for "badge_config", badge_config cannot be nil.')
+      if @selected_model.nil?
+        invalid_properties.push('invalid value for "selected_model", selected_model cannot be nil.')
       end
 
-      if @value.nil?
-        invalid_properties.push('invalid value for "value", value cannot be nil.')
+      if @content_by_model.nil?
+        invalid_properties.push('invalid value for "content_by_model", content_by_model cannot be nil.')
       end
 
       invalid_properties
@@ -109,21 +110,21 @@ 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 @badge_config.nil?
-      badge_config_validator = EnumAttributeValidator.new('String', ["set_count"])
-      return false unless badge_config_validator.valid?(@badge_config)
-      return false if @value.nil?
+      return false if @selected_model.nil?
+      selected_model_validator = EnumAttributeValidator.new('String', ["ALL_TRACKING_COMBINED_CONSENT", "CLICK_TRACKING_COMBINED_CONSENT", "MARKETING_AND_ALL_EMAIL_TRACKING", "MARKETING_AND_CLICK_TRACKING", "MARKETING_AND_OPEN_TRACKING", "MARKETING_OPEN_AND_CLICK_TRACKING", "OPEN_TRACKING_COMBINED_CONSENT"])
+      return false unless selected_model_validator.valid?(@selected_model)
+      return false if @content_by_model.nil?
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] badge_config Object to be assigned
-    def badge_config=(badge_config)
-      validator = EnumAttributeValidator.new('String', ["set_count"])
-      unless validator.valid?(badge_config)
-        fail ArgumentError, "invalid value for \"badge_config\", must be one of #{validator.allowable_values}."
+    # @param [Object] selected_model Object to be assigned
+    def selected_model=(selected_model)
+      validator = EnumAttributeValidator.new('String', ["ALL_TRACKING_COMBINED_CONSENT", "CLICK_TRACKING_COMBINED_CONSENT", "MARKETING_AND_ALL_EMAIL_TRACKING", "MARKETING_AND_CLICK_TRACKING", "MARKETING_AND_OPEN_TRACKING", "MARKETING_OPEN_AND_CLICK_TRACKING", "OPEN_TRACKING_COMBINED_CONSENT"])
+      unless validator.valid?(selected_model)
+        fail ArgumentError, "invalid value for \"selected_model\", must be one of #{validator.allowable_values}."
       end
-      @badge_config = badge_config
+      @selected_model = selected_model
     end
 
     # Checks equality by comparing each attribute.
@@ -131,8 +132,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          badge_config == o.badge_config &&
-          value == o.value
+          selected_model == o.selected_model &&
+          content_by_model == o.content_by_model
     end
 
     # @see the `==` method
@@ -144,7 +145,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [badge_config, value].hash
+      [selected_model, content_by_model].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,318 @@
+=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 MediaAsset
+    # The unique identifier for this media asset. Not allowed on update.
+    attr_accessor :id
+
+    # The company ID that owns this media.
+    attr_accessor :company_id
+
+    # The full URL to access the media.
+    attr_accessor :url
+
+    # The media type (e.g., 'video' for video assets).
+    attr_accessor :media_type
+
+    # The human-readable name of the media.
+    attr_accessor :name
+
+    # The size of the media file in bytes.
+    attr_accessor :file_size
+
+    # Optional thumbnail URL for video previews in RCS cards.
+    attr_accessor :thumbnail_url
+
+    # Localization key for this media asset, if applicable.
+    attr_accessor :l10n_key
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'company_id' => :'company_id',
+        :'url' => :'url',
+        :'media_type' => :'media_type',
+        :'name' => :'name',
+        :'file_size' => :'file_size',
+        :'thumbnail_url' => :'thumbnail_url',
+        :'l10n_key' => :'l10n_key'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'company_id' => :'String',
+        :'url' => :'String',
+        :'media_type' => :'String',
+        :'name' => :'String',
+        :'file_size' => :'Integer',
+        :'thumbnail_url' => :'String',
+        :'l10n_key' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'thumbnail_url',
+        :'l10n_key'
+      ])
+    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::MediaAsset` 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::MediaAsset`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'media_type')
+        self.media_type = attributes[:'media_type']
+      else
+        self.media_type = 'video'
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'file_size')
+        self.file_size = attributes[:'file_size']
+      end
+
+      if attributes.key?(:'thumbnail_url')
+        self.thumbnail_url = attributes[:'thumbnail_url']
+      end
+
+      if attributes.key?(:'l10n_key')
+        self.l10n_key = attributes[:'l10n_key']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @company_id.nil?
+        invalid_properties.push('invalid value for "company_id", company_id cannot be nil.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @file_size.nil?
+        invalid_properties.push('invalid value for "file_size", file_size 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 @id.nil?
+      return false if @company_id.nil?
+      return false if @url.nil?
+      return false if @name.nil?
+      return false if @file_size.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 &&
+          id == o.id &&
+          company_id == o.company_id &&
+          url == o.url &&
+          media_type == o.media_type &&
+          name == o.name &&
+          file_size == o.file_size &&
+          thumbnail_url == o.thumbnail_url &&
+          l10n_key == o.l10n_key
+    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
+      [id, company_id, url, media_type, name, file_size, thumbnail_url, l10n_key].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/media_asset_reference.rb

@@ -0,0 +1,240 @@
+=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 MediaAssetReference
+    # Reference to a static media asset.
+    attr_accessor :static_asset_id
+
+    # Dynamic template (e.g. Django tags) resolving to the media URL.
+    attr_accessor :dynamic_template
+
+    attr_accessor :thumbnail
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'static_asset_id' => :'static_asset_id',
+        :'dynamic_template' => :'dynamic_template',
+        :'thumbnail' => :'thumbnail'
+      }
+    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
+      {
+        :'static_asset_id' => :'String',
+        :'dynamic_template' => :'String',
+        :'thumbnail' => :'SlimImageReference'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'static_asset_id',
+        :'dynamic_template',
+      ])
+    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::MediaAssetReference` 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::MediaAssetReference`. 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?(:'static_asset_id')
+        self.static_asset_id = attributes[:'static_asset_id']
+      end
+
+      if attributes.key?(:'dynamic_template')
+        self.dynamic_template = attributes[:'dynamic_template']
+      end
+
+      if attributes.key?(:'thumbnail')
+        self.thumbnail = attributes[:'thumbnail']
+      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
+      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?
+      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 &&
+          static_asset_id == o.static_asset_id &&
+          dynamic_template == o.dynamic_template &&
+          thumbnail == o.thumbnail
+    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
+      [static_asset_id, dynamic_template, thumbnail].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