klaviyo-api-sdk 3.0.0 → 4.0.0

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

@@ -0,0 +1,220 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+The version of the OpenAPI document: 2023-07-15
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  class SMSContentSubObjectCreate
+    # The message body
+    attr_accessor :body
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'body' => :'body'
+      }
+    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
+      {
+        :'body' => :'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::SMSContentSubObjectCreate` 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::SMSContentSubObjectCreate`. 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?(:'body')
+        self.body = attributes[:'body']
+      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 &&
+          body == o.body
+    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
+      [body].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/{send_options_sub_object.rb → sms_send_options_sub_object.rb}

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-06-15
+The version of the OpenAPI document: 2023-07-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class SendOptionsSubObject
+  class SMSSendOptionsSubObject
     # Use smart sending. Defaults to True
     attr_accessor :use_smart_sending
 
@@ -47,13 +47,13 @@ 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::SendOptionsSubObject` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::SMSSendOptionsSubObject` 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::SendOptionsSubObject`. 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::SMSSendOptionsSubObject`. 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
       }

data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object_attributes.rb → sms_tracking_options_sub_object.rb}

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-06-15
+The version of the OpenAPI document: 2023-07-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -14,14 +14,18 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class UnsuppressionCreateJobCreateQueryResourceObjectAttributes
-    # One or more suppressions to be removed.
-    attr_accessor :suppressions
+  class SMSTrackingOptionsSubObject
+    # A list of UTM parameters. If an empty list is given and is_add_utm is True, uses company defaults.
+    attr_accessor :utm_params
+
+    # Whether the campaign needs UTM parameters. If set to False, UTM params will not be used.
+    attr_accessor :is_add_utm
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'suppressions' => :'suppressions'
+        :'utm_params' => :'utm_params',
+        :'is_add_utm' => :'is_add_utm'
       }
     end
 
@@ -33,7 +37,8 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'suppressions' => :'Array<Suppression>'
+        :'utm_params' => :'Array<UTMParamsSubObject>',
+        :'is_add_utm' => :'Boolean'
       }
     end
 
@@ -47,39 +52,38 @@ 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::UnsuppressionCreateJobCreateQueryResourceObjectAttributes` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::SMSTrackingOptionsSubObject` 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::UnsuppressionCreateJobCreateQueryResourceObjectAttributes`. 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::SMSTrackingOptionsSubObject`. 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?(:'suppressions')
-        if (value = attributes[:'suppressions']).is_a?(Array)
-          self.suppressions = value
+      if attributes.key?(:'utm_params')
+        if (value = attributes[:'utm_params']).is_a?(Array)
+          self.utm_params = value
         end
       end
+
+      if attributes.key?(:'is_add_utm')
+        self.is_add_utm = attributes[:'is_add_utm']
+      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 @suppressions.nil?
-        invalid_properties.push('invalid value for "suppressions", suppressions 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 @suppressions.nil?
       true
     end
 
@@ -88,7 +92,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          suppressions == o.suppressions
+          utm_params == o.utm_params &&
+          is_add_utm == o.is_add_utm
     end
 
     # @see the `==` method
@@ -100,7 +105,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [suppressions].hash
+      [utm_params, is_add_utm].hash
     end
 
     # Builds the object from hash

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

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

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

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

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

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

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

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

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-06-15
+The version of the OpenAPI document: 2023-07-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,6 +15,8 @@ require 'time'
 
 module KlaviyoAPI
   class SubscriptionCreateJobCreateQueryResourceObject
+    attr_accessor :relationships
+
     attr_accessor :attributes
 
     attr_accessor :type
@@ -22,6 +24,7 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'relationships' => :'relationships',
         :'attributes' => :'attributes',
         :'type' => :'type'
       }
@@ -35,6 +38,7 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'relationships' => :'SubscriptionDeleteJobCreateQueryResourceObjectRelationships',
         :'attributes' => :'SubscriptionCreateJobCreateQueryResourceObjectAttributes',
         :'type' => :'ProfileSubscriptionBulkCreateJobEnum'
       }
@@ -61,6 +65,10 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'relationships')
+        self.relationships = attributes[:'relationships']
+      end
+
       if attributes.key?(:'attributes')
         self.attributes = attributes[:'attributes']
       end
@@ -98,6 +106,7 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          relationships == o.relationships &&
           attributes == o.attributes &&
           type == o.type
     end
@@ -111,7 +120,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attributes, type].hash
+      [relationships, attributes, type].hash
     end
 
     # Builds the object from hash

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-06-15
+The version of the OpenAPI document: 2023-07-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,21 +15,16 @@ require 'time'
 
 module KlaviyoAPI
   class SubscriptionCreateJobCreateQueryResourceObjectAttributes
-    # One or more subscriptions to be created.
-    attr_accessor :subscriptions
+    attr_accessor :profiles
 
     # A custom method detail or source to store on the consent records.
     attr_accessor :custom_source
 
-    # The list to add the newly subscribed profiles to
-    attr_accessor :list_id
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'subscriptions' => :'subscriptions',
-        :'custom_source' => :'custom_source',
-        :'list_id' => :'list_id'
+        :'profiles' => :'profiles',
+        :'custom_source' => :'custom_source'
       }
     end
 
@@ -41,9 +36,8 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'subscriptions' => :'Array<Subscription>',
-        :'custom_source' => :'String',
-        :'list_id' => :'String'
+        :'profiles' => :'SubscriptionCreateJobCreateQueryResourceObjectAttributesProfiles',
+        :'custom_source' => :'String'
       }
     end
 
@@ -68,31 +62,21 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'subscriptions')
-        if (value = attributes[:'subscriptions']).is_a?(Array)
-          self.subscriptions = value
-        end
+      if attributes.key?(:'profiles')
+        self.profiles = attributes[:'profiles']
       end
 
       if attributes.key?(:'custom_source')
         self.custom_source = attributes[:'custom_source']
       end
-
-      if attributes.key?(:'list_id')
-        self.list_id = attributes[:'list_id']
-      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 @subscriptions.nil?
-        invalid_properties.push('invalid value for "subscriptions", subscriptions cannot be nil.')
-      end
-
-      if @list_id.nil?
-        invalid_properties.push('invalid value for "list_id", list_id cannot be nil.')
+      if @profiles.nil?
+        invalid_properties.push('invalid value for "profiles", profiles cannot be nil.')
       end
 
       invalid_properties
@@ -101,8 +85,7 @@ 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 @subscriptions.nil?
-      return false if @list_id.nil?
+      return false if @profiles.nil?
       true
     end
 
@@ -111,9 +94,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          subscriptions == o.subscriptions &&
-          custom_source == o.custom_source &&
-          list_id == o.list_id
+          profiles == o.profiles &&
+          custom_source == o.custom_source
     end
 
     # @see the `==` method
@@ -125,7 +107,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [subscriptions, custom_source, list_id].hash
+      [profiles, custom_source].hash
     end
 
     # Builds the object from hash