smplkit 3.0.13 → 3.0.14

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/{user_list_meta.rb → list_meta.rb}

@@ -14,13 +14,14 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
-  class UserListMeta < ApiModelBase
-    attr_accessor :page
+  # Top-level ``meta`` block included on every JSON:API list response.
+  class ListMeta < ApiModelBase
+    attr_accessor :pagination
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'page' => :'page'
+        :'pagination' => :'pagination'
       }
     end
 
@@ -37,7 +38,7 @@ module SmplkitGeneratedClient::App
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'page' => :'PageMeta'
+        :'pagination' => :'PaginationMeta'
       }
     end
 
@@ -51,22 +52,22 @@ module SmplkitGeneratedClient::App
     # @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 `SmplkitGeneratedClient::App::UserListMeta` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::App::ListMeta` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::App::UserListMeta`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::App::ListMeta`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'page')
-        self.page = attributes[:'page']
+      if attributes.key?(:'pagination')
+        self.pagination = attributes[:'pagination']
       else
-        self.page = nil
+        self.pagination = nil
       end
     end
 
@@ -75,8 +76,8 @@ module SmplkitGeneratedClient::App
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @page.nil?
-        invalid_properties.push('invalid value for "page", page cannot be nil.')
+      if @pagination.nil?
+        invalid_properties.push('invalid value for "pagination", pagination cannot be nil.')
       end
 
       invalid_properties
@@ -86,18 +87,18 @@ module SmplkitGeneratedClient::App
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @page.nil?
+      return false if @pagination.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] page Value to be assigned
-    def page=(page)
-      if page.nil?
-        fail ArgumentError, 'page cannot be nil'
+    # @param [Object] pagination Value to be assigned
+    def pagination=(pagination)
+      if pagination.nil?
+        fail ArgumentError, 'pagination cannot be nil'
       end
 
-      @page = page
+      @pagination = pagination
     end
 
     # Checks equality by comparing each attribute.
@@ -105,7 +106,7 @@ module SmplkitGeneratedClient::App
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          page == o.page
+          pagination == o.pagination
     end
 
     # @see the `==` method
@@ -117,7 +118,7 @@ module SmplkitGeneratedClient::App
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [page].hash
+      [pagination].hash
     end
 
     # Builds the object from hash

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_list_response.rb

@@ -18,10 +18,13 @@ module SmplkitGeneratedClient::App
   class MetricListResponse < ApiModelBase
     attr_accessor :data
 
+    attr_accessor :meta
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'data' => :'data'
+        :'data' => :'data',
+        :'meta' => :'meta'
       }
     end
 
@@ -38,7 +41,8 @@ module SmplkitGeneratedClient::App
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'Array<MetricResource>'
+        :'data' => :'Array<MetricResource>',
+        :'meta' => :'ListMeta'
       }
     end
 
@@ -71,6 +75,12 @@ module SmplkitGeneratedClient::App
       else
         self.data = nil
       end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      else
+        self.meta = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -82,6 +92,10 @@ module SmplkitGeneratedClient::App
         invalid_properties.push('invalid value for "data", data cannot be nil.')
       end
 
+      if @meta.nil?
+        invalid_properties.push('invalid value for "meta", meta cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -90,6 +104,7 @@ module SmplkitGeneratedClient::App
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @data.nil?
+      return false if @meta.nil?
       true
     end
 
@@ -103,12 +118,23 @@ module SmplkitGeneratedClient::App
       @data = data
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] meta Value to be assigned
+    def meta=(meta)
+      if meta.nil?
+        fail ArgumentError, 'meta cannot be nil'
+      end
+
+      @meta = meta
+    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 &&
-          data == o.data
+          data == o.data &&
+          meta == o.meta
     end
 
     # @see the `==` method
@@ -120,7 +146,7 @@ module SmplkitGeneratedClient::App
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [data].hash
+      [data, meta].hash
     end
 
     # Builds the object from hash

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_names_response.rb

@@ -18,10 +18,13 @@ module SmplkitGeneratedClient::App
   class MetricNamesResponse < ApiModelBase
     attr_accessor :data
 
+    attr_accessor :meta
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'data' => :'data'
+        :'data' => :'data',
+        :'meta' => :'meta'
       }
     end
 
@@ -38,7 +41,8 @@ module SmplkitGeneratedClient::App
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'Array<MetricNameItem>'
+        :'data' => :'Array<MetricNameItem>',
+        :'meta' => :'ListMeta'
       }
     end
 
@@ -71,6 +75,12 @@ module SmplkitGeneratedClient::App
       else
         self.data = nil
       end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      else
+        self.meta = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -82,6 +92,10 @@ module SmplkitGeneratedClient::App
         invalid_properties.push('invalid value for "data", data cannot be nil.')
       end
 
