smplkit 3.0.7 → 3.0.9

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/{subscription_list_meta.rb → subscription_response_attributes.rb}

@@ -14,25 +14,40 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
-  # Discount and totals summary attached to a subscription collection response.
-  class SubscriptionListMeta < ApiModelBase
-    # Sum of list prices across all subscriptions in cents.
-    attr_accessor :subtotal_cents
+  # Customer's subscription as returned by the API.
+  class SubscriptionResponseAttributes < ApiModelBase
+    # Lifecycle state of the subscription. `ACTIVE` while billing is current; `PAST_DUE` after a failed charge; `CANCELED` once the subscription has ended; `null` when the subscription has no billing object (fully comped at 100% discount).
+    attr_accessor :status
 
-    # Effective discount percentage applied.
-    attr_accessor :discount_pct
+    # ISO-8601 timestamp of the current billing period's start.
+    attr_accessor :current_period_start
 
-    # Discount amount in cents.
-    attr_accessor :discount_amount_cents
+    # ISO-8601 timestamp of the current billing period's end. Scheduled plan changes take effect at this moment.
+    attr_accessor :current_period_end
+
+    # Effective discount percentage applied to the subscription's monthly invoice. This is the value locked at the time of the customer's last subscription change; subsequent changes to the public discount schedule do not affect this customer until they themselves change their subscription.
+    attr_accessor :discount_pct
 
-    # Source of the discount. `VOLUME` indicates the standard volume-discount schedule; `OVERRIDE` indicates a custom discount set on the account.
+    # `VOLUME` when the discount comes from the multi-product discount schedule; `OVERRIDE` when an administrator has applied a custom discount.
     attr_accessor :discount_source
 
-    # Final monthly total in cents after the discount.
+    # Sum of all item list prices in cents, before discount.
+    attr_accessor :subtotal_cents
+
+    # Amount discounted from the subtotal in cents.
+    attr_accessor :discount_amount_cents
+
+    # Final monthly total in cents after the discount is applied.
     attr_accessor :total_cents
 
     attr_accessor :next_tier
 
+    # Identifier of the default payment method used to bill this subscription. `null` when the subscription has no associated payment method (e.g. fully comped).
+    attr_accessor :payment_method
+
+    # One entry per product currently enrolled on the subscription.
+    attr_accessor :items
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -58,12 +73,17 @@ module SmplkitGeneratedClient::App
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'subtotal_cents' => :'subtotal_cents',
+        :'status' => :'status',
+        :'current_period_start' => :'current_period_start',
+        :'current_period_end' => :'current_period_end',
         :'discount_pct' => :'discount_pct',
-        :'discount_amount_cents' => :'discount_amount_cents',
         :'discount_source' => :'discount_source',
+        :'subtotal_cents' => :'subtotal_cents',
+        :'discount_amount_cents' => :'discount_amount_cents',
         :'total_cents' => :'total_cents',
-        :'next_tier' => :'next_tier'
+        :'next_tier' => :'next_tier',
+        :'payment_method' => :'payment_method',
+        :'items' => :'items'
       }
     end
 
@@ -80,18 +100,27 @@ module SmplkitGeneratedClient::App
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'subtotal_cents' => :'Integer',
+        :'status' => :'String',
+        :'current_period_start' => :'String',
+        :'current_period_end' => :'String',
         :'discount_pct' => :'Integer',
-        :'discount_amount_cents' => :'Integer',
         :'discount_source' => :'String',
+        :'subtotal_cents' => :'Integer',
+        :'discount_amount_cents' => :'Integer',
         :'total_cents' => :'Integer',
-        :'next_tier' => :'NextTierMeta'
+        :'next_tier' => :'NextTierResponse',
+        :'payment_method' => :'String',
+        :'items' => :'Array<SubscriptionItemResponse>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'status',
+        :'current_period_start',
+        :'current_period_end',
+        :'payment_method',
       ])
     end
 
