metronome-sdk 2.0.0 → 2.2.0

data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb

@@ -1854,6 +1854,11 @@ module MetronomeSDK
             #   @return [Array<String>, nil]
             optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
 
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            optional :description, String
+
             # @!attribute hierarchy_configuration
             #   Optional configuration for commit hierarchy access control
             #
@@ -1913,7 +1918,7 @@ module MetronomeSDK
                      -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] },
                      nil?: true
 
-            # @!method initialize(id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, product_id: nil, rate_type: nil, rollover_fraction: nil, specifiers: nil)
+            # @!method initialize(id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, hierarchy_configuration: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, product_id: nil, rate_type: nil, rollover_fraction: nil, specifiers: nil)
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit}
             #   for more details.
@@ -1926,6 +1931,8 @@ module MetronomeSDK
             #
             #   @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If applicable*product_ids, applicable_product*
             #
+            #   @param description [String]
+            #
             #   @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for commit hierarchy access control
             #
             #   @param invoice_schedule [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit::InvoiceSchedule]
@@ -2187,6 +2194,11 @@ module MetronomeSDK
             optional :access_schedule,
                      -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCredit::AccessSchedule }
 
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            optional :description, String
+
             # @!attribute hierarchy_configuration
             #   Optional configuration for credit hierarchy access control
             #
@@ -2222,7 +2234,7 @@ module MetronomeSDK
             #   @return [Float, nil]
             optional :rollover_fraction, Float, nil?: true
 
-            # @!method initialize(id:, access_schedule: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, rollover_fraction: nil)
+            # @!method initialize(id:, access_schedule: nil, description: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, rollover_fraction: nil)
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCredit}
             #   for more details.
@@ -2231,6 +2243,8 @@ module MetronomeSDK
             #
             #   @param access_schedule [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCredit::AccessSchedule]
             #
+            #   @param description [String]
+            #
             #   @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for credit hierarchy access control
             #
             #   @param name [String]
@@ -3051,10 +3065,21 @@ module MetronomeSDK
             optional :quantity_updates,
                      -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::QuantityUpdate] }
 
-            # @!method initialize(id:, ending_before: nil, quantity_updates: nil)
+            # @!attribute seat_updates
+            #   Manage subscription seats for subscriptions in SEAT_BASED mode.
+            #
+            #   @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates, nil]
+            optional :seat_updates,
+                     -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates }
+
+            # @!method initialize(id:, ending_before: nil, quantity_updates: nil, seat_updates: nil)
             #   @param id [String]
+            #
             #   @param ending_before [Time]
+            #
             #   @param quantity_updates [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::QuantityUpdate>]
+            #
+            #   @param seat_updates [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates] Manage subscription seats for subscriptions in SEAT_BASED mode.
 
             class QuantityUpdate < MetronomeSDK::Internal::Type::BaseModel
               # @!attribute starting_at
@@ -3077,6 +3102,155 @@ module MetronomeSDK
               #   @param quantity [Float]
               #   @param quantity_delta [Float]
             end
