metronome-sdk 0.1.0.pre.alpha.3 → 0.1.0

data/rbi/metronome_sdk/models.rbi

@@ -1,6 +1,38 @@
 # typed: strong
 
 module MetronomeSDK
+  BaseUsageFilter = MetronomeSDK::Models::BaseUsageFilter
+
+  Commit = MetronomeSDK::Models::Commit
+
+  ContractWithoutAmendments = MetronomeSDK::Models::ContractWithoutAmendments
+
+  Credit = MetronomeSDK::Models::Credit
+
+  CreditTypeData = MetronomeSDK::Models::CreditTypeData
+
+  Discount = MetronomeSDK::Models::Discount
+
+  EventTypeFilter = MetronomeSDK::Models::EventTypeFilter
+
+  ID = MetronomeSDK::Models::ID
+
+  Override = MetronomeSDK::Models::Override
+
+  PropertyFilter = MetronomeSDK::Models::PropertyFilter
+
+  ProService = MetronomeSDK::Models::ProService
+
+  Rate = MetronomeSDK::Models::Rate
+
+  ScheduledCharge = MetronomeSDK::Models::ScheduledCharge
+
+  ScheduleDuration = MetronomeSDK::Models::ScheduleDuration
+
+  SchedulePointInTime = MetronomeSDK::Models::SchedulePointInTime
+
+  Tier = MetronomeSDK::Models::Tier
+
   V1 = MetronomeSDK::Models::V1
 
   V2 = MetronomeSDK::Models::V2

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

@@ -43,6 +43,9 @@ module MetronomeSDK
           # applies to, by looking at the credit_grant_type field on the credit grant. This
           # field is only defined for CreditPercentage and CreditBalance alerts
           credit_grant_type_filters: nil,
+          # ID of the credit's currency, defaults to USD. If the specific alert type
+          # requires a pricing unit/currency, find the ID in the
+          # [Metronome app](https://app.metronome.com/offering/pricing-units).
           credit_type_id: nil,
           # A list of custom field filters for alert types that support advanced filtering.
           # Only present for contract invoices.

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

@@ -12,13 +12,9 @@ module MetronomeSDK
             aggregation_type:
               MetronomeSDK::V1::BillableMetricCreateParams::AggregationType::OrSymbol,
             custom_fields: T::Hash[Symbol, String],
-            event_type_filter:
-              MetronomeSDK::V1::BillableMetricCreateParams::EventTypeFilter::OrHash,
+            event_type_filter: MetronomeSDK::EventTypeFilter::OrHash,
             group_keys: T::Array[T::Array[String]],
-            property_filters:
-              T::Array[
-                MetronomeSDK::V1::BillableMetricCreateParams::PropertyFilter::OrHash
-              ],
+            property_filters: T::Array[MetronomeSDK::PropertyFilter::OrHash],
             sql: String,
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(MetronomeSDK::Models::V1::BillableMetricCreateResponse)

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

@@ -22,11 +22,11 @@ module MetronomeSDK
               pricing_group_key: T::Array[String],
               quantity_conversion:
                 T.nilable(
-                  MetronomeSDK::V1::Contracts::ProductCreateParams::QuantityConversion::OrHash
+                  MetronomeSDK::V1::Contracts::QuantityConversion::OrHash
                 ),
               quantity_rounding:
                 T.nilable(
-                  MetronomeSDK::V1::Contracts::ProductCreateParams::QuantityRounding::OrHash
+                  MetronomeSDK::V1::Contracts::QuantityRounding::OrHash
                 ),
               tags: T::Array[String],
               request_options: MetronomeSDK::RequestOptions::OrHash
@@ -110,11 +110,11 @@ module MetronomeSDK
               pricing_group_key: T::Array[String],
               quantity_conversion:
                 T.nilable(
-                  MetronomeSDK::V1::Contracts::ProductUpdateParams::QuantityConversion::OrHash
+                  MetronomeSDK::V1::Contracts::QuantityConversion::OrHash
                 ),
               quantity_rounding:
                 T.nilable(
-                  MetronomeSDK::V1::Contracts::ProductUpdateParams::QuantityRounding::OrHash
+                  MetronomeSDK::V1::Contracts::QuantityRounding::OrHash
                 ),
               tags: T::Array[String],
               request_options: MetronomeSDK::RequestOptions::OrHash

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

@@ -61,10 +61,7 @@ module MetronomeSDK
                 price: Float,
                 pricing_group_values: T::Hash[Symbol, String],
                 quantity: Float,
