metronome-sdk 1.0.0 → 2.1.0

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

@@ -156,7 +156,7 @@ module MetronomeSDK
         # - Ingest aliases remain idempotent for archived customers. In order to reuse an
         #   ingest alias, first remove the ingest alias from the customer prior to
         #   archiving.
-        # - Any alerts associated with the customer will no longer be triggered.
+        # - Any notifications associated with the customer will no longer be triggered.
         sig do
           params(
             id: String,
@@ -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,
@@ -232,10 +233,11 @@ module MetronomeSDK
         )
         end
 
-        # Preview how a set of events will affect a customer's invoice. Generates a draft
-        # invoice for a customer using their current contract configuration and the
+        # 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 invoice 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: {}
@@ -300,6 +303,9 @@ module MetronomeSDK
         #   through system A (e.g. Stripe) but will now be billed through system B (e.g.
         #   AWS). Once created, the new configuration can then be associated to the
         #   customer's contract.
+        # - Multiple configurations can be added per destination. For example, you can
+        #   create two Stripe billing configurations for a Metronome customer that each
+        #   have a distinct `collection_method`.
         #
         # ### Delivery method options:
         #

data/rbi/metronome_sdk/resources/v1/payments.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Payments
+        # Fetch all payment attempts for the given invoice.
+        sig do
+          params(
+            customer_id: String,
+            invoice_id: String,
+            limit: Integer,
+            next_page: String,
+            statuses: T::Array[MetronomeSDK::V1::PaymentStatus::OrSymbol],
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(
+            MetronomeSDK::Internal::BodyCursorPage[MetronomeSDK::V1::Payment]
+          )
+        end
+        def list(
+          customer_id:,
+          invoice_id:,
+          # The maximum number of payments to return. Defaults to 25.
+          limit: nil,
+          # The next page token from a previous response.
+          next_page: nil,
+          statuses: nil,
+          request_options: {}
+        )
+        end
+
+        # Trigger a new attempt by canceling any existing attempts for this invoice and
+        # creating a new Payment. This will trigger another attempt to charge the
+        # Customer's configured Payment Gateway. Payment can only be attempted if all of
+        # the following are true:
+        #
+        # - The Metronome Invoice is finalized
+        # - PLG Invoicing is configured for the Customer
+        # - You cannot attempt payments for invoices that have already been `paid` or
+        #   `voided`.
+        #
+        # Attempting to payment on an ineligible Invoice or Customer will result in a
+        # `400` response.
+        sig do
+          params(
+            customer_id: String,
+            invoice_id: String,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::PaymentAttemptResponse)
+        end
+        def attempt(customer_id:, invoice_id:, request_options: {})
+        end
+
+        # Cancel an existing payment attempt for an invoice.
+        sig do
+          params(
+            customer_id: String,
+            invoice_id: String,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::PaymentCancelResponse)
+        end
+        def cancel(customer_id:, invoice_id:, 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/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/usage.rbi

@@ -84,8 +84,7 @@ module MetronomeSDK
         # ingestion, supports backdating 34 days, and is built to handle mission-critical
         # usage data with enterprise-grade reliability. Metronome supports 100,000 events
         # per second without requiring pre-aggregation or rollups and can scale up from
-        # there. See
-        # [Getting usage into Metronome](https://docs.metronome.com/connect-metronome/) to
+        # there. See the [Send usage events](/guides/events/send-usage-events) guide to
         # learn more about usage events.
         #
         # ### Use this endpoint to:
@@ -128,6 +127,9 @@ module MetronomeSDK
         # }
         # ```
         #
+        # Learn more about
+        # [usage event structure definitions](/guides/events/design-usage-events).
+        #
         # #### Transaction ID
         #
         # The transaction_id serves as your idempotency key, ensuring events are processed

data/rbi/metronome_sdk/resources/v1.rbi

@@ -42,6 +42,12 @@ module MetronomeSDK
       sig { returns(MetronomeSDK::Resources::V1::Contracts) }
       attr_reader :contracts
 
+      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/rbi/metronome_sdk/resources/v2/contracts.rbi

@@ -119,6 +119,8 @@ module MetronomeSDK
           params(
             contract_id: String,
             customer_id: String,
+            add_billing_provider_configuration_update:
+              MetronomeSDK::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::OrHash,
             add_commits:
               T::Array[MetronomeSDK::V2::ContractEditParams::AddCommit::OrHash],
             add_credits:
@@ -215,6 +217,10 @@ module MetronomeSDK
           contract_id:,
           # ID of the customer whose contract is being edited
           customer_id:,
+          # Update the billing provider configuration on the contract. Currently only
+          # supports adding a billing provider configuration to a contract that does not
+          # already have one.
+          add_billing_provider_configuration_update: nil,
           add_commits: nil,
           add_credits: nil,
           add_discounts: nil,
@@ -294,6 +300,8 @@ module MetronomeSDK
               MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule::OrHash,
             applicable_product_ids: T.nilable(T::Array[String]),
             applicable_product_tags: T.nilable(T::Array[String]),
+            hierarchy_configuration:
+              MetronomeSDK::CommitHierarchyConfiguration::OrHash,
             invoice_contract_id: String,
             invoice_schedule:
               MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule::OrHash,
@@ -320,6 +328,8 @@ module MetronomeSDK
           # applicable_product_tags or specifiers are not provided, the commit applies to
           # all products.
           applicable_product_tags: nil,
+          # Optional configuration for commit hierarchy access control
+          hierarchy_configuration: nil,
           # ID of contract to use for invoicing
           invoice_contract_id: nil,
           invoice_schedule: nil,
@@ -366,6 +376,8 @@ module MetronomeSDK
               MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule::OrHash,
             applicable_product_ids: T.nilable(T::Array[String]),
             applicable_product_tags: T.nilable(T::Array[String]),
+            hierarchy_configuration:
+              MetronomeSDK::CommitHierarchyConfiguration::OrHash,
             priority: T.nilable(Float),
             product_id: String,
             rate_type:
@@ -387,6 +399,8 @@ module MetronomeSDK
           # Which tags the credit applies to. If both applicable_product_ids and
           # applicable_product_tags are not provided, the credit applies to all products.
           applicable_product_tags: nil,
+          # Optional configuration for credit hierarchy access control
+          hierarchy_configuration: nil,
           # If multiple commits are applicable, the one with the lower priority will apply
           # first.
           priority: nil,

data/sig/metronome_sdk/errors.rbs

@@ -21,11 +21,14 @@ module MetronomeSDK
 
       attr_accessor status: Integer?
 
+      attr_accessor headers: ::Hash[String, String]?
+
       attr_accessor body: top?
 
       def initialize: (
         url: URI::Generic,
         ?status: Integer?,
+        ?headers: ::Hash[String, String]?,
         ?body: Object?,
         ?request: nil,
         ?response: nil,
@@ -37,6 +40,7 @@ module MetronomeSDK
       def initialize: (
         url: URI::Generic,
         ?status: nil,
+        ?headers: ::Hash[String, String]?,
         ?body: nil,
         ?request: nil,
         ?response: nil,
@@ -48,6 +52,7 @@ module MetronomeSDK
       def initialize: (
         url: URI::Generic,
         ?status: nil,
+        ?headers: ::Hash[String, String]?,
         ?body: nil,
         ?request: nil,
         ?response: nil,
@@ -59,6 +64,7 @@ module MetronomeSDK
       def self.for: (
         url: URI::Generic,
         status: Integer,
+        headers: ::Hash[String, String]?,
         body: Object?,
         request: nil,
         response: nil,
@@ -68,6 +74,7 @@ module MetronomeSDK
       def initialize: (
         url: URI::Generic,
         status: Integer,
+        headers: ::Hash[String, String]?,
         body: Object?,
         request: nil,
         response: nil,

data/sig/metronome_sdk/file_part.rbs

@@ -14,7 +14,7 @@ module MetronomeSDK
 
     def initialize: (
       Pathname | StringIO | IO | String content,
-      ?filename: String?,
+      ?filename: (Pathname | String)?,
       ?content_type: String?
     ) -> void
   end

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