klaviyo-api-sdk 4.0.0 → 4.1.0

data/lib/klaviyo-api-sdk/models/list_partial_update_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-07-15
+The version of the OpenAPI document: 2023-08-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,19 +15,19 @@ require 'time'
 
 module KlaviyoAPI
   class ListPartialUpdateQueryResourceObject
-    attr_accessor :attributes
-
     attr_accessor :type
 
     # Primary key that uniquely identifies this list. Generated by Klaviyo.
     attr_accessor :id
 
+    attr_accessor :attributes
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'attributes' => :'attributes',
         :'type' => :'type',
-        :'id' => :'id'
+        :'id' => :'id',
+        :'attributes' => :'attributes'
       }
     end
 
@@ -39,9 +39,9 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'attributes' => :'ListCreateQueryResourceObjectAttributes',
         :'type' => :'ListEnum',
-        :'id' => :'String'
+        :'id' => :'String',
+        :'attributes' => :'ListCreateQueryResourceObjectAttributes'
       }
     end
 
@@ -66,10 +66,6 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'attributes')
-        self.attributes = attributes[:'attributes']
-      end
-
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
@@ -77,16 +73,16 @@ module KlaviyoAPI
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
+
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      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
@@ -95,15 +91,19 @@ module KlaviyoAPI
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
+      if @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes 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?
+      return false if @attributes.nil?
       true
     end
 
@@ -112,9 +112,9 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          attributes == o.attributes &&
           type == o.type &&
-          id == o.id
+          id == o.id &&
+          attributes == o.attributes
     end
 
     # @see the `==` method
@@ -126,7 +126,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attributes, type, id].hash
+      [type, id, attributes].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/metric_aggregate_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-07-15
+The version of the OpenAPI document: 2023-08-15
 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.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-07-15
+The version of the OpenAPI document: 2023-08-15
 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_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-07-15
+The version of the OpenAPI document: 2023-08-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 MetricAggregateQueryResourceObject
-    attr_accessor :attributes
-
     attr_accessor :type
 
+    attr_accessor :attributes
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'attributes' => :'attributes',
-        :'type' => :'type'
+        :'type' => :'type',
+        :'attributes' => :'attributes'
       }
     end
 
@@ -35,8 +35,8 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'attributes' => :'MetricAggregateQueryResourceObjectAttributes',
-        :'type' => :'MetricAggregateEnum'
+        :'type' => :'MetricAggregateEnum',
+        :'attributes' => :'MetricAggregateQueryResourceObjectAttributes'
       }
     end
 
@@ -61,35 +61,35 @@ module KlaviyoAPI
         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?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      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 @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes 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 @attributes.nil?
       true
     end
 
@@ -98,8 +98,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          attributes == o.attributes &&
-          type == o.type
+          type == o.type &&
+          attributes == o.attributes
     end
 
     # @see the `==` method
@@ -111,7 +111,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attributes, type].hash
+      [type, attributes].hash
     end
 
     # Builds the object from hash

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-07-15
+The version of the OpenAPI document: 2023-08-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
-    # Provide a sort key (e.g. -$message)
-    attr_accessor :sort
+    # 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
+
     # Aggregation interval, e.g. \"hour\", \"day\", \"week\", \"month\"
     attr_accessor :interval
 
-    # The metric ID used in the aggregation.
-    attr_accessor :metric_id
+    # 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
 
     # 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
 
-    # Optional attribute(s) used for partitioning by the aggregation function
-    attr_accessor :by
+    # Provide a sort key (e.g. -$message)
+    attr_accessor :sort
 
     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
       {
-        :'sort' => :'sort',
-        :'page_cursor' => :'page_cursor',
-        :'interval' => :'interval',
         :'metric_id' => :'metric_id',
-        :'return_fields' => :'return_fields',
+        :'page_cursor' => :'page_cursor',
         :'measurements' => :'measurements',
+        :'interval' => :'interval',
         :'page_size' => :'page_size',
+        :'by' => :'by',
+        :'return_fields' => :'return_fields',
         :'filter' => :'filter',
         :'timezone' => :'timezone',
-        :'by' => :'by'
+        :'sort' => :'sort'
       }
     end
 
@@ -91,16 +91,16 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'sort' => :'String',
-        :'page_cursor' => :'String',
-        :'interval' => :'String',
         :'metric_id' => :'String',
