metronome-sdk 3.1.0 → 3.2.0

data/rbi/metronome_sdk/models/v1/usage_list_with_groups_params.rbi

@@ -60,6 +60,8 @@ module MetronomeSDK
         sig { params(ending_before: Time).void }
         attr_writer :ending_before
 
+        # Use group_key and group_filters instead. Use a single group key to group by.
+        # Compound group keys are not supported.
         sig do
           returns(
             T.nilable(MetronomeSDK::V1::UsageListWithGroupsParams::GroupBy)
@@ -75,6 +77,32 @@ module MetronomeSDK
         end
         attr_writer :group_by
 
+        # Object mapping group keys to arrays of values to filter on. Only usage matching
+        # these filter values will be returned. Keys must be present in group_key. Omit a
+        # key or use an empty array to include all values for that dimension.
+        sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
+        attr_reader :group_filters
+
+        sig { params(group_filters: T::Hash[Symbol, T::Array[String]]).void }
+        attr_writer :group_filters
+
+        # Group key to group usage by. Supports both simple (single key) and compound
+        # (multiple keys) group keys.
+        #
+        # For simple group keys, provide a single key e.g. `["region"]`. For compound
+        # group keys, provide multiple keys e.g. `["region", "team"]`.
+        #
+        # For streaming metrics, the keys must be defined as a simple or compound group
+        # key on the billable metric. For compound group keys, all keys must match an
+        # exact compound group key definition — partial matches are not allowed.
+        #
+        # Cannot be used together with `group_by`.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :group_key
+
+        sig { params(group_key: T::Array[String]).void }
+        attr_writer :group_key
+
         sig { returns(T.nilable(Time)) }
         attr_reader :starting_on
 
@@ -93,6 +121,8 @@ module MetronomeSDK
             ending_before: Time,
             group_by:
               MetronomeSDK::V1::UsageListWithGroupsParams::GroupBy::OrHash,
+            group_filters: T::Hash[Symbol, T::Array[String]],
+            group_key: T::Array[String],
             starting_on: Time,
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -113,7 +143,25 @@ module MetronomeSDK
           # are specified when this is true.
           current_period: nil,
           ending_before: nil,
+          # Use group_key and group_filters instead. Use a single group key to group by.
+          # Compound group keys are not supported.
           group_by: nil,
+          # Object mapping group keys to arrays of values to filter on. Only usage matching
+          # these filter values will be returned. Keys must be present in group_key. Omit a
+          # key or use an empty array to include all values for that dimension.
+          group_filters: nil,
+          # Group key to group usage by. Supports both simple (single key) and compound
+          # (multiple keys) group keys.
+          #
+          # For simple group keys, provide a single key e.g. `["region"]`. For compound
+          # group keys, provide multiple keys e.g. `["region", "team"]`.
+          #
+          # For streaming metrics, the keys must be defined as a simple or compound group
+          # key on the billable metric. For compound group keys, all keys must match an
+          # exact compound group key definition — partial matches are not allowed.
+          #
+          # Cannot be used together with `group_by`.
+          group_key: nil,
           starting_on: nil,
           request_options: {}
         )
@@ -131,6 +179,8 @@ module MetronomeSDK
               current_period: T::Boolean,
               ending_before: Time,
               group_by: MetronomeSDK::V1::UsageListWithGroupsParams::GroupBy,
+              group_filters: T::Hash[Symbol, T::Array[String]],
+              group_key: T::Array[String],
               starting_on: Time,
               request_options: MetronomeSDK::RequestOptions
             }
@@ -202,6 +252,8 @@ module MetronomeSDK
           sig { params(values: T::Array[String]).void }
           attr_writer :values
 