+
+            # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription#seat_updates
+            class SeatUpdates < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute add_seat_ids
+              #   Adds seat IDs to the subscription. If there are unassigned seats, the new seat
+              #   IDs will fill these unassigned seats and not increase the total subscription
+              #   quantity. Otherwise, if there are more new seat IDs than unassigned seats, the
+              #   total subscription quantity will increase.
+              #
+              #   @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddSeatID>, nil]
+              optional :add_seat_ids,
+                       -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddSeatID] }
+
+              # @!attribute add_unassigned_seats
+              #   Adds unassigned seats to the subscription. This will increase the total
+              #   subscription quantity.
+              #
+              #   @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddUnassignedSeat>, nil]
+              optional :add_unassigned_seats,
+                       -> do
+                         MetronomeSDK::Internal::Type::ArrayOf[
+                           MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddUnassignedSeat
+                         ]
+                       end
+
+              # @!attribute remove_seat_ids
+              #   Removes seat IDs from the subscription, if possible. If a seat ID is removed,
+              #   the total subscription quantity will decrease. Otherwise, if the seat ID is not
+              #   found on the subscription, this is a no-op.
+              #
+              #   @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveSeatID>, nil]
+              optional :remove_seat_ids,
+                       -> do
+                         MetronomeSDK::Internal::Type::ArrayOf[
+                           MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveSeatID
+                         ]
+                       end
+
+              # @!attribute remove_unassigned_seats
+              #   Removes unassigned seats from the subscription. This will decrease the total
+              #   subscription quantity if there are are unassigned seats.
+              #
+              #   @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveUnassignedSeat>, nil]
+              optional :remove_unassigned_seats,
+                       -> do
+                         MetronomeSDK::Internal::Type::ArrayOf[
+                           MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveUnassignedSeat
+                         ]
+                       end
+
+              # @!method initialize(add_seat_ids: nil, add_unassigned_seats: nil, remove_seat_ids: nil, remove_unassigned_seats: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates}
+              #   for more details.
+              #
+              #   Manage subscription seats for subscriptions in SEAT_BASED mode.
+              #
+              #   @param add_seat_ids [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddSeatID>] Adds seat IDs to the subscription. If there are unassigned seats, the new seat
+              #
+              #   @param add_unassigned_seats [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddUnassignedSeat>] Adds unassigned seats to the subscription. This will increase the total subscrip
+              #
+              #   @param remove_seat_ids [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveSeatID>] Removes seat IDs from the subscription, if possible. If a seat ID is removed, t
+              #
+              #   @param remove_unassigned_seats [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveUnassignedSeat>] Removes unassigned seats from the subscription. This will decrease the total sub
+
+              class AddSeatID < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute seat_ids
+                #
+                #   @return [Array<String>]
+                required :seat_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+                # @!attribute starting_at
+                #   Assigned seats will be added/removed starting at this date.
+                #
+                #   @return [Time]
+                required :starting_at, Time
+
+                # @!method initialize(seat_ids:, starting_at:)
+                #   @param seat_ids [Array<String>]
+                #
+                #   @param starting_at [Time] Assigned seats will be added/removed starting at this date.
+              end
+
+              class AddUnassignedSeat < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute quantity
+                #   The number of unassigned seats on the subscription will increase/decrease by
+                #   this delta. Must be greater than 0.
+                #
+                #   @return [Float]
+                required :quantity, Float
+
+                # @!attribute starting_at
+                #   Unassigned seats will be updated starting at this date.
+                #
+                #   @return [Time]
+                required :starting_at, Time
+
+                # @!method initialize(quantity:, starting_at:)
+                #   Some parameter documentations has been truncated, see
+                #   {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddUnassignedSeat}
+                #   for more details.
+                #
+                #   @param quantity [Float] The number of unassigned seats on the subscription will increase/decrease by thi
+                #
+                #   @param starting_at [Time] Unassigned seats will be updated starting at this date.
+              end
+
+              class RemoveSeatID < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute seat_ids
+                #
+                #   @return [Array<String>]
+                required :seat_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+                # @!attribute starting_at
+                #   Assigned seats will be added/removed starting at this date.
+                #
+                #   @return [Time]
+                required :starting_at, Time
+
+                # @!method initialize(seat_ids:, starting_at:)
+                #   @param seat_ids [Array<String>]
+                #
+                #   @param starting_at [Time] Assigned seats will be added/removed starting at this date.
+              end
+
+              class RemoveUnassignedSeat < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute quantity
+                #   The number of unassigned seats on the subscription will increase/decrease by
+                #   this delta. Must be greater than 0.
+                #
+                #   @return [Float]
+                required :quantity, Float
+
+                # @!attribute starting_at
+                #   Unassigned seats will be updated starting at this date.
+                #
+                #   @return [Time]
+                required :starting_at, Time
+
+                # @!method initialize(quantity:, starting_at:)
+                #   Some parameter documentations has been truncated, see
+                #   {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveUnassignedSeat}
+                #   for more details.
+                #
+                #   @param quantity [Float] The number of unassigned seats on the subscription will increase/decrease by thi
+                #
+                #   @param starting_at [Time] Unassigned seats will be updated starting at this date.
+              end
+            end
           end
         end
       end

