metronome-sdk 0.3.0 → 2.0.0

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

@@ -46,23 +46,13 @@ module MetronomeSDK
           attr_writer :amendment_id
 
           # This field's availability is dependent on your client's configuration.
-          sig do
-            returns(
-              T.nilable(
-                MetronomeSDK::V1::Customers::Invoice::BillableStatus::TaggedSymbol
-              )
-            )
-          end
+          sig { returns(T.nilable(T.anything)) }
           attr_reader :billable_status
 
-          sig do
-            params(
-              billable_status:
-                MetronomeSDK::V1::Customers::Invoice::BillableStatus::OrSymbol
-            ).void
-          end
+          sig { params(billable_status: T.anything).void }
           attr_writer :billable_status
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :contract_custom_fields
 
@@ -104,6 +94,7 @@ module MetronomeSDK
           sig { params(custom_fields: T::Hash[Symbol, T.anything]).void }
           attr_writer :custom_fields
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :customer_custom_fields
 
@@ -175,6 +166,7 @@ module MetronomeSDK
           sig { params(netsuite_sales_order_id: String).void }
           attr_writer :netsuite_sales_order_id
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :plan_custom_fields
 
@@ -242,8 +234,7 @@ module MetronomeSDK
               total: Float,
               type: String,
               amendment_id: String,
-              billable_status:
-                MetronomeSDK::V1::Customers::Invoice::BillableStatus::OrSymbol,
+              billable_status: T.anything,
               contract_custom_fields: T::Hash[Symbol, String],
               contract_id: String,
               correction_record:
@@ -284,6 +275,7 @@ module MetronomeSDK
             amendment_id: nil,
             # This field's availability is dependent on your client's configuration.
             billable_status: nil,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             contract_custom_fields: nil,
             contract_id: nil,
             correction_record: nil,
@@ -291,6 +283,7 @@ module MetronomeSDK
             # invoices only.
             created_at: nil,
             custom_fields: nil,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             customer_custom_fields: nil,
             # End of the usage period this invoice covers (UTC)
             end_timestamp: nil,
@@ -301,6 +294,7 @@ module MetronomeSDK
             net_payment_terms_days: nil,
             # This field's availability is dependent on your client's configuration.
             netsuite_sales_order_id: nil,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             plan_custom_fields: nil,
             plan_id: nil,
             plan_name: nil,
@@ -326,8 +320,7 @@ module MetronomeSDK
                 total: Float,
                 type: String,
                 amendment_id: String,
-                billable_status:
-                  MetronomeSDK::V1::Customers::Invoice::BillableStatus::TaggedSymbol,
+                billable_status: T.anything,
                 contract_custom_fields: T::Hash[Symbol, String],
                 contract_id: String,
                 correction_record:
@@ -384,11 +377,29 @@ module MetronomeSDK
             sig { returns(Float) }
             attr_accessor :total
 
-            # The type of line item. Possible values are 'aws_royalty',
-            # 'applied_commit_or_credit', 'scheduled', 'commit_purchase', 'cpu_conversion',
-            # 'discount', 'gcp_royalty', 'postpaid_trueup', 'professional_services',
-            # 'subscription', 'usage', 'legacy', 'minimum', 'product_charge',
-            # 'trial_discount', 'rollover', 'seat', 'grouped_charge'.
+            # The type of line item.
+            #
+            # - `scheduled`: Line item is associated with a scheduled charge. View the
+            #   scheduled_charge_id on the line item.
+            # - `commit_purchase`: Line item is associated with a payment for a prepaid
+            #   commit. View the commit_id on the line item.
+            # - `usage`: Line item is associated with a usage product or composite product.
+            #   View the product_id on the line item to determine which product.
+            # - `subscription`: Line item is associated with a subscription. e.g. monthly
+            #   recurring payment for an in-advance subscription.
+            # - `applied_commit_or_credit`: On metronome invoices, applied commits and credits
+            #   are associated with their own line items. These line items have negative
+            #   totals. Use the applied_commit_or_credit object on the line item to understand
+            #   the id of the applied commit or credit, and its type. Note that the
+            #   application of a postpaid commit is associated with a line item, but the total
+            #   on the line item is not included in the invoice's total as postpaid commits
+            #   are paid in-arrears.
+            # - `cpu_conversion`: Line item converting between a custom pricing unit and fiat
+            #   currency, using the conversion rate set on the rate card. This line item will
+            #   appear when there are products priced in custom pricing units, and there is
+            #   insufficient prepaid commit/credit in that custom pricing unit to fully cover
+            #   the spend. Then, the outstanding spend in custom pricing units will be
+            #   converted to fiat currency using a cpu_conversion line item.
             sig { returns(String) }
             attr_accessor :type
 
@@ -412,6 +423,7 @@ module MetronomeSDK
             end
             attr_writer :applied_commit_or_credit
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :commit_custom_fields
 
@@ -454,12 +466,14 @@ module MetronomeSDK
             sig { params(commit_type: String).void }
             attr_writer :commit_type
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :custom_fields
 
             sig { params(custom_fields: T::Hash[Symbol, String]).void }
             attr_writer :custom_fields
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :discount_custom_fields
 
@@ -569,6 +583,7 @@ module MetronomeSDK
             sig { params(pricing_group_values: T::Hash[Symbol, String]).void }
             attr_writer :pricing_group_values
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :product_custom_fields
 
@@ -600,6 +615,7 @@ module MetronomeSDK
             sig { params(product_type: String).void }
             attr_writer :product_type
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :professional_service_custom_fields
 
@@ -640,6 +656,7 @@ module MetronomeSDK
             end
             attr_writer :reseller_type
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :scheduled_charge_custom_fields
 