-        :'return_fields' => :'Array<String>',
+        :'page_cursor' => :'String',
         :'measurements' => :'Array<String>',
+        :'interval' => :'String',
         :'page_size' => :'Integer',
+        :'by' => :'Array<String>',
+        :'return_fields' => :'Array<String>',
         :'filter' => :'Array<String>',
         :'timezone' => :'String',
-        :'by' => :'Array<String>'
+        :'sort' => :'String'
       }
     end
 
@@ -125,42 +125,44 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'sort')
-        self.sort = attributes[:'sort']
+      if attributes.key?(:'metric_id')
+        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
+        end
+      end
+
       if attributes.key?(:'interval')
         self.interval = attributes[:'interval']
       else
         self.interval = 'day'
       end
 
-      if attributes.key?(:'metric_id')
-        self.metric_id = attributes[:'metric_id']
+      if attributes.key?(:'page_size')
+        self.page_size = attributes[:'page_size']
+      else
+        self.page_size = 500
       end
 
-      if attributes.key?(:'return_fields')
-        if (value = attributes[:'return_fields']).is_a?(Array)
-          self.return_fields = value
+      if attributes.key?(:'by')
+        if (value = attributes[:'by']).is_a?(Array)
+          self.by = value
         end
       end
 
-      if attributes.key?(:'measurements')
-        if (value = attributes[:'measurements']).is_a?(Array)
-          self.measurements = value
+      if attributes.key?(:'return_fields')
+        if (value = attributes[:'return_fields']).is_a?(Array)
+          self.return_fields = 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,10 +175,8 @@ module KlaviyoAPI
         self.timezone = 'UTC'
       end
 
-      if attributes.key?(:'by')
-        if (value = attributes[:'by']).is_a?(Array)
-          self.by = value
-        end
+      if attributes.key?(:'sort')
+        self.sort = attributes[:'sort']
       end
     end
 
@@ -202,26 +202,16 @@ module KlaviyoAPI
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      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)
-      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?
+      interval_validator = EnumAttributeValidator.new('String', ["day", "hour", "month", "week"])
+      return false unless interval_validator.valid?(@interval)
       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] sort Object to be assigned
-    def sort=(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"])
-      unless validator.valid?(sort)
-        fail ArgumentError, "invalid value for \"sort\", must be one of #{validator.allowable_values}."
-      end
-      @sort = sort
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] interval Object to be assigned
     def interval=(interval)
@@ -232,21 +222,31 @@ module KlaviyoAPI
       @interval = interval
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] sort Object to be assigned
+    def sort=(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"])
+      unless validator.valid?(sort)
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{validator.allowable_values}."
+      end
+      @sort = sort
+    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 &&
-          sort == o.sort &&
-          page_cursor == o.page_cursor &&
-          interval == o.interval &&
           metric_id == o.metric_id &&
-          return_fields == o.return_fields &&
+          page_cursor == o.page_cursor &&
           measurements == o.measurements &&
+          interval == o.interval &&
           page_size == o.page_size &&
+          by == o.by &&
+          return_fields == o.return_fields &&
           filter == o.filter &&
           timezone == o.timezone &&
-          by == o.by
+          sort == o.sort
     end
 
     # @see the `==` method
@@ -258,7 +258,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [sort, page_cursor, interval, metric_id, return_fields, measurements, page_size, filter, timezone, by].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_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-07-15
+The version of the OpenAPI document: 2023-08-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 MetricCreateQueryResourceObject
-    attr_accessor :attributes
-
     attr_accessor :type
 
+    attr_accessor :attributes
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'attributes' => :'attributes',
-        :'type' => :'type'
+        :'type' => :'type',
+        :'attributes' => :'attributes'
       }
     end
 
@@ -35,8 +35,8 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'attributes' => :'MetricCreateQueryResourceObjectAttributes',
-        :'type' => :'MetricEnum'
+        :'type' => :'MetricEnum',
+        :'attributes' => :'MetricCreateQueryResourceObjectAttributes'
       }
     end
 
@@ -61,35 +61,35 @@ module KlaviyoAPI
         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?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      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 @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes 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 @attributes.nil?
       true
     end
 
@@ -98,8 +98,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          attributes == o.attributes &&
-          type == o.type
+          type == o.type &&
+          attributes == o.attributes
     end
 
     # @see the `==` method
@@ -111,7 +111,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attributes, type].hash
+      [type, attributes].hash
     end
 
     # Builds the object from hash

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

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