-                tiers:
-                  T::Array[
-                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::Tier::OrHash
-                  ],
+                tiers: T::Array[MetronomeSDK::Tier::OrHash],
                 use_list_prices: T::Boolean,
                 request_options: MetronomeSDK::RequestOptions::OrHash
               ).returns(

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

@@ -30,6 +30,8 @@ module MetronomeSDK
                 MetronomeSDK::V1::ContractCreateParams::Discount::OrHash
               ],
             ending_before: Time,
+            hierarchy_configuration:
+              MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::OrHash,
             multiplier_override_prioritization:
               MetronomeSDK::V1::ContractCreateParams::MultiplierOverridePrioritization::OrSymbol,
             name: String,
@@ -41,6 +43,7 @@ module MetronomeSDK
               ],
             prepaid_balance_threshold_configuration:
               MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::OrHash,
+            priority: Float,
             professional_services:
               T::Array[
                 MetronomeSDK::V1::ContractCreateParams::ProfessionalService::OrHash
@@ -76,8 +79,7 @@ module MetronomeSDK
             transition:
               MetronomeSDK::V1::ContractCreateParams::Transition::OrHash,
             uniqueness_key: String,
-            usage_filter:
-              MetronomeSDK::V1::ContractCreateParams::UsageFilter::OrHash,
+            usage_filter: MetronomeSDK::BaseUsageFilter::OrHash,
             usage_statement_schedule:
               MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule::OrHash,
             request_options: MetronomeSDK::RequestOptions::OrHash
@@ -87,7 +89,8 @@ module MetronomeSDK
           customer_id:,
           # inclusive contract start time
           starting_at:,
-          # The billing provider configuration associated with a contract.
+          # The billing provider configuration associated with a contract. Provide either an
+          # ID or the provider and delivery method.
           billing_provider_configuration: nil,
           commits: nil,
           credits: nil,
@@ -96,6 +99,7 @@ module MetronomeSDK
           discounts: nil,
           # exclusive contract end time
           ending_before: nil,
+          hierarchy_configuration: nil,
           # Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list
           # prices automatically. EXPLICIT prioritization requires specifying priorities for
           # each multiplier; the one with the lowest priority value will be prioritized
@@ -107,6 +111,8 @@ module MetronomeSDK
           netsuite_sales_order_id: nil,
           overrides: 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
@@ -127,7 +133,7 @@ module MetronomeSDK
           # on a separate invoice from usage charges.
           scheduled_charges_on_usage_invoices: nil,
           spend_threshold_configuration: nil,
-          # (beta) Optional list of
+          # Optional list of
           # [subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/)
           # to add to the contract.
           subscriptions: nil,
@@ -349,6 +355,7 @@ module MetronomeSDK
             include_balance: T::Boolean,
             include_contract_balances: T::Boolean,
             include_ledgers: T::Boolean,
+            limit: Integer,
             next_page: String,
             starting_at: Time,
             request_options: MetronomeSDK::RequestOptions::OrHash
@@ -371,6 +378,8 @@ module MetronomeSDK
           # Include ledgers in the response. Setting this flag may cause the query to be
           # slower.
           include_ledgers: nil,
+          # The maximum number of commits to return. Defaults to 25.
+          limit: nil,
           # The next page token from a previous response.
           next_page: nil,
           # Include only balances that have any access on or after the provided date

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

@@ -134,6 +134,8 @@ module MetronomeSDK
         sig do
           params(
             next_page: String,
+            sort:
+              MetronomeSDK::V1::CreditGrantListEntriesParams::Sort::OrSymbol,
             credit_type_ids: T::Array[String],
             customer_ids: T::Array[String],
             ending_before: Time,
@@ -144,6 +146,8 @@ module MetronomeSDK
         def list_entries(
           # Query param: Cursor that indicates where the next page of results should start.
           next_page: nil,
+          # Query param: Ledgers sort order by date, asc or desc. Defaults to asc.
+          sort: nil,
           # Body param: A list of Metronome credit type IDs to fetch ledger entries for. If
           # absent, ledger entries for all credit types will be returned.
           credit_type_ids: nil,

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

@@ -51,11 +51,13 @@ module MetronomeSDK
             # Which contract the commit applies to. If not provided, the commit applies to all
             # contracts.
             applicable_contract_ids: nil,
-            # Which products the commit applies to. If both applicable_product_ids and
-            # applicable_product_tags are not provided, the commit applies to all products.
+            # Which products the commit applies to. If applicable_product_ids,
+            # applicable_product_tags or specifiers are not provided, the commit applies to
+            # all products.
             applicable_product_ids: nil,
-            # Which tags the commit applies to. If both applicable_product_ids and
-            # applicable_product_tags are not provided, the commit applies to all products.
+            # Which tags the commit applies to. If applicable_product_ids,
+            # applicable_product_tags or specifiers are not provided, the commit applies to
+            # all products.
             applicable_product_tags: nil,
             custom_fields: nil,
             # Used only in UI/API. It is not exposed to end customers.
@@ -101,6 +103,7 @@ module MetronomeSDK
               include_balance: T::Boolean,
               include_contract_commits: T::Boolean,
               include_ledgers: T::Boolean,
+              limit: Integer,
               next_page: String,
               starting_at: Time,
               request_options: MetronomeSDK::RequestOptions::OrHash
@@ -123,6 +126,8 @@ module MetronomeSDK
             # Include commit ledgers in the response. Setting this flag may cause the query to
             # be slower.
             include_ledgers: nil,
+            # The maximum number of commits to return. Defaults to 25.
+            limit: nil,
             # The next page token from a previous response.
             next_page: nil,
             # Include only commits that have any access on or after the provided date

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

@@ -83,6 +83,7 @@ module MetronomeSDK
               include_balance: T::Boolean,
               include_contract_credits: T::Boolean,
               include_ledgers: T::Boolean,
+              limit: Integer,
               next_page: String,
               starting_at: Time,
               request_options: MetronomeSDK::RequestOptions::OrHash
@@ -105,6 +106,8 @@ module MetronomeSDK
             # Include credit ledgers in the response. Setting this flag may cause the query to
             # be slower.
             include_ledgers: nil,
+            # The maximum number of commits to return. Defaults to 25.
+            limit: nil,
             # The next page token from a previous response.
             next_page: nil,
             # Include only credits that have any access on or after the provided date

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

@@ -45,7 +45,7 @@ module MetronomeSDK
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(
               MetronomeSDK::Internal::CursorPage[
-                MetronomeSDK::Models::V1::Customers::InvoiceListResponse
+                MetronomeSDK::V1::Customers::Invoice
               ]
             )
           end

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

@@ -77,9 +77,7 @@ module MetronomeSDK
             salesforce_account_ids: T::Array[String],
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(
-            MetronomeSDK::Internal::CursorPage[
-              MetronomeSDK::Models::V1::CustomerListResponse
-            ]
+            MetronomeSDK::Internal::CursorPage[MetronomeSDK::V1::CustomerDetail]
           )
         end
         def list(
@@ -175,6 +173,39 @@ 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
+        # provided events. This is useful for testing how new events will affect the
+        # customer's invoice before they are actually processed.
+        sig do
+          params(
+            customer_id: String,
+            events:
+              T::Array[
+                MetronomeSDK::V1::CustomerPreviewEventsParams::Event::OrHash
+              ],
+            mode: MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::OrSymbol,
+            skip_zero_qty_line_items: T::Boolean,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::CustomerPreviewEventsResponse)
+        end
+        def preview_events(
+          # Path param:
+          customer_id:,
+          # Body param:
+          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".
+          mode: nil,
+          # Body param: If set, all zero quantity line items will be filtered out of the
+          # response.
+          skip_zero_qty_line_items: nil,
+          request_options: {}
+        )
+        end
+
         # Sets the ingest aliases for a customer. Ingest aliases can be used in the
         # `customer_id` field when sending usage events to Metronome. This call is
         # idempotent. It fully replaces the set of ingest aliases for the given customer.

data/rbi/metronome_sdk/resources/v1/usage.rbi

@@ -107,6 +107,23 @@ 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.
+        sig do
+          params(
+            transaction_ids: T::Array[String],
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(T::Array[MetronomeSDK::Models::V1::UsageSearchResponseItem])
+        end
+        def search(
+          # The transaction IDs of the events to retrieve
+          transaction_ids:,
+          request_options: {}
+        )
+        end
+
         # @api private
         sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
         def self.new(client:)

data/rbi/metronome_sdk/resources/v2/contracts.rbi

@@ -32,8 +32,8 @@ module MetronomeSDK
         )
         end
 
-        # List all contracts for a customer. New clients should use this endpoint rather
-        # than the v1 endpoint.
+        # List all contracts for a customer in chronological order. New clients should use
+        # this endpoint rather than the v1 endpoint.
         sig do
           params(
             customer_id: String,
@@ -132,6 +132,7 @@ module MetronomeSDK
                 MetronomeSDK::V2::ContractEditParams::UpdateCommit::OrHash
               ],
             update_contract_end_date: T.nilable(Time),
+            update_contract_name: T.nilable(String),
             update_credits:
               T::Array[
                 MetronomeSDK::V2::ContractEditParams::UpdateCredit::OrHash
@@ -176,7 +177,7 @@ module MetronomeSDK
           add_reseller_royalties: nil,
           add_scheduled_charges: nil,
           add_spend_threshold_configuration: nil,
-          # (beta) Optional list of
+          # Optional list of
           # [subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/)
           # to add to the contract.
           add_subscriptions: nil,
@@ -196,6 +197,9 @@ module MetronomeSDK
           update_commits: nil,
           # RFC 3339 timestamp indicating when the contract will end (exclusive).
           update_contract_end_date: nil,
+          # Value to update the contract name to. If not provided, the contract name will
+          # remain unchanged.
+          update_contract_name: nil,
           update_credits: nil,
           update_prepaid_balance_threshold_configuration: nil,
           # Edits to these recurring commits will only affect commits whose access schedules
@@ -208,7 +212,7 @@ module MetronomeSDK
           update_recurring_credits: nil,
           update_scheduled_charges: nil,
           update_spend_threshold_configuration: nil,
-          # (beta) Optional list of subscriptions to update.
+          # Optional list of subscriptions to update.
           update_subscriptions: nil,
           request_options: {}
         )
@@ -229,9 +233,11 @@ module MetronomeSDK
               MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule::OrHash,
             product_id: String,
             specifiers:
-              T::Array[
-                MetronomeSDK::V2::ContractEditCommitParams::Specifier::OrHash
-              ],
+              T.nilable(
+                T::Array[
+                  MetronomeSDK::V2::ContractEditCommitParams::Specifier::OrHash
+                ]
+              ),
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(MetronomeSDK::Models::V2::ContractEditCommitResponse)
         end
@@ -241,11 +247,13 @@ module MetronomeSDK
           # ID of the customer whose commit is being edited
           customer_id:,
           access_schedule: nil,
-          # Which products the commit applies to. If both applicable_product_ids and
-          # applicable_product_tags are not provided, the commit applies to all products.
+          # Which products the commit applies to. If applicable_product_ids,
+          # applicable_product_tags or specifiers are not provided, the commit applies to
+          # all products.
           applicable_product_ids: nil,
-          # Which tags the commit applies to. If both applicable_product_ids and
-          # applicable_product_tags are not provided, the commit applies to all products.
+          # Which tags the commit applies to. If applicable_product_ids,
+          # applicable_product_tags or specifiers are not provided, the commit applies to
+          # all products.
           applicable_product_tags: nil,
           # ID of contract to use for invoicing
           invoice_contract_id: nil,
@@ -272,9 +280,11 @@ module MetronomeSDK
             applicable_product_tags: T.nilable(T::Array[String]),
             product_id: String,
             specifiers:
-              T::Array[
-                MetronomeSDK::V2::ContractEditCreditParams::Specifier::OrHash
-              ],
+              T.nilable(
+                T::Array[
+                  MetronomeSDK::V2::ContractEditCreditParams::Specifier::OrHash
+                ]
+              ),
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(MetronomeSDK::Models::V2::ContractEditCreditResponse)
         end

data/sig/metronome_sdk/errors.rbs

@@ -5,6 +5,15 @@ module MetronomeSDK
     end
 
     class ConversionError < MetronomeSDK::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
     end
 
     class APIError < MetronomeSDK::Errors::Error

data/sig/metronome_sdk/internal/type/converter.rbs

@@ -8,8 +8,10 @@ module MetronomeSDK
 
         type coerce_state =
           {
-            strictness: bool | :strong,
+            translate_names: bool,
+            strictness: bool,
             exactness: { yes: Integer, no: Integer, maybe: Integer },
+            error: Class,
             branched: Integer
           }
 
@@ -37,6 +39,10 @@ module MetronomeSDK
           | MetronomeSDK::Internal::Type::Converter::input spec
         ) -> (^-> top)
 
+        def self.new_coerce_state: (
+          ?translate_names: bool
+        ) -> MetronomeSDK::Internal::Type::Converter::coerce_state
+
         def self.coerce: (
           MetronomeSDK::Internal::Type::Converter::input target,
           top value,

data/sig/metronome_sdk/models/base_usage_filter.rbs

@@ -0,0 +1,28 @@
+module MetronomeSDK
+  module Models
+    type base_usage_filter =
+      { group_key: String, group_values: ::Array[String], starting_at: Time }
+
+    class BaseUsageFilter < MetronomeSDK::Internal::Type::BaseModel
+      attr_accessor group_key: String
+
+      attr_accessor group_values: ::Array[String]
+
+      attr_reader starting_at: Time?
+
+      def starting_at=: (Time) -> Time
+
+      def initialize: (
+        group_key: String,
+        group_values: ::Array[String],
+        ?starting_at: Time
+      ) -> void
+
+      def to_hash: -> {
+        group_key: String,
+        group_values: ::Array[String],
+        starting_at: Time
+      }
+    end
+  end
+end