klaviyo-api-sdk 2.0.0 → 4.0.0

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

@@ -0,0 +1,238 @@
+=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 ProfileSuppressionDeleteQueryResourceObject
+    attr_accessor :attributes
+
+    attr_accessor :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attributes' => :'attributes',
+        :'type' => :'type'
+      }
+    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
+      {
+        :'attributes' => :'ProfileSuppressionDeleteQueryResourceObjectAttributes',
+        :'type' => :'ProfileEnum'
+      }
+    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::ProfileSuppressionDeleteQueryResourceObject` 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::ProfileSuppressionDeleteQueryResourceObject`. 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?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      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 @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type 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 @attributes.nil?
+      return false if @type.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 &&
+          attributes == o.attributes &&
+          type == o.type
+    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
+      [attributes, type].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/{subscriptions.rb → profile_suppression_delete_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-02-22
+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,16 +14,14 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class Subscriptions
+  class ProfileSuppressionDeleteQueryResourceObjectAttributes
+    # The email of the profile to unsuppress.
     attr_accessor :email
 
-    attr_accessor :sms
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'email' => :'email',
-        :'sms' => :'sms'
+        :'email' => :'email'
       }
     end
 
@@ -35,8 +33,7 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'email' => :'EmailChannel',
-        :'sms' => :'SMSChannel'
+        :'email' => :'String'
       }
     end
 
@@ -50,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::Subscriptions` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::ProfileSuppressionDeleteQueryResourceObjectAttributes` 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::Subscriptions`. 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::ProfileSuppressionDeleteQueryResourceObjectAttributes`. 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
       }
@@ -64,10 +61,6 @@ module KlaviyoAPI
       if attributes.key?(:'email')
         self.email = attributes[:'email']
       end
-
-      if attributes.key?(:'sms')
-        self.sms = attributes[:'sms']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -88,8 +81,7 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          email == o.email &&
-          sms == o.sms
+          email == o.email
     end
 
     # @see the `==` method
@@ -101,7 +93,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, sms].hash
+      [email].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/{sms_render_options.rb → render_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-02-22
+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,22 +14,25 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class SMSRenderOptions
+  class RenderOptionsSubObject
+    attr_accessor :add_opt_out_language
+
     attr_accessor :shorten_links
 
-    attr_accessor :add_org_prefix
+    attr_accessor :include_contact_card
 
     attr_accessor :add_info_link
 
-    attr_accessor :add_opt_out_language
+    attr_accessor :add_org_prefix
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'add_opt_out_language' => :'add_opt_out_language',
         :'shorten_links' => :'shorten_links',
-        :'add_org_prefix' => :'add_org_prefix',
+        :'include_contact_card' => :'include_contact_card',
         :'add_info_link' => :'add_info_link',
-        :'add_opt_out_language' => :'add_opt_out_language'
+        :'add_org_prefix' => :'add_org_prefix'
       }
     end
 
@@ -41,10 +44,11 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'add_opt_out_language' => :'Boolean',
         :'shorten_links' => :'Boolean',
-        :'add_org_prefix' => :'Boolean',
+        :'include_contact_card' => :'Boolean',
         :'add_info_link' => :'Boolean',
-        :'add_opt_out_language' => :'Boolean'
+        :'add_org_prefix' => :'Boolean'
       }
     end
 
@@ -58,31 +62,41 @@ 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::SMSRenderOptions` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::RenderOptionsSubObject` 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::SMSRenderOptions`. 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::RenderOptionsSubObject`. 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_opt_out_language')
+        self.add_opt_out_language = attributes[:'add_opt_out_language']
+      end
+
       if attributes.key?(:'shorten_links')
         self.shorten_links = attributes[:'shorten_links']
+      else
+        self.shorten_links = true
       end
 
-      if attributes.key?(:'add_org_prefix')
-        self.add_org_prefix = attributes[:'add_org_prefix']
+      if attributes.key?(:'include_contact_card')
+        self.include_contact_card = attributes[:'include_contact_card']
       end
 
       if attributes.key?(:'add_info_link')
         self.add_info_link = attributes[:'add_info_link']
+      else
+        self.add_info_link = true
       end
 
-      if attributes.key?(:'add_opt_out_language')
-        self.add_opt_out_language = attributes[:'add_opt_out_language']
+      if attributes.key?(:'add_org_prefix')
+        self.add_org_prefix = attributes[:'add_org_prefix']
+      else
+        self.add_org_prefix = true
       end
     end
 
@@ -90,32 +104,12 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @shorten_links.nil?
-        invalid_properties.push('invalid value for "shorten_links", shorten_links cannot be nil.')
-      end
-
-      if @add_org_prefix.nil?
-        invalid_properties.push('invalid value for "add_org_prefix", add_org_prefix cannot be nil.')
-      end
-
-      if @add_info_link.nil?
-        invalid_properties.push('invalid value for "add_info_link", add_info_link cannot be nil.')
-      end
-
-      if @add_opt_out_language.nil?
-        invalid_properties.push('invalid value for "add_opt_out_language", add_opt_out_language 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 @shorten_links.nil?
-      return false if @add_org_prefix.nil?
-      return false if @add_info_link.nil?
-      return false if @add_opt_out_language.nil?
       true
     end
 
@@ -124,10 +118,11 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          add_opt_out_language == o.add_opt_out_language &&
           shorten_links == o.shorten_links &&
-          add_org_prefix == o.add_org_prefix &&
+          include_contact_card == o.include_contact_card &&
           add_info_link == o.add_info_link &&
-          add_opt_out_language == o.add_opt_out_language
+          add_org_prefix == o.add_org_prefix
     end
 
     # @see the `==` method
@@ -139,7 +134,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [shorten_links, add_org_prefix, add_info_link, add_opt_out_language].hash
+      [add_opt_out_language, shorten_links, include_contact_card, add_info_link, add_org_prefix].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/segment_enum.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-02-22
+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/segment_partial_update_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-02-22
+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/segment_partial_update_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-02-22
+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,18 +15,18 @@ require 'time'
 
 module KlaviyoAPI
   class SegmentPartialUpdateQueryResourceObject
+    attr_accessor :attributes
+
     attr_accessor :type
 
     attr_accessor :id
 
-    attr_accessor :attributes
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'attributes' => :'attributes',
         :'type' => :'type',
-        :'id' => :'id',
-        :'attributes' => :'attributes'
+        :'id' => :'id'
       }
     end
 
@@ -38,9 +38,9 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'attributes' => :'SegmentPartialUpdateQueryResourceObjectAttributes',
         :'type' => :'SegmentEnum',
-        :'id' => :'String',
-        :'attributes' => :'SegmentPartialUpdateQueryResourceObjectAttributes'
+        :'id' => :'String'
       }
     end
 
@@ -65,6 +65,10 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
@@ -72,16 +76,16 @@ module KlaviyoAPI
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
-
-      if attributes.key?(:'attributes')
-        self.attributes = attributes[:'attributes']
-      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 @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
+      end
+
       if @type.nil?
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
@@ -90,19 +94,15 @@ module KlaviyoAPI
         invalid_properties.push('invalid value for "id", id 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 @attributes.nil?
       return false if @type.nil?
       return false if @id.nil?
-      return false if @attributes.nil?
       true
     end
 
@@ -111,9 +111,9 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          attributes == o.attributes &&
           type == o.type &&
-          id == o.id &&
-          attributes == o.attributes
+          id == o.id
     end
 
     # @see the `==` method
@@ -125,7 +125,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, id, attributes].hash
+      [attributes, type, id].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/segment_partial_update_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-02-22
+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