@@ -685,6 +702,7 @@ module MetronomeSDK
             end
             attr_writer :sub_line_items
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :subscription_custom_fields
 
@@ -772,16 +790,35 @@ module MetronomeSDK
               credit_type:,
               name:,
               total:,
-              # The type of line item. Possible values are 'aws_royalty',
-              # 'applied_commit_or_credit', 'scheduled', 'commit_purchase', 'cpu_conversion',
-              # 'discount', 'gcp_royalty', 'postpaid_trueup', 'professional_services',
-              # 'subscription', 'usage', 'legacy', 'minimum', 'product_charge',
-              # 'trial_discount', 'rollover', 'seat', 'grouped_charge'.
+              # The type of line item.
+              #
+              # - `scheduled`: Line item is associated with a scheduled charge. View the
+              #   scheduled_charge_id on the line item.
+              # - `commit_purchase`: Line item is associated with a payment for a prepaid
+              #   commit. View the commit_id on the line item.
+              # - `usage`: Line item is associated with a usage product or composite product.
+              #   View the product_id on the line item to determine which product.
+              # - `subscription`: Line item is associated with a subscription. e.g. monthly
+              #   recurring payment for an in-advance subscription.
+              # - `applied_commit_or_credit`: On metronome invoices, applied commits and credits
+              #   are associated with their own line items. These line items have negative
+              #   totals. Use the applied_commit_or_credit object on the line item to understand
+              #   the id of the applied commit or credit, and its type. Note that the
+              #   application of a postpaid commit is associated with a line item, but the total
+              #   on the line item is not included in the invoice's total as postpaid commits
+              #   are paid in-arrears.
+              # - `cpu_conversion`: Line item converting between a custom pricing unit and fiat
+              #   currency, using the conversion rate set on the rate card. This line item will
+              #   appear when there are products priced in custom pricing units, and there is
+              #   insufficient prepaid commit/credit in that custom pricing unit to fully cover
+              #   the spend. Then, the outstanding spend in custom pricing units will be
+              #   converted to fiat currency using a cpu_conversion line item.
               type:,
               # Details about the credit or commit that was applied to this line item. Only
               # present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`
               # types.
               applied_commit_or_credit: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               commit_custom_fields: nil,
               # For line items with product of `USAGE`, `SUBSCRIPTION`, or `COMPOSITE` types,
               # the ID of the credit or commit that was applied to this line item. For line
@@ -794,7 +831,9 @@ module MetronomeSDK
               # `PrepaidCommit` (for commit types `PREPAID` and `CREDIT`) or `PostpaidCommit`
               # (for commit type `POSTPAID`).
               commit_type: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               custom_fields: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               discount_custom_fields: nil,
               # ID of the discount applied to this line item.
               discount_id: nil,
@@ -822,6 +861,7 @@ module MetronomeSDK
               # Includes the pricing group values associated with this line item if dimensional
               # pricing is used.
               pricing_group_values: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               product_custom_fields: nil,
               # ID of the product associated with the line item.
               product_id: nil,
@@ -833,17 +873,20 @@ module MetronomeSDK
               # `CompositeProductListItem` (for `COMPOSITE` type products). For scheduled
               # charges, commit and credit payments, the value is `FixedProductListItem`.
               product_type: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               professional_service_custom_fields: nil,
               professional_service_id: nil,
               # The quantity associated with the line item.
               quantity: nil,
               reseller_type: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               scheduled_charge_custom_fields: nil,
               # ID of scheduled charge.
               scheduled_charge_id: nil,
               # The line item's start date (inclusive).
               starting_at: nil,
               sub_line_items: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               subscription_custom_fields: nil,
               # Populated if the line item has a tiered price.
               tier: nil,
@@ -1067,6 +1110,7 @@ module MetronomeSDK
                   )
                 end
 
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               sig { returns(T::Hash[Symbol, String]) }
               attr_accessor :custom_fields
 
@@ -1172,6 +1216,7 @@ module MetronomeSDK
                 ).returns(T.attached_class)
               end
               def self.new(
+                # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
                 custom_fields:,
                 name:,
                 quantity:,
@@ -1342,41 +1387,6 @@ module MetronomeSDK
             end
           end
 
-          # This field's availability is dependent on your client's configuration.
-          module BillableStatus
-            extend MetronomeSDK::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  MetronomeSDK::V1::Customers::Invoice::BillableStatus
-                )
-              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 do
-              override.returns(
-                T::Array[
-                  MetronomeSDK::V1::Customers::Invoice::BillableStatus::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-
           class CorrectionRecord < MetronomeSDK::Internal::Type::BaseModel
             OrHash =
               T.type_alias do
@@ -1482,12 +1492,51 @@ 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:
@@ -1495,14 +1544,27 @@ module MetronomeSDK
                   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:,
                 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
 
@@ -1514,7 +1576,12 @@ module MetronomeSDK
                     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
@@ -1663,6 +1730,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
 
@@ -1705,12 +1833,51 @@ 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:
@@ -1718,14 +1885,27 @@ module MetronomeSDK
                 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:,
               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
 
@@ -1737,7 +1917,12 @@ module MetronomeSDK
                   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
@@ -1886,6 +2071,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
@@ -1911,6 +2157,7 @@ module MetronomeSDK
             sig { returns(Float) }
             attr_accessor :total
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :credit_grant_custom_fields
 
@@ -1938,6 +2185,7 @@ module MetronomeSDK
               credit_type:,
               name:,
               total:,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               credit_grant_custom_fields: nil,
               credit_grant_id: nil
             )