metronome-sdk 2.1.0 → 3.0.0

data/rbi/metronome_sdk/models/v1/custom_field_remove_key_params.rbi

@@ -151,6 +151,26 @@ module MetronomeSDK
               :subscription,
               MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol
             )
+          PACKAGE_COMMIT =
+            T.let(
+              :package_commit,
+              MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol
+            )
+          PACKAGE_CREDIT =
+            T.let(
+              :package_credit,
+              MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol
+            )
+          PACKAGE_SUBSCRIPTION =
+            T.let(
+              :package_subscription,
+              MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol
+            )
+          PACKAGE_SCHEDULED_CHARGE =
+            T.let(
+              :package_scheduled_charge,
+              MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/metronome_sdk/models/v1/custom_field_set_values_params.rbi

@@ -163,6 +163,26 @@ module MetronomeSDK
               :subscription,
               MetronomeSDK::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol
             )
+          PACKAGE_COMMIT =
+            T.let(
+              :package_commit,
+              MetronomeSDK::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol
+            )
+          PACKAGE_CREDIT =
+            T.let(
+              :package_credit,
+              MetronomeSDK::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol
+            )
+          PACKAGE_SUBSCRIPTION =
+            T.let(
+              :package_subscription,
+              MetronomeSDK::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol
+            )
+          PACKAGE_SCHEDULED_CHARGE =
+            T.let(
+              :package_scheduled_charge,
+              MetronomeSDK::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/metronome_sdk/models/v1/customer_create_params.rbi

@@ -62,6 +62,27 @@ module MetronomeSDK
         end
         attr_writer :customer_billing_provider_configurations
 
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration
+              ]
+            )
+          )
+        end
+        attr_reader :customer_revenue_system_configurations
+
+        sig do
+          params(
+            customer_revenue_system_configurations:
+              T::Array[
+                MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::OrHash
+              ]
+          ).void
+        end
+        attr_writer :customer_revenue_system_configurations
+
         # (deprecated, use ingest_aliases instead) an alias that can be used to refer to
         # this customer in usage events
         sig { returns(T.nilable(String)) }
@@ -87,6 +108,10 @@ module MetronomeSDK
               T::Array[
                 MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::OrHash
               ],
+            customer_revenue_system_configurations:
+              T::Array[
+                MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::OrHash
+              ],
             external_id: String,
             ingest_aliases: T::Array[String],
             request_options: MetronomeSDK::RequestOptions::OrHash
@@ -99,6 +124,7 @@ module MetronomeSDK
           # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           custom_fields: nil,
           customer_billing_provider_configurations: nil,
+          customer_revenue_system_configurations: nil,
           # (deprecated, use ingest_aliases instead) an alias that can be used to refer to
           # this customer in usage events
           external_id: nil,
@@ -119,6 +145,10 @@ module MetronomeSDK
                 T::Array[
                   MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration
                 ],
+              customer_revenue_system_configurations:
+                T::Array[
+                  MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration
+                ],
               external_id: String,
               ingest_aliases: T::Array[String],
               request_options: MetronomeSDK::RequestOptions
@@ -147,6 +177,18 @@ module MetronomeSDK
           end
           attr_accessor :billing_provider_type
 
+          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
+
           # True if the aws_product_code is a SAAS subscription product, false otherwise.
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :aws_is_subscription_product
@@ -201,6 +243,8 @@ module MetronomeSDK
               billing_provider_customer_id: String,
               billing_provider_type:
                 MetronomeSDK::V1::CustomerCreateParams::BillingConfig::BillingProviderType::OrSymbol,
+              aws_customer_account_id: String,
+              aws_customer_id: String,
               aws_is_subscription_product: T::Boolean,
               aws_product_code: String,
               aws_region:
@@ -212,6 +256,8 @@ module MetronomeSDK
           def self.new(
             billing_provider_customer_id:,
             billing_provider_type:,
+            aws_customer_account_id: nil,
+            aws_customer_id: nil,
             # True if the aws_product_code is a SAAS subscription product, false otherwise.
             aws_is_subscription_product: nil,
             aws_product_code: nil,
@@ -228,6 +274,8 @@ module MetronomeSDK
                 billing_provider_customer_id: String,
                 billing_provider_type:
                   MetronomeSDK::V1::CustomerCreateParams::BillingConfig::BillingProviderType::OrSymbol,
+                aws_customer_account_id: String,
+                aws_customer_id: String,
                 aws_is_subscription_product: T::Boolean,
                 aws_product_code: String,
                 aws_region:
@@ -770,6 +818,162 @@ module MetronomeSDK
             end
           end
         end
+
+        class CustomerRevenueSystemConfiguration < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # The revenue system provider set for this configuration.
+          sig do
+            returns(
+              MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::Provider::OrSymbol
+            )
+          end
+          attr_accessor :provider
+
+          # Configuration for the revenue system provider. The structure of this object is
+          # specific to the revenue system provider. For NetSuite, this should contain
+          # `netsuite_customer_id`.
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_reader :configuration
+
+          sig { params(configuration: T::Hash[Symbol, T.anything]).void }
+          attr_writer :configuration
+
+          # The method to use for delivering invoices to this customer. If not provided, the
+          # `delivery_method_id` must be provided.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::DeliveryMethod::OrSymbol
+              )
+            )
+          end
+          attr_reader :delivery_method
+
+          sig do
+            params(
+              delivery_method:
+                MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::DeliveryMethod::OrSymbol
+            ).void
+          end
+          attr_writer :delivery_method
+
+          # ID of the delivery method to use for this customer. If not provided, the
+          # `delivery_method` must be provided.
+          sig { returns(T.nilable(String)) }
+          attr_reader :delivery_method_id
+
+          sig { params(delivery_method_id: String).void }
+          attr_writer :delivery_method_id
+
+          sig do
+            params(
+              provider:
+                MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::Provider::OrSymbol,
+              configuration: T::Hash[Symbol, T.anything],
+              delivery_method:
+                MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::DeliveryMethod::OrSymbol,
+              delivery_method_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The revenue system provider set for this configuration.
+            provider:,
+            # Configuration for the revenue system provider. The structure of this object is
+            # specific to the revenue system provider. For NetSuite, this should contain
+            # `netsuite_customer_id`.
+            configuration: nil,
+            # The method to use for delivering invoices to this customer. If not provided, the
+            # `delivery_method_id` must be provided.
+            delivery_method: nil,
+            # ID of the delivery method to use for this customer. If not provided, the
+            # `delivery_method` must be provided.
+            delivery_method_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                provider:
+                  MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::Provider::OrSymbol,
+                configuration: T::Hash[Symbol, T.anything],
+                delivery_method:
+                  MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::DeliveryMethod::OrSymbol,
+                delivery_method_id: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The revenue system provider set for this configuration.
+          module Provider
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::Provider
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            NETSUITE =
+              T.let(
+                :netsuite,
+                MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::Provider::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::Provider::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The method to use for delivering invoices to this customer. If not provided, the
+          # `delivery_method_id` must be provided.
+          module DeliveryMethod
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::DeliveryMethod
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            DIRECT_TO_BILLING_PROVIDER =
+              T.let(
+                :direct_to_billing_provider,
+                MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::DeliveryMethod::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration::DeliveryMethod::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
     end
   end

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