metronome-sdk 1.0.0 → 2.1.0

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

@@ -9,21 +9,25 @@ module MetronomeSDK
         include MetronomeSDK::Internal::Type::RequestParameters
 
         # @!attribute id
-        #   The Metronome ID of the alert
+        #   The Metronome ID of the threshold notification
         #
         #   @return [String]
         required :id, String
 
         # @!attribute release_uniqueness_key
-        #   If true, resets the uniqueness key on this alert so it can be re-used
+        #   If true, resets the uniqueness key on this threshold notification so it can be
+        #   re-used
         #
         #   @return [Boolean, nil]
         optional :release_uniqueness_key, MetronomeSDK::Internal::Type::Boolean
 
         # @!method initialize(id:, release_uniqueness_key: nil, request_options: {})
-        #   @param id [String] The Metronome ID of the alert
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::AlertArchiveParams} for more details.
         #
-        #   @param release_uniqueness_key [Boolean] If true, resets the uniqueness key on this alert so it can be re-used
+        #   @param id [String] The Metronome ID of the threshold notification
+        #
+        #   @param release_uniqueness_key [Boolean] If true, resets the uniqueness key on this threshold notification so it can be r
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -9,41 +9,43 @@ module MetronomeSDK
         include MetronomeSDK::Internal::Type::RequestParameters
 
         # @!attribute alert_type
-        #   Type of the alert
+        #   Type of the threshold notification
         #
         #   @return [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType]
         required :alert_type, enum: -> { MetronomeSDK::V1::AlertCreateParams::AlertType }
 
         # @!attribute name
-        #   Name of the alert
+        #   Name of the threshold notification
         #
         #   @return [String]
         required :name, String
 
         # @!attribute threshold
-        #   Threshold value of the alert policy. Depending upon the alert type, this number
-        #   may represent a financial amount, the days remaining, or a percentage reached.
+        #   Threshold value of the notification policy. Depending upon the notification
+        #   type, this number may represent a financial amount, the days remaining, or a
+        #   percentage reached.
         #
         #   @return [Float]
         required :threshold, Float
 
         # @!attribute billable_metric_id
-        #   For alerts of type `usage_threshold_reached`, specifies which billable metric to
-        #   track the usage for.
+        #   For threshold notifications of type `usage_threshold_reached`, specifies which
+        #   billable metric to track the usage for.
         #
         #   @return [String, nil]
         optional :billable_metric_id, String
 
         # @!attribute credit_grant_type_filters
-        #   An array of strings, representing a way to filter the credit grant this alert
-        #   applies to, by looking at the credit_grant_type field on the credit grant. This
-        #   field is only defined for CreditPercentage and CreditBalance alerts
+        #   An array of strings, representing a way to filter the credit grant this
+        #   threshold notification applies to, by looking at the credit_grant_type field on
+        #   the credit grant. This field is only defined for CreditPercentage and
+        #   CreditBalance notifications
         #
         #   @return [Array<String>, nil]
         optional :credit_grant_type_filters, MetronomeSDK::Internal::Type::ArrayOf[String]
 
         # @!attribute credit_type_id
-        #   ID of the credit's currency, defaults to USD. If the specific alert type
+        #   ID of the credit's currency, defaults to USD. If the specific notification type
         #   requires a pricing unit/currency, find the ID in the
         #   [Metronome app](https://app.metronome.com/offering/pricing-units).
         #
@@ -51,46 +53,46 @@ module MetronomeSDK
         optional :credit_type_id, String
 
         # @!attribute custom_field_filters
-        #   A list of custom field filters for alert types that support advanced filtering.
-        #   Only present for contract invoices.
+        #   A list of custom field filters for threshold notification types that support
+        #   advanced filtering. Only present for contract invoices.
         #
         #   @return [Array<MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter>, nil]
         optional :custom_field_filters,
                  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::AlertCreateParams::CustomFieldFilter] }
 
         # @!attribute customer_id
-        #   If provided, will create this alert for this specific customer. To create an
-        #   alert for all customers, do not specify a `customer_id`.
+        #   If provided, will create this threshold notification for this specific customer.
+        #   To create a notification for all customers, do not specify a `customer_id`.
         #
         #   @return [String, nil]
         optional :customer_id, String
 
         # @!attribute evaluate_on_create