+          # Use group_key and group_filters instead. Use a single group key to group by.
+          # Compound group keys are not supported.
           sig do
             params(key: String, values: T::Array[String]).returns(
               T.attached_class

data/rbi/metronome_sdk/models/v1/usage_list_with_groups_response.rbi

@@ -15,9 +15,11 @@ module MetronomeSDK
         sig { returns(Time) }
         attr_accessor :ending_before
 
+        # Use `group` instead. The group key for single-key grouping.
         sig { returns(T.nilable(String)) }
         attr_accessor :group_key
 
+        # Use `group` instead. The group value for single-key grouping.
         sig { returns(T.nilable(String)) }
         attr_accessor :group_value
 
@@ -27,21 +29,39 @@ module MetronomeSDK
         sig { returns(T.nilable(Float)) }
         attr_accessor :value
 
+        # Map of group key to their value for this usage aggregate. For simple group keys,
+        # this should be a single key e.g. `{"region": "US-East"}` For compound group
+        # keys, this should contain the values of each group key that forms the compound
+        # e.g. `{"region": "US-East", "team": "engineering"}`
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :group
+
+        sig { params(group: T::Hash[Symbol, String]).void }
+        attr_writer :group
+
         sig do
           params(
             ending_before: Time,
             group_key: T.nilable(String),
             group_value: T.nilable(String),
             starting_on: Time,
-            value: T.nilable(Float)
+            value: T.nilable(Float),
+            group: T::Hash[Symbol, String]
           ).returns(T.attached_class)
         end
         def self.new(
           ending_before:,
+          # Use `group` instead. The group key for single-key grouping.
           group_key:,
+          # Use `group` instead. The group value for single-key grouping.
           group_value:,
           starting_on:,
-          value:
+          value:,
+          # Map of group key to their value for this usage aggregate. For simple group keys,
+          # this should be a single key e.g. `{"region": "US-East"}` For compound group
+          # keys, this should contain the values of each group key that forms the compound
+          # e.g. `{"region": "US-East", "team": "engineering"}`
+          group: nil
         )
         end
 
@@ -52,7 +72,8 @@ module MetronomeSDK
               group_key: T.nilable(String),
               group_value: T.nilable(String),
               starting_on: Time,
-              value: T.nilable(Float)
+              value: T.nilable(Float),
+              group: T::Hash[Symbol, String]
             }
           )
         end

data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi

@@ -2355,11 +2355,6 @@ module MetronomeSDK
                   :ANROK,
                   MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::TaxType::TaggedSymbol
                 )
-              AVALARA =
-                T.let(
-                  :AVALARA,
-                  MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::TaxType::TaggedSymbol
-                )
               PRECALCULATED =
                 T.let(
                   :PRECALCULATED,
@@ -3725,6 +3720,24 @@ module MetronomeSDK
             sig { params(is_prorated: T::Boolean).void }
             attr_writer :is_prorated
 
+            # Only set for TIERED_PERCENTAGE or PERCENTAGE rate_type.
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::V2::ContractEditParams::AddOverride::OverwriteRate::MinimumConfig
+                )
+              )
+            end
+            attr_reader :minimum_config
+
+            sig do
+              params(
+                minimum_config:
+                  MetronomeSDK::V2::ContractEditParams::AddOverride::OverwriteRate::MinimumConfig::OrHash
+              ).void
+            end
+            attr_writer :minimum_config
+
             # Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
             # this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
             sig { returns(T.nilable(Float)) }
@@ -3755,6 +3768,8 @@ module MetronomeSDK
                 credit_type_id: String,
                 custom_rate: T::Hash[Symbol, T.anything],
                 is_prorated: T::Boolean,
+                minimum_config:
+                  MetronomeSDK::V2::ContractEditParams::AddOverride::OverwriteRate::MinimumConfig::OrHash,
                 price: Float,
                 quantity: Float,
                 tiers: T::Array[MetronomeSDK::Tier::OrHash]
@@ -3769,6 +3784,8 @@ module MetronomeSDK
               # Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
               # set to true.
               is_prorated: nil,
+              # Only set for TIERED_PERCENTAGE or PERCENTAGE rate_type.
+              minimum_config: nil,
               # Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
               # this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
               price: nil,
@@ -3787,6 +3804,8 @@ module MetronomeSDK
                   credit_type_id: String,
                   custom_rate: T::Hash[Symbol, T.anything],
                   is_prorated: T::Boolean,
+                  minimum_config:
+                    MetronomeSDK::V2::ContractEditParams::AddOverride::OverwriteRate::MinimumConfig,
                   price: Float,
                   quantity: Float,
                   tiers: T::Array[MetronomeSDK::Tier]
@@ -3849,6 +3868,28 @@ module MetronomeSDK
               def self.values
               end
             end
+
+            class MinimumConfig < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::V2::ContractEditParams::AddOverride::OverwriteRate::MinimumConfig,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(Float) }
+              attr_accessor :minimum
+
+              # Only set for TIERED_PERCENTAGE or PERCENTAGE rate_type.
+              sig { params(minimum: Float).returns(T.attached_class) }
+              def self.new(minimum:)
+              end
+
+              sig { override.returns({ minimum: Float }) }
+              def to_hash
+              end
+            end
           end
 
           # Indicates whether the override applies to commit rates or list rates. Can only

