klaviyo-api-sdk 2.0.0 → 3.0.0

data/lib/klaviyo-api-sdk/models/metric_aggregate_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
@@ -15,35 +15,35 @@ require 'time'
 
 module KlaviyoAPI
   class MetricAggregateQueryResourceObjectAttributes
-    # The metric ID used in the aggregation.
-    attr_accessor :metric_id
+    # Provide a sort key (e.g. -$message)
+    attr_accessor :sort
 
     # Optional pagination cursor to iterate over large result sets
     attr_accessor :page_cursor
 
-    # Measurement key, e.g. `unique`, `sum_value`, `count`
-    attr_accessor :measurements
-
     # Aggregation interval, e.g. \"hour\", \"day\", \"week\", \"month\"
     attr_accessor :interval
 
-    # Alter the maximum number of returned rows in a single page of aggregation results
-    attr_accessor :page_size
-
-    # Optional attribute(s) used for partitioning by the aggregation function
-    attr_accessor :by
+    # The metric ID used in the aggregation.
+    attr_accessor :metric_id
 
     # Provide fields to limit the returned data
     attr_accessor :return_fields
 
+    # Measurement key, e.g. `unique`, `sum_value`, `count`
+    attr_accessor :measurements
+
+    # Alter the maximum number of returned rows in a single page of aggregation results
+    attr_accessor :page_size
+
     # 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
+    # Optional attribute(s) used for partitioning by the aggregation function
+    attr_accessor :by
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -70,16 +70,16 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'metric_id' => :'metric_id',
+        :'sort' => :'sort',
         :'page_cursor' => :'page_cursor',
-        :'measurements' => :'measurements',
         :'interval' => :'interval',
-        :'page_size' => :'page_size',
-        :'by' => :'by',
+        :'metric_id' => :'metric_id',
         :'return_fields' => :'return_fields',
+        :'measurements' => :'measurements',
+        :'page_size' => :'page_size',
         :'filter' => :'filter',
         :'timezone' => :'timezone',
-        :'sort' => :'sort'
+        :'by' => :'by'
       }
     end
 
@@ -91,16 +91,16 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'metric_id' => :'String',
+        :'sort' => :'String',
         :'page_cursor' => :'String',
-        :'measurements' => :'Array<String>',
         :'interval' => :'String',
-        :'page_size' => :'Integer',
-        :'by' => :'Array<String>',
+        :'metric_id' => :'String',
         :'return_fields' => :'Array<String>',
+        :'measurements' => :'Array<String>',
+        :'page_size' => :'Integer',
         :'filter' => :'Array<String>',
         :'timezone' => :'String',
-        :'sort' => :'String'
+        :'by' => :'Array<String>'
       }
     end
 
@@ -125,34 +125,20 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'metric_id')
-        self.metric_id = attributes[:'metric_id']
+      if attributes.key?(:'sort')
+        self.sort = attributes[:'sort']
       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
-        end
-      end
-
       if attributes.key?(:'interval')
         self.interval = attributes[:'interval']
       end
 
-      if attributes.key?(:'page_size')
-        self.page_size = attributes[:'page_size']
-      else
-        self.page_size = 500
-      end
-
-      if attributes.key?(:'by')
-        if (value = attributes[:'by']).is_a?(Array)
-          self.by = value
-        end
+      if attributes.key?(:'metric_id')
+        self.metric_id = attributes[:'metric_id']
       end
 
       if attributes.key?(:'return_fields')
@@ -161,6 +147,18 @@ module KlaviyoAPI
         end
       end
 
+      if attributes.key?(:'measurements')
+        if (value = attributes[:'measurements']).is_a?(Array)
+          self.measurements = value
+        end
+      end
+
+      if attributes.key?(:'page_size')
+        self.page_size = attributes[:'page_size']
+      else
+        self.page_size = 500
+      end
+
       if attributes.key?(:'filter')
         if (value = attributes[:'filter']).is_a?(Array)
           self.filter = value
@@ -173,8 +171,10 @@ module KlaviyoAPI
         self.timezone = 'UTC'
       end
 
-      if attributes.key?(:'sort')
-        self.sort = attributes[:'sort']
+      if attributes.key?(:'by')
+        if (value = attributes[:'by']).is_a?(Array)
+          self.by = value
+        end
       end
     end
 
@@ -182,6 +182,10 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @interval.nil?
+        invalid_properties.push('invalid value for "interval", interval cannot be nil.')
+      end
+
       if @metric_id.nil?
         invalid_properties.push('invalid value for "metric_id", metric_id cannot be nil.')
       end
@@ -190,10 +194,6 @@ module KlaviyoAPI
         invalid_properties.push('invalid value for "measurements", measurements cannot be nil.')
       end
 
