metronome-sdk 0.3.0 → 2.0.0

data/lib/metronome_sdk/models/v1/customers/invoice.rb

@@ -25,9 +25,7 @@ module MetronomeSDK
           #
           #   @return [Array<MetronomeSDK::Models::V1::Customers::Invoice::LineItem>]
           required :line_items,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::LineItem]
-                   }
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::LineItem] }
 
           # @!attribute status
           #
@@ -52,10 +50,11 @@ module MetronomeSDK
           # @!attribute billable_status
           #   This field's availability is dependent on your client's configuration.
           #
-          #   @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::BillableStatus, nil]
-          optional :billable_status, enum: -> { MetronomeSDK::V1::Customers::Invoice::BillableStatus }
+          #   @return [Object, nil]
+          optional :billable_status, MetronomeSDK::Internal::Type::Unknown
 
           # @!attribute contract_custom_fields
+          #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @return [Hash{Symbol=>String}, nil]
           optional :contract_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -83,6 +82,7 @@ module MetronomeSDK
           optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
 
           # @!attribute customer_custom_fields
+          #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @return [Hash{Symbol=>String}, nil]
           optional :customer_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -102,9 +102,7 @@ module MetronomeSDK
           #
           #   @return [Array<MetronomeSDK::Models::V1::Customers::Invoice::InvoiceAdjustment>, nil]
           optional :invoice_adjustments,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::InvoiceAdjustment]
-                   }
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::InvoiceAdjustment] }
 
           # @!attribute issued_at
           #   When the invoice was issued (UTC)
@@ -124,6 +122,7 @@ module MetronomeSDK
           optional :netsuite_sales_order_id, String
 
           # @!attribute plan_custom_fields
+          #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @return [Hash{Symbol=>String}, nil]
           optional :plan_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -181,9 +180,9 @@ module MetronomeSDK
           #
           #   @param amendment_id [String]
           #
-          #   @param billable_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::BillableStatus] This field's availability is dependent on your client's configuration.
+          #   @param billable_status [Object] This field's availability is dependent on your client's configuration.
           #
-          #   @param contract_custom_fields [Hash{Symbol=>String}]
+          #   @param contract_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @param contract_id [String]
           #
@@ -193,7 +192,7 @@ module MetronomeSDK
           #
           #   @param custom_fields [Hash{Symbol=>Object}]
           #
-          #   @param customer_custom_fields [Hash{Symbol=>String}]
+          #   @param customer_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @param end_timestamp [Time] End of the usage period this invoice covers (UTC)
           #
@@ -207,7 +206,7 @@ module MetronomeSDK
           #
           #   @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
           #
-          #   @param plan_custom_fields [Hash{Symbol=>String}]
+          #   @param plan_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @param plan_id [String]
           #
@@ -238,11 +237,29 @@ module MetronomeSDK
             required :total, Float
 
             # @!attribute type
-            #   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.
             #
             #   @return [String]
             required :type, String
@@ -257,6 +274,7 @@ module MetronomeSDK
                      -> { MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit }
 
             # @!attribute commit_custom_fields
+            #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
             #   @return [Hash{Symbol=>String}, nil]
             optional :commit_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -293,11 +311,13 @@ module MetronomeSDK
             optional :commit_type, String
 
             # @!attribute custom_fields
+            #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
             #   @return [Hash{Symbol=>String}, nil]
             optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
 
             # @!attribute discount_custom_fields
+            #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
             #   @return [Hash{Symbol=>String}, nil]
             optional :discount_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -381,6 +401,7 @@ module MetronomeSDK
             optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
 
             # @!attribute product_custom_fields
+            #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
             #   @return [Hash{Symbol=>String}, nil]
             optional :product_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -408,6 +429,7 @@ module MetronomeSDK
             optional :product_type, String
 
             # @!attribute professional_service_custom_fields
+            #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
             #   @return [Hash{Symbol=>String}, nil]
             optional :professional_service_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -429,6 +451,7 @@ module MetronomeSDK
             optional :reseller_type, enum: -> { MetronomeSDK::V1::Customers::Invoice::LineItem::ResellerType }
 
             # @!attribute scheduled_charge_custom_fields
