klaviyo-api-sdk 1.2.0 → 3.0.0

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

@@ -0,0 +1,252 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+The version of the OpenAPI document: 2023-06-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 SegmentPartialUpdateQueryResourceObject
+    attr_accessor :attributes
+
+    attr_accessor :type
+
+    attr_accessor :id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attributes' => :'attributes',
+        :'type' => :'type',
+        :'id' => :'id'
+      }
+    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' => :'SegmentPartialUpdateQueryResourceObjectAttributes',
+        :'type' => :'SegmentEnum',
+        :'id' => :'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::SegmentPartialUpdateQueryResourceObject` 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::SegmentPartialUpdateQueryResourceObject`. 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
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'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 @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
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id 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?
+      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 &&
+          id == o.id
+    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, id].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/{tag_update_query_as_sub_resource_attributes.rb → 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-06-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -14,8 +14,7 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class TagUpdateQueryAsSubResourceAttributes
-    # The Tag name
+  class SegmentPartialUpdateQueryResourceObjectAttributes
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -47,13 +46,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::TagUpdateQueryAsSubResourceAttributes` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::SegmentPartialUpdateQueryResourceObjectAttributes` 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::TagUpdateQueryAsSubResourceAttributes`. 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::SegmentPartialUpdateQueryResourceObjectAttributes`. 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/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-02-22
+The version of the OpenAPI document: 2023-06-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

data/lib/klaviyo-api-sdk/models/send_strategy_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-06-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,22 +15,22 @@ require 'time'
 
 module KlaviyoAPI
   class SendStrategySubObject
+    attr_accessor :options_sto
+
     # Describes the shape of the options object. Allowed values: ['static', 'throttled', 'immediate', 'smart_send_time']
     attr_accessor :method
 
-    attr_accessor :options_static
-
     attr_accessor :options_throttled
 
-    attr_accessor :options_sto
+    attr_accessor :options_static
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'options_sto' => :'options_sto',
         :'method' => :'method',
-        :'options_static' => :'options_static',
         :'options_throttled' => :'options_throttled',
-        :'options_sto' => :'options_sto'
+        :'options_static' => :'options_static'
       }
     end
 
@@ -42,10 +42,10 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'options_sto' => :'STOScheduleOptions',
         :'method' => :'String',
-        :'options_static' => :'StaticScheduleOptions',
         :'options_throttled' => :'ThrottledScheduleOptions',
-        :'options_sto' => :'STOScheduleOptions'
+        :'options_static' => :'StaticScheduleOptions'
       }
     end
 
@@ -70,20 +70,20 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'method')
-        self.method = attributes[:'method']
+      if attributes.key?(:'options_sto')
+        self.options_sto = attributes[:'options_sto']
       end
 
-      if attributes.key?(:'options_static')
-        self.options_static = attributes[:'options_static']
+      if attributes.key?(:'method')
+        self.method = attributes[:'method']
       end
 
       if attributes.key?(:'options_throttled')
         self.options_throttled = attributes[:'options_throttled']
       end
 
-      if attributes.key?(:'options_sto')
-        self.options_sto = attributes[:'options_sto']
+      if attributes.key?(:'options_static')
+        self.options_static = attributes[:'options_static']
       end
     end
 
@@ -110,10 +110,10 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          options_sto == o.options_sto &&
           method == o.method &&
-          options_static == o.options_static &&
           options_throttled == o.options_throttled &&
-          options_sto == o.options_sto
+          options_static == o.options_static
     end
 
     # @see the `==` method
@@ -125,7 +125,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [method, options_static, options_throttled, options_sto].hash
+      [options_sto, method, options_throttled, options_static].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-02-22
+The version of the OpenAPI document: 2023-06-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,21 +15,21 @@ require 'time'
 
 module KlaviyoAPI
   class StaticScheduleOptions
-    # The time to send at
-    attr_accessor :datetime
-
     # If the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time. Defaults to False.
     attr_accessor :is_local
 
     # Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends. Defaults to False.
     attr_accessor :send_past_recipients_immediately
 
+    # The time to send at
+    attr_accessor :datetime
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'datetime' => :'datetime',
         :'is_local' => :'is_local',
-        :'send_past_recipients_immediately' => :'send_past_recipients_immediately'
+        :'send_past_recipients_immediately' => :'send_past_recipients_immediately',
+        :'datetime' => :'datetime'
       }
     end
 
@@ -41,9 +41,9 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'datetime' => :'Time',
         :'is_local' => :'Boolean',
-        :'send_past_recipients_immediately' => :'Boolean'
+        :'send_past_recipients_immediately' => :'Boolean',
+        :'datetime' => :'Time'
       }
     end
 
@@ -68,10 +68,6 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'datetime')
-        self.datetime = attributes[:'datetime']
-      end
-
       if attributes.key?(:'is_local')
         self.is_local = attributes[:'is_local']
       end