-      if @interval.nil?
-        invalid_properties.push('invalid value for "interval", interval cannot be nil.')
-      end
-
       if @filter.nil?
         invalid_properties.push('invalid value for "filter", filter cannot be nil.')
       end
@@ -204,27 +204,17 @@ module KlaviyoAPI
     # 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 @metric_id.nil?
-      return false if @measurements.nil?
+      sort_validator = EnumAttributeValidator.new('String', ["$attributed_channel", "-$attributed_channel", "$attributed_flow", "-$attributed_flow", "$attributed_message", "-$attributed_message", "$attributed_variation", "-$attributed_variation", "$campaign_channel", "-$campaign_channel", "$flow", "-$flow", "$flow_channel", "-$flow_channel", "$message", "-$message", "$message_send_cohort", "-$message_send_cohort", "$variation", "-$variation", "$variation_send_cohort", "-$variation_send_cohort", "Bounce Type", "-Bounce Type", "Campaign Name", "-Campaign Name", "Client Canonical", "-Client Canonical", "Client Name", "-Client Name", "Client Type", "-Client Type", "Email Domain", "-Email Domain", "Failure Source", "-Failure Source", "Failure Type", "-Failure Type", "From Number", "-From Number", "From Phone Region", "-From Phone Region", "List", "-List", "Message Name", "-Message Name", "Message Type", "-Message Type", "Method", "-Method", "Subject", "-Subject", "To Number", "-To Number", "To Phone Region", "-To Phone Region", "URL", "-URL", "count", "-count", "form_id", "-form_id", "sum_value", "-sum_value", "unique", "-unique"])
+      return false unless sort_validator.valid?(@sort)
       return false if @interval.nil?
       interval_validator = EnumAttributeValidator.new('String', ["day", "hour", "month", "week"])
       return false unless interval_validator.valid?(@interval)
+      return false if @metric_id.nil?
+      return false if @measurements.nil?
       return false if @filter.nil?
-      sort_validator = EnumAttributeValidator.new('String', ["$attributed_channel", "-$attributed_channel", "$attributed_flow", "-$attributed_flow", "$attributed_message", "-$attributed_message", "$attributed_variation", "-$attributed_variation", "$campaign_channel", "-$campaign_channel", "$flow", "-$flow", "$flow_channel", "-$flow_channel", "$message", "-$message", "$message_send_cohort", "-$message_send_cohort", "$variation", "-$variation", "$variation_send_cohort", "-$variation_send_cohort", "Bounce Type", "-Bounce Type", "Campaign Name", "-Campaign Name", "Client Canonical", "-Client Canonical", "Client Name", "-Client Name", "Client Type", "-Client Type", "Email Domain", "-Email Domain", "Failure Source", "-Failure Source", "Failure Type", "-Failure Type", "From Number", "-From Number", "From Phone Region", "-From Phone Region", "List", "-List", "Message Name", "-Message Name", "Message Type", "-Message Type", "Method", "-Method", "Subject", "-Subject", "To Number", "-To Number", "To Phone Region", "-To Phone Region", "URL", "-URL", "count", "-count", "form_id", "-form_id", "sum_value", "-sum_value", "unique", "-unique"])
-      return false unless sort_validator.valid?(@sort)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] interval Object to be assigned
-    def interval=(interval)
-      validator = EnumAttributeValidator.new('String', ["day", "hour", "month", "week"])
-      unless validator.valid?(interval)
-        fail ArgumentError, "invalid value for \"interval\", must be one of #{validator.allowable_values}."
-      end
-      @interval = interval
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] sort Object to be assigned
     def sort=(sort)
@@ -235,21 +225,31 @@ module KlaviyoAPI
       @sort = sort
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] interval Object to be assigned
+    def interval=(interval)
+      validator = EnumAttributeValidator.new('String', ["day", "hour", "month", "week"])
+      unless validator.valid?(interval)
+        fail ArgumentError, "invalid value for \"interval\", must be one of #{validator.allowable_values}."
+      end
+      @interval = interval
+    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 &&
-          metric_id == o.metric_id &&
+          sort == o.sort &&
           page_cursor == o.page_cursor &&
-          measurements == o.measurements &&
           interval == o.interval &&
-          page_size == o.page_size &&
-          by == o.by &&
+          metric_id == o.metric_id &&
           return_fields == o.return_fields &&
+          measurements == o.measurements &&
+          page_size == o.page_size &&
           filter == o.filter &&
           timezone == o.timezone &&
-          sort == o.sort
+          by == o.by
     end
 
     # @see the `==` method