@@ -99,22 +128,28 @@ 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::SubscriptionListMeta` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::App::SubscriptionResponseAttributes` 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::SubscriptionListMeta`. 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::SubscriptionResponseAttributes`. 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?(:'subtotal_cents')
-        self.subtotal_cents = attributes[:'subtotal_cents']
-      else
-        self.subtotal_cents = nil
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'current_period_start')
+        self.current_period_start = attributes[:'current_period_start']
+      end
+
+      if attributes.key?(:'current_period_end')
+        self.current_period_end = attributes[:'current_period_end']
       end
 
       if attributes.key?(:'discount_pct')
@@ -123,18 +158,24 @@ module SmplkitGeneratedClient::App
         self.discount_pct = nil
       end
 
-      if attributes.key?(:'discount_amount_cents')
-        self.discount_amount_cents = attributes[:'discount_amount_cents']
-      else
-        self.discount_amount_cents = nil
-      end
-
       if attributes.key?(:'discount_source')
         self.discount_source = attributes[:'discount_source']
       else
         self.discount_source = nil
       end
 
+      if attributes.key?(:'subtotal_cents')
+        self.subtotal_cents = attributes[:'subtotal_cents']
+      else
+        self.subtotal_cents = nil
+      end
+
+      if attributes.key?(:'discount_amount_cents')
+        self.discount_amount_cents = attributes[:'discount_amount_cents']
+      else
+        self.discount_amount_cents = nil
+      end
+
       if attributes.key?(:'total_cents')
         self.total_cents = attributes[:'total_cents']
       else
@@ -144,6 +185,18 @@ module SmplkitGeneratedClient::App
       if attributes.key?(:'next_tier')
         self.next_tier = attributes[:'next_tier']
       end
+
+      if attributes.key?(:'payment_method')
+        self.payment_method = attributes[:'payment_method']
+      end
+
+      if attributes.key?(:'items')
+        if (value = attributes[:'items']).is_a?(Array)
+          self.items = value
+        end
+      else
+        self.items = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -151,26 +204,30 @@ module SmplkitGeneratedClient::App
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @subtotal_cents.nil?
-        invalid_properties.push('invalid value for "subtotal_cents", subtotal_cents cannot be nil.')
-      end
-
       if @discount_pct.nil?
         invalid_properties.push('invalid value for "discount_pct", discount_pct cannot be nil.')
       end
 
-      if @discount_amount_cents.nil?
-        invalid_properties.push('invalid value for "discount_amount_cents", discount_amount_cents cannot be nil.')
-      end
-
       if @discount_source.nil?
         invalid_properties.push('invalid value for "discount_source", discount_source cannot be nil.')
       end
 
+      if @subtotal_cents.nil?
+        invalid_properties.push('invalid value for "subtotal_cents", subtotal_cents cannot be nil.')
+      end
+
+      if @discount_amount_cents.nil?
+        invalid_properties.push('invalid value for "discount_amount_cents", discount_amount_cents cannot be nil.')
+      end
+
       if @total_cents.nil?
         invalid_properties.push('invalid value for "total_cents", total_cents cannot be nil.')
       end
 
+      if @items.nil?
+        invalid_properties.push('invalid value for "items", items cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -178,26 +235,17 @@ module SmplkitGeneratedClient::App
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @subtotal_cents.nil?
       return false if @discount_pct.nil?
-      return false if @discount_amount_cents.nil?
       return false if @discount_source.nil?
       discount_source_validator = EnumAttributeValidator.new('String', ["VOLUME", "OVERRIDE"])
       return false unless discount_source_validator.valid?(@discount_source)
+      return false if @subtotal_cents.nil?
+      return false if @discount_amount_cents.nil?
       return false if @total_cents.nil?
+      return false if @items.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] subtotal_cents Value to be assigned
-    def subtotal_cents=(subtotal_cents)
-      if subtotal_cents.nil?
-        fail ArgumentError, 'subtotal_cents cannot be nil'
-      end
-
-      @subtotal_cents = subtotal_cents
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] discount_pct Value to be assigned
     def discount_pct=(discount_pct)