data/lib/metronome_sdk/resources/v1/alerts.rb

@@ -53,7 +53,7 @@ module MetronomeSDK
         #   threshold notification evaluations in real-time as usage events stream in,
         #   unlike competitors who rely on periodic polling or batch evaluation cycles
         #
-        # @overload create(alert_type:, name:, threshold:, billable_metric_id: nil, credit_grant_type_filters: nil, credit_type_id: nil, custom_field_filters: nil, customer_id: nil, evaluate_on_create: nil, group_values: nil, invoice_types_filter: nil, plan_id: nil, uniqueness_key: nil, request_options: {})
+        # @overload create(alert_type:, name:, threshold:, billable_metric_id: nil, credit_grant_type_filters: nil, credit_type_id: nil, custom_field_filters: nil, customer_id: nil, evaluate_on_create: nil, group_values: nil, invoice_types_filter: nil, plan_id: nil, seat_filter: nil, uniqueness_key: nil, request_options: {})
         #
         # @param alert_type [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType] Type of the threshold notification
         #
@@ -79,6 +79,8 @@ module MetronomeSDK
         #
         # @param plan_id [String] If provided, will create this threshold notification for this specific plan. To
         #
+        # @param seat_filter [MetronomeSDK::Models::V1::AlertCreateParams::SeatFilter] Required for `low_remaining_seat_balance_reached` notifications. The alert is sc
+        #
         # @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}, nil]

data/lib/metronome_sdk/resources/v1/contracts.rb

@@ -140,7 +140,7 @@ module MetronomeSDK
         #   `usage_filters` to route the correct usage to each contract.
         #   [Read more about usage filters](https://docs.metronome.com/manage-product-access/provision-customer/#create-a-usage-filter).
         #
-        # @overload create(customer_id:, starting_at:, billing_provider_configuration: nil, commits: nil, credits: nil, custom_fields: nil, discounts: nil, ending_before: nil, hierarchy_configuration: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, overrides: nil, prepaid_balance_threshold_configuration: nil, priority: nil, professional_services: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, reseller_royalties: nil, salesforce_opportunity_id: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, total_contract_value: nil, transition: nil, uniqueness_key: nil, usage_filter: nil, usage_statement_schedule: nil, request_options: {})
+        # @overload create(customer_id:, starting_at:, billing_provider_configuration: nil, commits: nil, credits: nil, custom_fields: nil, discounts: nil, ending_before: nil, hierarchy_configuration: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, overrides: nil, prepaid_balance_threshold_configuration: nil, priority: nil, professional_services: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, reseller_royalties: nil, revenue_system_configuration: nil, salesforce_opportunity_id: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, total_contract_value: nil, transition: nil, uniqueness_key: nil, usage_filter: nil, usage_statement_schedule: nil, request_options: {})
         #
         # @param customer_id [String]
         #
@@ -186,6 +186,8 @@ module MetronomeSDK
         #
         # @param reseller_royalties [Array<MetronomeSDK::Models::V1::ContractCreateParams::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
         #
+        # @param revenue_system_configuration [MetronomeSDK::Models::V1::ContractCreateParams::RevenueSystemConfiguration] The revenue system configuration associated with a contract. Provide either an I
+        #
         # @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
         #
         # @param scheduled_charges [Array<MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge>]
@@ -318,7 +320,7 @@ module MetronomeSDK
         # upstream of the commit, whether that is via contract editing, rate editing, or
         # other actions that cause an invoice to be recalculated.
         #