@@ -261,7 +261,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [metric_id, page_cursor, measurements, interval, page_size, by, return_fields, filter, timezone, sort].hash
+      [sort, page_cursor, interval, metric_id, return_fields, measurements, page_size, filter, timezone, by].hash
     end
 
     # Builds the object from hash

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-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/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-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/profile_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-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,15 +15,15 @@ require 'time'
 
 module KlaviyoAPI
   class ProfileCreateQueryResourceObject
-    attr_accessor :type
-
     attr_accessor :attributes
 
+    attr_accessor :type
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'type' => :'type',
-        :'attributes' => :'attributes'
+        :'attributes' => :'attributes',
+        :'type' => :'type'
       }
     end
 
@@ -35,8 +35,8 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'type' => :'ProfileEnum',
-        :'attributes' => :'ProfileCreateQueryResourceObjectAttributes'
+        :'attributes' => :'ProfileCreateQueryResourceObjectAttributes',
+        :'type' => :'ProfileEnum'
       }
     end
 
@@ -61,35 +61,35 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
-      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 @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
-      end
-
       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 @type.nil?
       return false if @attributes.nil?
+      return false if @type.nil?
       true
     end
 
@@ -98,8 +98,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          type == o.type &&
-          attributes == o.attributes
+          attributes == o.attributes &&
+          type == o.type
     end
 
     # @see the `==` method
@@ -111,7 +111,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, attributes].hash
+      [attributes, type].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/profile_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-06-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,48 +15,48 @@ require 'time'
 
 module KlaviyoAPI
   class ProfileCreateQueryResourceObjectAttributes
-    # 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
-
     # 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
 
+    attr_accessor :location
+
+    # Name of the company or organization within the company for whom the individual works
+    attr_accessor :organization
+
+    # 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
+
+    # Individual's email address
+    attr_accessor :email
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'email' => :'email',
         :'phone_number' => :'phone_number',
-        :'external_id' => :'external_id',
         :'first_name' => :'first_name',
         :'last_name' => :'last_name',
-        :'organization' => :'organization',
         :'title' => :'title',
         :'image' => :'image',
+        :'properties' => :'properties',
         :'location' => :'location',
-        :'properties' => :'properties'
+        :'organization' => :'organization',
+        :'external_id' => :'external_id',
+        :'email' => :'email'
       }
     end
 
@@ -68,16 +68,16 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'email' => :'String',
         :'phone_number' => :'String',
-        :'external_id' => :'String',
         :'first_name' => :'String',
         :'last_name' => :'String',
-        :'organization' => :'String',
         :'title' => :'String',
         :'image' => :'String',
+        :'properties' => :'Object',
         :'location' => :'ProfileLocation',
-        :'properties' => :'Object'
+        :'organization' => :'String',
+        :'external_id' => :'String',
+        :'email' => :'String'
       }
     end
 
@@ -102,18 +102,10 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'email')
-        self.email = attributes[:'email']
-      end
-
       if attributes.key?(:'phone_number')
         self.phone_number = attributes[:'phone_number']
       end
 
-      if attributes.key?(:'external_id')
-        self.external_id = attributes[:'external_id']
-      end
-
       if attributes.key?(:'first_name')
         self.first_name = attributes[:'first_name']
       end
@@ -122,10 +114,6 @@ module KlaviyoAPI
         self.last_name = attributes[:'last_name']
       end
 
-      if attributes.key?(:'organization')
-        self.organization = attributes[:'organization']
-      end
-
       if attributes.key?(:'title')
         self.title = attributes[:'title']
       end
@@ -134,12 +122,24 @@ module KlaviyoAPI
         self.image = attributes[:'image']
       end
 
+      if attributes.key?(:'properties')
+        self.properties = attributes[:'properties']
+      end
+
       if attributes.key?(:'location')
         self.location = attributes[:'location']
       end
 
-      if attributes.key?(:'properties')
-        self.properties = attributes[:'properties']
+      if attributes.key?(:'organization')
+        self.organization = attributes[:'organization']
+      end
+
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
       end
     end
 
@@ -161,16 +161,16 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          email == o.email &&
           phone_number == o.phone_number &&
-          external_id == o.external_id &&
           first_name == o.first_name &&
           last_name == o.last_name &&
-          organization == o.organization &&
           title == o.title &&
           image == o.image &&
+          properties == o.properties &&
           location == o.location &&
-          properties == o.properties
+          organization == o.organization &&
+          external_id == o.external_id &&
+          email == o.email
     end
 
     # @see the `==` method
@@ -182,7 +182,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, phone_number, external_id, first_name, last_name, organization, title, image, location, properties].hash
+      [phone_number, first_name, last_name, title, image, properties, location, organization, external_id, email].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/profile_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-06-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1