@@ -208,16 +256,6 @@ module SmplkitGeneratedClient::App
       @discount_pct = discount_pct
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] discount_amount_cents Value to be assigned
-    def discount_amount_cents=(discount_amount_cents)
-      if discount_amount_cents.nil?
-        fail ArgumentError, 'discount_amount_cents cannot be nil'
-      end
-
-      @discount_amount_cents = discount_amount_cents
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] discount_source Object to be assigned
     def discount_source=(discount_source)
@@ -228,6 +266,26 @@ module SmplkitGeneratedClient::App
       @discount_source = discount_source
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] subtotal_cents Value to be assigned
+    def subtotal_cents=(subtotal_cents)
+      if subtotal_cents.nil?
+        fail ArgumentError, 'subtotal_cents cannot be nil'
+      end
+
+      @subtotal_cents = subtotal_cents
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] discount_amount_cents Value to be assigned
+    def discount_amount_cents=(discount_amount_cents)
+      if discount_amount_cents.nil?
+        fail ArgumentError, 'discount_amount_cents cannot be nil'
+      end
+
+      @discount_amount_cents = discount_amount_cents
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] total_cents Value to be assigned
     def total_cents=(total_cents)
@@ -238,17 +296,32 @@ module SmplkitGeneratedClient::App
       @total_cents = total_cents
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] items Value to be assigned
+    def items=(items)
+      if items.nil?
+        fail ArgumentError, 'items cannot be nil'
+      end
+
+      @items = items
+    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 &&
-          subtotal_cents == o.subtotal_cents &&
+          status == o.status &&
+          current_period_start == o.current_period_start &&
+          current_period_end == o.current_period_end &&
           discount_pct == o.discount_pct &&
-          discount_amount_cents == o.discount_amount_cents &&
           discount_source == o.discount_source &&
+          subtotal_cents == o.subtotal_cents &&
+          discount_amount_cents == o.discount_amount_cents &&
           total_cents == o.total_cents &&
-          next_tier == o.next_tier
+          next_tier == o.next_tier &&
+          payment_method == o.payment_method &&
+          items == o.items
     end
 
     # @see the `==` method
@@ -260,7 +333,7 @@ module SmplkitGeneratedClient::App
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [subtotal_cents, discount_pct, discount_amount_cents, discount_source, total_cents, next_tier].hash
+      [status, current_period_start, current_period_end, discount_pct, discount_source, subtotal_cents, discount_amount_cents, total_cents, next_tier, payment_method, items].hash
     end
 
     # Builds the object from hash

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

@@ -26,6 +26,9 @@ require 'smplkit_app_client/models/account_wipe_request'
 require 'smplkit_app_client/models/add_payment_method_attributes'
 require 'smplkit_app_client/models/add_payment_method_body'
 require 'smplkit_app_client/models/add_payment_method_data'
+require 'smplkit_app_client/models/admin_subscription_request'
+require 'smplkit_app_client/models/admin_subscription_request_attributes'
+require 'smplkit_app_client/models/admin_subscription_request_resource'
 require 'smplkit_app_client/models/api_key'
 require 'smplkit_app_client/models/api_key_list_response'
 require 'smplkit_app_client/models/api_key_request'
@@ -46,9 +49,6 @@ require 'smplkit_app_client/models/context_type_list_response'
 require 'smplkit_app_client/models/context_type_request'
 require 'smplkit_app_client/models/context_type_resource'
 require 'smplkit_app_client/models/context_type_response'
-require 'smplkit_app_client/models/create_subscription_attributes'
-require 'smplkit_app_client/models/create_subscription_body'
-require 'smplkit_app_client/models/create_subscription_data'
 require 'smplkit_app_client/models/email'
 require 'smplkit_app_client/models/email_resource'
 require 'smplkit_app_client/models/email_response'
@@ -84,7 +84,7 @@ require 'smplkit_app_client/models/metric_resource'
 require 'smplkit_app_client/models/metric_rollup_attributes'
 require 'smplkit_app_client/models/metric_rollup_list_response'
 require 'smplkit_app_client/models/metric_rollup_resource'
-require 'smplkit_app_client/models/next_tier_meta'
+require 'smplkit_app_client/models/next_tier_response'
 require 'smplkit_app_client/models/oidc_provider'
 require 'smplkit_app_client/models/page_meta'
 require 'smplkit_app_client/models/payment_method'
