metronome-sdk 0.3.0 → 2.0.0

data/lib/metronome_sdk/resources/v1/services.rb

@@ -4,10 +4,12 @@ module MetronomeSDK
   module Resources
     class V1
       class Services
-        # Fetches a list of services used by Metronome and the associated IP addresses. IP
-        # addresses are not necessarily unique between services. In most cases, IP
-        # addresses will appear in the list at least 30 days before they are used for the
-        # first time.
+        # Gets Metronome's service registry with associated IP addresses for security
+        # allowlisting and firewall configuration. Use this endpoint to maintain an
+        # up-to-date list of IPs that your systems should trust for Metronome
+        # communications. Returns service names and their current IP ranges, with new IPs
+        # typically appearing 30+ days before first use to ensure smooth allowlist
+        # updates.
         #
         # @overload list(request_options: {})
         #

data/lib/metronome_sdk/resources/v1/usage.rb

@@ -7,8 +7,39 @@ module MetronomeSDK
         # Some parameter documentations has been truncated, see
         # {MetronomeSDK::Models::V1::UsageListParams} for more details.
         #
-        # Fetch aggregated usage data for multiple customers and billable-metrics, broken
-        # into intervals of the specified length.
+        # Retrieve aggregated usage data across multiple customers and billable metrics in
+        # a single query. This batch endpoint enables you to fetch usage patterns at
+        # scale, broken down by time windows, making it ideal for building analytics
+        # dashboards, generating reports, and monitoring platform-wide usage trends.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Generate platform-wide usage reports for internal teams
+        # - Monitor aggregate usage trends across your entire customer base
+        # - Create comparative usage analyses between customers or time periods
+        # - Support capacity planning with historical usage patterns
+        #
+        # ### Key response fields:
+        #
+        # An array of `UsageBatchAggregate` objects containing:
+        #
+        # - `customer_id`: The customer this usage belongs to
+        # - `billable_metric_id` and `billable_metric_name`: What was measured
+        # - `start_timestamp` and `end_timestamp`: Time window for this data point
+        # - `value`: Aggregated usage amount for the period
+        # - `groups` (optional): Usage broken down by group keys with values
+        # - `next_page`: Pagination cursor for large result sets
+        #
+        # ### Usage guidelines:
+        #
+        # - Time windows: Set `window_size` to `hour`, `day`, or `none` (entire period)
+        # - Required parameters: Must specify `starting_on`, `ending_before`, and
+        #   `window_size`
+        # - Filtering options:
+        #   - `customer_ids`: Limit to specific customers (omit for all customers)
+        #   - `billable_metrics`: Limit to specific metrics (omit for all metrics)
+        # - Pagination: Use `next_page` cursor to retrieve large datasets
+        # - Null values: Group values may be null when no usage matches that group
         #
         # @overload list(ending_before:, starting_on:, window_size:, next_page: nil, billable_metrics: nil, customer_ids: nil, request_options: {})
         #
@@ -26,7 +57,7 @@ module MetronomeSDK
         #
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [MetronomeSDK::Models::V1::UsageListResponse]
+        # @return [MetronomeSDK::Internal::CursorPageWithoutLimit<MetronomeSDK::Models::V1::UsageListResponse>]
         #
         # @see MetronomeSDK::Models::V1::UsageListParams
         def list(params)
@@ -37,17 +68,99 @@ module MetronomeSDK
             path: "v1/usage",
             query: parsed.slice(*query_params),
             body: parsed.except(*query_params),
+            page: MetronomeSDK::Internal::CursorPageWithoutLimit,
             model: MetronomeSDK::Models::V1::UsageListResponse,
             options: options
           )
         end
 
-        # Send usage events to Metronome. The body of this request is expected to be a
-        # JSON array of between 1 and 100 usage events. Compressed request bodies are
-        # supported with a `Content-Encoding: gzip` header. See
-        # [Getting usage into Metronome](https://docs.metronome.com/connect-metronome/) to
+        # The ingest endpoint is the primary method for sending usage events to Metronome,
+        # serving as the foundation for all billing calculations in your usage-based
+        # pricing model. This high-throughput endpoint is designed for real-time streaming
+        # 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 the [Send usage events](/guides/events/send-usage-events) guide to
         # learn more about usage events.
         #