@@ -79,6 +75,10 @@ module KlaviyoAPI
       if attributes.key?(:'send_past_recipients_immediately')
         self.send_past_recipients_immediately = attributes[:'send_past_recipients_immediately']
       end
+
+      if attributes.key?(:'datetime')
+        self.datetime = attributes[:'datetime']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -104,9 +104,9 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          datetime == o.datetime &&
           is_local == o.is_local &&
-          send_past_recipients_immediately == o.send_past_recipients_immediately
+          send_past_recipients_immediately == o.send_past_recipients_immediately &&
+          datetime == o.datetime
     end
 
     # @see the `==` method
@@ -118,7 +118,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [datetime, is_local, send_past_recipients_immediately].hash
+      [is_local, send_past_recipients_immediately, datetime].hash
     end
 
     # Builds the object from hash

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-02-22
+The version of the OpenAPI document: 2023-06-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

data/lib/klaviyo-api-sdk/models/subscription.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-06-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -17,22 +17,22 @@ module KlaviyoAPI
   class Subscription
     attr_accessor :channels
 
-    # The email address to subscribe or to set on the profile if `channels` is specified and the email channel is omitted.
-    attr_accessor :email
-
     # The phone number to subscribe or to set on the profile if `channels` is specified and the SMS channel is omitted.
     attr_accessor :phone_number
 
     # The ID of the profile to subscribe. If provided, this will be used to perform the lookup.
     attr_accessor :profile_id
 
+    # The email address to subscribe or to set on the profile if `channels` is specified and the email channel is omitted.
+    attr_accessor :email
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'channels' => :'channels',
-        :'email' => :'email',
         :'phone_number' => :'phone_number',
-        :'profile_id' => :'profile_id'
+        :'profile_id' => :'profile_id',
+        :'email' => :'email'
       }
     end
 
@@ -45,9 +45,9 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'channels' => :'SubscriptionChannels',
-        :'email' => :'String',
         :'phone_number' => :'String',
-        :'profile_id' => :'String'
+        :'profile_id' => :'String',
+        :'email' => :'String'
       }
     end
 
@@ -76,10 +76,6 @@ module KlaviyoAPI
         self.channels = attributes[:'channels']
       end
 
-      if attributes.key?(:'email')
-        self.email = attributes[:'email']
-      end
-
       if attributes.key?(:'phone_number')
         self.phone_number = attributes[:'phone_number']
       end
@@ -87,6 +83,10 @@ module KlaviyoAPI
       if attributes.key?(:'profile_id')
         self.profile_id = attributes[:'profile_id']
       end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -108,9 +108,9 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           channels == o.channels &&
-          email == o.email &&
           phone_number == o.phone_number &&
-          profile_id == o.profile_id
+          profile_id == o.profile_id &&
+          email == o.email
     end
 
     # @see the `==` method
@@ -122,7 +122,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [channels, email, phone_number, profile_id].hash
+      [channels, phone_number, profile_id, email].hash
     end
 
     # Builds the object from hash

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-02-22
+The version of the OpenAPI document: 2023-06-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,12 +15,12 @@ require 'time'
 
 module KlaviyoAPI
   class SubscriptionChannels
-    # The communication types to subscribe to on the \"EMAIL\" Channel. Currently supports \"MARKETING\".
-    attr_accessor :email
-
     # The communication types to subscribe to on the \"SMS\" Channel. Currently supports \"MARKETING\".
     attr_accessor :sms
 
+    # The communication types to subscribe to on the \"EMAIL\" Channel. Currently supports \"MARKETING\".
+    attr_accessor :email
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -46,8 +46,8 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'email' => :'email',
-        :'sms' => :'sms'
+        :'sms' => :'sms',
+        :'email' => :'email'
       }
     end
 
@@ -59,8 +59,8 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'email' => :'Array<String>',
-        :'sms' => :'Array<String>'
+        :'sms' => :'Array<String>',
+        :'email' => :'Array<String>'
       }
     end
 
@@ -85,17 +85,17 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'email')
-        if (value = attributes[:'email']).is_a?(Array)
-          self.email = value
-        end
-      end
-
       if attributes.key?(:'sms')
         if (value = attributes[:'sms']).is_a?(Array)
           self.sms = value
         end
       end
+
+      if attributes.key?(:'email')
+        if (value = attributes[:'email']).is_a?(Array)
+          self.email = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -116,8 +116,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          email == o.email &&
-          sms == o.sms
+          sms == o.sms &&
+          email == o.email
     end
 
     # @see the `==` method
@@ -129,7 +129,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, sms].hash
+      [sms, email].hash
     end
 
     # Builds the object from hash

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-02-22
+The version of the OpenAPI document: 2023-06-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -32,7 +32,7 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'SubscriptionCreateJobCreateQueryAsSubResource'
+        :'data' => :'SubscriptionCreateJobCreateQueryResourceObject'
       }
     end