+            #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
             #   @return [Hash{Symbol=>String}, nil]
             optional :scheduled_charge_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -449,11 +472,10 @@ module MetronomeSDK
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem>, nil]
             optional :sub_line_items,
-                     -> {
-                       MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::LineItem::SubLineItem]
-                     }
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::LineItem::SubLineItem] }
 
             # @!attribute subscription_custom_fields
+            #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
             #   @return [Hash{Symbol=>String}, nil]
             optional :subscription_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -480,11 +502,11 @@ module MetronomeSDK
             #
             #   @param total [Float]
             #
-            #   @param type [String] The type of line item. Possible values are 'aws_royalty', 'applied_commit_or_cre
+            #   @param type [String] The type of line item.
             #
             #   @param applied_commit_or_credit [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit] Details about the credit or commit that was applied to this line item. Only pres
             #
-            #   @param commit_custom_fields [Hash{Symbol=>String}]
+            #   @param commit_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
             #   @param commit_id [String] For line items with product of `USAGE`, `SUBSCRIPTION`, or `COMPOSITE` types, th
             #
@@ -496,9 +518,9 @@ module MetronomeSDK
             #
             #   @param commit_type [String] `PrepaidCommit` (for commit types `PREPAID` and `CREDIT`) or `PostpaidCommit` (f
             #
-            #   @param custom_fields [Hash{Symbol=>String}]
+            #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
-            #   @param discount_custom_fields [Hash{Symbol=>String}]
+            #   @param discount_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
             #   @param discount_id [String] ID of the discount applied to this line item.
             #
@@ -526,7 +548,7 @@ module MetronomeSDK
             #
             #   @param pricing_group_values [Hash{Symbol=>String}] Includes the pricing group values associated with this line item if dimensional
             #
-            #   @param product_custom_fields [Hash{Symbol=>String}]
+            #   @param product_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
             #   @param product_id [String] ID of the product associated with the line item.
             #
@@ -534,7 +556,7 @@ module MetronomeSDK
             #
             #   @param product_type [String] The type of the line item's product. Possible values are `FixedProductListItem`
             #
-            #   @param professional_service_custom_fields [Hash{Symbol=>String}]
+            #   @param professional_service_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
             #   @param professional_service_id [String]
             #
@@ -542,7 +564,7 @@ module MetronomeSDK
             #
             #   @param reseller_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::LineItem::ResellerType]
             #
-            #   @param scheduled_charge_custom_fields [Hash{Symbol=>String}]
+            #   @param scheduled_charge_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
             #   @param scheduled_charge_id [String] ID of scheduled charge.
             #
@@ -550,7 +572,7 @@ module MetronomeSDK
             #
             #   @param sub_line_items [Array<MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem>]
             #
-            #   @param subscription_custom_fields [Hash{Symbol=>String}]
+            #   @param subscription_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
             #   @param tier [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::Tier] Populated if the line item has a tiered price.
             #
@@ -566,10 +588,7 @@ module MetronomeSDK
               # @!attribute type
               #
               #   @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::Type]
-              required :type,
-                       enum: -> {
-                         MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::Type
-                       }
+              required :type, enum: -> { MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::Type }
 
               # @!method initialize(id:, type:)
               #   Details about the credit or commit that was applied to this line item. Only
@@ -620,6 +639,7 @@ module MetronomeSDK
 
             class SubLineItem < MetronomeSDK::Internal::Type::BaseModel
               # @!attribute custom_fields
+              #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               #
               #   @return [Hash{Symbol=>String}]
               required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -672,25 +692,20 @@ module MetronomeSDK
               #   when the current tier started and ends (for tiered charges only)
               #
               #   @return [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem::TierPeriod, nil]
-              optional :tier_period,
-                       -> {
-                         MetronomeSDK::V1::Customers::Invoice::LineItem::SubLineItem::TierPeriod
-                       }
+              optional :tier_period, -> { MetronomeSDK::V1::Customers::Invoice::LineItem::SubLineItem::TierPeriod }
 
               # @!attribute tiers
               #
               #   @return [Array<MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem::Tier>, nil]
               optional :tiers,
-                       -> {
-                         MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::LineItem::SubLineItem::Tier]
-                       }
+                       -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::LineItem::SubLineItem::Tier] }
 
               # @!method initialize(custom_fields:, name:, quantity:, subtotal:, charge_id: nil, credit_grant_id: nil, end_date: nil, price: nil, start_date: nil, tier_period: nil, tiers: nil)
               #   Some parameter documentations has been truncated, see
               #   {MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem} for more
               #   details.
               #
