klaviyo-api-sdk 1.1.0 → 1.2.0

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

data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.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-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -17,6 +17,7 @@ module KlaviyoAPI
   class ListPartialUpdateQueryAsSubResource
     attr_accessor :type
 
+    # Primary key that uniquely identifies this list. Generated by Klaviyo.
     attr_accessor :id
 
     attr_accessor :attributes

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

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

data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_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-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -18,6 +18,9 @@ module KlaviyoAPI
     # The metric ID used in the aggregation.
     attr_accessor :metric_id
 
+    # Optional pagination cursor to iterate over large result sets
+    attr_accessor :page_cursor
+
     # Measurement key, e.g. `unique`, `sum_value`, `count`
     attr_accessor :measurements
 
@@ -33,16 +36,15 @@ module KlaviyoAPI
     # Provide fields to limit the returned data
     attr_accessor :return_fields
 
-    # List of filters, must include time range using ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).             These filters follow a similar format to those in `GET` requests, the primary difference is that this endpoint asks for a list.             The time range can be filtered by providing a `greater_or_equal` and a `less-than` filter on the `datetime` field.
+    # List of filters, must include time range using ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).             These filters follow a similar format to those in `GET` requests, the primary difference is that this endpoint asks for a list.             The time range can be filtered by providing a `greater-or-equal` and a `less-than` filter on the `datetime` field.
     attr_accessor :filter
 
     # The timezone used for processing the query, e.g. `'America/New_York'`.             This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones).             While most are supported, a few notable exceptions are `Factory`, `Europe/Kyiv` and `Pacific/Kanton`. This field is case-sensitive.
     attr_accessor :timezone
 
+    # Provide a sort key (e.g. -$message)
     attr_accessor :sort
 
-    attr_accessor :page_cursor
-
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -69,6 +71,7 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'metric_id' => :'metric_id',
+        :'page_cursor' => :'page_cursor',
         :'measurements' => :'measurements',
         :'interval' => :'interval',
         :'page_size' => :'page_size',
@@ -76,8 +79,7 @@ module KlaviyoAPI
         :'return_fields' => :'return_fields',
         :'filter' => :'filter',
         :'timezone' => :'timezone',
-        :'sort' => :'sort',
-        :'page_cursor' => :'page_cursor'
+        :'sort' => :'sort'
       }
     end
 
@@ -90,6 +92,7 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'metric_id' => :'String',
+        :'page_cursor' => :'String',
         :'measurements' => :'Array<String>',
         :'interval' => :'String',
         :'page_size' => :'Integer',
@@ -97,8 +100,7 @@ module KlaviyoAPI
         :'return_fields' => :'Array<String>',
         :'filter' => :'Array<String>',
         :'timezone' => :'String',
-        :'sort' => :'String',
-        :'page_cursor' => :'String'
+        :'sort' => :'String'
       }
     end
 
@@ -127,6 +129,10 @@ module KlaviyoAPI
         self.metric_id = attributes[:'metric_id']
       end
 
+      if attributes.key?(:'page_cursor')
+        self.page_cursor = attributes[:'page_cursor']
+      end
+
       if attributes.key?(:'measurements')
         if (value = attributes[:'measurements']).is_a?(Array)
           self.measurements = value
@@ -170,10 +176,6 @@ module KlaviyoAPI
       if attributes.key?(:'sort')
         self.sort = attributes[:'sort']
       end
-
-      if attributes.key?(:'page_cursor')
-        self.page_cursor = attributes[:'page_cursor']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -239,6 +241,7 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           metric_id == o.metric_id &&
+          page_cursor == o.page_cursor &&
           measurements == o.measurements &&
           interval == o.interval &&
           page_size == o.page_size &&
@@ -246,8 +249,7 @@ module KlaviyoAPI
           return_fields == o.return_fields &&
           filter == o.filter &&
           timezone == o.timezone &&
-          sort == o.sort &&
-          page_cursor == o.page_cursor
+          sort == o.sort
     end
 
     # @see the `==` method
@@ -259,7 +261,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [metric_id, measurements, interval, page_size, by, return_fields, filter, timezone, sort, page_cursor].hash
+      [metric_id, page_cursor, measurements, interval, page_size, by, return_fields, filter, timezone, sort].hash
     end
 
     # Builds the object from hash

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

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

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

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

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

data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.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-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,25 +15,30 @@ require 'time'
 
 module KlaviyoAPI
   class OnsiteProfileMetaIdentifiers
+    # Primary key that uniquely identifies this profile. Generated by Klaviyo.
     attr_accessor :id
 
-    attr_accessor :external_id
-
+    # Individual's email address
     attr_accessor :email
 
+    # Individual's phone number in E.164 format
     attr_accessor :phone_number
 
+    # A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
+    attr_accessor :external_id
+
     attr_accessor :anonymous_id
 
