metronome-sdk 2.1.0 → 2.2.0

data/rbi/metronome_sdk/models/v1/customer_set_billing_configurations_response.rbi

@@ -0,0 +1,281 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CustomerSetBillingConfigurationsResponse < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T::Array[
+              MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data
+            ]
+          )
+        end
+        attr_accessor :data
+
+        sig do
+          params(
+            data:
+              T::Array[
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(data:)
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                T::Array[
+                  MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # ID of the created configuration
+          sig { returns(T.nilable(String)) }
+          attr_reader :id
+
+          sig { params(id: String).void }
+          attr_writer :id
+
+          # The billing provider set for this configuration.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :billing_provider
+
+          sig do
+            params(
+              billing_provider:
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider::OrSymbol
+            ).void
+          end
+          attr_writer :billing_provider
+
+          # Configuration for the billing provider. The structure of this object is specific
+          # to the billing provider and delivery method combination.
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_reader :configuration
+
+          sig { params(configuration: T::Hash[Symbol, T.anything]).void }
+          attr_writer :configuration
+
+          # ID of the customer this configuration is associated with.
+          sig { returns(T.nilable(String)) }
+          attr_reader :customer_id
+
+          sig { params(customer_id: String).void }
+          attr_writer :customer_id
+
+          # ID of the delivery method used for this customer configuration.
+          sig { returns(T.nilable(String)) }
+          attr_reader :delivery_method_id
+
+          sig { params(delivery_method_id: String).void }
+          attr_writer :delivery_method_id
+
+          # The tax provider set for this configuration.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::TaxProvider::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :tax_provider
+
+          sig do
+            params(
+              tax_provider:
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::TaxProvider::OrSymbol
+            ).void
+          end
+          attr_writer :tax_provider
+
+          sig do
+            params(
+              id: String,
+              billing_provider:
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider::OrSymbol,
+              configuration: T::Hash[Symbol, T.anything],
+              customer_id: String,
+              delivery_method_id: String,
+              tax_provider:
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::TaxProvider::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # ID of the created configuration
+            id: nil,
+            # The billing provider set for this configuration.
+            billing_provider: nil,
+            # Configuration for the billing provider. The structure of this object is specific
+            # to the billing provider and delivery method combination.
+            configuration: nil,
+            # ID of the customer this configuration is associated with.
+            customer_id: nil,
+            # ID of the delivery method used for this customer configuration.
+            delivery_method_id: nil,
+            # The tax provider set for this configuration.
+            tax_provider: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                billing_provider:
+                  MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol,
+                configuration: T::Hash[Symbol, T.anything],
+                customer_id: String,
+                delivery_method_id: String,
+                tax_provider:
+                  MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::TaxProvider::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The billing provider set for this configuration.
+          module BillingProvider
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            AWS_MARKETPLACE =
+              T.let(
+                :aws_marketplace,
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            STRIPE =
+              T.let(
+                :stripe,
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            NETSUITE =
+              T.let(
+                :netsuite,
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            CUSTOM =
+              T.let(
+                :custom,
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            AZURE_MARKETPLACE =
+              T.let(
+                :azure_marketplace,
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            QUICKBOOKS_ONLINE =
+              T.let(
+                :quickbooks_online,
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            WORKDAY =
+              T.let(
+                :workday,
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            GCP_MARKETPLACE =
+              T.let(
+                :gcp_marketplace,
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            METRONOME =
+              T.let(
+                :metronome,
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The tax provider set for this configuration.
+          module TaxProvider
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::TaxProvider
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ANROK =
+              T.let(
+                :anrok,
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::TaxProvider::TaggedSymbol
+              )
+            AVALARA =
+              T.let(
+                :avalara,
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::TaxProvider::TaggedSymbol
+              )
+            STRIPE =
+              T.let(
+                :stripe,
+                MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::TaxProvider::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse::Data::TaxProvider::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -66,6 +66,25 @@ module MetronomeSDK
           end
           attr_writer :plans_or_contracts
 
+          # Only allowed for `low_remaining_seat_balance_reached` notifications. This
+          # filters alerts by the seat group key-value pair.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::Customers::AlertRetrieveParams::SeatFilter
+              )
+            )
+          end
+          attr_reader :seat_filter
+
+          sig do
+            params(
+              seat_filter:
+                MetronomeSDK::V1::Customers::AlertRetrieveParams::SeatFilter::OrHash
+            ).void
+          end
+          attr_writer :seat_filter
+
           sig do
             params(
               alert_id: String,
@@ -76,6 +95,8 @@ module MetronomeSDK
                 ],
               plans_or_contracts:
                 MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts::OrSymbol,
+              seat_filter:
+                MetronomeSDK::V1::Customers::AlertRetrieveParams::SeatFilter::OrHash,
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
@@ -90,6 +111,9 @@ module MetronomeSDK
             # When parallel threshold notifications are enabled during migration, this flag
             # denotes whether to fetch notifications for plans or contracts.
             plans_or_contracts: nil,
+            # Only allowed for `low_remaining_seat_balance_reached` notifications. This
+            # filters alerts by the seat group key-value pair.
+            seat_filter: nil,
             request_options: {}
           )
           end
@@ -105,6 +129,8 @@ module MetronomeSDK
                   ],
                 plans_or_contracts:
                   MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts::OrSymbol,
+                seat_filter:
+                  MetronomeSDK::V1::Customers::AlertRetrieveParams::SeatFilter,
                 request_options: MetronomeSDK::RequestOptions
               }
             )
@@ -173,6 +199,47 @@ module MetronomeSDK
             def self.values
             end
           end
+
+          class SeatFilter < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::Customers::AlertRetrieveParams::SeatFilter,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # The seat group key (e.g., "seat_id", "user_id")
+            sig { returns(String) }
+            attr_accessor :seat_group_key
+
+            # The specific seat identifier to filter by
+            sig { returns(String) }
+            attr_accessor :seat_group_value
+
+            # Only allowed for `low_remaining_seat_balance_reached` notifications. This
+            # filters alerts by the seat group key-value pair.
+            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")
+              seat_group_key:,
+              # The specific seat identifier to filter by
+              seat_group_value:
+            )
+            end
+
+            sig do
+              override.returns(
+                { seat_group_key: String, seat_group_value: String }
+              )
+            end
+            def to_hash
+            end
+          end
         end
       end
     end

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

@@ -1648,6 +1648,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 +1728,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 +1744,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 +1766,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 +1878,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 +2021,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 +2101,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 +2117,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 +2139,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 +2251,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,