metronome-sdk 0.2.0 → 1.0.0

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

@@ -54,6 +54,7 @@ module MetronomeSDK
           optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[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]
@@ -93,11 +94,8 @@ module MetronomeSDK
           #   specifiers to contribute to a commit's or credit's drawdown. This field cannot
           #   be used together with `applicable_product_ids` or `applicable_product_tags`.
           #
-          #   @return [Array<MetronomeSDK::Models::V1::Customers::CreditCreateParams::Specifier>, nil]
-          optional :specifiers,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CreditCreateParams::Specifier]
-                   }
+          #   @return [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil]
+          optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] }
 
           # @!attribute uniqueness_key
           #   Prevents the creation of duplicates. If a request to create a commit or credit
@@ -126,7 +124,7 @@ module MetronomeSDK
           #
           #   @param applicable_product_tags [Array<String>] Which tags the credit applies to. If both applicable*product_ids and applicable*
           #
-          #   @param custom_fields [Hash{Symbol=>String}]
+          #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @param description [String] Used only in UI/API. It is not exposed to end customers.
           #
@@ -138,7 +136,7 @@ module MetronomeSDK
           #
           #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
           #
-          #   @param specifiers [Array<MetronomeSDK::Models::V1::Customers::CreditCreateParams::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
+          #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>] List of filters that determine what kind of customer usage draws down a commit o
           #
           #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a commit or credit i
           #
@@ -149,9 +147,7 @@ module MetronomeSDK
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem>]
             required :schedule_items,
-                     -> {
-                       MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem]
-                     }
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem] }
 
             # @!attribute credit_type_id
             #   Defaults to USD (cents) if not passed
@@ -202,44 +198,6 @@ module MetronomeSDK
             # @!method self.values
             #   @return [Array<Symbol>]
           end
-
-          class Specifier < MetronomeSDK::Internal::Type::BaseModel
-            # @!attribute presentation_group_values
-            #
-            #   @return [Hash{Symbol=>String}, nil]
-            optional :presentation_group_values, MetronomeSDK::Internal::Type::HashOf[String]
-
-            # @!attribute pricing_group_values
-            #
-            #   @return [Hash{Symbol=>String}, nil]
-            optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
-
-            # @!attribute product_id
-            #   If provided, the specifier will only apply to the product with the specified ID.
-            #
-            #   @return [String, nil]
-            optional :product_id, String
-
-            # @!attribute product_tags
-            #   If provided, the specifier will only apply to products with all the specified
-            #   tags.
-            #
-            #   @return [Array<String>, nil]
-            optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-            # @!method initialize(presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {MetronomeSDK::Models::V1::Customers::CreditCreateParams::Specifier} for more
-            #   details.
-            #
-            #   @param presentation_group_values [Hash{Symbol=>String}]
-            #
-            #   @param pricing_group_values [Hash{Symbol=>String}]
-            #
-            #   @param product_id [String] If provided, the specifier will only apply to the product with the specified ID.
-            #
-            #   @param product_tags [Array<String>] If provided, the specifier will only apply to products with all the specified ta
-          end
         end
       end
     end

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

@@ -4,6 +4,7 @@ module MetronomeSDK
   module Models
     module V1
       module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Alerts#list
         class CustomerAlert < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute alert
           #
@@ -91,19 +92,14 @@ module MetronomeSDK
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::CustomFieldFilter>, nil]
             optional :custom_field_filters,
-                     -> {
-                       MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::CustomFieldFilter]
-                     }
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::CustomFieldFilter] }
 
             # @!attribute group_key_filter
             #   Scopes alert evaluation to a specific presentation group key on individual line
             #   items. Only present for spend alerts.
             #
             #   @return [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupKeyFilter, nil]
-            optional :group_key_filter,
-                     -> {
-                       MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupKeyFilter
-                     }
+            optional :group_key_filter, -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupKeyFilter }
 
             # @!attribute group_values
             #   Only present for `spend_threshold_reached` alerts. Scope alert to a specific
@@ -111,9 +107,7 @@ module MetronomeSDK
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupValue>, nil]
             optional :group_values,
-                     -> {
-                       MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue]
-                     }
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue] }
 
             # @!attribute invoice_types_filter
             #   Only supported for invoice_total_reached alerts. A list of invoice types to
@@ -206,9 +200,7 @@ module MetronomeSDK
               #
               #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::CustomFieldFilter::Entity]
               required :entity,
-                       enum: -> {
-                         MetronomeSDK::V1::Customers::CustomerAlert::Alert::CustomFieldFilter::Entity
-                       }
+                       enum: -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::CustomFieldFilter::Entity }
 
               # @!attribute key
               #
@@ -266,10 +258,10 @@ module MetronomeSDK
 
               # @!attribute value
               #
-              #   @return [String]
-              required :value, String
+              #   @return [String, nil]
+              optional :value, String
 
-              # @!method initialize(key:, value:)
+              # @!method initialize(key:, value: nil)
               #   @param key [String]
               #   @param value [String]
             end

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
           #
