metronome-sdk 2.1.0 → 3.0.0

data/rbi/metronome_sdk/models/v1/customers/billing_config_create_params.rbi

@@ -31,6 +31,18 @@ module MetronomeSDK
           sig { returns(String) }
           attr_accessor :billing_provider_customer_id
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :aws_customer_account_id
+
+          sig { params(aws_customer_account_id: String).void }
+          attr_writer :aws_customer_account_id
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :aws_customer_id
+
+          sig { params(aws_customer_id: String).void }
+          attr_writer :aws_customer_id
+
           sig { returns(T.nilable(String)) }
           attr_reader :aws_product_code
 
@@ -79,6 +91,8 @@ module MetronomeSDK
               billing_provider_type:
                 MetronomeSDK::V1::Customers::BillingConfigCreateParams::BillingProviderType::OrSymbol,
               billing_provider_customer_id: String,
+              aws_customer_account_id: String,
+              aws_customer_id: String,
               aws_product_code: String,
               aws_region:
                 MetronomeSDK::V1::Customers::BillingConfigCreateParams::AwsRegion::OrSymbol,
@@ -93,6 +107,8 @@ module MetronomeSDK
             # The customer ID in the billing provider's system. For Azure, this is the
             # subscription ID.
             billing_provider_customer_id:,
+            aws_customer_account_id: nil,
+            aws_customer_id: nil,
             aws_product_code: nil,
             aws_region: nil,
             # The collection method for the customer's invoices. NOTE:
@@ -109,6 +125,8 @@ module MetronomeSDK
                 billing_provider_type:
                   MetronomeSDK::V1::Customers::BillingConfigCreateParams::BillingProviderType::OrSymbol,
                 billing_provider_customer_id: String,
+                aws_customer_account_id: String,
+                aws_customer_id: String,
                 aws_product_code: String,
                 aws_region:
                   MetronomeSDK::V1::Customers::BillingConfigCreateParams::AwsRegion::OrSymbol,

data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi

@@ -57,6 +57,18 @@ module MetronomeSDK
                 )
               end
 
+            sig { returns(T.nilable(String)) }
+            attr_reader :aws_customer_account_id
+
+            sig { params(aws_customer_account_id: String).void }
+            attr_writer :aws_customer_account_id
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :aws_customer_id
+
+            sig { params(aws_customer_id: String).void }
+            attr_writer :aws_customer_id
+
             # Contract expiration date for the customer. The expected format is RFC 3339 and
             # can be retrieved from
             # [AWS's GetEntitlements API](https://docs.aws.amazon.com/marketplaceentitlement/latest/APIReference/API_GetEntitlements.html).
@@ -164,6 +176,8 @@ module MetronomeSDK
 
             sig do
               params(
+                aws_customer_account_id: String,
+                aws_customer_id: String,
                 aws_expiration_date: Time,
                 aws_is_subscription_product: T::Boolean,
                 aws_product_code: String,
@@ -180,6 +194,8 @@ module MetronomeSDK
               ).returns(T.attached_class)
             end
             def self.new(
+              aws_customer_account_id: nil,
+              aws_customer_id: nil,
               # Contract expiration date for the customer. The expected format is RFC 3339 and
               # can be retrieved from
               # [AWS's GetEntitlements API](https://docs.aws.amazon.com/marketplaceentitlement/latest/APIReference/API_GetEntitlements.html).
@@ -208,6 +224,8 @@ module MetronomeSDK
             sig do
               override.returns(
                 {
+                  aws_customer_account_id: String,
+                  aws_customer_id: String,
                   aws_expiration_date: Time,
                   aws_is_subscription_product: T::Boolean,
                   aws_product_code: String,

data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi

@@ -209,6 +209,25 @@ module MetronomeSDK
             sig { params(invoice_types_filter: T::Array[String]).void }
             attr_writer :invoice_types_filter
 
+            # Only present for low_remaining_seat_balance_reached notifications. The seat
+            # group key or seat group key-value pair the alert is scoped to.
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::V1::Customers::CustomerAlert::Alert::SeatFilter
+                )
+              )
+            end
+            attr_reader :seat_filter
+
+            sig do
+              params(
+                seat_filter:
+                  MetronomeSDK::V1::Customers::CustomerAlert::Alert::SeatFilter::OrHash
+              ).void
+            end
+            attr_writer :seat_filter
+
             # Prevents the creation of duplicates. If a request to create a record is made
             # with a previously used uniqueness key, a new record will not be created and the
             # request will fail with a 409 error.
@@ -241,6 +260,8 @@ module MetronomeSDK
                     MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue::OrHash
                   ],
                 invoice_types_filter: T::Array[String],
