klaviyo-api-sdk 1.0.0 → 1.1.0

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

@@ -0,0 +1,240 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+The version of the OpenAPI document: 2023-01-24
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  class UTMParamsSubObject
+    # Name of the UTM param
+    attr_accessor :name
+
+    # Value of the UTM param. Can be templated data.
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'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
+      {
+        :'name' => :'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::UTMParamsSubObject` 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::UTMParamsSubObject`. 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?(:'name')
+        self.name = attributes[:'name']
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name 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 @name.nil?
+      return false if @value.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 &&
+          name == o.name &&
+          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
+      [name, 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/v2_template_render_query_as_sub_resource.rb

@@ -3,10 +3,10 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2022-10-17
+The version of the OpenAPI document: 2023-01-24
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.1
+OpenAPI Generator version: 6.2.1
 
 =end
 
@@ -15,37 +15,13 @@ require 'time'
 
 module KlaviyoAPI
   class V2TemplateRenderQueryAsSubResource
-    attr_accessor :type
-
-    attr_accessor :attributes
-
-    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
+    # The ID of MessageTemplate
+    attr_accessor :id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'type' => :'type',
-        :'attributes' => :'attributes'
+        :'id' => :'id'
       }
     end
 
@@ -57,14 +33,14 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'type' => :'String',
-        :'attributes' => :'V2TemplateRenderQueryAsSubResourceAttributes'
+        :'id' => :'Object'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'id'
       ])
     end
 
@@ -83,12 +59,8 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
-      end
-
-      if attributes.key?(:'attributes')
-        self.attributes = attributes[:'attributes']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
     end
 
@@ -96,44 +68,21 @@ module KlaviyoAPI
     # @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 @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?
-      type_validator = EnumAttributeValidator.new('String', ["template"])
-      return false unless type_validator.valid?(@type)
-      return false if @attributes.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] type Object to be assigned
-    def type=(type)
-      validator = EnumAttributeValidator.new('String', ["template"])
-      unless validator.valid?(type)
-        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
-      end
-      @type = 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 &&
-          type == o.type &&
-          attributes == o.attributes
+          id == o.id
     end
 
     # @see the `==` method
@@ -145,7 +94,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, attributes].hash
+      [id].hash
     end
 
     # Builds the object from hash

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

@@ -3,10 +3,10 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2022-10-17
+The version of the OpenAPI document: 2023-01-24
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.1
+OpenAPI Generator version: 6.2.1
 
 =end
 

data/lib/klaviyo-api-sdk.rb

@@ -3,10 +3,10 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2022-10-17
+The version of the OpenAPI document: 2023-01-24
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.1
+OpenAPI Generator version: 6.2.1
 
 =end
 
@@ -17,6 +17,28 @@ require 'klaviyo-api-sdk/version'
 require 'klaviyo-api-sdk/configuration'
 
 # Models
+require 'klaviyo-api-sdk/models/audiences_sub_object'
+require 'klaviyo-api-sdk/models/campaign_clone_query'
+require 'klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes'
+require 'klaviyo-api-sdk/models/campaign_create_query'
+require 'klaviyo-api-sdk/models/campaign_create_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes'
+require 'klaviyo-api-sdk/models/campaign_message_assign_template_query'
+require 'klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes'
+require 'klaviyo-api-sdk/models/campaign_message_partial_update_query'
+require 'klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes'
+require 'klaviyo-api-sdk/models/campaign_partial_update_query'
+require 'klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes'
+require 'klaviyo-api-sdk/models/campaign_send_job_create_query'
+require 'klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes'
+require 'klaviyo-api-sdk/models/campaign_send_job_partial_update_query'
+require 'klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes'
 require 'klaviyo-api-sdk/models/catalog_category_create_job_create_query'
 require 'klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource'
 require 'klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes'
@@ -74,6 +96,10 @@ require 'klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_r
 require 'klaviyo-api-sdk/models/catalog_variant_update_query'
 require 'klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource'
 require 'klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes'
+require 'klaviyo-api-sdk/models/content_sub_object'
+require 'klaviyo-api-sdk/models/data_privacy_create_deletion_job_query'
+require 'klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes'
 require 'klaviyo-api-sdk/models/email_message_content'
 require 'klaviyo-api-sdk/models/email_tracking_options'
 require 'klaviyo-api-sdk/models/error_source'
@@ -103,7 +129,6 @@ require 'klaviyo-api-sdk/models/included_lists'
 require 'klaviyo-api-sdk/models/included_lists_attributes'
 require 'klaviyo-api-sdk/models/included_metrics'
 require 'klaviyo-api-sdk/models/included_metrics_attributes'
