metronome-sdk 2.0.0 → 2.2.0

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

@@ -52,6 +52,29 @@ module MetronomeSDK
           sig { params(billable_status: T.anything).void }
           attr_writer :billable_status
 
+          # Account hierarchy M3 - Required on invoices with type USAGE_CONSOLIDATED. List
+          # of constituent invoices that were consolidated to create this invoice.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice
+                ]
+              )
+            )
+          end
+          attr_reader :constituent_invoices
+
+          sig do
+            params(
+              constituent_invoices:
+                T::Array[
+                  MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice::OrHash
+                ]
+            ).void
+          end
+          attr_writer :constituent_invoices
+
           # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :contract_custom_fields
@@ -166,6 +189,20 @@ module MetronomeSDK
           sig { params(netsuite_sales_order_id: String).void }
           attr_writer :netsuite_sales_order_id
 
+          # Account hierarchy M3 - Required for account hierarchy usage invoices. An object
+          # containing the contract and customer UUIDs that pay for this invoice.
+          sig do
+            returns(T.nilable(MetronomeSDK::V1::Customers::Invoice::Payer))
+          end
+          attr_reader :payer
+
+          sig do
+            params(
+              payer: MetronomeSDK::V1::Customers::Invoice::Payer::OrHash
+            ).void
+          end
+          attr_writer :payer
+
           # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :plan_custom_fields
@@ -235,6 +272,10 @@ module MetronomeSDK
               type: String,
               amendment_id: String,
               billable_status: T.anything,
+              constituent_invoices:
+                T::Array[
+                  MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice::OrHash
+                ],
               contract_custom_fields: T::Hash[Symbol, String],
               contract_id: String,
               correction_record:
@@ -254,6 +295,7 @@ module MetronomeSDK
               issued_at: Time,
               net_payment_terms_days: Float,
               netsuite_sales_order_id: String,
+              payer: MetronomeSDK::V1::Customers::Invoice::Payer::OrHash,
               plan_custom_fields: T::Hash[Symbol, String],
               plan_id: String,
               plan_name: String,
@@ -275,6 +317,9 @@ module MetronomeSDK
             amendment_id: nil,
             # This field's availability is dependent on your client's configuration.
             billable_status: nil,
+            # Account hierarchy M3 - Required on invoices with type USAGE_CONSOLIDATED. List
+            # of constituent invoices that were consolidated to create this invoice.
+            constituent_invoices: nil,
             # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             contract_custom_fields: nil,
             contract_id: nil,
@@ -294,6 +339,9 @@ module MetronomeSDK
             net_payment_terms_days: nil,
             # This field's availability is dependent on your client's configuration.
             netsuite_sales_order_id: nil,
+            # Account hierarchy M3 - Required for account hierarchy usage invoices. An object
+            # containing the contract and customer UUIDs that pay for this invoice.
+            payer: nil,
             # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             plan_custom_fields: nil,
             plan_id: nil,
@@ -321,6 +369,10 @@ module MetronomeSDK
                 type: String,
                 amendment_id: String,
                 billable_status: T.anything,
+                constituent_invoices:
+                  T::Array[
+                    MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice
+                  ],
                 contract_custom_fields: T::Hash[Symbol, String],
                 contract_id: String,
                 correction_record:
@@ -340,6 +392,7 @@ module MetronomeSDK
                 issued_at: Time,
                 net_payment_terms_days: Float,
                 netsuite_sales_order_id: String,
+                payer: MetronomeSDK::V1::Customers::Invoice::Payer,
                 plan_custom_fields: T::Hash[Symbol, String],
                 plan_id: String,
                 plan_name: String,
@@ -545,6 +598,26 @@ module MetronomeSDK
             sig { params(netsuite_item_id: String).void }
             attr_writer :netsuite_item_id
 