-              #   @param custom_fields [Hash{Symbol=>String}]
+              #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               #
               #   @param name [String]
               #
@@ -790,19 +805,6 @@ module MetronomeSDK
             end
           end
 
-          # This field's availability is dependent on your client's configuration.
-          #
-          # @see MetronomeSDK::Models::V1::Customers::Invoice#billable_status
-          module BillableStatus
-            extend MetronomeSDK::Internal::Type::Enum
-
-            BILLABLE = :billable
-            UNBILLABLE = :unbillable
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-
           # @see MetronomeSDK::Models::V1::Customers::Invoice#correction_record
           class CorrectionRecord < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute corrected_invoice_id
@@ -838,33 +840,65 @@ module MetronomeSDK
               #
               #   @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType]
               required :billing_provider_type,
-                       enum: -> {
-                         MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType
-                       }
+                       enum: -> { MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType }
 
               # @!attribute external_status
               #
               #   @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus, nil]
               optional :external_status,
-                       enum: -> {
-                         MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus
-                       }
+                       enum: -> { MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus }
 
               # @!attribute invoice_id
               #
               #   @return [String, nil]
               optional :invoice_id, String
 
+              # @!attribute invoiced_sub_total
+              #   The subtotal amount invoiced, if available from the billing provider.
+              #
+              #   @return [Float, nil]
+              optional :invoiced_sub_total, Float
+
+              # @!attribute invoiced_total
+              #   The total amount invoiced, if available from the billing provider.
+              #
+              #   @return [Float, nil]
+              optional :invoiced_total, Float
+
               # @!attribute issued_at_timestamp
               #
               #   @return [Time, nil]
               optional :issued_at_timestamp, Time
 
-              # @!method initialize(billing_provider_type:, external_status: nil, invoice_id: nil, issued_at_timestamp: nil)
+              # @!attribute pdf_url
+              #   A URL to the PDF of the invoice, if available from the billing provider.
+              #
+              #   @return [String, nil]
+              optional :pdf_url, String
+
+              # @!attribute tax
+              #   Tax details for the invoice, if available from the billing provider.
+              #
+              #   @return [MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax, nil]
+              optional :tax,
+                       -> { MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax }
+
+              # @!method initialize(billing_provider_type:, external_status: nil, invoice_id: nil, invoiced_sub_total: nil, invoiced_total: nil, issued_at_timestamp: nil, pdf_url: nil, tax: nil)
               #   @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType]
+              #
               #   @param external_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus]
+              #
               #   @param invoice_id [String]
+              #
+              #   @param invoiced_sub_total [Float] The subtotal amount invoiced, if available from the billing provider.
+              #
+              #   @param invoiced_total [Float] The total amount invoiced, if available from the billing provider.
+              #
               #   @param issued_at_timestamp [Time]
+              #
+              #   @param pdf_url [String] A URL to the PDF of the invoice, if available from the billing provider.
+              #
+              #   @param tax [MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax] Tax details for the invoice, if available from the billing provider.
 
               # @see MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice#billing_provider_type
               module BillingProviderType
@@ -902,6 +936,36 @@ module MetronomeSDK
                 # @!method self.values
                 #   @return [Array<Symbol>]
               end
+
+              # @see MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice#tax
+              class Tax < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute total_tax_amount
+                #   The total tax amount applied to the invoice.
+                #
+                #   @return [Float, nil]
+                optional :total_tax_amount, Float
+
+                # @!attribute total_taxable_amount
+                #   The total taxable amount of the invoice.
+                #
+                #   @return [Float, nil]
+                optional :total_taxable_amount, Float
+
+                # @!attribute transaction_id
+                #   The transaction ID associated with the tax calculation.
+                #
+                #   @return [String, nil]
+                optional :transaction_id, String
+
+                # @!method initialize(total_tax_amount: nil, total_taxable_amount: nil, transaction_id: nil)
+                #   Tax details for the invoice, if available from the billing provider.
+                #
+                #   @param total_tax_amount [Float] The total tax amount applied to the invoice.
+                #
+                #   @param total_taxable_amount [Float] The total taxable amount of the invoice.
+                #
+                #   @param transaction_id [String] The transaction ID associated with the tax calculation.
+              end
             end
           end
 