@@ -56,6 +54,7 @@ module MetronomeSDK
           optional :billable_status, enum: -> { MetronomeSDK::V1::Customers::Invoice::BillableStatus }
 
           # @!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]
@@ -183,7 +182,7 @@ module MetronomeSDK
           #
           #   @param billable_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::BillableStatus] 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]
           #
@@ -237,6 +236,34 @@ module MetronomeSDK
             #   @return [Float]
             required :total, Float
 
+            # @!attribute type
+            #   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
+
             # @!attribute applied_commit_or_credit
             #   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`
@@ -247,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]
@@ -283,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]
@@ -371,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]
@@ -398,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]
@@ -419,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]
@@ -439,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]
@@ -460,7 +492,7 @@ module MetronomeSDK
             #   @return [Float, nil]
             optional :unit_price, Float
 
-            # @!method initialize(credit_type:, name:, total:, applied_commit_or_credit: nil, commit_custom_fields: nil, commit_id: nil, commit_netsuite_item_id: nil, commit_netsuite_sales_order_id: nil, commit_segment_id: nil, commit_type: nil, custom_fields: nil, discount_custom_fields: nil, discount_id: nil, ending_before: nil, group_key: nil, group_value: nil, is_prorated: nil, list_price: nil, metadata: nil, netsuite_invoice_billing_end: nil, netsuite_invoice_billing_start: nil, netsuite_item_id: nil, postpaid_commit: nil, presentation_group_values: nil, pricing_group_values: nil, product_custom_fields: nil, product_id: nil, product_tags: nil, product_type: nil, professional_service_custom_fields: nil, professional_service_id: nil, quantity: nil, reseller_type: nil, scheduled_charge_custom_fields: nil, scheduled_charge_id: nil, starting_at: nil, sub_line_items: nil, subscription_custom_fields: nil, tier: nil, unit_price: nil)
+            # @!method initialize(credit_type:, name:, total:, type:, applied_commit_or_credit: nil, commit_custom_fields: nil, commit_id: nil, commit_netsuite_item_id: nil, commit_netsuite_sales_order_id: nil, commit_segment_id: nil, commit_type: nil, custom_fields: nil, discount_custom_fields: nil, discount_id: nil, ending_before: nil, group_key: nil, group_value: nil, is_prorated: nil, list_price: nil, metadata: nil, netsuite_invoice_billing_end: nil, netsuite_invoice_billing_start: nil, netsuite_item_id: nil, postpaid_commit: nil, presentation_group_values: nil, pricing_group_values: nil, product_custom_fields: nil, product_id: nil, product_tags: nil, product_type: nil, professional_service_custom_fields: nil, professional_service_id: nil, quantity: nil, reseller_type: nil, scheduled_charge_custom_fields: nil, scheduled_charge_id: nil, starting_at: nil, sub_line_items: nil, subscription_custom_fields: nil, tier: nil, unit_price: nil)
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V1::Customers::Invoice::LineItem} for more details.
             #
@@ -470,9 +502,11 @@ module MetronomeSDK
             #
             #   @param total [Float]
             #
+            #   @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
             #
@@ -484,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.
             #
@@ -514,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.
             #
@@ -522,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]
             #
@@ -530,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.
             #
@@ -538,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.
             #
@@ -554,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
@@ -608,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]
@@ -660,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]
               #
@@ -826,17 +853,13 @@ 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
               #
@@ -978,6 +1001,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]
@@ -989,9 +1013,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
 
@@ -1010,10 +1038,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/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

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

@@ -10,6 +10,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]
@@ -33,10 +34,7 @@ module MetronomeSDK
         # @!attribute minimums
         #
         #   @return [Array<MetronomeSDK::Models::V1::PlanDetail::Minimum>, nil]
-        optional :minimums,
-                 -> {
-                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::Minimum]
-                 }
+        optional :minimums, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::Minimum] }
 
         # @!attribute overage_rates
         #
@@ -46,11 +44,17 @@ module MetronomeSDK
 
         # @!method initialize(id:, custom_fields:, name:, credit_grants: nil, description: nil, minimums: nil, overage_rates: nil)
         #   @param id [String]
-        #   @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]
+        #
         #   @param credit_grants [Array<MetronomeSDK::Models::V1::PlanDetail::CreditGrant>]
+        #
         #   @param description [String]
+        #
         #   @param minimums [Array<MetronomeSDK::Models::V1::PlanDetail::Minimum>]
+        #
         #   @param overage_rates [Array<MetronomeSDK::Models::V1::PlanDetail::OverageRate>]
 
         class CreditGrant < MetronomeSDK::Internal::Type::BaseModel

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

@@ -21,6 +21,7 @@ module MetronomeSDK
         required :credit_type, -> { MetronomeSDK::CreditTypeData }
 
         # @!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]
@@ -81,7 +82,7 @@ module MetronomeSDK
         #
         #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
         #
-        #   @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]
         #