-        #   If true, the alert will evaluate immediately on customers that already meet the
-        #   alert threshold. If false, it will only evaluate on future customers that
-        #   trigger the alert threshold. Defaults to true.
+        #   If true, the threshold notification will evaluate immediately on customers that
+        #   already meet the notification threshold. If false, it will only evaluate on
+        #   future customers that trigger the threshold. Defaults to true.
         #
         #   @return [Boolean, nil]
         optional :evaluate_on_create, MetronomeSDK::Internal::Type::Boolean
 
         # @!attribute group_values
-        #   Only present for `spend_threshold_reached` alerts. Scope alert to a specific
-        #   group key on individual line items.
+        #   Only present for `spend_threshold_reached` notifications. Scope notification to
+        #   a specific group key on individual line items.
         #
         #   @return [Array<MetronomeSDK::Models::V1::AlertCreateParams::GroupValue>, nil]
         optional :group_values,
                  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::AlertCreateParams::GroupValue] }
 
         # @!attribute invoice_types_filter
-        #   Only supported for invoice_total_reached alerts. A list of invoice types to
-        #   evaluate.
+        #   Only supported for invoice_total_reached threshold notifications. A list of
+        #   invoice types to evaluate.
         #
         #   @return [Array<String>, nil]
         optional :invoice_types_filter, MetronomeSDK::Internal::Type::ArrayOf[String]
 
         # @!attribute plan_id
-        #   If provided, will create this alert for this specific plan. To create an alert
-        #   for all customers, do not specify a `plan_id`.
+        #   If provided, will create this threshold notification for this specific plan. To
+        #   create a notification for all customers, do not specify a `plan_id`.
         #
         #   @return [String, nil]
         optional :plan_id, String
@@ -107,35 +109,35 @@ module MetronomeSDK
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V1::AlertCreateParams} for more details.
         #
-        #   @param alert_type [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType] Type of the alert
+        #   @param alert_type [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType] Type of the threshold notification
         #
-        #   @param name [String] Name of the alert
+        #   @param name [String] Name of the threshold notification
         #
-        #   @param threshold [Float] Threshold value of the alert policy. Depending upon the alert type, this number
+        #   @param threshold [Float] Threshold value of the notification policy. Depending upon the notification typ
         #
-        #   @param billable_metric_id [String] For alerts of type `usage_threshold_reached`, specifies which billable metric to
+        #   @param billable_metric_id [String] For threshold notifications of type `usage_threshold_reached`, specifies which b
         #
-        #   @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this alert ap
+        #   @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this threshol
         #
-        #   @param credit_type_id [String] ID of the credit's currency, defaults to USD. If the specific alert type require
+        #   @param credit_type_id [String] ID of the credit's currency, defaults to USD. If the specific notification type
         #
-        #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter>] A list of custom field filters for alert types that support advanced filtering.
+        #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter>] A list of custom field filters for threshold notification types that support adv
         #
-        #   @param customer_id [String] If provided, will create this alert for this specific customer. To create an ale
+        #   @param customer_id [String] If provided, will create this threshold notification for this specific customer.
         #
-        #   @param evaluate_on_create [Boolean] If true, the alert will evaluate immediately on customers that already meet the
+        #   @param evaluate_on_create [Boolean] If true, the threshold notification will evaluate immediately on customers that
         #
-        #   @param group_values [Array<MetronomeSDK::Models::V1::AlertCreateParams::GroupValue>] Only present for `spend_threshold_reached` alerts. Scope alert to a specific gro
+        #   @param group_values [Array<MetronomeSDK::Models::V1::AlertCreateParams::GroupValue>] Only present for `spend_threshold_reached` notifications. Scope notification to
         #
-        #   @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached alerts. A list of invoice types to eval
+        #   @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached threshold notifications. A list of invo
         #
-        #   @param plan_id [String] If provided, will create this alert for this specific plan. To create an alert f
+        #   @param plan_id [String] If provided, will create this threshold notification for this specific plan. To
         #
         #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
-        # Type of the alert
+        # Type of the threshold notification
         module AlertType
           extend MetronomeSDK::Internal::Type::Enum
 

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

@@ -702,6 +702,7 @@ module MetronomeSDK
               NONE = :NONE
               STRIPE = :STRIPE
               ANROK = :ANROK
+              AVALARA = :AVALARA
               PRECALCULATED = :PRECALCULATED
 
               # @!method self.values

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