+                seat_filter:
+                  MetronomeSDK::V1::Customers::CustomerAlert::Alert::SeatFilter::OrHash,
                 uniqueness_key: String
               ).returns(T.attached_class)
             end
@@ -275,6 +296,9 @@ module MetronomeSDK
               # Only supported for invoice_total_reached threshold notifications. A list of
               # invoice types to evaluate.
               invoice_types_filter: nil,
+              # Only present for low_remaining_seat_balance_reached notifications. The seat
+              # group key or seat group key-value pair the alert is scoped to.
+              seat_filter: nil,
               # Prevents the creation of duplicates. If a request to create a record is made
               # with a previously used uniqueness key, a new record will not be created and the
               # request will fail with a 409 error.
@@ -306,6 +330,8 @@ module MetronomeSDK
                       MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue
                     ],
                   invoice_types_filter: T::Array[String],
+                  seat_filter:
+                    MetronomeSDK::V1::Customers::CustomerAlert::Alert::SeatFilter,
                   uniqueness_key: String
                 }
               )
@@ -595,6 +621,51 @@ module MetronomeSDK
               def to_hash
               end
             end
+
+            class SeatFilter < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::V1::Customers::CustomerAlert::Alert::SeatFilter,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              # The seat group key (e.g., "seat_id", "user_id") that the alert is scoped to.
+              sig { returns(String) }
+              attr_accessor :seat_group_key
+
+              # The seat group value that the alert is scoped to.
+              sig { returns(T.nilable(String)) }
+              attr_reader :seat_group_value
+
+              sig { params(seat_group_value: String).void }
+              attr_writer :seat_group_value
+
+              # Only present for low_remaining_seat_balance_reached notifications. The seat
+              # group key or seat group key-value pair the alert is scoped to.
+              sig do
+                params(
+                  seat_group_key: String,
+                  seat_group_value: String
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # The seat group key (e.g., "seat_id", "user_id") that the alert is scoped to.
+                seat_group_key:,
+                # The seat group value that the alert is scoped to.
+                seat_group_value: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  { seat_group_key: String, seat_group_value: String }
+                )
+              end
+              def to_hash
+              end
+            end
           end
 
           # The status of the threshold notification. If the notification is archived, null

data/rbi/metronome_sdk/models/v1/customers/invoice.rbi

@@ -238,6 +238,17 @@ module MetronomeSDK
           end
           attr_writer :reseller_royalty
 
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  MetronomeSDK::V1::Customers::Invoice::RevenueSystemInvoice
+                ]
+              )
+            )
+          end
+          attr_accessor :revenue_system_invoices
+
           # This field's availability is dependent on your client's configuration.
           sig { returns(T.nilable(String)) }
           attr_reader :salesforce_opportunity_id
@@ -301,6 +312,12 @@ module MetronomeSDK
               plan_name: String,
               reseller_royalty:
                 MetronomeSDK::V1::Customers::Invoice::ResellerRoyalty::OrHash,
+              revenue_system_invoices:
+                T.nilable(
+                  T::Array[
+                    MetronomeSDK::V1::Customers::Invoice::RevenueSystemInvoice::OrHash
+                  ]
+                ),
               salesforce_opportunity_id: String,
               start_timestamp: Time,
               subtotal: Float
@@ -348,6 +365,7 @@ module MetronomeSDK
             plan_name: nil,
             # Only present for contract invoices with reseller royalties.
             reseller_royalty: nil,
+            revenue_system_invoices: nil,
             # This field's availability is dependent on your client's configuration.
             salesforce_opportunity_id: nil,
             # Beginning of the usage period this invoice covers (UTC)
@@ -398,6 +416,12 @@ module MetronomeSDK
                 plan_name: String,
                 reseller_royalty:
                   MetronomeSDK::V1::Customers::Invoice::ResellerRoyalty,