data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi

@@ -2017,6 +2017,24 @@ module MetronomeSDK
               sig { params(is_prorated: T::Boolean).void }
               attr_writer :is_prorated
 
+              # Only set for TIERED_PERCENTAGE or PERCENTAGE rate_type.
+              sig do
+                returns(
+                  T.nilable(
+                    MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::MinimumConfig
+                  )
+                )
+              end
+              attr_reader :minimum_config
+
+              sig do
+                params(
+                  minimum_config:
+                    MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::MinimumConfig::OrHash
+                ).void
+              end
+              attr_writer :minimum_config
+
               # Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
               # this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
               sig { returns(T.nilable(Float)) }
@@ -2046,6 +2064,8 @@ module MetronomeSDK
                   credit_type: MetronomeSDK::CreditTypeData::OrHash,
                   custom_rate: T::Hash[Symbol, T.anything],
                   is_prorated: T::Boolean,
+                  minimum_config:
+                    MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::MinimumConfig::OrHash,
                   price: Float,
                   quantity: Float,
                   tiers: T::Array[MetronomeSDK::Tier::OrHash]
@@ -2060,6 +2080,8 @@ module MetronomeSDK
                 # Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
                 # set to true.
                 is_prorated: nil,
+                # Only set for TIERED_PERCENTAGE or PERCENTAGE rate_type.
+                minimum_config: nil,
                 # Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
                 # this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
                 price: nil,
@@ -2078,6 +2100,8 @@ module MetronomeSDK
                     credit_type: MetronomeSDK::CreditTypeData,
                     custom_rate: T::Hash[Symbol, T.anything],
                     is_prorated: T::Boolean,
+                    minimum_config:
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::MinimumConfig,
                     price: Float,
                     quantity: Float,
                     tiers: T::Array[MetronomeSDK::Tier]
@@ -2140,6 +2164,28 @@ module MetronomeSDK
                 def self.values
                 end
               end
+
+              class MinimumConfig < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::MinimumConfig,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                sig { returns(Float) }
+                attr_accessor :minimum
+
+                # Only set for TIERED_PERCENTAGE or PERCENTAGE rate_type.
+                sig { params(minimum: Float).returns(T.attached_class) }
+                def self.new(minimum:)
+                end
+
+                sig { override.returns({ minimum: Float }) }
+                def to_hash
+                end
+              end
             end
 
             class Product < MetronomeSDK::Internal::Type::BaseModel

data/rbi/metronome_sdk/resources/v1/alerts.rbi

@@ -3,6 +3,11 @@
 module MetronomeSDK
   module Resources
     class V1
+      # [Alerts](https://docs.metronome.com/connecting-metronome/alerts/) monitor
+      # customer spending, balances, and other billing factors. Use these endpoints to
+      # create, retrieve, and archive customer alerts. To view sample alert payloads by
+      # alert type, navigate
+      # [here.](https://docs.metronome.com/manage-product-access/create-manage-alerts/#webhook-notifications)
       class Alerts
         # Create a new threshold notification to monitor customer spending, balances, and
         # billing metrics in real-time. Metronome's notification system provides

data/rbi/metronome_sdk/resources/v1/audit_logs.rbi

@@ -3,6 +3,8 @@
 module MetronomeSDK
   module Resources
     class V1
+      # [Security](https://docs.metronome.com/developer-resources/security/) endpoints
+      # allow you to retrieve security-related data.
       class AuditLogs
         # Get a comprehensive audit trail of all operations performed in your Metronome
         # account, whether initiated through the API, web interface, or automated

data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi

@@ -3,6 +3,9 @@
 module MetronomeSDK
   module Resources
     class V1
+      # [Billable metrics](https://docs.metronome.com/understanding-metronome/how-metronome-works#billable-metrics)
+      # in Metronome represent the various consumption components that Metronome meters
+      # and aggregates.
       class BillableMetrics
         # Create billable metrics programmatically with this endpoint—an essential step in
         # configuring your pricing and packaging in Metronome.

data/rbi/metronome_sdk/resources/v1/contracts/named_schedules.rbi

@@ -4,6 +4,8 @@ module MetronomeSDK
   module Resources
     class V1
       class Contracts