+        # ### Use this endpoint to:
+        #
+        # Create a customer usage pipeline into Metronome that drives billable metrics,
+        # credit drawdown, and invoicing. Track customer behavior, resource consumption,
+        # and feature usage
+        #
+        # ### What happens when you send events:
+        #
+        # - Events are validated and processed in real-time
+        # - Events are matched to customers using customer IDs or customer ingest aliases
+        # - Events are matched to billable metrics and are immediately available for usage
+        #   and spend calculations
+        #
+        # ### Usage guidelines:
+        #
+        # - Historical events can be backdated up to 34 days and will immediately impact
+        #   live customer spend
+        # - Duplicate events are automatically detected and ignored (34-day deduplication
+        #   window)
+        #
+        # #### Event structure:
+        #
+        # Usage events are simple JSON objects designed for flexibility and ease of
+        # integration:
+        #
+        # ```json
+        # {
+        #   "transaction_id": "2021-01-01T00:00:00Z_cluster42",
+        #   "customer_id": "team@example.com",
+        #   "event_type": "api_request",
+        #   "timestamp": "2021-01-01T00:00:00Z",
+        #   "properties": {
+        #     "endpoint": "/v1/users",
+        #     "method": "POST",
+        #     "response_time_ms": 45,
+        #     "region": "us-west-2"
+        #   }
+        # }
+        # ```
+        #
+        # 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
+        # exactly once. Metronome maintains a 34-day deduplication window - significantly
+        # longer than typical 12-hour windows - enabling robust backfill scenarios without
+        # duplicate billing.
+        #
+        # - Best Practices:
+        #   - Use UUIDs for one-time events: uuid4()
+        #   - For heartbeat events, use deterministic IDs
+        #   - Include enough context to avoid collisions across different event sources
+        #
+        # #### Customer ID
+        #
+        # Identifies which customer should be billed for this usage. Supports two
+        # identification methods:
+        #
+        # - Metronome Customer ID: The UUID returned when creating a customer
+        # - Ingest Alias: Your system's identifier (email, account number, etc.)
+        #
+        # Ingest aliases enable seamless integration without requiring ID mapping, and
+        # customers can have multiple aliases for flexibility.
+        #
+        # #### Event Type:
+        #
+        # Categorizes the event type for billable metric matching. Choose descriptive
+        # names that aligns with the product surface area.
+        #
+        # #### Properties:
+        #
+        # Flexible metadata also used to match billable metrics or to be used to serve as
+        # group keys to create multiple pricing dimensions or breakdown costs by novel
+        # properties for end customers or internal finance teams measuring underlying
+        # COGs.
+        #
         # @overload ingest(usage: nil, request_options: {})
         #
         # @param usage [Array<MetronomeSDK::Models::V1::UsageIngestParams::Usage>]
@@ -70,8 +183,40 @@ module MetronomeSDK
         # Some parameter documentations has been truncated, see
         # {MetronomeSDK::Models::V1::UsageListWithGroupsParams} for more details.
         #
