metronome-sdk 1.0.0 → 2.1.0

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

@@ -46,22 +46,34 @@ module MetronomeSDK
           attr_writer :amendment_id
 
           # This field's availability is dependent on your client's configuration.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :billable_status
+
+          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(
-                MetronomeSDK::V1::Customers::Invoice::BillableStatus::TaggedSymbol
+                T::Array[
+                  MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice
+                ]
               )
             )
           end
-          attr_reader :billable_status
+          attr_reader :constituent_invoices
 
           sig do
             params(
-              billable_status:
-                MetronomeSDK::V1::Customers::Invoice::BillableStatus::OrSymbol
+              constituent_invoices:
+                T::Array[
+                  MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice::OrHash
+                ]
             ).void
           end
-          attr_writer :billable_status
+          attr_writer :constituent_invoices
 
           # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
@@ -177,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
@@ -245,8 +271,11 @@ module MetronomeSDK
               total: Float,
               type: String,
               amendment_id: String,
-              billable_status:
-                MetronomeSDK::V1::Customers::Invoice::BillableStatus::OrSymbol,
+              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:
@@ -266,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,
@@ -287,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,
@@ -306,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,
@@ -332,8 +368,11 @@ module MetronomeSDK
                 total: Float,
                 type: String,
                 amendment_id: String,
-                billable_status:
-                  MetronomeSDK::V1::Customers::Invoice::BillableStatus::TaggedSymbol,
+                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:
@@ -353,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,
@@ -558,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(
@@ -773,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)],
@@ -866,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
@@ -935,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)],
@@ -1048,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
@@ -1400,38 +1522,40 @@ module MetronomeSDK
             end
           end
 
-          # This field's availability is dependent on your client's configuration.
-          module BillableStatus
-            extend MetronomeSDK::Internal::Type::Enum
-
-            TaggedSymbol =
+          class ConstituentInvoice < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
               T.type_alias do