-require 'klaviyo-api-sdk/models/included_profile'
 require 'klaviyo-api-sdk/models/included_profiles'
 require 'klaviyo-api-sdk/models/included_profiles_attributes'
 require 'klaviyo-api-sdk/models/included_segments'
@@ -113,7 +138,6 @@ require 'klaviyo-api-sdk/models/included_variants_links'
 require 'klaviyo-api-sdk/models/list_create_query'
 require 'klaviyo-api-sdk/models/list_create_query_as_sub_resource'
 require 'klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes'
-require 'klaviyo-api-sdk/models/list_delete_query_as_sub_resource'
 require 'klaviyo-api-sdk/models/list_members_add_query'
 require 'klaviyo-api-sdk/models/list_members_add_query_data_inner'
 require 'klaviyo-api-sdk/models/list_members_delete_query'
@@ -144,6 +168,10 @@ require 'klaviyo-api-sdk/models/sms_tracking_options'
 require 'klaviyo-api-sdk/models/segment_partial_update_query'
 require 'klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource'
 require 'klaviyo-api-sdk/models/send_options'
+require 'klaviyo-api-sdk/models/send_options_sub_object'
+require 'klaviyo-api-sdk/models/send_strategy_sub_object'
+require 'klaviyo-api-sdk/models/send_time_sub_object'
+require 'klaviyo-api-sdk/models/static_schedule_options'
 require 'klaviyo-api-sdk/models/subscription'
 require 'klaviyo-api-sdk/models/subscription_create_job_create_query'
 require 'klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource'
@@ -152,35 +180,55 @@ require 'klaviyo-api-sdk/models/suppression'
 require 'klaviyo-api-sdk/models/suppression_create_job_create_query'
 require 'klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource'
 require 'klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes'
+require 'klaviyo-api-sdk/models/tag_create_query'
+require 'klaviyo-api-sdk/models/tag_create_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes'
+require 'klaviyo-api-sdk/models/tag_group_create_query'
+require 'klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes'
+require 'klaviyo-api-sdk/models/tag_group_update_query'
+require 'klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource_attributes'
+require 'klaviyo-api-sdk/models/tag_segment_op'
+require 'klaviyo-api-sdk/models/tag_segment_op_data_inner'
+require 'klaviyo-api-sdk/models/tag_update_query'
+require 'klaviyo-api-sdk/models/tag_update_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes'
 require 'klaviyo-api-sdk/models/template_clone_query'
 require 'klaviyo-api-sdk/models/template_clone_query_as_sub_resource'
 require 'klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes'
 require 'klaviyo-api-sdk/models/template_create_query'
 require 'klaviyo-api-sdk/models/template_create_query_as_sub_resource'
 require 'klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes'
-require 'klaviyo-api-sdk/models/template_delete_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/template_render_query'
+require 'klaviyo-api-sdk/models/template_render_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes'
 require 'klaviyo-api-sdk/models/template_update_query'
 require 'klaviyo-api-sdk/models/template_update_query_as_sub_resource'
 require 'klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes'
+require 'klaviyo-api-sdk/models/throttled_schedule_options'
+require 'klaviyo-api-sdk/models/tracking_options_sub_object'
+require 'klaviyo-api-sdk/models/utm_params_sub_object'
 require 'klaviyo-api-sdk/models/unsubscription_create_job_create_query'
 require 'klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource'
 require 'klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes'
 require 'klaviyo-api-sdk/models/unsuppression_create_job_create_query'
 require 'klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource'
+require 'klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes'
 require 'klaviyo-api-sdk/models/utm_param_info'
-require 'klaviyo-api-sdk/models/v2_template_render_query'
 require 'klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource'
-require 'klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource_attributes'
 
 # APIs
 require 'klaviyo-api-sdk/api/catalogs_api'
 require 'klaviyo-api-sdk/api/client_api'
+require 'klaviyo-api-sdk/api/data_privacy_api'
 require 'klaviyo-api-sdk/api/events_api'
 require 'klaviyo-api-sdk/api/flows_api'
 require 'klaviyo-api-sdk/api/lists_api'
 require 'klaviyo-api-sdk/api/metrics_api'
 require 'klaviyo-api-sdk/api/profiles_api'
 require 'klaviyo-api-sdk/api/segments_api'
+require 'klaviyo-api-sdk/api/tags_api'
 require 'klaviyo-api-sdk/api/templates_api'
 
 # retry logic