@@ -924,16 +988,51 @@ module MetronomeSDK
             #   @return [String, nil]
             optional :invoice_id, String
 
+            # @!attribute invoiced_sub_total
+            #   The subtotal amount invoiced, if available from the billing provider.
+            #
+            #   @return [Float, nil]
+            optional :invoiced_sub_total, Float
+
+            # @!attribute invoiced_total
+            #   The total amount invoiced, if available from the billing provider.
+            #
+            #   @return [Float, nil]
+            optional :invoiced_total, Float
+
             # @!attribute issued_at_timestamp
             #
             #   @return [Time, nil]
             optional :issued_at_timestamp, Time
 
-            # @!method initialize(billing_provider_type:, external_status: nil, invoice_id: nil, issued_at_timestamp: nil)
+            # @!attribute pdf_url
+            #   A URL to the PDF of the invoice, if available from the billing provider.
+            #
+            #   @return [String, nil]
+            optional :pdf_url, String
+
+            # @!attribute tax
+            #   Tax details for the invoice, if available from the billing provider.
+            #
+            #   @return [MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::Tax, nil]
+            optional :tax, -> { MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax }
+
+            # @!method initialize(billing_provider_type:, external_status: nil, invoice_id: nil, invoiced_sub_total: nil, invoiced_total: nil, issued_at_timestamp: nil, pdf_url: nil, tax: nil)
             #   @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::BillingProviderType]
+            #
             #   @param external_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::ExternalStatus]
+            #
             #   @param invoice_id [String]
+            #
+            #   @param invoiced_sub_total [Float] The subtotal amount invoiced, if available from the billing provider.
+            #
+            #   @param invoiced_total [Float] The total amount invoiced, if available from the billing provider.
+            #
             #   @param issued_at_timestamp [Time]
+            #
+            #   @param pdf_url [String] A URL to the PDF of the invoice, if available from the billing provider.
+            #
+            #   @param tax [MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::Tax] Tax details for the invoice, if available from the billing provider.
 
             # @see MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice#billing_provider_type
             module BillingProviderType
@@ -971,6 +1070,36 @@ module MetronomeSDK
               # @!method self.values
               #   @return [Array<Symbol>]
             end
+
+            # @see MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice#tax
+            class Tax < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute total_tax_amount
+              #   The total tax amount applied to the invoice.
+              #
+              #   @return [Float, nil]
+              optional :total_tax_amount, Float
+
+              # @!attribute total_taxable_amount
+              #   The total taxable amount of the invoice.
+              #
+              #   @return [Float, nil]
+              optional :total_taxable_amount, Float
+
+              # @!attribute transaction_id
+              #   The transaction ID associated with the tax calculation.
+              #
+              #   @return [String, nil]
+              optional :transaction_id, String
+
+              # @!method initialize(total_tax_amount: nil, total_taxable_amount: nil, transaction_id: nil)
+              #   Tax details for the invoice, if available from the billing provider.
+              #
+              #   @param total_tax_amount [Float] The total tax amount applied to the invoice.
+              #
+              #   @param total_taxable_amount [Float] The total taxable amount of the invoice.
+              #
+              #   @param transaction_id [String] The transaction ID associated with the tax calculation.
+            end
           end
 
           class InvoiceAdjustment < MetronomeSDK::Internal::Type::BaseModel
@@ -990,6 +1119,7 @@ module MetronomeSDK
             required :total, Float
 
             # @!attribute credit_grant_custom_fields
+            #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             #
             #   @return [Hash{Symbol=>String}, nil]
             optional :credit_grant_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -1001,9 +1131,13 @@ module MetronomeSDK
 
             # @!method initialize(credit_type:, name:, total:, credit_grant_custom_fields: nil, credit_grant_id: nil)
             #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+            #
             #   @param name [String]
+            #
             #   @param total [Float]
-            #   @param credit_grant_custom_fields [Hash{Symbol=>String}]
+            #
+            #   @param credit_grant_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+            #
             #   @param credit_grant_id [String]
           end
 