-        # Fetch aggregated usage data for the specified customer, billable-metric, and
-        # optional group, broken into intervals of the specified length.
+        # Retrieve granular usage data for a specific customer and billable metric, with
+        # the ability to break down usage by custom grouping dimensions. This endpoint
+        # enables deep usage analytics by segmenting data across attributes like region,
+        # user, model type, or any custom dimension defined in your billable metrics.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Analyze usage patterns broken down by specific attributes (region, user,
+        #   department, etc.)
+        # - Build detailed usage dashboards with dimensional filtering
+        # - Identify high-usage segments for optimization opportunities
+        #
+        # ### Key response fields:
+        #
+        # An array of `PagedUsageAggregate` objects containing:
+        #
+        # - `starting_on` and `ending_before`: Time window boundaries
+        # - `group_key`: The dimension being grouped by (e.g., "region")
+        # - `group_value`: The specific value for this group (e.g., "US-East")
+        # - `value`: Aggregated usage for this group and time window
+        # - `next_page`: Pagination cursor for large datasets
+        #
+        # ### Usage guidelines:
+        #
+        # - Required parameters: Must specify `customer_id`, `billable_metric_id`, and
+        #   `window_size`
+        # - Time windows: Set `window_size` to hour, day, or none for different
+        #   granularities
+        # - Group filtering: Use `group_by` to specify:
+        #   - key: The dimension to group by (must be set on the billable metric as a
+        #     group key)
+        #   - values: Optional array to filter to specific values only
+        # - Pagination: Use limit and `next_page` for large result sets
+        # - Null handling: `group_value` may be null for unmatched data
         #
         # @overload list_with_groups(billable_metric_id:, customer_id:, window_size:, limit: nil, next_page: nil, current_period: nil, ending_before: nil, group_by: nil, starting_on: nil, request_options: {})
         #
@@ -112,10 +257,40 @@ module MetronomeSDK
           )
         end
 
-        # For a set of events, look up matched billable metrics and customers by
-        # transaction id. This endpoint looks at transactions that occurred in the last 34
-        # days, and is intended for sampling-based testing workflows. It is heavily rate
-        # limited.
+        # This endpoint retrieves events by transaction ID for events that occurred within
+        # the last 34 days. It is specifically designed for sampling-based testing
+        # workflows to detect revenue leakage. The Event Search API provides a critical
+        # observability tool that validates the integrity of your usage pipeline by
+        # allowing you to sample raw events and verify their matching against active
+        # billable metrics.
+        #
+        # Why event observability matters for revenue leakage: Silent revenue loss occurs
+        # when events are dropped, delayed, or fail to match billable metrics due to:
+        #
+        # - Upstream system failures
+        # - Event format changes
+        # - Misconfigured billable metrics
+        #
+        # ### Use this endpoint to:
+        #
+        # - Sample raw events and validate they match the expected billable metrics
+        # - Build custom leakage detection alerts to prevent silent revenue loss
+        # - Verify event processing accuracy during system changes or metric updates
+        # - Debug event matching issues in real-time
+        #
+        # ### Key response fields:
+        #
+        # - Complete event details including transaction ID, customer ID, and properties
+        # - Matched Metronome customer (if any)
+        # - Matched billable metric information (if any)
+        # - Processing status and duplicate detection flags
+        #
+        # ### Usage guidelines:
+        #
+        # ⚠️ Important: This endpoint is heavily rate limited and designed for sampling
+        # workflows only. Do not use this endpoint to check every event in your system.
+        # Instead, implement a sampling strategy to randomly validate a subset of events
+        # for observability purposes.
         #
         # @overload search(transaction_ids:, request_options: {})
         #

data/lib/metronome_sdk/resources/v1.rb

@@ -42,6 +42,9 @@ module MetronomeSDK
       # @return [MetronomeSDK::Resources::V1::Contracts]
       attr_reader :contracts
 
+      # @return [MetronomeSDK::Resources::V1::Payments]
+      attr_reader :payments
+
       # @api private
       #
       # @param client [MetronomeSDK::Client]
@@ -60,6 +63,7 @@ module MetronomeSDK
         @services = MetronomeSDK::Resources::V1::Services.new(client: client)
         @invoices = MetronomeSDK::Resources::V1::Invoices.new(client: client)
         @contracts = MetronomeSDK::Resources::V1::Contracts.new(client: client)
+        @payments = MetronomeSDK::Resources::V1::Payments.new(client: client)
       end
     end
   end

data/lib/metronome_sdk/resources/v2/contracts.rb

@@ -7,8 +7,23 @@ module MetronomeSDK
         # Some parameter documentations has been truncated, see
         # {MetronomeSDK::Models::V2::ContractRetrieveParams} for more details.
         #