+                revenue_system_invoices:
+                  T.nilable(
+                    T::Array[
+                      MetronomeSDK::V1::Customers::Invoice::RevenueSystemInvoice
+                    ]
+                  ),
                 salesforce_opportunity_id: String,
                 start_timestamp: Time,
                 subtotal: Float
@@ -1648,6 +1672,13 @@ module MetronomeSDK
               sig { params(billing_provider_error: String).void }
               attr_writer :billing_provider_error
 
+              # The ID of the payment in the external system, if available.
+              sig { returns(T.nilable(String)) }
+              attr_reader :external_payment_id
+
+              sig { params(external_payment_id: String).void }
+              attr_writer :external_payment_id
+
               sig do
                 returns(
                   T.nilable(
@@ -1721,6 +1752,7 @@ module MetronomeSDK
                   billing_provider_type:
                     MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType::OrSymbol,
                   billing_provider_error: String,
+                  external_payment_id: String,
                   external_status:
                     MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus::OrSymbol,
                   invoice_id: String,
@@ -1736,6 +1768,8 @@ module MetronomeSDK
                 billing_provider_type:,
                 # Error message from the billing provider, if available.
                 billing_provider_error: nil,
+                # The ID of the payment in the external system, if available.
+                external_payment_id: nil,
                 external_status: nil,
                 invoice_id: nil,
                 # The subtotal amount invoiced, if available from the billing provider.
@@ -1756,6 +1790,7 @@ module MetronomeSDK
                     billing_provider_type:
                       MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType::TaggedSymbol,
                     billing_provider_error: String,
+                    external_payment_id: String,
                     external_status:
                       MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus::TaggedSymbol,
                     invoice_id: String,
@@ -1867,6 +1902,11 @@ module MetronomeSDK
                     :PAID,
                     MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus::TaggedSymbol
                   )
+                PARTIALLY_PAID =
+                  T.let(
+                    :PARTIALLY_PAID,
+                    MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus::TaggedSymbol
+                  )
                 UNCOLLECTIBLE =
                   T.let(
                     :UNCOLLECTIBLE,
@@ -2005,6 +2045,13 @@ module MetronomeSDK
             sig { params(billing_provider_error: String).void }
             attr_writer :billing_provider_error
 
+            # The ID of the payment in the external system, if available.
+            sig { returns(T.nilable(String)) }
+            attr_reader :external_payment_id
+
+            sig { params(external_payment_id: String).void }
+            attr_writer :external_payment_id
+
             sig do
               returns(
                 T.nilable(
@@ -2078,6 +2125,7 @@ module MetronomeSDK
                 billing_provider_type:
                   MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::BillingProviderType::OrSymbol,
                 billing_provider_error: String,
+                external_payment_id: String,
                 external_status:
                   MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::ExternalStatus::OrSymbol,
                 invoice_id: String,
@@ -2093,6 +2141,8 @@ module MetronomeSDK
               billing_provider_type:,
               # Error message from the billing provider, if available.
               billing_provider_error: nil,
+              # The ID of the payment in the external system, if available.
+              external_payment_id: nil,
               external_status: nil,
               invoice_id: nil,
               # The subtotal amount invoiced, if available from the billing provider.
@@ -2113,6 +2163,7 @@ module MetronomeSDK
                   billing_provider_type:
                     MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::BillingProviderType::TaggedSymbol,
                   billing_provider_error: String,
+                  external_payment_id: String,
                   external_status:
                     MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::ExternalStatus::TaggedSymbol,
                   invoice_id: String,
@@ -2224,6 +2275,11 @@ module MetronomeSDK
                   :PAID,
                   MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::ExternalStatus::TaggedSymbol
                 )
+              PARTIALLY_PAID =
+                T.let(
+                  :PARTIALLY_PAID,
+                  MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::ExternalStatus::TaggedSymbol
+                )
               UNCOLLECTIBLE =
                 T.let(
                   :UNCOLLECTIBLE,
@@ -2673,6 +2729,71 @@ module MetronomeSDK
               end
             end
           end
+
+          class RevenueSystemInvoice < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::Customers::Invoice::RevenueSystemInvoice,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :revenue_system_external_entity_type
+
+            sig { returns(String) }
+            attr_accessor :revenue_system_provider
+
+            sig { returns(String) }
+            attr_accessor :sync_status
+
+            # The error message from the revenue system, if available.
+            sig { returns(T.nilable(String)) }
+            attr_reader :error_message
+
+            sig { params(error_message: String).void }
+            attr_writer :error_message
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :revenue_system_external_entity_id
+
+            sig { params(revenue_system_external_entity_id: String).void }
+            attr_writer :revenue_system_external_entity_id
+
+            sig do
+              params(
+                revenue_system_external_entity_type: String,
+                revenue_system_provider: String,
+                sync_status: String,
+                error_message: String,
+                revenue_system_external_entity_id: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              revenue_system_external_entity_type:,
+              revenue_system_provider:,
+              sync_status:,
+              # The error message from the revenue system, if available.
+              error_message: nil,
+              revenue_system_external_entity_id: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  revenue_system_external_entity_type: String,
+                  revenue_system_provider: String,
+                  sync_status: String,
+                  error_message: String,
+                  revenue_system_external_entity_id: String
+                }
+              )
+            end
+            def to_hash
+            end
+          end
         end
       end
     end

data/rbi/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rbi

@@ -147,6 +147,12 @@ module MetronomeSDK
             end
             attr_accessor :adjustment_type
 
+            sig { returns(T.nilable(Float)) }
+            attr_reader :quantity
+
+            sig { params(quantity: Float).void }
+            attr_writer :quantity
+
             # Used in pricing tiers. Indicates at what metric value the price applies.
             sig { returns(T.nilable(Float)) }
             attr_reader :tier
@@ -164,6 +170,7 @@ module MetronomeSDK
               params(
                 adjustment_type:
                   MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse::Price::AdjustmentType::OrSymbol,
+                quantity: Float,
                 tier: Float,
                 value: Float
               ).returns(T.attached_class)
@@ -171,6 +178,7 @@ module MetronomeSDK
             def self.new(
               # Determines how the value will be applied.
               adjustment_type:,
+              quantity: nil,
               # Used in pricing tiers. Indicates at what metric value the price applies.
               tier: nil,
               value: nil
@@ -182,6 +190,7 @@ module MetronomeSDK
                 {
                   adjustment_type:
                     MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse::Price::AdjustmentType::TaggedSymbol,
+                  quantity: Float,
                   tier: Float,
                   value: Float
                 }

data/rbi/metronome_sdk/models/v1/payment.rbi

@@ -72,6 +72,21 @@ module MetronomeSDK
         end
         attr_writer :payment_gateway
 
+        sig do
+          returns(
+            T.nilable(T::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment])
+          )
+        end
+        attr_reader :revenue_system_payments
+
+        sig do
+          params(
+            revenue_system_payments:
+              T::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment::OrHash]
+          ).void
+        end
+        attr_writer :revenue_system_payments
+
         sig do
           returns(T.nilable(MetronomeSDK::V1::PaymentStatus::TaggedSymbol))
         end
@@ -98,6 +113,8 @@ module MetronomeSDK
             fiat_credit_type: MetronomeSDK::CreditTypeData::OrHash,
             invoice_id: String,
             payment_gateway: MetronomeSDK::V1::Payment::PaymentGateway::OrHash,
+            revenue_system_payments:
+              T::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment::OrHash],
             status: MetronomeSDK::V1::PaymentStatus::OrSymbol,
             updated_at: Time
           ).returns(T.attached_class)