-        # @overload add_manual_balance_entry(id:, amount:, customer_id:, reason:, segment_id:, contract_id: nil, timestamp: nil, request_options: {})
+        # @overload add_manual_balance_entry(id:, amount:, customer_id:, reason:, segment_id:, contract_id: nil, per_group_amounts: nil, timestamp: nil, request_options: {})
         #
         # @param id [String] ID of the balance (commit or credit) to update.
         #
@@ -332,6 +334,8 @@ module MetronomeSDK
         #
         # @param contract_id [String] ID of the contract to update. Leave blank to update a customer level balance.
         #
+        # @param per_group_amounts [Hash{Symbol=>Float}] If using individually configured commits/credits attached to seat managed subscr
+        #
         # @param timestamp [Time] RFC 3339 timestamp indicating when the manual adjustment takes place. If not pro
         #
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -352,7 +356,7 @@ module MetronomeSDK
 
         # Amendments will be replaced by Contract editing. New clients should implement
         # using the `editContract` endpoint. Read more about the migration to contract
-        # editing [here](https://docs.metronome.com/migrate-amendments-to-edits/) and
+        # editing [here](/guides/implement-metronome/migrate-amendments-to-edits/) and
         # reach out to your Metronome representative for more details. Once contract
         # editing is enabled, access to this endpoint will be removed.
         #
@@ -514,7 +518,7 @@ module MetronomeSDK
         #   segments
         # - Manual adjustments: Includes all manual ledger entries, even future-dated ones
         #
-        # @overload list_balances(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: {})
+        # @overload list_balances(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: {})
         #
         # @param customer_id [String]
         #
@@ -524,6 +528,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/resources/v1/credit_grants.rb

@@ -7,7 +7,8 @@ module MetronomeSDK
         # Some parameter documentations has been truncated, see
         # {MetronomeSDK::Models::V1::CreditGrantCreateParams} for more details.
         #
-        # Create a new credit grant
+        # Create a new credit grant. This is a Plans (deprecated) endpoint. New clients
+        # should implement using Contracts.
         #
         # @overload create(customer_id:, expires_at:, grant_amount:, name:, paid_amount:, priority:, credit_grant_type: nil, custom_fields: nil, effective_at: nil, invoice_date: nil, product_ids: nil, reason: nil, rollover_settings: nil, uniqueness_key: nil, request_options: {})
         #
@@ -58,7 +59,8 @@ module MetronomeSDK
         # Some parameter documentations has been truncated, see
         # {MetronomeSDK::Models::V1::CreditGrantListParams} for more details.
         #
-        # List credit grants. This list does not included voided grants.
+        # List credit grants. This list does not included voided grants. This is a Plans
+        # (deprecated) endpoint. New clients should implement using Contracts.
         #
         # @overload list(limit: nil, next_page: nil, credit_grant_ids: nil, credit_type_ids: nil, customer_ids: nil, effective_before: nil, not_expiring_before: nil, request_options: {})
         #
@@ -95,7 +97,8 @@ module MetronomeSDK
           )
         end
 
-        # Edit an existing credit grant
+        # Edit an existing credit grant. This is a Plans (deprecated) endpoint. New
+        # clients should implement using Contracts.
         #
         # @overload edit(id:, credit_grant_type: nil, expires_at: nil, name: nil, request_options: {})
         #
@@ -128,7 +131,8 @@ module MetronomeSDK
         #
         # Fetches a list of credit ledger entries. Returns lists of ledgers per customer.
         # Ledger entries are returned in chronological order. Ledger entries associated
-        # with voided credit grants are not included.
+        # with voided credit grants are not included. This is a Plans (deprecated)
+        # endpoint. New clients should implement using Contracts.
         #
         # @overload list_entries(next_page: nil, sort: nil, credit_type_ids: nil, customer_ids: nil, ending_before: nil, starting_on: nil, request_options: {})
         #