-        # Get a specific contract. New clients should use this endpoint rather than the v1
-        # endpoint.
+        # Gets the details for a specific contract, including contract term, rate card
+        # information, credits and commits, and more.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Check the duration of a customer's current contract
+        # - Get details on contract terms, including access schedule amounts for
+        #   commitments and credits
+        # - Understand the state of a contract at a past time. As you can evolve the terms
+        #   of a contract over time through editing, use the `as_of_date` parameter to
+        #   view the full contract configuration as of that point in time.
+        #
+        # ### Usage guidelines:
+        #
+        # - Optionally, use the `include_balance` and `include_ledger` fields to include
+        #   balances and ledgers in the credit and commit responses. Using these fields
+        #   will cause the query to be slower.
         #
         # @overload retrieve(contract_id:, customer_id:, as_of_date: nil, include_balance: nil, include_ledgers: nil, request_options: {})
         #
@@ -41,8 +56,21 @@ module MetronomeSDK
         # Some parameter documentations has been truncated, see
         # {MetronomeSDK::Models::V2::ContractListParams} for more details.
         #
-        # List all contracts for a customer in chronological order. New clients should use
-        # this endpoint rather than the v1 endpoint.
+        # For a given customer, lists all of their contracts in chronological order.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Check if a customer is provisioned with any contract, and at which tier
+        # - Check the duration and terms of a customer's current contract
+        # - Power a page in your end customer experience that shows the customer's history
+        #   of tiers (e.g. this customer started out on the Pro Plan, then downgraded to
+        #   the Starter plan).
+        #
+        # ### Usage guidelines:
+        #
+        # Use the `starting_at`, `covering_date`, and `include_archived` parameters to
+        # filter the list of returned contracts. For example, to list only currently
+        # active contracts, pass `covering_date` equal to the current time.
         #
         # @overload list(customer_id:, covering_date: nil, include_archived: nil, include_balance: nil, include_ledgers: nil, starting_at: nil, request_options: {})
         #
@@ -77,14 +105,37 @@ module MetronomeSDK
         # Some parameter documentations has been truncated, see
         # {MetronomeSDK::Models::V2::ContractEditParams} for more details.
         #
-        # Edit a contract. Contract editing must be enabled to use this endpoint.
+        # The ability to edit a contract helps you react quickly to the needs of your
+        # customers and your business.
         #
-        # @overload edit(contract_id:, customer_id:, add_commits: nil, add_credits: nil, add_discounts: nil, add_overrides: nil, add_prepaid_balance_threshold_configuration: nil, add_professional_services: nil, add_recurring_commits: nil, add_recurring_credits: nil, add_reseller_royalties: nil, add_scheduled_charges: nil, add_spend_threshold_configuration: nil, add_subscriptions: nil, allow_contract_ending_before_finalized_invoice: nil, archive_commits: nil, archive_credits: nil, archive_scheduled_charges: nil, remove_overrides: nil, update_commits: nil, update_contract_end_date: nil, update_contract_name: nil, update_credits: nil, update_prepaid_balance_threshold_configuration: nil, update_recurring_commits: nil, update_recurring_credits: nil, update_scheduled_charges: nil, update_spend_threshold_configuration: nil, update_subscriptions: nil, request_options: {})
+        # ### Use this endpoint to:
+        #
+        # - Encode mid-term commitment and discount changes
+        # - Fix configuration mistakes and easily roll back packaging changes
+        #
+        # ### Key response fields:
+        #
+        # - The `id` of the edit
+        # - Complete edit details. For example, if you edited the contract to add new
+        #   overrides and credits, you will receive the IDs of those overrides and credits
+        #   in the response.
+        #
+        # ### Usage guidelines:
+        #
+        # - When you edit a contract, any draft invoices update immediately to reflect
+        #   that edit. Finalized invoices remain unchanged - you must void and regenerate
+        #   them in the UI or API to reflect the edit.
+        # - Contract editing must be enabled to use this endpoint. Reach out to your
+        #   Metronome representative to learn more.
+        #
+        # @overload edit(contract_id:, customer_id:, add_billing_provider_configuration_update: nil, add_commits: nil, add_credits: nil, add_discounts: nil, add_overrides: nil, add_prepaid_balance_threshold_configuration: nil, add_professional_services: nil, add_recurring_commits: nil, add_recurring_credits: nil, add_reseller_royalties: nil, add_scheduled_charges: nil, add_spend_threshold_configuration: nil, add_subscriptions: nil, allow_contract_ending_before_finalized_invoice: nil, archive_commits: nil, archive_credits: nil, archive_scheduled_charges: nil, remove_overrides: nil, uniqueness_key: nil, update_commits: nil, update_contract_end_date: nil, update_contract_name: nil, update_credits: nil, update_prepaid_balance_threshold_configuration: nil, update_recurring_commits: nil, update_recurring_credits: nil, update_scheduled_charges: nil, update_spend_threshold_configuration: nil, update_subscriptions: nil, request_options: {})
         #
         # @param contract_id [String] ID of the contract being edited
         #
         # @param customer_id [String] ID of the customer whose contract is being edited
         #