+        # Named schedules are used for storing custom data that can change over time.
+        # Named schedules are often used in custom pricing logic.
         class NamedSchedules
           # Get a named schedule for the given rate card. This endpoint's availability is
           # dependent on your client's configuration.

data/rbi/metronome_sdk/resources/v1/contracts/products.rbi

@@ -4,6 +4,7 @@ module MetronomeSDK
   module Resources
     class V1
       class Contracts
+        # Products are the items that customers purchase.
         class Products
           # Create a new product object. Products in Metronome represent your company's
           # individual product or service offerings. A Product can be thought of as the

data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rbi

@@ -5,6 +5,8 @@ module MetronomeSDK
     class V1
       class Contracts
         class RateCards
+          # Named schedules are used for storing custom data that can change over time.
+          # Named schedules are often used in custom pricing logic.
           class NamedSchedules
             # Get a named schedule for the given contract. This endpoint's availability is
             # dependent on your client's configuration.

data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rbi

@@ -5,6 +5,7 @@ module MetronomeSDK
     class V1
       class Contracts
         class RateCards
+          # Rate cards are used to define default pricing for products.
           class ProductOrders
             # The ordering of products on a rate card determines the order in which the
             # products will appear on customers' invoices. Use this endpoint to set the order

data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi

@@ -5,6 +5,7 @@ module MetronomeSDK
     class V1
       class Contracts
         class RateCards
+          # Rate cards are used to define default pricing for products.
           class Rates
             # Understand the rate schedule at a given timestamp, optionally filtering the list
             # of rates returned based on properties such as `product_id` and
@@ -65,6 +66,8 @@ module MetronomeSDK
                 custom_rate: T::Hash[Symbol, T.anything],
                 ending_before: Time,
                 is_prorated: T::Boolean,
+                minimum_config:
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::MinimumConfig::OrHash,
                 price: Float,
                 pricing_group_values: T::Hash[Symbol, String],
                 quantity: Float,
@@ -101,6 +104,8 @@ module MetronomeSDK
               # Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
               # set to true.
               is_prorated: nil,
+              # Only set for TIERED_PERCENTAGE or PERCENTAGE rate_type.
+              minimum_config: nil,
               # Default price. For FLAT and SUBSCRIPTION rate_type, this must be >=0. For
               # PERCENTAGE rate_type, this is a decimal fraction, e.g. use 0.1 for 10%; this
               # must be >=0 and <=1.

data/rbi/metronome_sdk/resources/v1/contracts/rate_cards.rbi

@@ -4,7 +4,9 @@ module MetronomeSDK
   module Resources
     class V1
       class Contracts
+        # Rate cards are used to define default pricing for products.
         class RateCards