@@ -164,7 +168,8 @@ module MetronomeSDK
           )
         end
 
-        # Void a credit grant
+        # Void a credit grant. This is a Plans (deprecated) endpoint. New clients should
+        # implement using Contracts.
         #
         # @overload void(id:, release_uniqueness_key: nil, void_credit_purchase_invoice: nil, request_options: {})
         #

data/lib/metronome_sdk/resources/v1/customers/alerts.rb

@@ -64,7 +64,7 @@ module MetronomeSDK
           # - Error handling: Returns 404 if either the customer or alert_id doesn't exist
           #   or isn't accessible to your organization
           #
-          # @overload retrieve(alert_id:, customer_id:, group_values: nil, plans_or_contracts: nil, request_options: {})
+          # @overload retrieve(alert_id:, customer_id:, group_values: nil, plans_or_contracts: nil, seat_filter: nil, request_options: {})
           #
           # @param alert_id [String] The Metronome ID of the threshold notification
           #
@@ -74,6 +74,8 @@ module MetronomeSDK
           #
           # @param plans_or_contracts [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::PlansOrContracts] When parallel threshold notifications are enabled during migration, this flag de
           #
+          # @param seat_filter [MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::SeatFilter] Only allowed for `low_remaining_seat_balance_reached` notifications. This filter
+          #
           # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [MetronomeSDK::Models::V1::Customers::AlertRetrieveResponse]

data/lib/metronome_sdk/resources/v1/customers/billing_config.rb

@@ -9,9 +9,10 @@ module MetronomeSDK
           # {MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams} for more
           # details.
           #
-          # Set the billing configuration for a given customer.
+          # Set the billing configuration for a given customer. This is a Plans (deprecated)
+          # endpoint. New clients should implement using Contracts.
           #
-          # @overload create(customer_id:, billing_provider_type:, billing_provider_customer_id:, aws_product_code: nil, aws_region: nil, stripe_collection_method: nil, request_options: {})
+          # @overload create(customer_id:, billing_provider_type:, billing_provider_customer_id:, aws_customer_account_id: nil, aws_customer_id: nil, aws_product_code: nil, aws_region: nil, stripe_collection_method: nil, request_options: {})
           #
           # @param customer_id [String] Path param:
           #
@@ -19,11 +20,15 @@ module MetronomeSDK
           #
           # @param billing_provider_customer_id [String] Body param: The customer ID in the billing provider's system. For Azure, this is
           #
+          # @param aws_customer_account_id [String] Body param:
+          #
+          # @param aws_customer_id [String] Body param:
+          #
           # @param aws_product_code [String] Body param:
           #
           # @param aws_region [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::AwsRegion] Body param:
           #
-          # @param stripe_collection_method [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod] Body param:
+          # @param stripe_collection_method [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod] Body param: The collection method for the customer's invoices.
           #
           # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -49,7 +54,8 @@ module MetronomeSDK
             )
           end
 
-          # Fetch the billing configuration for the given customer.
+          # Fetch the billing configuration for the given customer. This is a Plans
+          # (deprecated) endpoint. New clients should implement using Contracts.
           #
           # @overload retrieve(customer_id:, billing_provider_type:, request_options: {})
           #
@@ -81,7 +87,8 @@ module MetronomeSDK
           end
 
           # Delete the billing configuration for a given customer. Note: this is unsupported
-          # for Azure and AWS Marketplace customers.
+          # for Azure and AWS Marketplace customers. This is a Plans (deprecated) endpoint.
+          # New clients should implement using Contracts.
           #
           # @overload delete(customer_id:, billing_provider_type:, request_options: {})
           #

data/lib/metronome_sdk/resources/v1/customers/commits.rb

@@ -37,7 +37,8 @@ module MetronomeSDK
           # #### Billing configuration:
           #
           # - invoice_contract_id is required for postpaid commits and for prepaid commits