+        # @param add_billing_provider_configuration_update [MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate] Update the billing provider configuration on the contract. Currently only suppor
+        #
         # @param add_commits [Array<MetronomeSDK::Models::V2::ContractEditParams::AddCommit>]
         #
         # @param add_credits [Array<MetronomeSDK::Models::V2::ContractEditParams::AddCredit>]
@@ -93,7 +144,7 @@ module MetronomeSDK
         #
         # @param add_overrides [Array<MetronomeSDK::Models::V2::ContractEditParams::AddOverride>]
         #
-        # @param add_prepaid_balance_threshold_configuration [MetronomeSDK::Models::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration]
+        # @param add_prepaid_balance_threshold_configuration [MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2]
         #
         # @param add_professional_services [Array<MetronomeSDK::Models::V2::ContractEditParams::AddProfessionalService>] This field's availability is dependent on your client's configuration.
         #
@@ -105,7 +156,7 @@ module MetronomeSDK
         #
         # @param add_scheduled_charges [Array<MetronomeSDK::Models::V2::ContractEditParams::AddScheduledCharge>]
         #
-        # @param add_spend_threshold_configuration [MetronomeSDK::Models::V2::ContractEditParams::AddSpendThresholdConfiguration]
+        # @param add_spend_threshold_configuration [MetronomeSDK::Models::SpendThresholdConfigurationV2]
         #
         # @param add_subscriptions [Array<MetronomeSDK::Models::V2::ContractEditParams::AddSubscription>] Optional list of [subscriptions](https://docs.metronome.com/manage-product-acces
         #
@@ -119,6 +170,8 @@ module MetronomeSDK
         #
         # @param remove_overrides [Array<MetronomeSDK::Models::V2::ContractEditParams::RemoveOverride>] IDs of overrides to remove
         #
+        # @param uniqueness_key [String] Optional uniqueness key to prevent duplicate contract edits.
+        #
         # @param update_commits [Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateCommit>]
         #
         # @param update_contract_end_date [Time, nil] RFC 3339 timestamp indicating when the contract will end (exclusive).
@@ -158,10 +211,24 @@ module MetronomeSDK
         # Some parameter documentations has been truncated, see
         # {MetronomeSDK::Models::V2::ContractEditCommitParams} for more details.
         #
-        # Edit a customer or contract commit. Contract commits can only be edited using
-        # this endpoint if contract editing is enabled.
+        # Edit specific details for a contract-level or customer-level commit. Use this
+        # endpoint to modify individual commit access schedules, invoice schedules,
+        # applicable products, invoicing contracts, or other fields.
+        #
+        # ### Usage guidelines:
         #
-        # @overload edit_commit(commit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, invoice_contract_id: nil, invoice_schedule: nil, priority: nil, product_id: nil, specifiers: nil, request_options: {})
+        # - As with all edits in Metronome, draft invoices will reflect the edit
+        #   immediately, while finalized invoices are untouched unless voided and
+        #   regenerated.
+        # - If a commit's invoice schedule item is associated with a finalized invoice,
+        #   you cannot remove or update the invoice schedule item.
+        # - If a commit's invoice schedule item is associated with a voided invoice, you
+        #   cannot remove the invoice schedule item.
+        # - You cannot remove an commit access schedule segment that was applied to a
+        #   finalized invoice. You can void the invoice beforehand and then remove the
+        #   access schedule segment.
+        #
+        # @overload edit_commit(commit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, invoice_contract_id: nil, invoice_schedule: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
         #
         # @param commit_id [String] ID of the commit to edit
         #