@@ -927,6 +927,7 @@ module MetronomeSDK
               NONE = :NONE
               STRIPE = :STRIPE
               ANROK = :ANROK
+              AVALARA = :AVALARA
               PRECALCULATED = :PRECALCULATED
 
               # @!method self.values
@@ -1347,11 +1348,52 @@ module MetronomeSDK
         class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute parent
           #
-          #   @return [MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::Parent]
-          required :parent, -> { MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Parent }
+          #   @return [MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::Parent, nil]
+          optional :parent, -> { MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Parent }
 
-          # @!method initialize(parent:)
+          # @!attribute parent_behavior
+          #
+          #   @return [MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior, nil]
+          optional :parent_behavior,
+                   -> { MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior }
+
+          # @!attribute payer
+          #   Account hierarchy M3 - Indicates which customer should pay for the child's
+          #   invoice charges
+          #
+          #   **SELF**: The child pays for its own invoice charges
+          #
+          #   **PARENT**: The parent pays for the child's invoice charges
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::Payer, nil]
+          optional :payer, enum: -> { MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Payer }
+
+          # @!attribute usage_statement_behavior
+          #   Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+          #   on the parent's invoices.
+          #
+          #   **CONSOLIDATE**: Child's invoice statements will be added to parent's
+          #   consolidated invoices
+          #
+          #   **SEPARATE**: Child's invoice statements will appear not appear on parent's
+          #   consolidated invoices
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior, nil]
+          optional :usage_statement_behavior,
+                   enum: -> { MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior }
+
+          # @!method initialize(parent: nil, parent_behavior: nil, payer: nil, usage_statement_behavior: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration} for
+          #   more details.
+          #
           #   @param parent [MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::Parent]
+          #
+          #   @param parent_behavior [MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior]
+          #
+          #   @param payer [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::Payer] Account hierarchy M3 - Indicates which customer should pay for the child's invoi
+          #
+          #   @param usage_statement_behavior [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior] Account hierarchy M3 - Indicates the behavior of the child's invoice statements
 
           # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration#parent
           class Parent < MetronomeSDK::Internal::Type::BaseModel
@@ -1369,6 +1411,86 @@ module MetronomeSDK
             #   @param contract_id [String]
             #   @param customer_id [String]
           end
+
+          # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration#parent_behavior
+          class ParentBehavior < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute invoice_consolidation_type
+            #   Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+            #   generated by the parent in a customer hierarchy
+            #
+            #   **CONCATENATE**: Statements on the invoices of child customers will be appended
+            #   to the consolidated invoice
+            #
+            #   **NONE**: Do not generate consolidated invoices
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType, nil]
+            optional :invoice_consolidation_type,
+                     enum: -> { MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType }
+
+            # @!method initialize(invoice_consolidation_type: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior}
+            #   for more details.
+            #
+            #   @param invoice_consolidation_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType] Account hierarchy M3 - Indicates the desired behavior of consolidated invoices g
+
+            # Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+            # generated by the parent in a customer hierarchy
+            #
+            # **CONCATENATE**: Statements on the invoices of child customers will be appended
+            # to the consolidated invoice
+            #
+            # **NONE**: Do not generate consolidated invoices
+            #
+            # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior#invoice_consolidation_type
+            module InvoiceConsolidationType
+              extend MetronomeSDK::Internal::Type::Enum
+
+              CONCATENATE = :CONCATENATE
+              NONE = :NONE
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # Account hierarchy M3 - Indicates which customer should pay for the child's
+          # invoice charges
+          #
+          # **SELF**: The child pays for its own invoice charges
+          #
+          # **PARENT**: The parent pays for the child's invoice charges
+          #
+          # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration#payer
+          module Payer
+            extend MetronomeSDK::Internal::Type::Enum
+
+            SELF = :SELF
+            PARENT = :PARENT
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+          # on the parent's invoices.
+          #
+          # **CONSOLIDATE**: Child's invoice statements will be added to parent's
+          # consolidated invoices
+          #
+          # **SEPARATE**: Child's invoice statements will appear not appear on parent's
+          # consolidated invoices
+          #
+          # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration#usage_statement_behavior
+          module UsageStatementBehavior
+            extend MetronomeSDK::Internal::Type::Enum
+
+            CONSOLIDATE = :CONSOLIDATE
+            SEPARATE = :SEPARATE
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
 
         # Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list
@@ -2125,20 +2247,26 @@ module MetronomeSDK
             required :subscription_id, String
 
             # @!attribute allocation