@@ -113,6 +130,7 @@ module MetronomeSDK
           fiat_credit_type: nil,
           invoice_id: nil,
           payment_gateway: nil,
+          revenue_system_payments: nil,
           status: nil,
           updated_at: nil
         )
@@ -131,6 +149,8 @@ module MetronomeSDK
               fiat_credit_type: MetronomeSDK::CreditTypeData,
               invoice_id: String,
               payment_gateway: MetronomeSDK::V1::Payment::PaymentGateway,
+              revenue_system_payments:
+                T::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment],
               status: MetronomeSDK::V1::PaymentStatus::TaggedSymbol,
               updated_at: Time
             }
@@ -318,6 +338,65 @@ module MetronomeSDK
             end
           end
         end
+
+        class RevenueSystemPayment < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V1::Payment::RevenueSystemPayment,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :revenue_system_provider
+
+          sig { returns(String) }
+          attr_accessor :sync_status
+
+          # The error message from the revenue system, if available.
+          sig { returns(T.nilable(String)) }
+          attr_reader :error_message
+
+          sig { params(error_message: String).void }
+          attr_writer :error_message
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :revenue_system_external_payment_id
+
+          sig { params(revenue_system_external_payment_id: String).void }
+          attr_writer :revenue_system_external_payment_id
+
+          sig do
+            params(
+              revenue_system_provider: String,
+              sync_status: String,
+              error_message: String,
+              revenue_system_external_payment_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            revenue_system_provider:,
+            sync_status:,
+            # The error message from the revenue system, if available.
+            error_message: nil,
+            revenue_system_external_payment_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                revenue_system_provider: String,
+                sync_status: String,
+                error_message: String,
+                revenue_system_external_payment_id: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
       end
     end
   end

data/rbi/metronome_sdk/models/v1/setting_upsert_avalara_credentials_params.rbi

@@ -36,6 +36,14 @@ module MetronomeSDK
         sig { returns(T::Array[String]) }
         attr_accessor :delivery_method_ids
 
+        # Commit transactions if you want Metronome tax calculations used for reporting
+        # and tax filings.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :commit_transactions
+
+        sig { params(commit_transactions: T::Boolean).void }
+        attr_writer :commit_transactions
+
         sig do
           params(
             avalara_environment:
@@ -43,6 +51,7 @@ module MetronomeSDK
             avalara_password: String,
             avalara_username: String,
             delivery_method_ids: T::Array[String],
+            commit_transactions: T::Boolean,
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -56,6 +65,9 @@ module MetronomeSDK
           # The delivery method IDs of the billing provider configurations to update, can be
           # found in the response of the `/listConfiguredBillingProviders` endpoint.
           delivery_method_ids:,
+          # Commit transactions if you want Metronome tax calculations used for reporting
+          # and tax filings.
+          commit_transactions: nil,
           request_options: {}
         )
         end
@@ -68,6 +80,7 @@ module MetronomeSDK
               avalara_password: String,
               avalara_username: String,
               delivery_method_ids: T::Array[String],
+              commit_transactions: T::Boolean,
               request_options: MetronomeSDK::RequestOptions
             }
           )