+          # Rate cards are used to define default pricing for products.
           sig do
             returns(
               MetronomeSDK::Resources::V1::Contracts::RateCards::ProductOrders
@@ -12,11 +14,14 @@ module MetronomeSDK
           end
           attr_reader :product_orders
 
+          # Rate cards are used to define default pricing for products.
           sig do
             returns(MetronomeSDK::Resources::V1::Contracts::RateCards::Rates)
           end
           attr_reader :rates
 
+          # Named schedules are used for storing custom data that can change over time.
+          # Named schedules are often used in custom pricing logic.
           sig do
             returns(
               MetronomeSDK::Resources::V1::Contracts::RateCards::NamedSchedules

data/rbi/metronome_sdk/resources/v1/contracts.rbi

@@ -4,12 +4,16 @@ module MetronomeSDK
   module Resources
     class V1
       class Contracts
+        # Products are the items that customers purchase.
         sig { returns(MetronomeSDK::Resources::V1::Contracts::Products) }
         attr_reader :products
 
+        # Rate cards are used to define default pricing for products.
         sig { returns(MetronomeSDK::Resources::V1::Contracts::RateCards) }
         attr_reader :rate_cards
 
+        # Named schedules are used for storing custom data that can change over time.
+        # Named schedules are often used in custom pricing logic.
         sig { returns(MetronomeSDK::Resources::V1::Contracts::NamedSchedules) }
         attr_reader :named_schedules
 
@@ -167,7 +171,6 @@ module MetronomeSDK
             package_id: String,
             prepaid_balance_threshold_configuration:
               MetronomeSDK::PrepaidBalanceThresholdConfiguration::OrHash,
-            priority: Float,
             professional_services:
               T::Array[
                 MetronomeSDK::V1::ContractCreateParams::ProfessionalService::OrHash
@@ -245,8 +248,6 @@ module MetronomeSDK
           # and uniqueness_key are allowed.
           package_id: nil,
           prepaid_balance_threshold_configuration: nil,
-          # Priority of the contract.
-          priority: nil,
           # This field's availability is dependent on your client's configuration.
           professional_services: nil,
           # Selects the rate card linked to the specified alias as of the contract's start

data/rbi/metronome_sdk/resources/v1/credit_grants.rbi

@@ -3,6 +3,9 @@
 module MetronomeSDK
   module Resources
     class V1
+      # [Credit grants](https://docs.metronome.com/invoicing/how-billing-works/manage-credits/)
+      # adjust a customer balance for prepayments, reimbursements, promotions, and so
+      # on. Use these endpoints to create, retrieve, update, and delete credit grants.
       class CreditGrants
         # Create a new credit grant. This is a Plans (deprecated) endpoint. New clients
         # should implement using Contracts.

data/rbi/metronome_sdk/resources/v1/custom_fields.rbi

@@ -3,6 +3,9 @@
 module MetronomeSDK
   module Resources
     class V1
+      # [Custom fields](https://docs.metronome.com/integrations/custom-fields/) enable
+      # adding additional data to Metronome entities. Use these endpoints to create,
+      # retrieve, update, and delete custom fields.
       class CustomFields
         # Creates a new custom field key for a given entity (e.g. billable metric,
         # contract, alert).

data/rbi/metronome_sdk/resources/v1/customers/alerts.rbi

@@ -4,6 +4,11 @@ module MetronomeSDK
   module Resources
     class V1
       class Customers
+        # [Alerts](https://docs.metronome.com/connecting-metronome/alerts/) monitor
+        # customer spending, balances, and other billing factors. Use these endpoints to
+        # create, retrieve, and archive customer alerts. To view sample alert payloads by
+        # alert type, navigate
+        # [here.](https://docs.metronome.com/manage-product-access/create-manage-alerts/#webhook-notifications)
         class Alerts
           # Retrieve the real-time evaluation status for a specific threshold
           # notification-customer pair. This endpoint provides instant visibility into

data/rbi/metronome_sdk/resources/v1/customers/billing_config.rbi

@@ -4,6 +4,10 @@ module MetronomeSDK
   module Resources
     class V1
       class Customers
+        # [Customers](https://docs.metronome.com/provisioning/create-customers/) in
+        # Metronome represent your users for all billing and reporting. Use these
+        # endpoints to create, retrieve, update, and archive customers and their billing
+        # configuration.
         class BillingConfig
           # Set the billing configuration for a given customer. This is a Plans (deprecated)
           # endpoint. New clients should implement using Contracts.

data/rbi/metronome_sdk/resources/v1/customers/commits.rbi

@@ -4,6 +4,7 @@ module MetronomeSDK
   module Resources
     class V1
       class Customers
+        # Credits and commits are used to manage customer balances.
         class Commits
           # Creates customer-level commits that establish spending commitments for customers
           # across their Metronome usage. Commits represent contracted spending obligations

data/rbi/metronome_sdk/resources/v1/customers/credits.rbi

@@ -4,6 +4,7 @@ module MetronomeSDK
   module Resources
     class V1
       class Customers
+        # Credits and commits are used to manage customer balances.
         class Credits
           # Creates customer-level credits that provide spending allowances or free credit
           # balances for customers across their Metronome usage. Note: In most cases, you

data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi

@@ -4,6 +4,10 @@ module MetronomeSDK
   module Resources
     class V1
       class Customers
+        # [Invoices](https://docs.metronome.com/invoicing/) reflect how much a customer
+        # spent during a period, which is the basis for billing. Metronome automatically
+        # generates invoices based upon your pricing, packaging, and usage events. Use
+        # these endpoints to retrieve invoices.
         class Invoices
           # Retrieve detailed information for a specific invoice by its unique identifier.
           # This endpoint returns comprehensive invoice data including line items, applied

data/rbi/metronome_sdk/resources/v1/customers/named_schedules.rbi

@@ -4,6 +4,8 @@ module MetronomeSDK
   module Resources
     class V1
       class Customers
+        # Named schedules are used for storing custom data that can change over time.
+        # Named schedules are often used in custom pricing logic.
         class NamedSchedules
           # Get a named schedule for the given customer. This endpoint's availability is
           # dependent on your client's configuration.

data/rbi/metronome_sdk/resources/v1/customers/plans.rbi

@@ -4,6 +4,10 @@ module MetronomeSDK
   module Resources
     class V1
       class Customers
+        # [Plans](https://docs.metronome.com/pricing-and-packaging/create-plans/)
+        # determine the base pricing for a customer. Use these endpoints to add a plan to
+        # a customer, end a customer plan, retrieve plans, and retrieve plan details.
+        # Create plans in the [Metronome app](https://app.metronome.com/plans).
         class Plans
           # List the given customer's plans in reverse-chronological order. This is a Plans
           # (deprecated) endpoint. New clients should implement using Contracts.

data/rbi/metronome_sdk/resources/v1/customers.rbi

@@ -4,24 +4,45 @@ module MetronomeSDK
   module Resources
     class V1
       class Customers
+        # [Alerts](https://docs.metronome.com/connecting-metronome/alerts/) monitor
+        # customer spending, balances, and other billing factors. Use these endpoints to
+        # create, retrieve, and archive customer alerts. To view sample alert payloads by
+        # alert type, navigate
+        # [here.](https://docs.metronome.com/manage-product-access/create-manage-alerts/#webhook-notifications)
         sig { returns(MetronomeSDK::Resources::V1::Customers::Alerts) }
         attr_reader :alerts
 
+        # [Plans](https://docs.metronome.com/pricing-and-packaging/create-plans/)
+        # determine the base pricing for a customer. Use these endpoints to add a plan to
+        # a customer, end a customer plan, retrieve plans, and retrieve plan details.
+        # Create plans in the [Metronome app](https://app.metronome.com/plans).
         sig { returns(MetronomeSDK::Resources::V1::Customers::Plans) }
         attr_reader :plans
 
+        # [Invoices](https://docs.metronome.com/invoicing/) reflect how much a customer
+        # spent during a period, which is the basis for billing. Metronome automatically
+        # generates invoices based upon your pricing, packaging, and usage events. Use
+        # these endpoints to retrieve invoices.
         sig { returns(MetronomeSDK::Resources::V1::Customers::Invoices) }
         attr_reader :invoices
 
+        # [Customers](https://docs.metronome.com/provisioning/create-customers/) in
+        # Metronome represent your users for all billing and reporting. Use these
+        # endpoints to create, retrieve, update, and archive customers and their billing
+        # configuration.
         sig { returns(MetronomeSDK::Resources::V1::Customers::BillingConfig) }
         attr_reader :billing_config
 
+        # Credits and commits are used to manage customer balances.
         sig { returns(MetronomeSDK::Resources::V1::Customers::Commits) }
         attr_reader :commits
 
+        # Credits and commits are used to manage customer balances.
         sig { returns(MetronomeSDK::Resources::V1::Customers::Credits) }
         attr_reader :credits
 
+        # Named schedules are used for storing custom data that can change over time.
+        # Named schedules are often used in custom pricing logic.
         sig { returns(MetronomeSDK::Resources::V1::Customers::NamedSchedules) }
         attr_reader :named_schedules
 

data/rbi/metronome_sdk/resources/v1/dashboards.rbi

@@ -3,6 +3,10 @@
 module MetronomeSDK
   module Resources
     class V1
+      # [Customers](https://docs.metronome.com/provisioning/create-customers/) in
+      # Metronome represent your users for all billing and reporting. Use these
+      # endpoints to create, retrieve, update, and archive customers and their billing
+      # configuration.
       class Dashboards
         # Generate secure, embeddable dashboard URLs that allow you to seamlessly
         # integrate Metronome's billing visualizations directly into your application.

data/rbi/metronome_sdk/resources/v1/invoices.rbi

@@ -3,6 +3,10 @@
 module MetronomeSDK
   module Resources
     class V1
+      # [Invoices](https://docs.metronome.com/invoicing/) reflect how much a customer
+      # spent during a period, which is the basis for billing. Metronome automatically
+      # generates invoices based upon your pricing, packaging, and usage events. Use
+      # these endpoints to retrieve invoices.
       class Invoices
         # This endpoint regenerates a voided invoice and recalculates the invoice based on
         # up-to-date rates, available balances, and other fees regardless of the billing