klaviyo-api-sdk 12.0.0 → 13.0.1

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

@@ -0,0 +1,271 @@
+=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 CampaignMessageStaticCount
+    attr_accessor :badge_config
+
+    attr_accessor :value
+
+    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
+      {
+        :'badge_config' => :'badge_config',
+        :'value' => :'value'
+      }
+    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
+      {
+        :'badge_config' => :'String',
+        :'value' => :'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::CampaignMessageStaticCount` 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
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'badge_config')
+        self.badge_config = attributes[:'badge_config']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      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 @badge_config.nil?
+        invalid_properties.push('invalid value for "badge_config", badge_config 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 @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?
+      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}."
+      end
+      @badge_config = badge_config
+    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 &&
+          badge_config == o.badge_config &&
+          value == o.value
+    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
+      [badge_config, value].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/campaign_partial_update_query.rb

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -23,7 +22,7 @@ module KlaviyoAPI
     # ID of the metric to be used for conversion statistics
     attr_accessor :conversion_metric_id
 
-    # API filter string used to filter the query. Allowed filters are send_channel, campaign_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. When filtering on send_channel, allowed values are email, push-notification, sms, whatsapp.
+    # API filter string used to filter the query. Allowed filters are send_channel, campaign_id, campaign_message_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. When filtering on send_channel, allowed values are email, sms, push-notification.
     attr_accessor :filter
 
     class EnumAttributeValidator

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

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

data/lib/klaviyo-api-sdk/models/{email_tracking_options.rb → campaigns_email_tracking_options.rb}

@@ -3,7 +3,6 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -14,22 +13,26 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class EmailTrackingOptions
-    attr_accessor :add_utm
+  class CampaignsEmailTrackingOptions
+    # Whether the campaign needs custom tracking parameters. If set to False, tracking params will not be used.
+    attr_accessor :add_tracking_params
 
-    attr_accessor :utm_params
-
-    attr_accessor :is_tracking_opens
+    # A list of custom tracking parameters. If an empty list is given and add_tracking_params is True, uses company defaults.
+    attr_accessor :custom_tracking_params
 
+    # Whether the campaign is tracking click events. If not specified, uses company defaults.
     attr_accessor :is_tracking_clicks
 
+    # Whether the campaign is tracking open events. If not specified, uses company defaults.
+    attr_accessor :is_tracking_opens
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'add_utm' => :'add_utm',
-        :'utm_params' => :'utm_params',
-        :'is_tracking_opens' => :'is_tracking_opens',
-        :'is_tracking_clicks' => :'is_tracking_clicks'
+        :'add_tracking_params' => :'add_tracking_params',
+        :'custom_tracking_params' => :'custom_tracking_params',
+        :'is_tracking_clicks' => :'is_tracking_clicks',
+        :'is_tracking_opens' => :'is_tracking_opens'
       }
     end
 
@@ -41,16 +44,20 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'add_utm' => :'Boolean',
-        :'utm_params' => :'Array<UtmParamInfo>',
-        :'is_tracking_opens' => :'Boolean',
-        :'is_tracking_clicks' => :'Boolean'
+        :'add_tracking_params' => :'Boolean',
+        :'custom_tracking_params' => :'Array<CampaignsEmailTrackingOptionsCustomTrackingParamsInner>',
+        :'is_tracking_clicks' => :'Boolean',
+        :'is_tracking_opens' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'add_tracking_params',
+        :'custom_tracking_params',
+        :'is_tracking_clicks',
+        :'is_tracking_opens'
       ])
     end
 
@@ -58,66 +65,46 @@ 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::EmailTrackingOptions` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::CampaignsEmailTrackingOptions` 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::EmailTrackingOptions`. 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::CampaignsEmailTrackingOptions`. 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?(:'add_utm')
-        self.add_utm = attributes[:'add_utm']
+      if attributes.key?(:'add_tracking_params')
+        self.add_tracking_params = attributes[:'add_tracking_params']
       end
 
-      if attributes.key?(:'utm_params')
-        if (value = attributes[:'utm_params']).is_a?(Array)
-          self.utm_params = value
+      if attributes.key?(:'custom_tracking_params')
+        if (value = attributes[:'custom_tracking_params']).is_a?(Array)
+          self.custom_tracking_params = value
         end
       end
 
-      if attributes.key?(:'is_tracking_opens')
-        self.is_tracking_opens = attributes[:'is_tracking_opens']
-      end
-
       if attributes.key?(:'is_tracking_clicks')
         self.is_tracking_clicks = attributes[:'is_tracking_clicks']
       end
+
+      if attributes.key?(:'is_tracking_opens')
+        self.is_tracking_opens = attributes[:'is_tracking_opens']
+      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 @add_utm.nil?
-        invalid_properties.push('invalid value for "add_utm", add_utm cannot be nil.')
-      end
-
-      if @utm_params.nil?
-        invalid_properties.push('invalid value for "utm_params", utm_params cannot be nil.')
-      end
-
-      if @is_tracking_opens.nil?
-        invalid_properties.push('invalid value for "is_tracking_opens", is_tracking_opens cannot be nil.')
-      end
-
-      if @is_tracking_clicks.nil?
-        invalid_properties.push('invalid value for "is_tracking_clicks", is_tracking_clicks 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 @add_utm.nil?
-      return false if @utm_params.nil?
-      return false if @is_tracking_opens.nil?
-      return false if @is_tracking_clicks.nil?
       true
     end
 
@@ -126,10 +113,10 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          add_utm == o.add_utm &&
-          utm_params == o.utm_params &&
-          is_tracking_opens == o.is_tracking_opens &&
-          is_tracking_clicks == o.is_tracking_clicks
+          add_tracking_params == o.add_tracking_params &&
+          custom_tracking_params == o.custom_tracking_params &&
+          is_tracking_clicks == o.is_tracking_clicks &&
+          is_tracking_opens == o.is_tracking_opens
     end
 
     # @see the `==` method
@@ -141,7 +128,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [add_utm, utm_params, is_tracking_opens, is_tracking_clicks].hash
+      [add_tracking_params, custom_tracking_params, is_tracking_clicks, is_tracking_opens].hash
     end
 
     # Builds the object from hash