@@ -93,7 +93,6 @@ require 'smplkit_app_client/models/payment_method_request'
 require 'smplkit_app_client/models/payment_method_resource'
 require 'smplkit_app_client/models/payment_method_response'
 require 'smplkit_app_client/models/plan'
-require 'smplkit_app_client/models/plan_change_request'
 require 'smplkit_app_client/models/plan_definition'
 require 'smplkit_app_client/models/plan_list_response'
 require 'smplkit_app_client/models/plan_resource'
@@ -109,11 +108,18 @@ require 'smplkit_app_client/models/service_response'
 require 'smplkit_app_client/models/setup_intent_attributes'
 require 'smplkit_app_client/models/setup_intent_resource'
 require 'smplkit_app_client/models/setup_intent_response'
-require 'smplkit_app_client/models/subscription_attributes'
-require 'smplkit_app_client/models/subscription_list_meta'
-require 'smplkit_app_client/models/subscription_list_response'
+require 'smplkit_app_client/models/subscription_change_projection'
+require 'smplkit_app_client/models/subscription_item_request'
+require 'smplkit_app_client/models/subscription_item_response'
+require 'smplkit_app_client/models/subscription_preview_attributes'
+require 'smplkit_app_client/models/subscription_preview_resource'
+require 'smplkit_app_client/models/subscription_preview_response'
+require 'smplkit_app_client/models/subscription_request'
+require 'smplkit_app_client/models/subscription_request_attributes'
+require 'smplkit_app_client/models/subscription_request_resource'
 require 'smplkit_app_client/models/subscription_resource'
 require 'smplkit_app_client/models/subscription_response'
+require 'smplkit_app_client/models/subscription_response_attributes'
 require 'smplkit_app_client/models/user'
 require 'smplkit_app_client/models/user_list_meta'
 require 'smplkit_app_client/models/user_list_response'
@@ -138,6 +144,7 @@ require 'smplkit_app_client/api/metrics_api'
 require 'smplkit_app_client/api/plans_api'
 require 'smplkit_app_client/api/products_api'
 require 'smplkit_app_client/api/services_api'
+require 'smplkit_app_client/api/subscription_api'
 require 'smplkit_app_client/api/users_api'
 
 module SmplkitGeneratedClient::App

data/lib/smplkit/_generated/app/spec/api/api_keys_api_spec.rb

@@ -73,6 +73,7 @@ describe 'APIKeysApi' do
   # List all API keys for the authenticated account.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :filter_status 
+  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `name`. Allowed values: `created_at`, `-created_at`, `expires_at`, `-expires_at`, `last_used_at`, `-last_used_at`, `name`, `-name`, `status`, `-status`.
   # @return [ApiKeyListResponse]
   describe 'list_api_keys test' do
     it 'should work' do

data/lib/smplkit/_generated/app/spec/api/billing_api_spec.rb

@@ -32,18 +32,6 @@ describe 'BillingApi' do
     end
   end
 
-  # unit tests for cancel_subscription
-  # Cancel Subscription
-  # Cancel a subscription at end of the current billing period.
-  # @param id 
-  # @param [Hash] opts the optional parameters
-  # @return [SubscriptionResponse]
-  describe 'cancel_subscription test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   # unit tests for create_payment_method
   # Add Payment Method
   # Register a Stripe payment method (`pm_...`) on the account. The client first creates the Stripe payment method using a SetupIntent and Stripe Elements, then submits its identifier here to persist it.
@@ -56,18 +44,6 @@ describe 'BillingApi' do
     end
   end
 
-  # unit tests for create_subscription
-  # Create Subscription
-  # Create a new paid subscription for a product.
-  # @param create_subscription_body 
-  # @param [Hash] opts the optional parameters
-  # @return [SubscriptionResponse]
-  describe 'create_subscription test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   # unit tests for delete_payment_method
   # Delete Payment Method
   # Delete a payment method. Returns 409 if this is the only payment method on file and the account has an active paid subscription. If the deleted payment method was the default, the oldest remaining payment method is promoted to default.