-                T.all(
-                  Symbol,
-                  MetronomeSDK::V1::Customers::Invoice::BillableStatus
+                T.any(
+                  MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice,
+                  MetronomeSDK::Internal::AnyHash
                 )
               end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-            BILLABLE =
-              T.let(
-                :billable,
-                MetronomeSDK::V1::Customers::Invoice::BillableStatus::TaggedSymbol
-              )
-            UNBILLABLE =
-              T.let(
-                :unbillable,
-                MetronomeSDK::V1::Customers::Invoice::BillableStatus::TaggedSymbol
-              )
+            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(
-                T::Array[
-                  MetronomeSDK::V1::Customers::Invoice::BillableStatus::TaggedSymbol
-                ]
+                { contract_id: String, customer_id: String, invoice_id: String }
               )
             end
-            def self.values
+            def to_hash
             end
           end
 
@@ -1517,6 +1641,13 @@ 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
+
               sig do
                 returns(
                   T.nilable(
@@ -1540,27 +1671,82 @@ module MetronomeSDK
               sig { params(invoice_id: String).void }
               attr_writer :invoice_id
 
+              # The subtotal amount invoiced, if available from the billing provider.
+              sig { returns(T.nilable(Float)) }
+              attr_reader :invoiced_sub_total
+
+              sig { params(invoiced_sub_total: Float).void }
+              attr_writer :invoiced_sub_total
+
+              # The total amount invoiced, if available from the billing provider.
+              sig { returns(T.nilable(Float)) }
+              attr_reader :invoiced_total
+
+              sig { params(invoiced_total: Float).void }
+              attr_writer :invoiced_total
+
               sig { returns(T.nilable(Time)) }
               attr_reader :issued_at_timestamp
 
               sig { params(issued_at_timestamp: Time).void }
               attr_writer :issued_at_timestamp
 
+              # A URL to the PDF of the invoice, if available from the billing provider.
+              sig { returns(T.nilable(String)) }
+              attr_reader :pdf_url
+
+              sig { params(pdf_url: String).void }
+              attr_writer :pdf_url
+
+              # Tax details for the invoice, if available from the billing provider.
+              sig do
+                returns(
+                  T.nilable(
+                    MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax
+                  )
+                )
+              end
+              attr_reader :tax
+
+              sig do
+                params(
+                  tax:
+                    MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax::OrHash
+                ).void
+              end
+              attr_writer :tax
+
               sig do
                 params(
                   billing_provider_type:
                     MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType::OrSymbol,
+                  billing_provider_error: String,
                   external_status:
                     MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus::OrSymbol,
                   invoice_id: String,
-                  issued_at_timestamp: Time
+                  invoiced_sub_total: Float,
+                  invoiced_total: Float,
+                  issued_at_timestamp: Time,
+                  pdf_url: String,
+                  tax:
+                    MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax::OrHash
                 ).returns(T.attached_class)
               end
               def self.new(
                 billing_provider_type:,
+                # Error message from the billing provider, if available.
+                billing_provider_error: nil,
                 external_status: nil,
                 invoice_id: nil,
-                issued_at_timestamp: nil
+                # The subtotal amount invoiced, if available from the billing provider.
+                invoiced_sub_total: nil,
+                # The total amount invoiced, if available from the billing provider.
+                invoiced_total: nil,
+                issued_at_timestamp: nil,
+                # A URL to the PDF of the invoice, if available from the billing provider.
+                pdf_url: nil,
+                # Tax details for the invoice, if available from the billing provider.
+                tax: nil
               )
               end
 
@@ -1569,10 +1755,16 @@ module MetronomeSDK
                   {
                     billing_provider_type:
                       MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType::TaggedSymbol,
+                    billing_provider_error: String,
                     external_status:
                       MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus::TaggedSymbol,
                     invoice_id: String,
-                    issued_at_timestamp: Time
+                    invoiced_sub_total: Float,
+                    invoiced_total: Float,
+                    issued_at_timestamp: Time,
+                    pdf_url: String,
+                    tax:
+                      MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax
                   }
                 )
               end
@@ -1631,6 +1823,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(
@@ -1721,6 +1918,67 @@ module MetronomeSDK
                 def self.values
                 end
               end
+
+              class Tax < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                # The total tax amount applied to the invoice.
+                sig { returns(T.nilable(Float)) }
+                attr_reader :total_tax_amount
+
+                sig { params(total_tax_amount: Float).void }
+                attr_writer :total_tax_amount
+
+                # The total taxable amount of the invoice.
+                sig { returns(T.nilable(Float)) }
+                attr_reader :total_taxable_amount
+
+                sig { params(total_taxable_amount: Float).void }
+                attr_writer :total_taxable_amount
+
+                # The transaction ID associated with the tax calculation.
+                sig { returns(T.nilable(String)) }
+                attr_reader :transaction_id
+
+                sig { params(transaction_id: String).void }
+                attr_writer :transaction_id
+
+                # Tax details for the invoice, if available from the billing provider.
+                sig do
+                  params(
+                    total_tax_amount: Float,
+                    total_taxable_amount: Float,
+                    transaction_id: String
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # The total tax amount applied to the invoice.
+                  total_tax_amount: nil,
+                  # The total taxable amount of the invoice.
+                  total_taxable_amount: nil,
+                  # The transaction ID associated with the tax calculation.
+                  transaction_id: nil
+                )
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      total_tax_amount: Float,
+                      total_taxable_amount: Float,
+                      transaction_id: String
+                    }
+                  )
+                end
+                def to_hash
+                end
+              end
             end
           end
 
@@ -1740,6 +1998,13 @@ 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
+
             sig do
               returns(
                 T.nilable(
@@ -1763,27 +2028,82 @@ module MetronomeSDK
             sig { params(invoice_id: String).void }
             attr_writer :invoice_id
 
+            # The subtotal amount invoiced, if available from the billing provider.
+            sig { returns(T.nilable(Float)) }
+            attr_reader :invoiced_sub_total
+
+            sig { params(invoiced_sub_total: Float).void }
+            attr_writer :invoiced_sub_total
+
+            # The total amount invoiced, if available from the billing provider.
+            sig { returns(T.nilable(Float)) }
+            attr_reader :invoiced_total
+
+            sig { params(invoiced_total: Float).void }
+            attr_writer :invoiced_total
+
             sig { returns(T.nilable(Time)) }
             attr_reader :issued_at_timestamp
 
             sig { params(issued_at_timestamp: Time).void }
             attr_writer :issued_at_timestamp
 
+            # A URL to the PDF of the invoice, if available from the billing provider.
+            sig { returns(T.nilable(String)) }
+            attr_reader :pdf_url
+
+            sig { params(pdf_url: String).void }
+            attr_writer :pdf_url
+
+            # Tax details for the invoice, if available from the billing provider.
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax
+                )
+              )
+            end
+            attr_reader :tax
+
+            sig do
+              params(
+                tax:
+                  MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax::OrHash
+              ).void
+            end
+            attr_writer :tax
+
             sig do
               params(
                 billing_provider_type:
                   MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::BillingProviderType::OrSymbol,
+                billing_provider_error: String,
                 external_status:
                   MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::ExternalStatus::OrSymbol,
                 invoice_id: String,
-                issued_at_timestamp: Time
+                invoiced_sub_total: Float,
+                invoiced_total: Float,
+                issued_at_timestamp: Time,
+                pdf_url: String,
+                tax:
+                  MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax::OrHash
               ).returns(T.attached_class)
             end
             def self.new(
               billing_provider_type:,
+              # Error message from the billing provider, if available.
+              billing_provider_error: nil,
               external_status: nil,
               invoice_id: nil,
-              issued_at_timestamp: nil
+              # The subtotal amount invoiced, if available from the billing provider.
+              invoiced_sub_total: nil,
+              # The total amount invoiced, if available from the billing provider.
+              invoiced_total: nil,
+              issued_at_timestamp: nil,
+              # A URL to the PDF of the invoice, if available from the billing provider.
+              pdf_url: nil,
+              # Tax details for the invoice, if available from the billing provider.
+              tax: nil
             )
             end
 
@@ -1792,10 +2112,16 @@ module MetronomeSDK
                 {
                   billing_provider_type:
                     MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::BillingProviderType::TaggedSymbol,
+                  billing_provider_error: String,
                   external_status:
                     MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::ExternalStatus::TaggedSymbol,
                   invoice_id: String,
-                  issued_at_timestamp: Time
+                  invoiced_sub_total: Float,
+                  invoiced_total: Float,
+                  issued_at_timestamp: Time,
+                  pdf_url: String,
+                  tax:
+                    MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax
                 }
               )
             end