+    #  Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo's web tracking.  You can use this field as a filter when retrieving profiles via the Get Profiles endpoint. 
     attr_accessor :_kx
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
-        :'external_id' => :'external_id',
         :'email' => :'email',
         :'phone_number' => :'phone_number',
+        :'external_id' => :'external_id',
         :'anonymous_id' => :'anonymous_id',
         :'_kx' => :'_kx'
       }
@@ -48,9 +53,9 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'id' => :'String',
-        :'external_id' => :'String',
         :'email' => :'String',
         :'phone_number' => :'String',
+        :'external_id' => :'String',
         :'anonymous_id' => :'String',
         :'_kx' => :'String'
       }
@@ -81,10 +86,6 @@ module KlaviyoAPI
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'external_id')
-        self.external_id = attributes[:'external_id']
-      end
-
       if attributes.key?(:'email')
         self.email = attributes[:'email']
       end
@@ -93,6 +94,10 @@ module KlaviyoAPI
         self.phone_number = attributes[:'phone_number']
       end
 
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      end
+
       if attributes.key?(:'anonymous_id')
         self.anonymous_id = attributes[:'anonymous_id']
       end
@@ -121,9 +126,9 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          external_id == o.external_id &&
           email == o.email &&
           phone_number == o.phone_number &&
+          external_id == o.external_id &&
           anonymous_id == o.anonymous_id &&
           _kx == o._kx
     end
@@ -137,7 +142,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, external_id, email, phone_number, anonymous_id, _kx].hash
+      [id, email, phone_number, external_id, anonymous_id, _kx].hash
     end
 
     # Builds the object from hash

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

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

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

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

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

data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_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-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,26 +15,35 @@ require 'time'
 
 module KlaviyoAPI
   class ProfileCreateQueryAsSubResourceAttributes
+    # Individual's email address
     attr_accessor :email
 
+    # Individual's phone number in E.164 format
     attr_accessor :phone_number
 
+    # A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
     attr_accessor :external_id
 
     attr_accessor :anonymous_id
 
+    # Individual's first name
     attr_accessor :first_name
 
+    # Individual's last name
     attr_accessor :last_name
 
+    # Name of the company or organization within the company for whom the individual works
     attr_accessor :organization
 
+    # Individual's job title
     attr_accessor :title
 
+    # URL pointing to the location of a profile image
     attr_accessor :image
 
     attr_accessor :location
 
+    # An object containing key/value pairs for any custom properties assigned to this profile
     attr_accessor :properties
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/klaviyo-api-sdk/models/profile_location.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-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,22 +15,29 @@ require 'time'
 
 module KlaviyoAPI
   class ProfileLocation
+    # First line of street address
     attr_accessor :address1
 
+    # Second line of street address
     attr_accessor :address2
 
+    # City name
     attr_accessor :city
 
+    # Country name
     attr_accessor :country
 
     attr_accessor :latitude
 
     attr_accessor :longitude
 
+    # Region within a country, such as state or province
     attr_accessor :region
 
+    # Zip code
     attr_accessor :zip
 
+    # Time zone name. We recommend using time zones from the IANA Time Zone Database.
     attr_accessor :timezone
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -61,7 +68,7 @@ module KlaviyoAPI
         :'city' => :'String',
         :'country' => :'String',
         :'latitude' => :'ProfileLocationLatitude',
-        :'longitude' => :'ProfileLocationLatitude',
+        :'longitude' => :'ProfileLocationLongitude',
         :'region' => :'String',
         :'zip' => :'String',
         :'timezone' => :'String'

data/lib/klaviyo-api-sdk/models/profile_location_latitude.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-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
+  # Latitude coordinate. We recommend providing a precision of four decimal places.
   module ProfileLocationLatitude
     class << self
       # List of class defined in oneOf (OpenAPI v3)

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

@@ -0,0 +1,106 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+The version of the OpenAPI document: 2023-02-22
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  # Longitude coordinate. We recommend providing a precision of four decimal places.
+  module ProfileLocationLongitude
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'Float',
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.parse(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = KlaviyoAPI.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise unless (data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model && model.valid?
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

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

data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.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-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -17,6 +17,7 @@ module KlaviyoAPI
   class ProfilePartialUpdateQueryAsSubResource
     attr_accessor :type
 
+    # Primary key that uniquely identifies this profile. Generated by Klaviyo.
     attr_accessor :id
 
     attr_accessor :attributes

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-01-24
+The version of the OpenAPI document: 2023-02-22
 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_as_sub_resource.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-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -62,7 +62,7 @@ module KlaviyoAPI
       {
         :'type' => :'String',
         :'id' => :'String',
-        :'attributes' => :'ListCreateQueryAsSubResourceAttributes'
+        :'attributes' => :'SegmentPartialUpdateQueryAsSubResourceAttributes'
       }
     end