@@ -1022,10 +1156,7 @@ module MetronomeSDK
             # @!attribute reseller_type
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty::ResellerType]
-            required :reseller_type,
-                     enum: -> {
-                       MetronomeSDK::V1::Customers::Invoice::ResellerRoyalty::ResellerType
-                     }
+            required :reseller_type, enum: -> { MetronomeSDK::V1::Customers::Invoice::ResellerRoyalty::ResellerType }
 
             # @!attribute aws_options
             #

data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb

@@ -72,10 +72,7 @@ module MetronomeSDK
           #   The granularity of the breakdowns to return. Defaults to day.
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::WindowSize, nil]
-          optional :window_size,
-                   enum: -> {
-                     MetronomeSDK::V1::Customers::InvoiceListBreakdownsParams::WindowSize
-                   }
+          optional :window_size, enum: -> { MetronomeSDK::V1::Customers::InvoiceListBreakdownsParams::WindowSize }
 
           # @!method initialize(customer_id:, ending_before:, starting_on:, credit_type_id: nil, limit: nil, next_page: nil, skip_zero_qty_line_items: nil, sort: nil, status: nil, window_size: nil, request_options: {})
           #   Some parameter documentations has been truncated, see

data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_pdf_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Invoices#retrieve_pdf
+        class InvoiceRetrievePdfParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute invoice_id
+          #
+          #   @return [String]
+          required :invoice_id, String
+
+          # @!method initialize(customer_id:, invoice_id:, request_options: {})
+          #   @param customer_id [String]
+          #   @param invoice_id [String]
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/customers/plan_add_params.rb

@@ -46,9 +46,7 @@ module MetronomeSDK
           #
           #   @return [Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment>, nil]
           optional :overage_rate_adjustments,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::PlanAddParams::OverageRateAdjustment]
-                   }
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::PlanAddParams::OverageRateAdjustment] }
 
           # @!attribute price_adjustments
           #   A list of price adjustments can be applied on top of the pricing in the plans.
@@ -58,9 +56,7 @@ module MetronomeSDK
           #
           #   @return [Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment>, nil]
           optional :price_adjustments,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::PlanAddParams::PriceAdjustment]
-                   }
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::PlanAddParams::PriceAdjustment] }
 
           # @!attribute trial_spec
           #   A custom trial can be set for the customer's plan. See the

data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb

@@ -13,6 +13,7 @@ module MetronomeSDK
           required :id, String
 
           # @!attribute custom_fields
+          #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @return [Hash{Symbol=>String}]
           required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -56,7 +57,7 @@ module MetronomeSDK
           # @!method initialize(id:, custom_fields:, plan_description:, plan_id:, plan_name:, starting_on:, ending_before: nil, net_payment_terms_days: nil, trial_info: nil)
           #   @param id [String] the ID of the customer plan
           #
-          #   @param custom_fields [Hash{Symbol=>String}]
+          #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @param plan_description [String]
           #

data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb

@@ -24,27 +24,21 @@ module MetronomeSDK
         #
         #   @return [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride>, nil]
         optional :bm_group_key_overrides,
-                 -> {
-                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride]
-                 }
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride] }
 
         # @!attribute color_overrides
         #   Optional list of colors to override
         #
         #   @return [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::ColorOverride>, nil]
         optional :color_overrides,
-                 -> {
-                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride]
-                 }
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride] }
 
         # @!attribute dashboard_options
         #   Optional dashboard specific options
         #
         #   @return [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::DashboardOption>, nil]
         optional :dashboard_options,
-                 -> {
-                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::DashboardGetEmbeddableURLParams::DashboardOption]
-                 }
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::DashboardGetEmbeddableURLParams::DashboardOption] }
 
         # @!method initialize(customer_id:, dashboard:, bm_group_key_overrides: nil, color_overrides: nil, dashboard_options: nil, request_options: {})
         #   @param customer_id [String]
@@ -90,8 +84,7 @@ module MetronomeSDK
           #   names. e.g. {"a": "Asia", "b": "Euro"}
           #
           #   @return [Hash{Symbol=>Object}, nil]
-          optional :value_display_names,
-                   MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+          optional :value_display_names, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
 
           # @!method initialize(group_key_name:, display_name: nil, value_display_names: nil)
           #   Some parameter documentations has been truncated, see