-          #   with billing (only optional for free prepaid commits)
+          #   with billing (only optional for free prepaid commits) unless do_not_invoice is
+          #   set to true
           # - For postpaid commits: access_schedule and invoice_schedule must have matching
           #   amounts
           # - For postpaid commits: only one schedule item is allowed in both schedules.

data/lib/metronome_sdk/resources/v1/customers/invoices.rb

@@ -175,7 +175,8 @@ module MetronomeSDK
           # Some parameter documentations has been truncated, see
           # {MetronomeSDK::Models::V1::Customers::InvoiceAddChargeParams} for more details.
           #
-          # Add a one time charge to the specified invoice
+          # Add a one time charge to the specified invoice. This is a Plans (deprecated)
+          # endpoint. New clients should implement using Contracts.
           #
           # @overload add_charge(customer_id:, charge_id:, customer_plan_id:, description:, invoice_start_timestamp:, price:, quantity:, request_options: {})
           #

data/lib/metronome_sdk/resources/v1/customers/plans.rb

@@ -5,7 +5,8 @@ module MetronomeSDK
     class V1
       class Customers
         class Plans
-          # List the given customer's plans in reverse-chronological order.
+          # List the given customer's plans in reverse-chronological order. This is a Plans
+          # (deprecated) endpoint. New clients should implement using Contracts.
           #
           # @overload list(customer_id:, limit: nil, next_page: nil, request_options: {})
           #
@@ -41,7 +42,8 @@ module MetronomeSDK
           #
           # Associate an existing customer with a plan for a specified date range. See the
           # [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
-          # for details on the price adjustments.
+          # for details on the price adjustments. This is a Plans (deprecated) endpoint. New
+          # clients should implement using Contracts.
           #
           # @overload add(customer_id:, plan_id:, starting_on:, ending_before: nil, net_payment_terms_days: nil, overage_rate_adjustments: nil, price_adjustments: nil, trial_spec: nil, request_options: {})
           #
@@ -84,7 +86,8 @@ module MetronomeSDK
           # Some parameter documentations has been truncated, see
           # {MetronomeSDK::Models::V1::Customers::PlanEndParams} for more details.
           #
-          # Change the end date of a customer's plan.
+          # Change the end date of a customer's plan. This is a Plans (deprecated) endpoint.
+          # New clients should implement using Contracts.
           #
           # @overload end_(customer_id:, customer_plan_id:, ending_before: nil, void_invoices: nil, void_stripe_invoices: nil, request_options: {})
           #
@@ -124,7 +127,8 @@ module MetronomeSDK
 
           # Lists a customer plans adjustments. See the
           # [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
-          # for details.
+          # for details. This is a Plans (deprecated) endpoint. New clients should implement
+          # using Contracts.
           #
           # @overload list_price_adjustments(customer_id:, customer_plan_id:, limit: nil, next_page: nil, request_options: {})
           #

data/lib/metronome_sdk/resources/v1/customers.rb

@@ -63,7 +63,7 @@ module MetronomeSDK
         # For details on different billing configurations for different systems, review
         # the `/setCustomerBillingConfiguration` end-point.
         #
-        # @overload create(name:, billing_config: nil, custom_fields: nil, customer_billing_provider_configurations: nil, external_id: nil, ingest_aliases: nil, request_options: {})
+        # @overload create(name:, billing_config: nil, custom_fields: nil, customer_billing_provider_configurations: nil, customer_revenue_system_configurations: nil, external_id: nil, ingest_aliases: nil, request_options: {})
         #
         # @param name [String] This will be truncated to 160 characters if the provided name is longer.
         #
@@ -73,6 +73,8 @@ module MetronomeSDK
         #
         # @param customer_billing_provider_configurations [Array<MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration>]
         #
