metronome-sdk 0.2.0 → 1.0.0

data/rbi/metronome_sdk/models/v1/customer_retrieve_billing_configurations_response.rbi

@@ -0,0 +1,265 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CustomerRetrieveBillingConfigurationsResponse < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T::Array[
+              MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data
+            ]
+          )
+        end
+        attr_accessor :data
+
+        sig do
+          params(
+            data:
+              T::Array[
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(data:)
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                T::Array[
+                  MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # ID of this configuration; can be provided as the
+          # billing_provider_configuration_id when creating a contract.
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :archived_at
+
+          # The billing provider set for this configuration.
+          sig do
+            returns(
+              MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+            )
+          end
+          attr_accessor :billing_provider
+
+          # Configuration for the billing provider. The structure of this object is specific
+          # to the billing provider.
+          sig { returns(T::Hash[Symbol, T.anything]) }
+          attr_accessor :configuration
+
+          sig { returns(String) }
+          attr_accessor :customer_id
+
+          # The method to use for delivering invoices to this customer.
+          sig do
+            returns(
+              MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::DeliveryMethod::TaggedSymbol
+            )
+          end
+          attr_accessor :delivery_method
+
+          # Configuration for the delivery method. The structure of this object is specific
+          # to the delivery method.
+          sig { returns(T::Hash[Symbol, T.anything]) }
+          attr_accessor :delivery_method_configuration
+
+          # ID of the delivery method to use for this customer.
+          sig { returns(String) }
+          attr_accessor :delivery_method_id
+
+          sig do
+            params(
+              id: String,
+              archived_at: T.nilable(Time),
+              billing_provider:
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider::OrSymbol,
+              configuration: T::Hash[Symbol, T.anything],
+              customer_id: String,
+              delivery_method:
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::DeliveryMethod::OrSymbol,
+              delivery_method_configuration: T::Hash[Symbol, T.anything],
+              delivery_method_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # ID of this configuration; can be provided as the
+            # billing_provider_configuration_id when creating a contract.
+            id:,
+            archived_at:,
+            # The billing provider set for this configuration.
+            billing_provider:,
+            # Configuration for the billing provider. The structure of this object is specific
+            # to the billing provider.
+            configuration:,
+            customer_id:,
+            # The method to use for delivering invoices to this customer.
+            delivery_method:,
+            # Configuration for the delivery method. The structure of this object is specific
+            # to the delivery method.
+            delivery_method_configuration:,
+            # ID of the delivery method to use for this customer.
+            delivery_method_id:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                archived_at: T.nilable(Time),
+                billing_provider:
+                  MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol,
+                configuration: T::Hash[Symbol, T.anything],
+                customer_id: String,
+                delivery_method:
+                  MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::DeliveryMethod::TaggedSymbol,
+                delivery_method_configuration: T::Hash[Symbol, T.anything],
+                delivery_method_id: String
+              }
+            )
+          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::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            AWS_MARKETPLACE =
+              T.let(
+                :aws_marketplace,
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            STRIPE =
+              T.let(
+                :stripe,
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            NETSUITE =
+              T.let(
+                :netsuite,
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            CUSTOM =
+              T.let(
+                :custom,
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            AZURE_MARKETPLACE =
+              T.let(
+                :azure_marketplace,
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            QUICKBOOKS_ONLINE =
+              T.let(
+                :quickbooks_online,
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            WORKDAY =
+              T.let(
+                :workday,
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+            GCP_MARKETPLACE =
+              T.let(
+                :gcp_marketplace,
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The method to use for delivering invoices to this customer.
+          module DeliveryMethod
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::DeliveryMethod
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            DIRECT_TO_BILLING_PROVIDER =
+              T.let(
+                :direct_to_billing_provider,
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::DeliveryMethod::TaggedSymbol
+              )
+            AWS_SQS =
+              T.let(
+                :aws_sqs,
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::DeliveryMethod::TaggedSymbol
+              )
+            TACKLE =
+              T.let(
+                :tackle,
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::DeliveryMethod::TaggedSymbol
+              )
+            AWS_SNS =
+              T.let(
+                :aws_sns,
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::DeliveryMethod::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::DeliveryMethod::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customer_set_billing_configurations_params.rbi

@@ -0,0 +1,348 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CustomerSetBillingConfigurationsParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::V1::CustomerSetBillingConfigurationsParams,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T::Array[
+              MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data
+            ]
+          )
+        end
+        attr_accessor :data
+
+        sig do
+          params(
+            data:
+              T::Array[
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::OrHash
+              ],
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(data:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                T::Array[
+                  MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data
+                ],
+              request_options: MetronomeSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # The billing provider set for this configuration.
+          sig do
+            returns(
+              MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider::OrSymbol
+            )
+          end
+          attr_accessor :billing_provider
+
+          sig { returns(String) }
+          attr_accessor :customer_id
+
+          # Configuration for the billing provider. The structure of this object is specific
+          # to the billing provider and delivery method combination. Defaults to an empty
+          # object, however, for most billing provider + delivery method combinations, it
+          # will not be a valid configuration. For AWS marketplace configurations, the
+          # aws_is_subscription_product flag can be used to indicate a product with
+          # usage-based pricing. More information can be found
+          # [here](https://docs.metronome.com/invoice-customers/solutions/marketplaces/invoice-aws/#provision-aws-marketplace-customers-in-metronome).
+          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::CustomerSetBillingConfigurationsParams::Data::DeliveryMethod::OrSymbol
+              )
+            )
+          end
+          attr_reader :delivery_method
+
+          sig do
+            params(
+              delivery_method:
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::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
+
+          # Specifies which tax provider Metronome should use for tax calculation when
+          # billing through Stripe. This is only supported for Stripe billing provider
+          # configurations with auto_charge_payment_intent or manual_charge_payment_intent
+          # collection methods.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::TaxProvider::OrSymbol
+              )
+            )
+          end
+          attr_reader :tax_provider
+
+          sig do
+            params(
+              tax_provider:
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::TaxProvider::OrSymbol
+            ).void
+          end
+          attr_writer :tax_provider
+
+          sig do
+            params(
+              billing_provider:
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider::OrSymbol,
+              customer_id: String,
+              configuration: T::Hash[Symbol, T.anything],
+              delivery_method:
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::DeliveryMethod::OrSymbol,
+              delivery_method_id: String,
+              tax_provider:
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::TaxProvider::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The billing provider set for this configuration.
+            billing_provider:,
+            customer_id:,
+            # Configuration for the billing provider. The structure of this object is specific
+            # to the billing provider and delivery method combination. Defaults to an empty
+            # object, however, for most billing provider + delivery method combinations, it
+            # will not be a valid configuration. For AWS marketplace configurations, the
+            # aws_is_subscription_product flag can be used to indicate a product with
+            # usage-based pricing. More information can be found
+            # [here](https://docs.metronome.com/invoice-customers/solutions/marketplaces/invoice-aws/#provision-aws-marketplace-customers-in-metronome).
+            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,
+            # Specifies which tax provider Metronome should use for tax calculation when
+            # billing through Stripe. This is only supported for Stripe billing provider
+            # configurations with auto_charge_payment_intent or manual_charge_payment_intent
+            # collection methods.
+            tax_provider: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                billing_provider:
+                  MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider::OrSymbol,
+                customer_id: String,
+                configuration: T::Hash[Symbol, T.anything],
+                delivery_method:
+                  MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::DeliveryMethod::OrSymbol,
+                delivery_method_id: String,
+                tax_provider:
+                  MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::TaxProvider::OrSymbol
+              }
+            )
+          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::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            AWS_MARKETPLACE =
+              T.let(
+                :aws_marketplace,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider::TaggedSymbol
+              )
+            STRIPE =
+              T.let(
+                :stripe,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider::TaggedSymbol
+              )
+            NETSUITE =
+              T.let(
+                :netsuite,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider::TaggedSymbol
+              )
+            CUSTOM =
+              T.let(
+                :custom,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider::TaggedSymbol
+              )
+            AZURE_MARKETPLACE =
+              T.let(
+                :azure_marketplace,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider::TaggedSymbol
+              )
+            QUICKBOOKS_ONLINE =
+              T.let(
+                :quickbooks_online,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider::TaggedSymbol
+              )
+            WORKDAY =
+              T.let(
+                :workday,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider::TaggedSymbol
+              )
+            GCP_MARKETPLACE =
+              T.let(
+                :gcp_marketplace,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider::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::CustomerSetBillingConfigurationsParams::Data::DeliveryMethod
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            DIRECT_TO_BILLING_PROVIDER =
+              T.let(
+                :direct_to_billing_provider,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::DeliveryMethod::TaggedSymbol
+              )
+            AWS_SQS =
+              T.let(
+                :aws_sqs,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::DeliveryMethod::TaggedSymbol
+              )
+            TACKLE =
+              T.let(
+                :tackle,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::DeliveryMethod::TaggedSymbol
+              )
+            AWS_SNS =
+              T.let(
+                :aws_sns,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::DeliveryMethod::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::DeliveryMethod::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # Specifies which tax provider Metronome should use for tax calculation when
+          # billing through Stripe. This is only supported for Stripe billing provider
+          # configurations with auto_charge_payment_intent or manual_charge_payment_intent
+          # collection methods.
+          module TaxProvider
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::TaxProvider
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ANROK =
+              T.let(
+                :anrok,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::TaxProvider::TaggedSymbol
+              )
+            AVALARA =
+              T.let(
+                :avalara,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::TaxProvider::TaggedSymbol
+              )
+            STRIPE =
+              T.let(
+                :stripe,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::TaxProvider::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::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

@@ -24,6 +24,29 @@ module MetronomeSDK
           sig { returns(String) }
           attr_accessor :customer_id
 
+          # Only present for `spend_threshold_reached` alerts. Retrieve the alert for a
+          # specific group key-value pair.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  MetronomeSDK::V1::Customers::AlertRetrieveParams::GroupValue
+                ]
+              )
+            )
+          end
+          attr_reader :group_values
+
+          sig do
+            params(
+              group_values:
+                T::Array[
+                  MetronomeSDK::V1::Customers::AlertRetrieveParams::GroupValue::OrHash
+                ]
+            ).void
+          end
+          attr_writer :group_values
+
           # When parallel alerts are enabled during migration, this flag denotes whether to
           # fetch alerts for plans or contracts.
           sig do
@@ -47,6 +70,10 @@ module MetronomeSDK
             params(
               alert_id: String,
               customer_id: String,
+              group_values:
+                T::Array[
+                  MetronomeSDK::V1::Customers::AlertRetrieveParams::GroupValue::OrHash
+                ],
               plans_or_contracts:
                 MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts::OrSymbol,
               request_options: MetronomeSDK::RequestOptions::OrHash
@@ -57,6 +84,9 @@ module MetronomeSDK
             alert_id:,
             # The Metronome ID of the customer
             customer_id:,
+            # Only present for `spend_threshold_reached` alerts. Retrieve the alert for a
+            # specific group key-value pair.
+            group_values: nil,
             # When parallel alerts are enabled during migration, this flag denotes whether to
             # fetch alerts for plans or contracts.
             plans_or_contracts: nil,
@@ -69,6 +99,10 @@ module MetronomeSDK
               {
                 alert_id: String,
                 customer_id: String,
+                group_values:
+                  T::Array[
+                    MetronomeSDK::V1::Customers::AlertRetrieveParams::GroupValue
+                  ],
                 plans_or_contracts:
                   MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts::OrSymbol,
                 request_options: MetronomeSDK::RequestOptions
@@ -78,6 +112,32 @@ module MetronomeSDK
           def to_hash
           end
 
+          class GroupValue < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::Customers::AlertRetrieveParams::GroupValue,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :key
+
+            sig { returns(String) }
+            attr_accessor :value
+
+            # Scopes alert evaluation to a specific presentation group key on individual line
+            # items. Only present for spend alerts.
+            sig { params(key: String, value: String).returns(T.attached_class) }
+            def self.new(key:, value:)
+            end
+
+            sig { override.returns({ key: String, value: String }) }
+            def to_hash
+            end
+          end
+
           # When parallel alerts are enabled during migration, this flag denotes whether to
           # fetch alerts for plans or contracts.
           module PlansOrContracts