klaviyo-api-sdk 2.0.0 → 4.0.0

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-07-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/{unsuppression_create_job_create_query.rb → server_bis_subscription_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-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 UnsuppressionCreateJobCreateQuery
+  class ServerBISSubscriptionCreateQuery
     attr_accessor :data
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -32,7 +32,7 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'UnsuppressionCreateJobCreateQueryResourceObject'
+        :'data' => :'ServerBISSubscriptionCreateQueryResourceObject'
       }
     end
 
@@ -46,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::UnsuppressionCreateJobCreateQuery` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::ServerBISSubscriptionCreateQuery` 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::UnsuppressionCreateJobCreateQuery`. 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::ServerBISSubscriptionCreateQuery`. 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/server_bis_subscription_create_query_resource_object.rb

@@ -0,0 +1,247 @@
+=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 ServerBISSubscriptionCreateQueryResourceObject
+    attr_accessor :relationships
+
+    attr_accessor :attributes
+
+    attr_accessor :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'relationships' => :'relationships',
+        :'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
+      {
+        :'relationships' => :'ServerBISSubscriptionCreateQueryResourceObjectRelationships',
+        :'attributes' => :'ServerBISSubscriptionCreateQueryResourceObjectAttributes',
+        :'type' => :'BackInStockSubscriptionEnum'
+      }
+    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::ServerBISSubscriptionCreateQueryResourceObject` 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::ServerBISSubscriptionCreateQueryResourceObject`. 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?(:'relationships')
+        self.relationships = attributes[:'relationships']
+      end
+
+      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 &&
+          relationships == o.relationships &&
+          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
+      [relationships, 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/{unsubscription_create_job_create_query_resource_object_attributes.rb → server_bis_subscription_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-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,39 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class UnsubscriptionCreateJobCreateQueryResourceObjectAttributes
-    # Optional, the list to remove the profiles from
-    attr_accessor :list_id
-
-    # The emails to unsubscribe if any.
-    attr_accessor :emails
+  class ServerBISSubscriptionCreateQueryResourceObjectAttributes
+    # The channel(s) through which the profile would like to receive the back in stock notification. This can be leveraged within a back in stock flow to notify the subscriber through their preferred channel(s).
+    attr_accessor :channels
+
+    attr_accessor :profile
+
+    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
 
-    # The phone numbers to unsubscribe if any.
-    attr_accessor :phone_numbers
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'list_id' => :'list_id',
-        :'emails' => :'emails',
-        :'phone_numbers' => :'phone_numbers'
+        :'channels' => :'channels',
+        :'profile' => :'profile'
       }
     end
 
@@ -41,9 +58,8 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'list_id' => :'String',
-        :'emails' => :'Array<String>',
-        :'phone_numbers' => :'Array<String>'
+        :'channels' => :'Array<String>',
+        :'profile' => :'ServerBISSubscriptionCreateQueryResourceObjectAttributesProfile'
       }
     end
 
@@ -57,31 +73,25 @@ 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::UnsubscriptionCreateJobCreateQueryResourceObjectAttributes` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::ServerBISSubscriptionCreateQueryResourceObjectAttributes` 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::UnsubscriptionCreateJobCreateQueryResourceObjectAttributes`. 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::ServerBISSubscriptionCreateQueryResourceObjectAttributes`. 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?(:'list_id')
-        self.list_id = attributes[:'list_id']
-      end
-
-      if attributes.key?(:'emails')
-        if (value = attributes[:'emails']).is_a?(Array)
-          self.emails = value
+      if attributes.key?(:'channels')
+        if (value = attributes[:'channels']).is_a?(Array)
+          self.channels = value
         end
       end
 
-      if attributes.key?(:'phone_numbers')
-        if (value = attributes[:'phone_numbers']).is_a?(Array)
-          self.phone_numbers = value
-        end
+      if attributes.key?(:'profile')
+        self.profile = attributes[:'profile']
       end
     end
 
@@ -89,12 +99,17 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @channels.nil?
+        invalid_properties.push('invalid value for "channels", channels 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 @channels.nil?
       true
     end
 
@@ -103,9 +118,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          list_id == o.list_id &&
-          emails == o.emails &&
-          phone_numbers == o.phone_numbers
+          channels == o.channels &&
+          profile == o.profile
     end
 
     # @see the `==` method
@@ -117,7 +131,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [list_id, emails, phone_numbers].hash
+      [channels, profile].hash
     end
 
     # Builds the object from hash