@@ -80,19 +56,6 @@ describe 'BillingApi' do
     end
   end
 
-  # unit tests for downgrade_subscription
-  # Downgrade Subscription
-  # Downgrade an existing paid subscription to a lower plan.
-  # @param id 
-  # @param plan_change_request 
-  # @param [Hash] opts the optional parameters
-  # @return [SubscriptionResponse]
-  describe 'downgrade_subscription test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   # unit tests for execute_setup_intent
   # Execute Setup Intent
   # Create a Stripe SetupIntent for adding a payment method without an immediate charge. Returns the `client_secret` to pass to Stripe Elements in the browser.
@@ -130,8 +93,9 @@ describe 'BillingApi' do
 
   # unit tests for list_invoices
   # List Invoices
-  # Return invoice history for the account from Stripe.
+  # Return invoice history for the account from Stripe.  Default sort is `-created_at` (newest first).
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `-created_at`. Allowed values: `created_at`, `-created_at`, `status`, `-status`, `total`, `-total`.
   # @return [InvoiceListResponse]
   describe 'list_invoices test' do
     it 'should work' do
@@ -143,6 +107,7 @@ describe 'BillingApi' do
   # List Payment Methods
   # List all payment methods for the account. Default is returned first, then newest first.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `-created_at`. Allowed values: `created_at`, `-created_at`, `exp_year`, `-exp_year`, `is_default`, `-is_default`, `updated_at`, `-updated_at`.
   # @return [PaymentMethodListResponse]
   describe 'list_payment_methods test' do
     it 'should work' do
@@ -150,17 +115,6 @@ describe 'BillingApi' do
     end
   end
 
-  # unit tests for list_subscriptions
-  # List Subscriptions
-  # Return subscription rows for the authenticated account.
-  # @param [Hash] opts the optional parameters
-  # @return [SubscriptionListResponse]
-  describe 'list_subscriptions test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   # unit tests for set_default_payment_method
   # Set Default Payment Method
   # Mark this payment method as the account's default. Idempotent: returns 200 with no changes when the payment method is already the default.
@@ -173,30 +127,6 @@ describe 'BillingApi' do
     end
   end
 
-  # unit tests for uncancel_subscription
-  # Undo Cancellation
-  # Reverse a pending cancellation; subscription will renew as normal.
-  # @param id 
-  # @param [Hash] opts the optional parameters
-  # @return [SubscriptionResponse]
-  describe 'uncancel_subscription test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for undowngrade_subscription
-  # Undo Pending Downgrade
-  # Reverse a pending downgrade scheduled for end of the current billing period.
-  # @param id 
-  # @param [Hash] opts the optional parameters
-  # @return [SubscriptionResponse]
-  describe 'undowngrade_subscription test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   # unit tests for update_payment_method
   # Update Payment Method
   # Update the mutable fields of a payment method (`billing_details`, `exp_month`, `exp_year`). The `default` flag is not mutable via PUT — use the `set_default` action instead.
@@ -210,17 +140,4 @@ describe 'BillingApi' do
     end
   end
 
-  # unit tests for upgrade_subscription
-  # Upgrade Subscription
-  # Upgrade an existing paid subscription to a higher plan.
-  # @param id 
-  # @param plan_change_request 
-  # @param [Hash] opts the optional parameters
-  # @return [SubscriptionResponse]
-  describe 'upgrade_subscription test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
 end

data/lib/smplkit/_generated/app/spec/api/context_types_api_spec.rb

@@ -72,6 +72,7 @@ describe 'ContextTypesApi' do
   # List Context Types
   # List all context types for the authenticated account.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `key`. Allowed values: `created_at`, `-created_at`, `key`, `-key`, `name`, `-name`, `updated_at`, `-updated_at`.
   # @return [ContextTypeListResponse]
   describe 'list_context_types test' do
     it 'should work' do

data/lib/smplkit/_generated/app/spec/api/contexts_api_spec.rb

@@ -73,6 +73,7 @@ describe 'ContextsApi' do
   # List all context instances for the authenticated account.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :filter_context_type 