+      if @meta.nil?
+        invalid_properties.push('invalid value for "meta", meta cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -90,6 +104,7 @@ module SmplkitGeneratedClient::App
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @data.nil?
+      return false if @meta.nil?
       true
     end
 
@@ -103,12 +118,23 @@ module SmplkitGeneratedClient::App
       @data = data
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] meta Value to be assigned
+    def meta=(meta)
+      if meta.nil?
+        fail ArgumentError, 'meta cannot be nil'
+      end
+
+      @meta = meta
+    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 &&
-          data == o.data
+          data == o.data &&
+          meta == o.meta
     end
 
     # @see the `==` method
@@ -120,7 +146,7 @@ module SmplkitGeneratedClient::App
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [data].hash
+      [data, meta].hash
     end
 
     # Builds the object from hash

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_rollup_list_response.rb

@@ -18,10 +18,13 @@ module SmplkitGeneratedClient::App
   class MetricRollupListResponse < ApiModelBase
     attr_accessor :data
 
+    attr_accessor :meta
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'data' => :'data'
+        :'data' => :'data',
+        :'meta' => :'meta'
       }
     end
 
@@ -38,7 +41,8 @@ module SmplkitGeneratedClient::App
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'Array<MetricRollupResource>'
+        :'data' => :'Array<MetricRollupResource>',
+        :'meta' => :'ListMeta'
       }
     end
 
@@ -71,6 +75,12 @@ module SmplkitGeneratedClient::App
       else
         self.data = nil
       end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      else
+        self.meta = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -82,6 +92,10 @@ module SmplkitGeneratedClient::App
         invalid_properties.push('invalid value for "data", data cannot be nil.')
       end
 
+      if @meta.nil?
+        invalid_properties.push('invalid value for "meta", meta cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -90,6 +104,7 @@ module SmplkitGeneratedClient::App
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @data.nil?
+      return false if @meta.nil?
       true
     end
 
@@ -103,12 +118,23 @@ module SmplkitGeneratedClient::App
       @data = data
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] meta Value to be assigned
+    def meta=(meta)
+      if meta.nil?
+        fail ArgumentError, 'meta cannot be nil'
+      end
+
+      @meta = meta
+    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 &&
-          data == o.data
+          data == o.data &&
+          meta == o.meta
     end
 
     # @see the `==` method
@@ -120,7 +146,7 @@ module SmplkitGeneratedClient::App
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [data].hash
+      [data, meta].hash
     end
 
     # Builds the object from hash

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/{page_meta.rb → pagination_meta.rb}

@@ -14,26 +14,26 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
-  # Pagination metadata returned with a collection response.
-  class PageMeta < ApiModelBase
-    # Page size used for this response.
-    attr_accessor :size
-
+  # Pagination block returned inside ``meta`` on every list response.  ``page`` and ``size`` are always present and echo the parameters that served the response (their defaults when the client omitted them). ``total`` and ``total_pages`` are present only when the request included ``meta[total]=true``.
+  class PaginationMeta < ApiModelBase
     # 1-based page number returned.
-    attr_accessor :number
+    attr_accessor :page
 
-    # Total number of matching items across all pages.
-    attr_accessor :total_items
+    # Number of items per page.
+    attr_accessor :size
 
-    # Total number of pages at the current page size.
+    # Total number of matching items across all pages. Present only when the request included `meta[total]=true`.
+    attr_accessor :total
+
+    # Total number of pages at the requested page size. Present only when the request included `meta[total]=true`.
     attr_accessor :total_pages
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'page' => :'page',
         :'size' => :'size',
-        :'number' => :'number',
-        :'total_items' => :'total_items',
+        :'total' => :'total',
         :'total_pages' => :'total_pages'
       }
     end
@@ -51,9 +51,9 @@ module SmplkitGeneratedClient::App
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'page' => :'Integer',
         :'size' => :'Integer',
-        :'number' => :'Integer',
-        :'total_items' => :'Integer',
+        :'total' => :'Integer',
         :'total_pages' => :'Integer'
       }
     end
@@ -61,6 +61,8 @@ module SmplkitGeneratedClient::App
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'total',
+        :'total_pages'
       ])
     end
 
@@ -68,40 +70,36 @@ module SmplkitGeneratedClient::App
     # @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 `SmplkitGeneratedClient::App::PageMeta` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::App::PaginationMeta` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::App::PageMeta`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::App::PaginationMeta`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'size')
-        self.size = attributes[:'size']
+      if attributes.key?(:'page')
+        self.page = attributes[:'page']
       else
-        self.size = nil
+        self.page = nil
       end
 