data/rbi/metronome_sdk/models/v1/settings/billing_provider_create_params.rbi

@@ -99,6 +99,11 @@ module MetronomeSDK
                 :azure_marketplace,
                 MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::TaggedSymbol
               )
+            GCP_MARKETPLACE =
+              T.let(
+                :gcp_marketplace,
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::TaggedSymbol
+              )
 
             sig do
               override.returns(

data/rbi/metronome_sdk/models/v1/usage_search_response.rbi

@@ -180,7 +180,8 @@ module MetronomeSDK
           sig { params(aggregation_key: String).void }
           attr_writer :aggregation_key
 
-          # Specifies the type of aggregation performed on matching events.
+          # Specifies the type of aggregation performed on matching events. Includes
+          # "custom_sql" for events search endpoint responses.
           sig do
             returns(
               T.nilable(
@@ -296,7 +297,8 @@ module MetronomeSDK
             # key must be one of the property filter names and is not applicable when the
             # aggregation type is 'count'.
             aggregation_key: nil,
-            # Specifies the type of aggregation performed on matching events.
+            # Specifies the type of aggregation performed on matching events. Includes
+            # "custom_sql" for events search endpoint responses.
             aggregation_type: nil,
             # RFC 3339 timestamp indicating when the billable metric was archived. If not
             # provided, the billable metric is not archived.
@@ -345,7 +347,8 @@ module MetronomeSDK
           def to_hash
           end
 
-          # Specifies the type of aggregation performed on matching events.
+          # Specifies the type of aggregation performed on matching events. Includes
+          # "custom_sql" for events search endpoint responses.
           module AggregationType
             extend MetronomeSDK::Internal::Type::Enum
 
@@ -383,6 +386,11 @@ module MetronomeSDK
                 :UNIQUE,
                 MetronomeSDK::Models::V1::UsageSearchResponseItem::MatchedBillableMetric::AggregationType::TaggedSymbol
               )
+            CUSTOM_SQL =
+              T.let(
+                :custom_sql,
+                MetronomeSDK::Models::V1::UsageSearchResponseItem::MatchedBillableMetric::AggregationType::TaggedSymbol
+              )
 
             sig do
               override.returns(