@@ -1854,6 +2180,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(
@@ -1944,6 +2275,67 @@ module MetronomeSDK
               def self.values
               end
             end
+
+            class Tax < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              # The total tax amount applied to the invoice.
+              sig { returns(T.nilable(Float)) }
+              attr_reader :total_tax_amount
+
+              sig { params(total_tax_amount: Float).void }
+              attr_writer :total_tax_amount
+
+              # The total taxable amount of the invoice.
+              sig { returns(T.nilable(Float)) }
+              attr_reader :total_taxable_amount
+
+              sig { params(total_taxable_amount: Float).void }
+              attr_writer :total_taxable_amount
+
+              # The transaction ID associated with the tax calculation.
+              sig { returns(T.nilable(String)) }
+              attr_reader :transaction_id
+
+              sig { params(transaction_id: String).void }
+              attr_writer :transaction_id
+
+              # Tax details for the invoice, if available from the billing provider.
+              sig do
+                params(
+                  total_tax_amount: Float,
+                  total_taxable_amount: Float,
+                  transaction_id: String
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # The total tax amount applied to the invoice.
+                total_tax_amount: nil,
+                # The total taxable amount of the invoice.
+                total_taxable_amount: nil,
+                # The transaction ID associated with the tax calculation.
+                transaction_id: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    total_tax_amount: Float,
+                    total_taxable_amount: Float,
+                    transaction_id: String
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
           end
 
           class InvoiceAdjustment < MetronomeSDK::Internal::Type::BaseModel
@@ -2018,6 +2410,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