-      if attributes.key?(:'number')
-        self.number = attributes[:'number']
+      if attributes.key?(:'size')
+        self.size = attributes[:'size']
       else
-        self.number = nil
+        self.size = nil
       end
 
-      if attributes.key?(:'total_items')
-        self.total_items = attributes[:'total_items']
-      else
-        self.total_items = nil
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
       end
 
       if attributes.key?(:'total_pages')
         self.total_pages = attributes[:'total_pages']
-      else
-        self.total_pages = nil
       end
     end
 
@@ -110,20 +108,12 @@ module SmplkitGeneratedClient::App
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @size.nil?
-        invalid_properties.push('invalid value for "size", size cannot be nil.')
-      end
-
-      if @number.nil?
-        invalid_properties.push('invalid value for "number", number cannot be nil.')
-      end
-
-      if @total_items.nil?
-        invalid_properties.push('invalid value for "total_items", total_items cannot be nil.')
+      if @page.nil?
+        invalid_properties.push('invalid value for "page", page cannot be nil.')
       end
 
-      if @total_pages.nil?
-        invalid_properties.push('invalid value for "total_pages", total_pages cannot be nil.')
+      if @size.nil?
+        invalid_properties.push('invalid value for "size", size cannot be nil.')
       end
 
       invalid_properties
@@ -133,51 +123,29 @@ module SmplkitGeneratedClient::App
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @page.nil?
       return false if @size.nil?
-      return false if @number.nil?
-      return false if @total_items.nil?
-      return false if @total_pages.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] size Value to be assigned
-    def size=(size)
-      if size.nil?
-        fail ArgumentError, 'size cannot be nil'
-      end
-
-      @size = size
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] number Value to be assigned
-    def number=(number)
-      if number.nil?
-        fail ArgumentError, 'number cannot be nil'
+    # @param [Object] page Value to be assigned
+    def page=(page)
+      if page.nil?
+        fail ArgumentError, 'page cannot be nil'
       end
 
-      @number = number
+      @page = page
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] total_items Value to be assigned
-    def total_items=(total_items)
-      if total_items.nil?
-        fail ArgumentError, 'total_items cannot be nil'
-      end
-
-      @total_items = total_items
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] total_pages Value to be assigned
-    def total_pages=(total_pages)
-      if total_pages.nil?
-        fail ArgumentError, 'total_pages cannot be nil'
+    # @param [Object] size Value to be assigned
+    def size=(size)
+      if size.nil?
+        fail ArgumentError, 'size cannot be nil'
       end
 
-      @total_pages = total_pages
+      @size = size
     end
 
     # Checks equality by comparing each attribute.
@@ -185,9 +153,9 @@ module SmplkitGeneratedClient::App
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          page == o.page &&
           size == o.size &&
-          number == o.number &&
-          total_items == o.total_items &&
+          total == o.total &&
           total_pages == o.total_pages
     end
 
@@ -200,7 +168,7 @@ module SmplkitGeneratedClient::App
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [size, number, total_items, total_pages].hash
+      [page, size, total, total_pages].hash
     end
 
     # Builds the object from hash

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/payment_method_list_response.rb

@@ -18,10 +18,13 @@ module SmplkitGeneratedClient::App
   class PaymentMethodListResponse < ApiModelBase
     attr_accessor :data
 
+    attr_accessor :meta
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'data' => :'data'
+        :'data' => :'data',
+        :'meta' => :'meta'
       }
     end
 
@@ -38,7 +41,8 @@ module SmplkitGeneratedClient::App
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'Array<PaymentMethodResource>'
+        :'data' => :'Array<PaymentMethodResource>',
+        :'meta' => :'ListMeta'
       }
     end
 
@@ -71,6 +75,12 @@ module SmplkitGeneratedClient::App
       else
         self.data = nil
       end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      else
+        self.meta = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -82,6 +92,10 @@ module SmplkitGeneratedClient::App
         invalid_properties.push('invalid value for "data", data cannot be nil.')
       end
 
+      if @meta.nil?
+        invalid_properties.push('invalid value for "meta", meta cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -90,6 +104,7 @@ module SmplkitGeneratedClient::App
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @data.nil?
+      return false if @meta.nil?
       true
     end
 
@@ -103,12 +118,23 @@ module SmplkitGeneratedClient::App
       @data = data
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] meta Value to be assigned
+    def meta=(meta)
+      if meta.nil?
+        fail ArgumentError, 'meta cannot be nil'
+      end
+
+      @meta = meta
+    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 &&
-          data == o.data
+          data == o.data &&
+          meta == o.meta
     end
 
     # @see the `==` method
@@ -120,7 +146,7 @@ module SmplkitGeneratedClient::App
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [data].hash
+      [data, meta].hash
     end
 
     # Builds the object from hash