+        # @param customer_revenue_system_configurations [Array<MetronomeSDK::Models::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration>]
+        #
         # @param external_id [String] (deprecated, use ingest_aliases instead) an alias that can be used to refer to t
         #
         # @param ingest_aliases [Array<String>] Aliases that can be used to refer to this customer in usage events
@@ -240,7 +242,8 @@ module MetronomeSDK
 
         # Fetch daily pending costs for the specified customer, broken down by credit type
         # and line items. Note: this is not supported for customers whose plan includes a
-        # UNIQUE-type billable metric.
+        # UNIQUE-type billable metric. This is a Plans (deprecated) endpoint. New clients
+        # should implement using Contracts.
         #
         # @overload list_costs(customer_id:, ending_before:, starting_on:, limit: nil, next_page: nil, request_options: {})
         #
@@ -281,17 +284,18 @@ module MetronomeSDK
         # Preview how a set of events will affect a customer's invoices. Generates draft
         # invoices for a customer using their current contract configuration and the
         # provided events. This is useful for testing how new events will affect the
-        # customer's invoices before they are actually processed.
+        # customer's invoices before they are actually processed. Customers on contracts
+        # with SQL billable metrics are not supported.
         #
         # @overload preview_events(customer_id:, events:, mode: nil, skip_zero_qty_line_items: nil, request_options: {})
         #
         # @param customer_id [String] Path param:
         #
-        # @param events [Array<MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Event>] Body param:
+        # @param events [Array<MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Event>] Body param: Array of usage events to include in the preview calculation. Must co
         #
-        # @param mode [Symbol, MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Mode] Body param: If set to "replace", the preview will be generated as if those were
+        # @param mode [Symbol, MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Mode] Body param: Controls how the provided events are combined with existing usage da
         #
-        # @param skip_zero_qty_line_items [Boolean] Body param: If set, all zero quantity line items will be filtered out of the res
+        # @param skip_zero_qty_line_items [Boolean] Body param: When `true`, line items with zero quantity are excluded from the res
         #
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -384,7 +388,7 @@ module MetronomeSDK
         # @param data [Array<MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsParams::Data>]
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse]
         #
         # @see MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsParams
         def set_billing_configurations(params)
@@ -393,7 +397,7 @@ module MetronomeSDK
             method: :post,
             path: "v1/setCustomerBillingProviderConfigurations",
             body: parsed,
-            model: NilClass,
+            model: MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse,
             options: options
           )
         end

data/lib/metronome_sdk/resources/v1/plans.rb

@@ -4,7 +4,8 @@ module MetronomeSDK
   module Resources
     class V1
       class Plans
-        # List all available plans.
+        # List all available plans. This is a Plans (deprecated) endpoint. New clients
+        # should implement using Contracts.
         #
         # @overload list(limit: nil, next_page: nil, request_options: {})
         #
@@ -29,7 +30,8 @@ module MetronomeSDK
           )
         end
 
-        # Fetch high level details of a specific plan.
+        # Fetch high level details of a specific plan. This is a Plans (deprecated)
+        # endpoint. New clients should implement using Contracts.
         #
         # @overload get_details(plan_id:, request_options: {})
         #
@@ -53,7 +55,8 @@ module MetronomeSDK
           )
         end
 
-        # Fetches a list of charges of a specific plan.
+        # Fetches a list of charges of a specific plan. This is a Plans (deprecated)
+        # endpoint. New clients should implement using Contracts.
         #
         # @overload list_charges(plan_id:, limit: nil, next_page: nil, request_options: {})
         #
@@ -88,7 +91,8 @@ module MetronomeSDK
         # {MetronomeSDK::Models::V1::PlanListCustomersParams} for more details.
         #
         # Fetches a list of customers on a specific plan (by default, only currently
-        # active plans are included)
+        # active plans are included). This is a Plans (deprecated) endpoint. New clients
+        # should implement using Contracts.
         #
         # @overload list_customers(plan_id:, limit: nil, next_page: nil, status: nil, request_options: {})
         #