+  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `key`. Allowed values: `created_at`, `-created_at`, `key`, `-key`, `name`, `-name`, `updated_at`, `-updated_at`.
   # @return [ContextListResponse]
   describe 'list_contexts test' do
     it 'should work' do

data/lib/smplkit/_generated/app/spec/api/environments_api_spec.rb

@@ -85,6 +85,7 @@ describe 'EnvironmentsApi' do
   # List Environments
   # List all environments for the authenticated account.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `name`. Allowed values: `created_at`, `-created_at`, `key`, `-key`, `name`, `-name`, `updated_at`, `-updated_at`.
   # @return [EnvironmentListResponse]
   describe 'list_environments test' do
     it 'should work' do

data/lib/smplkit/_generated/app/spec/api/invitations_api_spec.rb

@@ -62,6 +62,7 @@ describe 'InvitationsApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [String] :filter_status 
   # @option opts [String] :filter_token 
+  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `-created_at`. Allowed values: `created_at`, `-created_at`, `email`, `-email`, `status`, `-status`.
   # @return [InvitationListResponse]
   describe 'list_invitations test' do
     it 'should work' do

data/lib/smplkit/_generated/app/spec/api/metrics_api_spec.rb

@@ -46,8 +46,9 @@ describe 'MetricsApi' do
 
   # unit tests for list_metric_names
   # List Metric Names
-  # Return distinct metric names recorded for the account, each with a representative unit. Plain-JSON response (not JSON:API) — this is metadata for discovery, not a metric resource.
+  # Return distinct metric names recorded for the account, each with a representative unit. Plain-JSON response (not JSON:API) — this is metadata for discovery, not a metric resource.  Default sort is `name` ascending.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `name`. Allowed values: `name`, `-name`.
   # @return [MetricNamesResponse]
   describe 'list_metric_names test' do
     it 'should work' do
@@ -62,6 +63,7 @@ describe 'MetricsApi' do
   # @param filter_rollup 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :filter_recorded_at 
+  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `bucket`. Allowed values: `bucket`, `-bucket`.
   # @return [MetricRollupListResponse]
   describe 'list_metric_rollups test' do
     it 'should work' do
@@ -75,6 +77,7 @@ describe 'MetricsApi' do
   # @param filter_name 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :filter_recorded_at 
+  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `-recorded_at`. Allowed values: `recorded_at`, `-recorded_at`, `value`, `-value`.
   # @return [MetricListResponse]
   describe 'list_metrics test' do
     it 'should work' do

data/lib/smplkit/_generated/app/spec/api/plans_api_spec.rb

@@ -34,8 +34,9 @@ describe 'PlansApi' do
 
   # unit tests for list_plans
   # List Plans
-  # Return all plan tier definitions as JSON:API resources.
+  # Return all plan tier definitions as JSON:API resources.  Default sort is `sort_order` ascending — the natural ladder defined in `plans.yaml`. Pass `sort=display_name` for an alphabetical view.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `sort_order`. Allowed values: `display_name`, `-display_name`, `id`, `-id`, `sort_order`, `-sort_order`.
   # @return [PlanListResponse]
   describe 'list_plans test' do
     it 'should work' do

data/lib/smplkit/_generated/app/spec/api/products_api_spec.rb

@@ -34,8 +34,9 @@ describe 'ProductsApi' do
 
   # unit tests for list_products
   # List Products
-  # Return all flag-enabled products with their plans, limits, and marketing content.
+  # Return all flag-enabled products with their plans, limits, and marketing content.  Default sort is `display_name` ascending.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `display_name`. Allowed values: `display_name`, `-display_name`, `id`, `-id`.
   # @return [ProductListResponse]
   describe 'list_products test' do
     it 'should work' do

data/lib/smplkit/_generated/app/spec/api/services_api_spec.rb

@@ -72,6 +72,7 @@ describe 'ServicesApi' do
   # List Services
   # List all services for the authenticated account.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `name`. Allowed values: `created_at`, `-created_at`, `key`, `-key`, `name`, `-name`, `updated_at`, `-updated_at`.
   # @return [ServiceListResponse]
   describe 'list_services test' do
     it 'should work' do