@@ -173,6 +240,8 @@ module MetronomeSDK
         #
         # @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If applicable*product_ids, applicable_product*
         #
+        # @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for commit hierarchy access control
+        #
         # @param invoice_contract_id [String] ID of contract to use for invoicing
         #
         # @param invoice_schedule [MetronomeSDK::Models::V2::ContractEditCommitParams::InvoiceSchedule]
@@ -181,7 +250,9 @@ module MetronomeSDK
         #
         # @param product_id [String]
         #
-        # @param specifiers [Array<MetronomeSDK::Models::V2::ContractEditCommitParams::Specifier>, nil] List of filters that determine what kind of customer usage draws down a commit o
+        # @param rate_type [Symbol, MetronomeSDK::Models::V2::ContractEditCommitParams::RateType] If provided, updates the commit to use the specified rate type for current and f
+        #
+        # @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil] List of filters that determine what kind of customer usage draws down a commit o
         #
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -202,10 +273,24 @@ module MetronomeSDK
         # Some parameter documentations has been truncated, see
         # {MetronomeSDK::Models::V2::ContractEditCreditParams} for more details.
         #
-        # Edit a customer or contract credit. Contract credits can only be edited using
-        # this endpoint if contract editing is enabled.
+        # Edit details for a contract-level or customer-level credit.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Extend the duration or the amount of an existing free credit like a trial
+        # - Modify individual credit access schedules, applicable products, priority, or
+        #   other fields.
+        #
+        # ### Usage guidelines:
         #
-        # @overload edit_credit(credit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, priority: nil, product_id: nil, specifiers: nil, request_options: {})
+        # - As with all edits in Metronome, draft invoices will reflect the edit
+        #   immediately, while finalized invoices are untouched unless voided and
+        #   regenerated.
+        # - You cannot remove an access schedule segment that was applied to a finalized
+        #   invoice. You can void the invoice beforehand and then remove the access
+        #   schedule segment.
+        #
+        # @overload edit_credit(credit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
         #
         # @param credit_id [String] ID of the credit to edit
         #
@@ -217,11 +302,15 @@ module MetronomeSDK
         #
         # @param applicable_product_tags [Array<String>, nil] Which tags the credit applies to. If both applicable*product_ids and applicable*
         #
+        # @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for credit hierarchy access control
+        #
         # @param priority [Float, nil] If multiple commits are applicable, the one with the lower priority will apply f
         #
         # @param product_id [String]
         #
-        # @param specifiers [Array<MetronomeSDK::Models::V2::ContractEditCreditParams::Specifier>, nil] List of filters that determine what kind of customer usage draws down a commit o
+        # @param rate_type [Symbol, MetronomeSDK::Models::V2::ContractEditCreditParams::RateType] If provided, updates the credit to use the specified rate type for current and f
+        #
+        # @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil] List of filters that determine what kind of customer usage draws down a commit o
         #
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -239,8 +328,21 @@ module MetronomeSDK
           )
         end
 
-        # Get the edit history of a specific contract. Contract editing must be enabled to
-        # use this endpoint.
+        # List all the edits made to a contract over time. In Metronome, you can edit a
+        # contract at any point after it's created to fix mistakes or reflect changes in
+        # terms. Metronome stores a full history of all edits that were ever made to a
+        # contract, whether through the UI, `editContract` endpoint, or other endpoints
+        # like `updateContractEndDate`.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Understand what changes were made to a contract, when, and by who
+        #
+        # ### Key response fields:
+        #
+        # - An array of every edit ever made to the contract
+        # - Details on each individual edit - for example showing that in one edit, a user
+        #   added two discounts and incremented a subscription quantity.
         #
         # @overload get_edit_history(contract_id:, customer_id:, request_options: {})
         #

data/lib/metronome_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MetronomeSDK
-  VERSION = "0.3.0"
+  VERSION = "2.0.0"
 end