-            #   If set to POOLED, allocation added per seat is pooled across the account.
+            #   If set to POOLED, allocation added per seat is pooled across the account. (BETA)
+            #   If set to INDIVIDUAL, each seat in the subscription will have its own
+            #   allocation.
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation, nil]
             optional :allocation,
                      enum: -> { MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation }
 
             # @!method initialize(apply_seat_increase_config:, subscription_id:, allocation: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig}
+            #   for more details.
+            #
             #   Attach a subscription to the recurring commit/credit.
             #
             #   @param apply_seat_increase_config [MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig]
             #
             #   @param subscription_id [String] ID of the subscription to configure on the recurring commit/credit.
             #
-            #   @param allocation [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account.
+            #   @param allocation [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account. (BETA)
 
             # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig#apply_seat_increase_config
             class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
@@ -2152,7 +2280,9 @@ module MetronomeSDK
               #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
             end
 
-            # If set to POOLED, allocation added per seat is pooled across the account.
+            # If set to POOLED, allocation added per seat is pooled across the account. (BETA)
+            # If set to INDIVIDUAL, each seat in the subscription will have its own
+            # allocation.
             #
             # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig#allocation
             module Allocation
@@ -2466,20 +2596,26 @@ module MetronomeSDK
             required :subscription_id, String
 
             # @!attribute allocation
-            #   If set to POOLED, allocation added per seat is pooled across the account.
+            #   If set to POOLED, allocation added per seat is pooled across the account. (BETA)
+            #   If set to INDIVIDUAL, each seat in the subscription will have its own
+            #   allocation.
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation, nil]
             optional :allocation,
                      enum: -> { MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation }
 
             # @!method initialize(apply_seat_increase_config:, subscription_id:, allocation: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig}
+            #   for more details.
+            #
             #   Attach a subscription to the recurring commit/credit.
             #
             #   @param apply_seat_increase_config [MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig]
             #
             #   @param subscription_id [String] ID of the subscription to configure on the recurring commit/credit.
             #
-            #   @param allocation [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account.
+            #   @param allocation [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account. (BETA)
 
             # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig#apply_seat_increase_config
             class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
@@ -2493,7 +2629,9 @@ module MetronomeSDK
               #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
             end
 
-            # If set to POOLED, allocation added per seat is pooled across the account.
+            # If set to POOLED, allocation added per seat is pooled across the account. (BETA)
+            # If set to INDIVIDUAL, each seat in the subscription will have its own
+            # allocation.
             #
             # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig#allocation
             module Allocation
@@ -2936,6 +3074,11 @@ module MetronomeSDK
           #   QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
           #   directly on the subscription. `initial_quantity` must be provided with this
           #   option. Compatible with recurring commits/credits that use POOLED allocation.
+          #   **SEAT_BASED**: (BETA) Use when you want to pass specific seat identifiers (e.g.
+          #   add user_123) to increment and decrement a subscription quantity, rather than
+          #   directly providing the quantity. You must use a **SEAT_BASED** subscription to
+          #   use a linked recurring credit with an allocation per seat. `seat_config` must be
+          #   provided with this option.
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Subscription::QuantityManagementMode, nil]
           optional :quantity_management_mode,
@@ -3084,6 +3227,11 @@ module MetronomeSDK
           # QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
           # directly on the subscription. `initial_quantity` must be provided with this
           # option. Compatible with recurring commits/credits that use POOLED allocation.
+          # **SEAT_BASED**: (BETA) Use when you want to pass specific seat identifiers (e.g.
+          # add user_123) to increment and decrement a subscription quantity, rather than
+          # directly providing the quantity. You must use a **SEAT_BASED** subscription to
+          # use a linked recurring credit with an allocation per seat. `seat_config` must be
+          # provided with this option.
           #
           # @see MetronomeSDK::Models::V1::ContractCreateParams::Subscription#quantity_management_mode
           module QuantityManagementMode

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

@@ -30,6 +30,12 @@ module MetronomeSDK
         #   @return [Time, nil]
         optional :effective_before, Time
 
+        # @!attribute exclude_zero_balances
+        #   Exclude balances with zero amounts from the response.
+        #
+        #   @return [Boolean, nil]
+        optional :exclude_zero_balances, MetronomeSDK::Internal::Type::Boolean
+
         # @!attribute include_archived
         #   Include archived credits and credits from archived contracts.
         #
