metronome-sdk 2.0.0 → 2.1.0

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

@@ -4,7 +4,8 @@ module MetronomeSDK
   module Resources
     class V1
       class CreditGrants
-        # Create a new credit grant
+        # Create a new credit grant. This is a Plans (deprecated) endpoint. New clients
+        # should implement using Contracts.
         sig do
           params(
             customer_id: String,
@@ -65,7 +66,8 @@ module MetronomeSDK
         )
         end
 
-        # List credit grants. This list does not included voided grants.
+        # List credit grants. This list does not included voided grants. This is a Plans
+        # (deprecated) endpoint. New clients should implement using Contracts.
         sig do
           params(
             limit: Integer,
@@ -105,7 +107,8 @@ module MetronomeSDK
         )
         end
 
-        # Edit an existing credit grant
+        # Edit an existing credit grant. This is a Plans (deprecated) endpoint. New
+        # clients should implement using Contracts.
         sig do
           params(
             id: String,
@@ -130,7 +133,8 @@ module MetronomeSDK
 
         # Fetches a list of credit ledger entries. Returns lists of ledgers per customer.
         # Ledger entries are returned in chronological order. Ledger entries associated
-        # with voided credit grants are not included.
+        # with voided credit grants are not included. This is a Plans (deprecated)
+        # endpoint. New clients should implement using Contracts.
         sig do
           params(
             next_page: String,
@@ -170,7 +174,8 @@ module MetronomeSDK
         )
         end
 
-        # Void a credit grant
+        # Void a credit grant. This is a Plans (deprecated) endpoint. New clients should
+        # implement using Contracts.
         sig do
           params(
             id: String,

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

@@ -5,7 +5,8 @@ module MetronomeSDK
     class V1
       class Customers
         class BillingConfig
-          # Set the billing configuration for a given customer.
+          # Set the billing configuration for a given customer. This is a Plans (deprecated)
+          # endpoint. New clients should implement using Contracts.
           sig do
             params(
               customer_id: String,
@@ -32,13 +33,15 @@ module MetronomeSDK
             aws_product_code: nil,
             # Body param:
             aws_region: nil,
-            # Body param:
+            # Body param: The collection method for the customer's invoices. NOTE:
+            # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
             stripe_collection_method: nil,
             request_options: {}
           )
           end
 
-          # Fetch the billing configuration for the given customer.
+          # Fetch the billing configuration for the given customer. This is a Plans
+          # (deprecated) endpoint. New clients should implement using Contracts.
           sig do
             params(
               customer_id: String,
@@ -58,7 +61,8 @@ module MetronomeSDK
           end
 
           # Delete the billing configuration for a given customer. Note: this is unsupported
-          # for Azure and AWS Marketplace customers.
+          # for Azure and AWS Marketplace customers. This is a Plans (deprecated) endpoint.
+          # New clients should implement using Contracts.
           sig do
             params(
               customer_id: String,

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

@@ -34,7 +34,8 @@ module MetronomeSDK
           # #### Billing configuration:
           #
           # - invoice_contract_id is required for postpaid commits and for prepaid commits
-          #   with billing (only optional for free prepaid commits)
+          #   with billing (only optional for free prepaid commits) unless do_not_invoice is
+          #   set to true
           # - For postpaid commits: access_schedule and invoice_schedule must have matching
           #   amounts
           # - For postpaid commits: only one schedule item is allowed in both schedules.
@@ -123,7 +124,7 @@ module MetronomeSDK
             description: nil,
             # The contract that this commit will be billed on. This is required for "POSTPAID"
             # commits and for "PREPAID" commits unless there is no invoice schedule above
-            # (i.e., the commit is 'free').
+            # (i.e., the commit is 'free'), or if do_not_invoice is set to true.
             invoice_contract_id: nil,
             # Required for "POSTPAID" commits: the true up invoice will be generated at this
             # time and only one schedule item is allowed; the total must match

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

@@ -159,7 +159,8 @@ module MetronomeSDK
           )
           end
 
-          # Add a one time charge to the specified invoice
+          # Add a one time charge to the specified invoice. This is a Plans (deprecated)
+          # endpoint. New clients should implement using Contracts.
           sig do
             params(
               customer_id: String,

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

@@ -5,7 +5,8 @@ module MetronomeSDK
     class V1
       class Customers
         class Plans
-          # List the given customer's plans in reverse-chronological order.
+          # List the given customer's plans in reverse-chronological order. This is a Plans
+          # (deprecated) endpoint. New clients should implement using Contracts.
           sig do
             params(
               customer_id: String,
@@ -31,7 +32,8 @@ module MetronomeSDK
 
           # Associate an existing customer with a plan for a specified date range. See the
           # [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
-          # for details on the price adjustments.
+          # for details on the price adjustments. This is a Plans (deprecated) endpoint. New
+          # clients should implement using Contracts.
           sig do
             params(
               customer_id: String,
@@ -82,7 +84,8 @@ module MetronomeSDK
           )
           end
 
-          # Change the end date of a customer's plan.
+          # Change the end date of a customer's plan. This is a Plans (deprecated) endpoint.
+          # New clients should implement using Contracts.
           sig do
             params(
               customer_id: String,
@@ -116,7 +119,8 @@ module MetronomeSDK
 
           # Lists a customer plans adjustments. See the
           # [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
-          # for details.
+          # for details. This is a Plans (deprecated) endpoint. New clients should implement
+          # using Contracts.
           sig do
             params(
               customer_id: String,

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

@@ -202,7 +202,8 @@ module MetronomeSDK
 
         # Fetch daily pending costs for the specified customer, broken down by credit type
         # and line items. Note: this is not supported for customers whose plan includes a
-        # UNIQUE-type billable metric.
+        # UNIQUE-type billable metric. This is a Plans (deprecated) endpoint. New clients
+        # should implement using Contracts.
         sig do
           params(
             customer_id: String,
@@ -235,7 +236,8 @@ module MetronomeSDK
         # Preview how a set of events will affect a customer's invoices. Generates draft
         # invoices for a customer using their current contract configuration and the
         # provided events. This is useful for testing how new events will affect the
-        # customer's invoices before they are actually processed.
+        # customer's invoices before they are actually processed. Customers on contracts
+        # with SQL billable metrics are not supported.
         sig do
           params(
             customer_id: String,
@@ -251,14 +253,15 @@ module MetronomeSDK
         def preview_events(
           # Path param:
           customer_id:,
-          # Body param:
+          # Body param: Array of usage events to include in the preview calculation. Must
+          # contain at least one event in `merge` mode.
           events:,
-          # Body param: If set to "replace", the preview will be generated as if those were
-          # the only events for the specified customer. If set to "merge", the events will
-          # be merged with any existing events for the specified customer. Defaults to
-          # "replace".
+          # Body param: Controls how the provided events are combined with existing usage
+          # data. Use `replace` to calculate the preview as if these are the only events for
+          # the customer, ignoring all historical usage. Use `merge` to combine these events
+          # with the customer's existing usage. Defaults to `replace`.
           mode: nil,
-          # Body param: If set, all zero quantity line items will be filtered out of the
+          # Body param: When `true`, line items with zero quantity are excluded from the
           # response.
           skip_zero_qty_line_items: nil,
           request_options: {}

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

@@ -4,7 +4,8 @@ module MetronomeSDK
   module Resources
     class V1
       class Plans
-        # List all available plans.
+        # List all available plans. This is a Plans (deprecated) endpoint. New clients
+        # should implement using Contracts.
         sig do
           params(
             limit: Integer,
@@ -25,7 +26,8 @@ module MetronomeSDK
         )
         end
 
-        # Fetch high level details of a specific plan.
+        # Fetch high level details of a specific plan. This is a Plans (deprecated)
+        # endpoint. New clients should implement using Contracts.
         sig do
           params(
             plan_id: String,
@@ -35,7 +37,8 @@ module MetronomeSDK
         def get_details(plan_id:, request_options: {})
         end
 
-        # Fetches a list of charges of a specific plan.
+        # Fetches a list of charges of a specific plan. This is a Plans (deprecated)
+        # endpoint. New clients should implement using Contracts.
         sig do
           params(
             plan_id: String,
@@ -60,7 +63,8 @@ module MetronomeSDK
         end
 
         # Fetches a list of customers on a specific plan (by default, only currently
-        # active plans are included)
+        # active plans are included). This is a Plans (deprecated) endpoint. New clients
+        # should implement using Contracts.
         sig do
           params(
             plan_id: String,

data/rbi/metronome_sdk/resources/v1/settings/billing_providers.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Settings
+        class BillingProviders
+          # Set up account-level configuration for a billing provider. Once configured,
+          # individual contracts across customers can be mapped to this configuration using
+          # the returned delivery_method_id.
+          sig do
+            params(
+              billing_provider:
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::OrSymbol,
+              configuration: T::Hash[Symbol, T.anything],
+              delivery_method:
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::OrSymbol,
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Models::V1::Settings::BillingProviderCreateResponse
+            )
+          end
+          def create(
+            # The billing provider set for this configuration.
+            billing_provider:,
+            # Account-level configuration for the billing provider. The structure of this
+            # object is specific to the billing provider and delivery provider combination.
+            # See examples below.
+            configuration:,
+            # The method to use for delivering invoices for this configuration.
+            delivery_method:,
+            request_options: {}
+          )
+          end
+
+          # Lists all configured billing providers and their delivery method configurations
+          # for your account. Returns provider details, delivery method IDs, and
+          # configuration settings needed for mapping individual customer contracts to
+          # billing integrations.
+          sig do
+            params(
+              next_page: T.nilable(String),
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Models::V1::Settings::BillingProviderListResponse
+            )
+          end
+          def list(
+            # The cursor to the next page of results
+            next_page: nil,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/resources/v1/settings.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Settings
+        sig { returns(MetronomeSDK::Resources::V1::Settings::BillingProviders) }
+        attr_reader :billing_providers
+
+        # Set the Avalara credentials for some specified `delivery_method_ids`, which can
+        # be found in the `/listConfiguredBillingProviders` response. This maps the
+        # Avalara credentials to the appropriate billing entity. These credentials are
+        # only used for PLG Invoicing today.
+        sig do
+          params(
+            avalara_environment:
+              MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment::OrSymbol,
+            avalara_password: String,
+            avalara_username: String,
+            delivery_method_ids: T::Array[String],
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(
+            MetronomeSDK::Models::V1::SettingUpsertAvalaraCredentialsResponse
+          )
+        end
+        def upsert_avalara_credentials(
+          # The Avalara environment to use (SANDBOX or PRODUCTION).
+          avalara_environment:,
+          # The password for the Avalara account.
+          avalara_password:,
+          # The username for the Avalara account.
+          avalara_username:,
+          # The delivery method IDs of the billing provider configurations to update, can be
+          # found in the response of the `/listConfiguredBillingProviders` endpoint.
+          delivery_method_ids:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/resources/v1.rbi

@@ -45,6 +45,9 @@ module MetronomeSDK
       sig { returns(MetronomeSDK::Resources::V1::Payments) }
       attr_reader :payments
 
+      sig { returns(MetronomeSDK::Resources::V1::Settings) }
+      attr_reader :settings
+
       # @api private
       sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
       def self.new(client:)

data/sig/metronome_sdk/models/contract.rbs

@@ -353,6 +353,7 @@ module MetronomeSDK
           | :quickbooks_online
           | :workday
           | :gcp_marketplace
+          | :metronome
 
         module BillingProvider
           extend MetronomeSDK::Internal::Type::Enum
@@ -365,6 +366,7 @@ module MetronomeSDK
           QUICKBOOKS_ONLINE: :quickbooks_online
           WORKDAY: :workday
           GCP_MARKETPLACE: :gcp_marketplace
+          METRONOME: :metronome
 
           def self?.values: -> ::Array[MetronomeSDK::Models::Contract::CustomerBillingProviderConfiguration::billing_provider]
         end

data/sig/metronome_sdk/models/contract_v2.rbs

@@ -2176,6 +2176,7 @@ module MetronomeSDK
           | :quickbooks_online
           | :workday
           | :gcp_marketplace
+          | :metronome
 
         module BillingProvider
           extend MetronomeSDK::Internal::Type::Enum
@@ -2188,6 +2189,7 @@ module MetronomeSDK
           QUICKBOOKS_ONLINE: :quickbooks_online
           WORKDAY: :workday
           GCP_MARKETPLACE: :gcp_marketplace
+          METRONOME: :metronome
 
           def self?.values: -> ::Array[MetronomeSDK::Models::ContractV2::CustomerBillingProviderConfiguration::billing_provider]
         end

data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs

@@ -7,6 +7,7 @@ module MetronomeSDK
           id: String,
           covering_date: Time,
           effective_before: Time,
+          exclude_zero_balances: bool,
           include_archived: bool,
           include_balance: bool,
           include_contract_balances: bool,
@@ -35,6 +36,10 @@ module MetronomeSDK
 
         def effective_before=: (Time) -> Time
 
+        attr_reader exclude_zero_balances: bool?
+
+        def exclude_zero_balances=: (bool) -> bool
+
         attr_reader include_archived: bool?
 
         def include_archived=: (bool) -> bool
@@ -68,6 +73,7 @@ module MetronomeSDK
           ?id: String,
           ?covering_date: Time,
           ?effective_before: Time,
+          ?exclude_zero_balances: bool,
           ?include_archived: bool,
           ?include_balance: bool,
           ?include_contract_balances: bool,
@@ -83,6 +89,7 @@ module MetronomeSDK
           id: String,
           covering_date: Time,
           effective_before: Time,
+          exclude_zero_balances: bool,
           include_archived: bool,
           include_balance: bool,
           include_contract_balances: bool,

data/sig/metronome_sdk/models/v1/customer_create_params.rbs

@@ -124,6 +124,7 @@ module MetronomeSDK
             | :quickbooks_online
             | :workday
             | :gcp_marketplace
+            | :metronome
 
           module BillingProviderType
             extend MetronomeSDK::Internal::Type::Enum
@@ -136,6 +137,7 @@ module MetronomeSDK
             QUICKBOOKS_ONLINE: :quickbooks_online
             WORKDAY: :workday
             GCP_MARKETPLACE: :gcp_marketplace
+            METRONOME: :metronome
 
             def self?.values: -> ::Array[MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig::billing_provider_type]
           end

data/sig/metronome_sdk/models/v1/customer_retrieve_billing_configurations_response.rbs

@@ -77,6 +77,7 @@ module MetronomeSDK
             | :quickbooks_online
             | :workday
             | :gcp_marketplace
+            | :metronome
 
           module BillingProvider
             extend MetronomeSDK::Internal::Type::Enum
@@ -89,6 +90,7 @@ module MetronomeSDK
             QUICKBOOKS_ONLINE: :quickbooks_online
             WORKDAY: :workday
             GCP_MARKETPLACE: :gcp_marketplace
+            METRONOME: :metronome
 
             def self?.values: -> ::Array[MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::billing_provider]
           end

data/sig/metronome_sdk/models/v1/customer_set_billing_configurations_params.rbs

@@ -85,6 +85,7 @@ module MetronomeSDK
             | :quickbooks_online
             | :workday
             | :gcp_marketplace
+            | :metronome
 
           module BillingProvider
             extend MetronomeSDK::Internal::Type::Enum
@@ -97,6 +98,7 @@ module MetronomeSDK
             QUICKBOOKS_ONLINE: :quickbooks_online
             WORKDAY: :workday
             GCP_MARKETPLACE: :gcp_marketplace
+            METRONOME: :metronome
 
             def self?.values: -> ::Array[MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsParams::Data::billing_provider]
           end

data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs

@@ -68,6 +68,7 @@ module MetronomeSDK
             | :quickbooks_online
             | :workday
             | :gcp_marketplace
+            | :metronome
 
           module BillingProviderType
             extend MetronomeSDK::Internal::Type::Enum
@@ -80,6 +81,7 @@ module MetronomeSDK
             QUICKBOOKS_ONLINE: :quickbooks_online
             WORKDAY: :workday
             GCP_MARKETPLACE: :gcp_marketplace
+            METRONOME: :metronome
 
             def self?.values: -> ::Array[MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::billing_provider_type]
           end

data/sig/metronome_sdk/models/v1/customers/billing_config_delete_params.rbs

@@ -38,6 +38,7 @@ module MetronomeSDK
             | :quickbooks_online
             | :workday
             | :gcp_marketplace
+            | :metronome
 
           module BillingProviderType
             extend MetronomeSDK::Internal::Type::Enum
@@ -50,6 +51,7 @@ module MetronomeSDK
             QUICKBOOKS_ONLINE: :quickbooks_online
             WORKDAY: :workday
             GCP_MARKETPLACE: :gcp_marketplace
+            METRONOME: :metronome
 
             def self?.values: -> ::Array[MetronomeSDK::Models::V1::Customers::BillingConfigDeleteParams::billing_provider_type]
           end

data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rbs

@@ -38,6 +38,7 @@ module MetronomeSDK
             | :quickbooks_online
             | :workday
             | :gcp_marketplace
+            | :metronome
 
           module BillingProviderType
             extend MetronomeSDK::Internal::Type::Enum
@@ -50,6 +51,7 @@ module MetronomeSDK
             QUICKBOOKS_ONLINE: :quickbooks_online
             WORKDAY: :workday
             GCP_MARKETPLACE: :gcp_marketplace
+            METRONOME: :metronome
 
             def self?.values: -> ::Array[MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveParams::billing_provider_type]
           end

data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs

@@ -150,6 +150,7 @@ module MetronomeSDK
               | :low_remaining_contract_credit_balance_reached
               | :low_remaining_contract_credit_percentage_reached
               | :low_remaining_contract_credit_and_commit_balance_reached
+              | :low_remaining_seat_balance_reached
               | :invoice_total_reached
 
             module Type
@@ -168,6 +169,7 @@ module MetronomeSDK
               LOW_REMAINING_CONTRACT_CREDIT_BALANCE_REACHED: :low_remaining_contract_credit_balance_reached
               LOW_REMAINING_CONTRACT_CREDIT_PERCENTAGE_REACHED: :low_remaining_contract_credit_percentage_reached
               LOW_REMAINING_CONTRACT_CREDIT_AND_COMMIT_BALANCE_REACHED: :low_remaining_contract_credit_and_commit_balance_reached
+              LOW_REMAINING_SEAT_BALANCE_REACHED: :low_remaining_seat_balance_reached
               INVOICE_TOTAL_REACHED: :invoice_total_reached
 
               def self?.values: -> ::Array[MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::type_]