data/lib/metronome_sdk.rb

@@ -50,23 +50,44 @@ require_relative "metronome_sdk/errors"
 require_relative "metronome_sdk/internal/transport/base_client"
 require_relative "metronome_sdk/internal/transport/pooled_net_requester"
 require_relative "metronome_sdk/client"
+require_relative "metronome_sdk/internal/body_cursor_page"
 require_relative "metronome_sdk/internal/cursor_page"
+require_relative "metronome_sdk/internal/cursor_page_without_limit"
+require_relative "metronome_sdk/models/base_threshold_commit"
+require_relative "metronome_sdk/models/update_base_threshold_commit"
 require_relative "metronome_sdk/models/id"
 require_relative "metronome_sdk/models/v1/customers/invoice"
 require_relative "metronome_sdk/models/base_usage_filter"
 require_relative "metronome_sdk/models/commit"
+require_relative "metronome_sdk/models/commit_hierarchy_configuration"
+require_relative "metronome_sdk/models/commit_rate"
+require_relative "metronome_sdk/models/commit_specifier"
+require_relative "metronome_sdk/models/commit_specifier_input"
+require_relative "metronome_sdk/models/contract"
+require_relative "metronome_sdk/models/contract_v2"
 require_relative "metronome_sdk/models/contract_without_amendments"
 require_relative "metronome_sdk/models/credit"
 require_relative "metronome_sdk/models/credit_type_data"
 require_relative "metronome_sdk/models/discount"
 require_relative "metronome_sdk/models/event_type_filter"
+require_relative "metronome_sdk/models/hierarchy_configuration"
 require_relative "metronome_sdk/models/override"
+require_relative "metronome_sdk/models/override_tier"
+require_relative "metronome_sdk/models/overwrite_rate"
+require_relative "metronome_sdk/models/payment_gate_config"
+require_relative "metronome_sdk/models/payment_gate_config_v2"
+require_relative "metronome_sdk/models/prepaid_balance_threshold_configuration"
+require_relative "metronome_sdk/models/prepaid_balance_threshold_configuration_v2"
 require_relative "metronome_sdk/models/property_filter"
 require_relative "metronome_sdk/models/pro_service"
 require_relative "metronome_sdk/models/rate"
+require_relative "metronome_sdk/models/recurring_commit_subscription_config"
 require_relative "metronome_sdk/models/scheduled_charge"
 require_relative "metronome_sdk/models/schedule_duration"
 require_relative "metronome_sdk/models/schedule_point_in_time"
+require_relative "metronome_sdk/models/spend_threshold_configuration"
+require_relative "metronome_sdk/models/spend_threshold_configuration_v2"
+require_relative "metronome_sdk/models/subscription"
 require_relative "metronome_sdk/models/tier"
 require_relative "metronome_sdk/models/v1/alert_archive_params"
 require_relative "metronome_sdk/models/v1/alert_archive_response"
@@ -171,10 +192,11 @@ require_relative "metronome_sdk/models/v1/customer_list_costs_response"
 require_relative "metronome_sdk/models/v1/customer_list_params"
 require_relative "metronome_sdk/models/v1/customer_preview_events_params"
 require_relative "metronome_sdk/models/v1/customer_preview_events_response"
+require_relative "metronome_sdk/models/v1/customer_retrieve_billing_configurations_params"
+require_relative "metronome_sdk/models/v1/customer_retrieve_billing_configurations_response"
 require_relative "metronome_sdk/models/v1/customer_retrieve_params"
 require_relative "metronome_sdk/models/v1/customer_retrieve_response"
 require_relative "metronome_sdk/models/v1/customers/alert_list_params"
-require_relative "metronome_sdk/models/v1/customers/alert_list_response"
 require_relative "metronome_sdk/models/v1/customers/alert_reset_params"
 require_relative "metronome_sdk/models/v1/customers/alert_retrieve_params"
 require_relative "metronome_sdk/models/v1/customers/alert_retrieve_response"