@@ -74,7 +80,7 @@ module MetronomeSDK
         #   @return [Time, nil]
         optional :starting_at, Time
 
-        # @!method initialize(customer_id:, id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_balances: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {})
+        # @!method initialize(customer_id:, id: nil, covering_date: nil, effective_before: nil, exclude_zero_balances: nil, include_archived: nil, include_balance: nil, include_contract_balances: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V1::ContractListBalancesParams} for more details.
         #
@@ -86,6 +92,8 @@ module MetronomeSDK
         #
         #   @param effective_before [Time] Include only balances that have any access before the provided date (exclusive)
         #
+        #   @param exclude_zero_balances [Boolean] Exclude balances with zero amounts from the response.
+        #
         #   @param include_archived [Boolean] Include archived credits and credits from archived contracts.
         #
         #   @param include_balance [Boolean] Include the balance of credits and commits in the response. Setting this flag ma

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

@@ -91,12 +91,18 @@ module MetronomeSDK
           optional :aws_region, enum: -> { MetronomeSDK::V1::CustomerCreateParams::BillingConfig::AwsRegion }
 
           # @!attribute stripe_collection_method
+          #   The collection method for the customer's invoices. NOTE:
+          #   `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig::StripeCollectionMethod, nil]
           optional :stripe_collection_method,
                    enum: -> { MetronomeSDK::V1::CustomerCreateParams::BillingConfig::StripeCollectionMethod }
 
           # @!method initialize(billing_provider_customer_id:, billing_provider_type:, aws_is_subscription_product: nil, aws_product_code: nil, aws_region: nil, stripe_collection_method: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig} for more
+          #   details.
+          #
           #   @param billing_provider_customer_id [String]
           #
           #   @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig::BillingProviderType]
@@ -107,7 +113,7 @@ module MetronomeSDK
           #
           #   @param aws_region [Symbol, MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig::AwsRegion]
           #
-          #   @param stripe_collection_method [Symbol, MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig::StripeCollectionMethod]
+          #   @param stripe_collection_method [Symbol, MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig::StripeCollectionMethod] The collection method for the customer's invoices.
 
           # @see MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig#billing_provider_type
           module BillingProviderType
@@ -121,6 +127,7 @@ module MetronomeSDK
             QUICKBOOKS_ONLINE = :quickbooks_online
             WORKDAY = :workday
             GCP_MARKETPLACE = :gcp_marketplace
+            METRONOME = :metronome
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -160,6 +167,9 @@ module MetronomeSDK
             #   @return [Array<Symbol>]
           end
 
+          # The collection method for the customer's invoices. NOTE:
+          # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
+          #
           # @see MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig#stripe_collection_method
           module StripeCollectionMethod
             extend MetronomeSDK::Internal::Type::Enum

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

@@ -47,6 +47,12 @@ module MetronomeSDK
         #   @return [String]
         required :name, String
 
+        # @!attribute updated_at
+        #   RFC 3339 timestamp indicating when the customer was last updated.
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
         # @!attribute archived_at
         #   RFC 3339 timestamp indicating when the customer was archived. Null if the
         #   customer is active.
@@ -60,7 +66,7 @@ module MetronomeSDK
         #   @return [MetronomeSDK::Models::V1::CustomerDetail::CurrentBillableStatus, nil]
         optional :current_billable_status, -> { MetronomeSDK::V1::CustomerDetail::CurrentBillableStatus }
 
-        # @!method initialize(id:, created_at:, custom_fields:, customer_config:, external_id:, ingest_aliases:, name:, archived_at: nil, current_billable_status: nil)
+        # @!method initialize(id:, created_at:, custom_fields:, customer_config:, external_id:, ingest_aliases:, name:, updated_at:, archived_at: nil, current_billable_status: nil)
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V1::CustomerDetail} for more details.
         #
@@ -78,6 +84,8 @@ module MetronomeSDK
         #
         #   @param name [String]
         #
+        #   @param updated_at [Time] RFC 3339 timestamp indicating when the customer was last updated.
+        #
         #   @param archived_at [Time, nil] RFC 3339 timestamp indicating when the customer was archived. Null if the custom
         #
         #   @param current_billable_status [MetronomeSDK::Models::V1::CustomerDetail::CurrentBillableStatus] This field's availability is dependent on your client's configuration.