+            # Account hierarchy M3 - Present on line items from invoices with type
+            # USAGE_CONSOLIDATED. Indicates the original customer, contract, invoice and line
+            # item from which this line item was copied.
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::V1::Customers::Invoice::LineItem::Origin
+                )
+              )
+            end
+            attr_reader :origin
+
+            sig do
+              params(
+                origin:
+                  MetronomeSDK::V1::Customers::Invoice::LineItem::Origin::OrHash
+              ).void
+            end
+            attr_writer :origin
+
             # Only present for line items paying for a postpaid commit true-up.
             sig do
               returns(
@@ -760,6 +833,8 @@ module MetronomeSDK
                 netsuite_invoice_billing_end: Time,
                 netsuite_invoice_billing_start: Time,
                 netsuite_item_id: String,
+                origin:
+                  MetronomeSDK::V1::Customers::Invoice::LineItem::Origin::OrHash,
                 postpaid_commit:
                   MetronomeSDK::V1::Customers::Invoice::LineItem::PostpaidCommit::OrHash,
                 presentation_group_values: T::Hash[Symbol, T.nilable(String)],
@@ -853,6 +928,10 @@ module MetronomeSDK
               # The start date for the billing period on the invoice.
               netsuite_invoice_billing_start: nil,
               netsuite_item_id: nil,
+              # Account hierarchy M3 - Present on line items from invoices with type
+              # USAGE_CONSOLIDATED. Indicates the original customer, contract, invoice and line
+              # item from which this line item was copied.
+              origin: nil,
               # Only present for line items paying for a postpaid commit true-up.
               postpaid_commit: nil,
               # Includes the presentation group values associated with this line item if
@@ -922,6 +1001,8 @@ module MetronomeSDK
                   netsuite_invoice_billing_end: Time,
                   netsuite_invoice_billing_start: Time,
                   netsuite_item_id: String,
+                  origin:
+                    MetronomeSDK::V1::Customers::Invoice::LineItem::Origin,
                   postpaid_commit:
                     MetronomeSDK::V1::Customers::Invoice::LineItem::PostpaidCommit,
                   presentation_group_values: T::Hash[Symbol, T.nilable(String)],
@@ -1035,6 +1116,60 @@ module MetronomeSDK
               end
             end
 
+            class Origin < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::V1::Customers::Invoice::LineItem::Origin,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(String) }
+              attr_accessor :contract_id
+
+              sig { returns(String) }
+              attr_accessor :customer_id
+
+              sig { returns(String) }
+              attr_accessor :invoice_id
+
+              sig { returns(String) }
+              attr_accessor :line_item_id
+
+              # Account hierarchy M3 - Present on line items from invoices with type
+              # USAGE_CONSOLIDATED. Indicates the original customer, contract, invoice and line
+              # item from which this line item was copied.
+              sig do
+                params(
+                  contract_id: String,
+                  customer_id: String,
+                  invoice_id: String,
+                  line_item_id: String
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                contract_id:,
+                customer_id:,
+                invoice_id:,
+                line_item_id:
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    contract_id: String,
+                    customer_id: String,
+                    invoice_id: String,
+                    line_item_id: String
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+
             class PostpaidCommit < MetronomeSDK::Internal::Type::BaseModel
               OrHash =
                 T.type_alias do
@@ -1387,6 +1522,43 @@ module MetronomeSDK
             end
           end
 
+          class ConstituentInvoice < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :contract_id
+
+            sig { returns(String) }
+            attr_accessor :customer_id
+
+            sig { returns(String) }
+            attr_accessor :invoice_id
+
+            sig do
+              params(
+                contract_id: String,
+                customer_id: String,
+                invoice_id: String
+              ).returns(T.attached_class)
+            end
+            def self.new(contract_id:, customer_id:, invoice_id:)
+            end
+
+            sig do
+              override.returns(
+                { contract_id: String, customer_id: String, invoice_id: String }
+              )
+            end
+            def to_hash
+            end
+          end
+
           class CorrectionRecord < MetronomeSDK::Internal::Type::BaseModel
             OrHash =
               T.type_alias do
@@ -1469,6 +1641,20 @@ module MetronomeSDK
               end
               attr_accessor :billing_provider_type
 
+              # Error message from the billing provider, if available.
+              sig { returns(T.nilable(String)) }
+              attr_reader :billing_provider_error
+
+              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(
@@ -1541,6 +1727,8 @@ module MetronomeSDK
                 params(
                   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,
@@ -1554,6 +1742,10 @@ module MetronomeSDK
               end
               def self.new(
                 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.
@@ -1573,6 +1765,8 @@ 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,
@@ -1640,6 +1834,11 @@ module MetronomeSDK
                     :gcp_marketplace,
                     MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType::TaggedSymbol
                   )
+                METRONOME =
+                  T.let(
+                    :metronome,
+                    MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType::TaggedSymbol
+                  )
 
                 sig do
                   override.returns(
@@ -1679,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,
@@ -1810,6 +2014,20 @@ module MetronomeSDK
             end
             attr_accessor :billing_provider_type
 
+            # Error message from the billing provider, if available.
+            sig { returns(T.nilable(String)) }
+            attr_reader :billing_provider_error
+
+            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(
@@ -1882,6 +2100,8 @@ module MetronomeSDK
               params(
                 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,
@@ -1895,6 +2115,10 @@ module MetronomeSDK
             end
             def self.new(
               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.
@@ -1914,6 +2138,8 @@ 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,
@@ -1981,6 +2207,11 @@ module MetronomeSDK
                   :gcp_marketplace,
                   MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::BillingProviderType::TaggedSymbol
                 )
+              METRONOME =
+                T.let(
+                  :metronome,
+                  MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::BillingProviderType::TaggedSymbol
+                )
 
               sig do
                 override.returns(
@@ -2020,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,
@@ -2206,6 +2442,38 @@ module MetronomeSDK
             end
           end
 
+          class Payer < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::Customers::Invoice::Payer,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :contract_id
+
+            sig { returns(String) }
+            attr_accessor :customer_id
+
+            # Account hierarchy M3 - Required for account hierarchy usage invoices. An object
+            # containing the contract and customer UUIDs that pay for this invoice.
+            sig do
+              params(contract_id: String, customer_id: String).returns(
+                T.attached_class
+              )
+            end
+            def self.new(contract_id:, customer_id:)
+            end
+
+            sig do
+              override.returns({ contract_id: String, customer_id: String })
+            end
+            def to_hash
+            end
+          end
+
           class ResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel
             OrHash =
               T.type_alias do

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

@@ -215,14 +215,21 @@ module MetronomeSDK
             end
             attr_writer :error
 
+            sig { returns(T.nilable(String)) }
+            attr_reader :payment_method_id
+
+            sig { params(payment_method_id: String).void }
+            attr_writer :payment_method_id
+
             sig do
               params(
                 payment_intent_id: String,
                 error:
-                  MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error::OrHash
+                  MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error::OrHash,
+                payment_method_id: String
               ).returns(T.attached_class)
             end
-            def self.new(payment_intent_id:, error: nil)
+            def self.new(payment_intent_id:, error: nil, payment_method_id: nil)
             end
 
             sig do
@@ -230,7 +237,8 @@ module MetronomeSDK
                 {
                   payment_intent_id: String,
                   error:
-                    MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error
+                    MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error,
+                  payment_method_id: String
                 }
               )
             end

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

@@ -0,0 +1,128 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class SettingUpsertAvalaraCredentialsParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # The Avalara environment to use (SANDBOX or PRODUCTION).
+        sig do
+          returns(
+            MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment::OrSymbol
+          )
+        end
+        attr_accessor :avalara_environment
+
+        # The password for the Avalara account.
+        sig { returns(String) }
+        attr_accessor :avalara_password
+
+        # The username for the Avalara account.
+        sig { returns(String) }
+        attr_accessor :avalara_username
+
+        # The delivery method IDs of the billing provider configurations to update, can be
+        # found in the response of the `/listConfiguredBillingProviders` endpoint.
+        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:
+              MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment::OrSymbol,
+            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
+        def self.new(
+          # The Avalara environment to use (SANDBOX or PRODUCTION).
+          avalara_environment:,
+          # The password for the Avalara account.
+          avalara_password:,
+          # The username for the Avalara account.
+          avalara_username:,
+          # 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
+
+        sig do
+          override.returns(
+            {
+              avalara_environment:
+                MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment::OrSymbol,
+              avalara_password: String,
+              avalara_username: String,
+              delivery_method_ids: T::Array[String],
+              commit_transactions: T::Boolean,
+              request_options: MetronomeSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The Avalara environment to use (SANDBOX or PRODUCTION).
+        module AvalaraEnvironment
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PRODUCTION =
+            T.let(
+              :PRODUCTION,
+              MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment::TaggedSymbol
+            )
+          SANDBOX =
+            T.let(
+              :SANDBOX,
+              MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/setting_upsert_avalara_credentials_response.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class SettingUpsertAvalaraCredentialsResponse < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Models::V1::SettingUpsertAvalaraCredentialsResponse,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.attached_class) }
+        def self.new
+        end
+
+        sig { override.returns({}) }
+        def to_hash
+        end
+      end
+    end
+  end
+end