@@ -185,13 +207,11 @@ require_relative "metronome_sdk/models/v1/customers/billing_config_retrieve_resp
 require_relative "metronome_sdk/models/v1/customers/commit_create_params"
 require_relative "metronome_sdk/models/v1/customers/commit_create_response"
 require_relative "metronome_sdk/models/v1/customers/commit_list_params"
-require_relative "metronome_sdk/models/v1/customers/commit_list_response"
 require_relative "metronome_sdk/models/v1/customers/commit_update_end_date_params"
 require_relative "metronome_sdk/models/v1/customers/commit_update_end_date_response"
 require_relative "metronome_sdk/models/v1/customers/credit_create_params"
 require_relative "metronome_sdk/models/v1/customers/credit_create_response"
 require_relative "metronome_sdk/models/v1/customers/credit_list_params"
-require_relative "metronome_sdk/models/v1/customers/credit_list_response"
 require_relative "metronome_sdk/models/v1/customers/credit_update_end_date_params"
 require_relative "metronome_sdk/models/v1/customers/credit_update_end_date_response"
 require_relative "metronome_sdk/models/v1/customers/customer_alert"
@@ -201,6 +221,7 @@ require_relative "metronome_sdk/models/v1/customers/invoice_list_breakdowns_para
 require_relative "metronome_sdk/models/v1/customers/invoice_list_breakdowns_response"
 require_relative "metronome_sdk/models/v1/customers/invoice_list_params"
 require_relative "metronome_sdk/models/v1/customers/invoice_retrieve_params"
+require_relative "metronome_sdk/models/v1/customers/invoice_retrieve_pdf_params"
 require_relative "metronome_sdk/models/v1/customers/invoice_retrieve_response"
 require_relative "metronome_sdk/models/v1/customers/named_schedule_retrieve_params"
 require_relative "metronome_sdk/models/v1/customers/named_schedule_retrieve_response"
@@ -213,6 +234,7 @@ require_relative "metronome_sdk/models/v1/customers/plan_list_params"
 require_relative "metronome_sdk/models/v1/customers/plan_list_price_adjustments_params"
 require_relative "metronome_sdk/models/v1/customers/plan_list_price_adjustments_response"
 require_relative "metronome_sdk/models/v1/customers/plan_list_response"
+require_relative "metronome_sdk/models/v1/customer_set_billing_configurations_params"
 require_relative "metronome_sdk/models/v1/customer_set_ingest_aliases_params"
 require_relative "metronome_sdk/models/v1/customer_set_name_params"
 require_relative "metronome_sdk/models/v1/customer_set_name_response"
@@ -229,6 +251,13 @@ require_relative "metronome_sdk/models/v1/invoice_regenerate_params"
 require_relative "metronome_sdk/models/v1/invoice_regenerate_response"
 require_relative "metronome_sdk/models/v1/invoice_void_params"
 require_relative "metronome_sdk/models/v1/invoice_void_response"
+require_relative "metronome_sdk/models/v1/payment"
+require_relative "metronome_sdk/models/v1/payment_attempt_params"
+require_relative "metronome_sdk/models/v1/payment_attempt_response"
+require_relative "metronome_sdk/models/v1/payment_cancel_params"
+require_relative "metronome_sdk/models/v1/payment_cancel_response"
+require_relative "metronome_sdk/models/v1/payment_list_params"
+require_relative "metronome_sdk/models/v1/payment_status"
 require_relative "metronome_sdk/models/v1/plan_detail"
 require_relative "metronome_sdk/models/v1/plan_get_details_params"
 require_relative "metronome_sdk/models/v1/plan_get_details_response"
@@ -287,6 +316,7 @@ require_relative "metronome_sdk/resources/v1/customers/plans"
 require_relative "metronome_sdk/resources/v1/custom_fields"
 require_relative "metronome_sdk/resources/v1/dashboards"
 require_relative "metronome_sdk/resources/v1/invoices"
+require_relative "metronome_sdk/resources/v1/payments"
 require_relative "metronome_sdk/resources/v1/plans"
 require_relative "metronome_sdk/resources/v1/pricing_units"
 require_relative "metronome_sdk/resources/v1/services"