klaviyo-api-sdk 4.1.0 → 5.0.0

data/lib/klaviyo-api-sdk/models/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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

data/lib/klaviyo-api-sdk/models/server_bis_subscription_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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -90,6 +90,10 @@ module KlaviyoAPI
         invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
       end
 
+      if @relationships.nil?
+        invalid_properties.push('invalid value for "relationships", relationships cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -98,6 +102,7 @@ module KlaviyoAPI
     def valid?
       return false if @type.nil?
       return false if @attributes.nil?
+      return false if @relationships.nil?
       true
     end
 

data/lib/klaviyo-api-sdk/models/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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -66,12 +66,17 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @variant.nil?
+        invalid_properties.push('invalid value for "variant", variant 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 @variant.nil?
       true
     end
 

data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -17,6 +17,7 @@ module KlaviyoAPI
   class ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariantData
     attr_accessor :type
 
+    # The catalog variant ID for which the profile is subscribing to back in stock notifications. This ID is made up of the integration type, catalog ID, and and the external ID of the variant like so: `integrationType:::catalogId:::externalId`. If the integration you are using is not set up for multi-catalog storage, the 'catalogId' will be `$default`. For Shopify `$shopify:::$default:::33001893429341`
     attr_accessor :id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

data/lib/klaviyo-api-sdk/models/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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -0,0 +1,224 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+The version of the OpenAPI document: 2023-10-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 SMSSubscriptionParameters
+    attr_accessor :marketing
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'marketing' => :'marketing'
+      }
+    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
+      {
+        :'marketing' => :'MarketingSubscriptionParameters'
+      }
+    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::SMSSubscriptionParameters` 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::SMSSubscriptionParameters`. 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?(:'marketing')
+        self.marketing = attributes[:'marketing']
+      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 @marketing.nil?
+        invalid_properties.push('invalid value for "marketing", marketing 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 @marketing.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 &&
+          marketing == o.marketing
+    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
+      [marketing].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/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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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-08-15
+The version of the OpenAPI document: 2023-10-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-08-15
+The version of the OpenAPI document: 2023-10-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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,34 +15,10 @@ 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
 
-    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
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -59,8 +35,8 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'email' => :'Array<String>',
-        :'sms' => :'Array<String>'
+        :'email' => :'EmailSubscriptionParameters',
+        :'sms' => :'SMSSubscriptionParameters'
       }
     end
 
@@ -86,15 +62,11 @@ module KlaviyoAPI
       }
 
       if attributes.key?(:'email')
-        if (value = attributes[:'email']).is_a?(Array)
-          self.email = value
-        end
+        self.email = attributes[:'email']
       end
 
       if attributes.key?(:'sms')
-        if (value = attributes[:'sms']).is_a?(Array)
-          self.sms = value
-        end
+        self.sms = attributes[:'sms']
       end
     end
 

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-08-15
+The version of the OpenAPI document: 2023-10-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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -90,6 +90,10 @@ module KlaviyoAPI
         invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
       end
 
+      if @relationships.nil?
+        invalid_properties.push('invalid value for "relationships", relationships cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -98,6 +102,7 @@ module KlaviyoAPI
     def valid?
       return false if @type.nil?
       return false if @attributes.nil?
+      return false if @relationships.nil?
       true
     end
 

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-08-15
+The version of the OpenAPI document: 2023-10-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_attributes_profiles.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-08-15
+The version of the OpenAPI document: 2023-10-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_relationships.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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -66,12 +66,17 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @list.nil?
+        invalid_properties.push('invalid value for "list", list 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 @list.nil?
       true
     end
 

data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.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-08-15
+The version of the OpenAPI document: 2023-10-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_relationships_list_data.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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -17,6 +17,7 @@ module KlaviyoAPI
   class SubscriptionCreateJobCreateQueryResourceObjectRelationshipsListData
     attr_accessor :type
 
+    # The list to add the newly subscribed profiles to
     attr_accessor :id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/klaviyo-api-sdk/models/subscription_delete_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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

data/lib/klaviyo-api-sdk/models/subscription_delete_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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -40,7 +40,7 @@ module KlaviyoAPI
       {
         :'type' => :'ProfileSubscriptionBulkDeleteJobEnum',
         :'attributes' => :'SubscriptionDeleteJobCreateQueryResourceObjectAttributes',
-        :'relationships' => :'SubscriptionCreateJobCreateQueryResourceObjectRelationships'
+        :'relationships' => :'SubscriptionDeleteJobCreateQueryResourceObjectRelationships'
       }
     end
 

data/lib/klaviyo-api-sdk/models/subscription_delete_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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.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-08-15
+The version of the OpenAPI document: 2023-10-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1