metronome-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.3

data/lib/metronome_sdk/models.rb

@@ -5,60 +5,39 @@ module MetronomeSDK
     cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, MetronomeSDK::Internal::AnyHash) } }
   end
 
-  [
-    *MetronomeSDK::Internal::Type::Enum.included_modules,
-    *MetronomeSDK::Internal::Type::Union.included_modules
-  ].each do |cls|
-    cls.constants.each do |name|
-      case cls.const_get(name)
-      in true | false
-        cls.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, cls) } }
-        cls.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
-      in Integer
-        cls.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, cls) } }
-        cls.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
-      in Float
-        cls.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, cls) } }
-        cls.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
-      in Symbol
-        cls.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, cls) } }
-        cls.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
-      else
+  MetronomeSDK::Internal::Util.walk_namespaces(MetronomeSDK::Models).each do |mod|
+    case mod
+    in MetronomeSDK::Internal::Type::Enum | MetronomeSDK::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, mod) } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, mod) } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, mod) } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, mod) } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
       end
+    else
     end
   end
 
-  BaseUsageFilter = MetronomeSDK::Models::BaseUsageFilter
+  MetronomeSDK::Internal::Util.walk_namespaces(MetronomeSDK::Models)
+                              .lazy
+                              .grep(MetronomeSDK::Internal::Type::Union)
+                              .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
 
-  Commit = MetronomeSDK::Models::Commit
-
-  ContractWithoutAmendments = MetronomeSDK::Models::ContractWithoutAmendments
-
-  Credit = MetronomeSDK::Models::Credit
-
-  CreditTypeData = MetronomeSDK::Models::CreditTypeData
-
-  Discount = MetronomeSDK::Models::Discount
-
-  EventTypeFilter = MetronomeSDK::Models::EventTypeFilter
-
-  ID = MetronomeSDK::Models::ID
-
-  Override = MetronomeSDK::Models::Override
-
-  PropertyFilter = MetronomeSDK::Models::PropertyFilter
-
-  ProService = MetronomeSDK::Models::ProService
-
-  Rate = MetronomeSDK::Models::Rate
-
-  ScheduledCharge = MetronomeSDK::Models::ScheduledCharge
-
-  ScheduleDuration = MetronomeSDK::Models::ScheduleDuration
-
-  SchedulePointInTime = MetronomeSDK::Models::SchedulePointInTime
-
-  Tier = MetronomeSDK::Models::Tier
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
 
   V1 = MetronomeSDK::Models::V1
 

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

@@ -11,7 +11,7 @@ module MetronomeSDK
         #
         # @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_key_filter: nil, invoice_types_filter: nil, plan_id: nil, uniqueness_key: nil, request_options: {})
         #
-        # @param alert_type [Symbol, MetronomeSDK::V1::AlertCreateParams::AlertType] Type of the alert
+        # @param alert_type [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType] Type of the alert
         #
         # @param name [String] Name of the alert
         #
@@ -23,13 +23,13 @@ module MetronomeSDK
         #
         # @param credit_type_id [String]
         #
-        # @param custom_field_filters [Array<MetronomeSDK::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 alert types that support advanced filtering.
         #
         # @param customer_id [String] If provided, will create this alert for this specific customer. To create an ale
         #
         # @param evaluate_on_create [Boolean] If true, the alert will evaluate immediately on customers that already meet the
         #
-        # @param group_key_filter [MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
+        # @param group_key_filter [MetronomeSDK::Models::V1::AlertCreateParams::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
         #
         # @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached alerts. A list of invoice types to eval
         #

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

@@ -24,7 +24,7 @@ module MetronomeSDK
         #
         # @param resource_type [String] Optional parameter that can be used to filter which audit logs are returned. If
         #
-        # @param sort [Symbol, MetronomeSDK::V1::AuditLogListParams::Sort] Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.
+        # @param sort [Symbol, MetronomeSDK::Models::V1::AuditLogListParams::Sort] Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.
         #
         # @param starting_on [Time] RFC 3339 timestamp of the earliest audit log to return. Cannot be used with 'nex
         #

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

@@ -15,15 +15,15 @@ module MetronomeSDK
         #
         # @param aggregation_key [String] Specifies the type of aggregation performed on matching events. Required if `sql
         #
-        # @param aggregation_type [Symbol, MetronomeSDK::V1::BillableMetricCreateParams::AggregationType] Specifies the type of aggregation performed on matching events.
+        # @param aggregation_type [Symbol, MetronomeSDK::Models::V1::BillableMetricCreateParams::AggregationType] Specifies the type of aggregation performed on matching events.
         #
         # @param custom_fields [Hash{Symbol=>String}] Custom fields to attach to the billable metric.
         #
-        # @param event_type_filter [MetronomeSDK::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
+        # @param event_type_filter [MetronomeSDK::Models::V1::BillableMetricCreateParams::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
         #
         # @param group_keys [Array<Array<String>>] Property names that are used to group usage costs on an invoice. Each entry repr
         #
-        # @param property_filters [Array<MetronomeSDK::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
+        # @param property_filters [Array<MetronomeSDK::Models::V1::BillableMetricCreateParams::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
         #
         # @param sql [String] The SQL query associated with the billable metric. This field is mutually exclus
         #

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

@@ -14,7 +14,7 @@ module MetronomeSDK
           #
           # @param name [String] displayed on invoices
           #
-          # @param type [Symbol, MetronomeSDK::V1::Contracts::ProductCreateParams::Type]
+          # @param type [Symbol, MetronomeSDK::Models::V1::Contracts::ProductCreateParams::Type]
           #
           # @param billable_metric_id [String] Required for USAGE products
           #
@@ -34,9 +34,9 @@ module MetronomeSDK
           #
           # @param pricing_group_key [Array<String>] For USAGE products only. If set, pricing for this product will be determined for
           #
-          # @param quantity_conversion [MetronomeSDK::V1::Contracts::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
+          # @param quantity_conversion [MetronomeSDK::Models::V1::Contracts::ProductCreateParams::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
           #
-          # @param quantity_rounding [MetronomeSDK::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
+          # @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::ProductCreateParams::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
           #
           # @param tags [Array<String>]
           #
@@ -108,9 +108,9 @@ module MetronomeSDK
           #
           # @param pricing_group_key [Array<String>] For USAGE products only. If set, pricing for this product will be determined for
           #
-          # @param quantity_conversion [MetronomeSDK::V1::Contracts::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
+          # @param quantity_conversion [MetronomeSDK::Models::V1::Contracts::ProductUpdateParams::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
           #
-          # @param quantity_rounding [MetronomeSDK::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
+          # @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::ProductUpdateParams::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
           #
           # @param tags [Array<String>] If not provided, defaults to product's current tags
           #
@@ -130,6 +130,9 @@ module MetronomeSDK
             )
           end
 
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Contracts::ProductListParams} for more details.
+          #
           # List products
           #
           # @overload list(limit: nil, next_page: nil, archive_filter: nil, request_options: {})
@@ -138,7 +141,7 @@ module MetronomeSDK
           #
           # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
           #
-          # @param archive_filter [Symbol, MetronomeSDK::V1::Contracts::ProductListParams::ArchiveFilter] Body param: Filter options for the product list
+          # @param archive_filter [Symbol, MetronomeSDK::Models::V1::Contracts::ProductListParams::ArchiveFilter] Body param: Filter options for the product list. If not provided, defaults to no
           #
           # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
           #

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

@@ -10,7 +10,7 @@ module MetronomeSDK
             #
             # @overload update(product_moves:, rate_card_id:, request_options: {})
             #
-            # @param product_moves [Array<MetronomeSDK::V1::Contracts::RateCards::ProductOrderUpdateParams::ProductMove>]
+            # @param product_moves [Array<MetronomeSDK::Models::V1::Contracts::RateCards::ProductOrderUpdateParams::ProductMove>]
             #
             # @param rate_card_id [String] ID of the rate card to update
             #

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

@@ -22,7 +22,7 @@ module MetronomeSDK
             #
             # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
             #
-            # @param selectors [Array<MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector>] Body param: List of rate selectors, rates matching ANY of the selector will be i
+            # @param selectors [Array<MetronomeSDK::Models::V1::Contracts::RateCards::RateListParams::Selector>] Body param: List of rate selectors, rates matching ANY of the selector will be i
             #
             # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
             #
@@ -49,7 +49,7 @@ module MetronomeSDK
             #
             # Add a new rate
             #
-            # @overload add(entitled:, product_id:, rate_card_id:, rate_type:, starting_at:, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil, request_options: {})
+            # @overload add(entitled:, product_id:, rate_card_id:, rate_type:, starting_at:, billing_frequency: nil, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil, request_options: {})
             #
             # @param entitled [Boolean]
             #
@@ -57,11 +57,13 @@ module MetronomeSDK
             #
             # @param rate_card_id [String] ID of the rate card to update
             #
-            # @param rate_type [Symbol, MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType]
+            # @param rate_type [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::RateType]
             #
             # @param starting_at [Time] inclusive effective date
             #
-            # @param commit_rate [MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
+            # @param billing_frequency [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::BillingFrequency] Optional. Frequency to bill subscriptions with. Required for subscription type p
+            #
+            # @param commit_rate [MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
             #
             # @param credit_type_id [String] The Metronome ID of the credit type to associate with price, defaults to USD (ce
             #
@@ -77,7 +79,7 @@ module MetronomeSDK
             #
             # @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
             #
-            # @param tiers [Array<MetronomeSDK::Tier>] Only set for TIERED rate_type.
+            # @param tiers [Array<MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::Tier>] Only set for TIERED rate_type.
             #
             # @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
             #
@@ -102,7 +104,7 @@ module MetronomeSDK
             # @overload add_many(rate_card_id:, rates:, request_options: {})
             #
             # @param rate_card_id [String]
-            # @param rates [Array<MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate>]
+            # @param rates [Array<MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate>]
             # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
             #
             # @return [MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyResponse]

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

@@ -23,9 +23,9 @@ module MetronomeSDK
           #
           # @param name [String] Used only in UI/API. It is not exposed to end customers.
           #
-          # @param aliases [Array<MetronomeSDK::V1::Contracts::RateCardCreateParams::Alias>] Reference this alias when creating a contract. If the same alias is assigned to
+          # @param aliases [Array<MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::Alias>] Reference this alias when creating a contract. If the same alias is assigned to
           #
-          # @param credit_type_conversions [Array<MetronomeSDK::V1::Contracts::RateCardCreateParams::CreditTypeConversion>] Required when using custom pricing units in rates.
+          # @param credit_type_conversions [Array<MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::CreditTypeConversion>] Required when using custom pricing units in rates.
           #
           # @param custom_fields [Hash{Symbol=>String}]
           #
@@ -80,7 +80,7 @@ module MetronomeSDK
           #
           # @param rate_card_id [String] ID of the rate card to update
           #
-          # @param aliases [Array<MetronomeSDK::V1::Contracts::RateCardUpdateParams::Alias>] Reference this alias when creating a contract. If the same alias is assigned to
+          # @param aliases [Array<MetronomeSDK::Models::V1::Contracts::RateCardUpdateParams::Alias>] Reference this alias when creating a contract. If the same alias is assigned to
           #
           # @param description [String]
           #
@@ -171,7 +171,7 @@ module MetronomeSDK
           #
           # @param ending_before [Time] Body param: optional exclusive end date for the rates schedule. When not specifi
           #
-          # @param selectors [Array<MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector>] Body param: List of rate selectors, rates matching ANY of the selector will be i
+          # @param selectors [Array<MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector>] Body param: List of rate selectors, rates matching ANY of the selector will be i
           #
           # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
           #

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

@@ -18,25 +18,25 @@ module MetronomeSDK
         #
         # Create a new contract
         #
-        # @overload create(customer_id:, starting_at:, billing_provider_configuration: nil, commits: nil, credits: nil, custom_fields: nil, discounts: nil, ending_before: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, overrides: nil, prepaid_balance_threshold_configuration: 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, 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, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, overrides: nil, prepaid_balance_threshold_configuration: 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: {})
         #
         # @param customer_id [String]
         #
         # @param starting_at [Time] inclusive contract start time
         #
-        # @param billing_provider_configuration [MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration] The billing provider configuration associated with a contract.
+        # @param billing_provider_configuration [MetronomeSDK::Models::V1::ContractCreateParams::BillingProviderConfiguration] The billing provider configuration associated with a contract.
         #
-        # @param commits [Array<MetronomeSDK::V1::ContractCreateParams::Commit>]
+        # @param commits [Array<MetronomeSDK::Models::V1::ContractCreateParams::Commit>]
         #
-        # @param credits [Array<MetronomeSDK::V1::ContractCreateParams::Credit>]
+        # @param credits [Array<MetronomeSDK::Models::V1::ContractCreateParams::Credit>]
         #
         # @param custom_fields [Hash{Symbol=>String}]
         #
-        # @param discounts [Array<MetronomeSDK::V1::ContractCreateParams::Discount>] This field's availability is dependent on your client's configuration.
+        # @param discounts [Array<MetronomeSDK::Models::V1::ContractCreateParams::Discount>] This field's availability is dependent on your client's configuration.
         #
         # @param ending_before [Time] exclusive contract end time
         #
-        # @param multiplier_override_prioritization [Symbol, MetronomeSDK::V1::ContractCreateParams::MultiplierOverridePrioritization] Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list price
+        # @param multiplier_override_prioritization [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::MultiplierOverridePrioritization] Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list price
         #
         # @param name [String]
         #
@@ -44,39 +44,41 @@ module MetronomeSDK
         #
         # @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
         #
-        # @param overrides [Array<MetronomeSDK::V1::ContractCreateParams::Override>]
+        # @param overrides [Array<MetronomeSDK::Models::V1::ContractCreateParams::Override>]
         #
-        # @param prepaid_balance_threshold_configuration [MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration]
+        # @param prepaid_balance_threshold_configuration [MetronomeSDK::Models::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration]
         #
-        # @param professional_services [Array<MetronomeSDK::V1::ContractCreateParams::ProfessionalService>] This field's availability is dependent on your client's configuration.
+        # @param professional_services [Array<MetronomeSDK::Models::V1::ContractCreateParams::ProfessionalService>] This field's availability is dependent on your client's configuration.
         #
         # @param rate_card_alias [String] Selects the rate card linked to the specified alias as of the contract's start d
         #
         # @param rate_card_id [String]
         #
-        # @param recurring_commits [Array<MetronomeSDK::V1::ContractCreateParams::RecurringCommit>]
+        # @param recurring_commits [Array<MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit>]
         #
-        # @param recurring_credits [Array<MetronomeSDK::V1::ContractCreateParams::RecurringCredit>]
+        # @param recurring_credits [Array<MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit>]
         #
-        # @param reseller_royalties [Array<MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
+        # @param reseller_royalties [Array<MetronomeSDK::Models::V1::ContractCreateParams::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
         #
         # @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
         #
-        # @param scheduled_charges [Array<MetronomeSDK::V1::ContractCreateParams::ScheduledCharge>]
+        # @param scheduled_charges [Array<MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge>]
         #
-        # @param scheduled_charges_on_usage_invoices [Symbol, MetronomeSDK::V1::ContractCreateParams::ScheduledChargesOnUsageInvoices] Determines which scheduled and commit charges to consolidate onto the Contract's
+        # @param scheduled_charges_on_usage_invoices [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::ScheduledChargesOnUsageInvoices] Determines which scheduled and commit charges to consolidate onto the Contract's
         #
-        # @param spend_threshold_configuration [MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration]
+        # @param spend_threshold_configuration [MetronomeSDK::Models::V1::ContractCreateParams::SpendThresholdConfiguration]
+        #
+        # @param subscriptions [Array<MetronomeSDK::Models::V1::ContractCreateParams::Subscription>] (beta) Optional list of [subscriptions](https://docs.metronome.com/manage-produc
         #
         # @param total_contract_value [Float] This field's availability is dependent on your client's configuration.
         #
-        # @param transition [MetronomeSDK::V1::ContractCreateParams::Transition]
+        # @param transition [MetronomeSDK::Models::V1::ContractCreateParams::Transition]
         #
         # @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
         #
-        # @param usage_filter [MetronomeSDK::BaseUsageFilter]
+        # @param usage_filter [MetronomeSDK::Models::V1::ContractCreateParams::UsageFilter]
         #
-        # @param usage_statement_schedule [MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule]
+        # @param usage_statement_schedule [MetronomeSDK::Models::V1::ContractCreateParams::UsageStatementSchedule]
         #
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -214,25 +216,25 @@ module MetronomeSDK
         #
         # @param starting_at [Time] inclusive start time for the amendment
         #
-        # @param commits [Array<MetronomeSDK::V1::ContractAmendParams::Commit>]
+        # @param commits [Array<MetronomeSDK::Models::V1::ContractAmendParams::Commit>]
         #
-        # @param credits [Array<MetronomeSDK::V1::ContractAmendParams::Credit>]
+        # @param credits [Array<MetronomeSDK::Models::V1::ContractAmendParams::Credit>]
         #
         # @param custom_fields [Hash{Symbol=>String}]
         #
-        # @param discounts [Array<MetronomeSDK::V1::ContractAmendParams::Discount>] This field's availability is dependent on your client's configuration.
+        # @param discounts [Array<MetronomeSDK::Models::V1::ContractAmendParams::Discount>] This field's availability is dependent on your client's configuration.
         #
         # @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
         #
-        # @param overrides [Array<MetronomeSDK::V1::ContractAmendParams::Override>]
+        # @param overrides [Array<MetronomeSDK::Models::V1::ContractAmendParams::Override>]
         #
-        # @param professional_services [Array<MetronomeSDK::V1::ContractAmendParams::ProfessionalService>] This field's availability is dependent on your client's configuration.
+        # @param professional_services [Array<MetronomeSDK::Models::V1::ContractAmendParams::ProfessionalService>] This field's availability is dependent on your client's configuration.
         #
-        # @param reseller_royalties [Array<MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
+        # @param reseller_royalties [Array<MetronomeSDK::Models::V1::ContractAmendParams::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
         #
         # @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
         #
-        # @param scheduled_charges [Array<MetronomeSDK::V1::ContractAmendParams::ScheduledCharge>]
+        # @param scheduled_charges [Array<MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge>]
         #
         # @param total_contract_value [Float] This field's availability is dependent on your client's configuration.
         #
@@ -285,7 +287,7 @@ module MetronomeSDK
         #
         # @overload create_historical_invoices(invoices:, preview:, request_options: {})
         #
-        # @param invoices [Array<MetronomeSDK::V1::ContractCreateHistoricalInvoicesParams::Invoice>]
+        # @param invoices [Array<MetronomeSDK::Models::V1::ContractCreateHistoricalInvoicesParams::Invoice>]
         # @param preview [Boolean]
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -363,7 +365,7 @@ module MetronomeSDK
         #
         # @param at [Time] Body param: optional timestamp which overlaps with the returned rate schedule se
         #
-        # @param selectors [Array<MetronomeSDK::V1::ContractRetrieveRateScheduleParams::Selector>] Body param: List of rate selectors, rates matching ANY of the selectors will be
+        # @param selectors [Array<MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector>] Body param: List of rate selectors, rates matching ANY of the selectors will be
         #
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -383,6 +385,31 @@ module MetronomeSDK
           )
         end
 
+        # Fetch the quantity and price for a subscription over time. End-point does not
+        # return future scheduled changes.
+        #
+        # @overload retrieve_subscription_quantity_history(contract_id:, customer_id:, subscription_id:, request_options: {})
+        #
+        # @param contract_id [String]
+        # @param customer_id [String]
+        # @param subscription_id [String]
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse]
+        #
+        # @see MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryParams
+        def retrieve_subscription_quantity_history(params)
+          parsed, options =
+            MetronomeSDK::V1::ContractRetrieveSubscriptionQuantityHistoryParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/contracts/getSubscriptionQuantityHistory",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse,
+            options: options
+          )
+        end
+
         # Create a new scheduled invoice for Professional Services terms on a contract.
         # This endpoint's availability is dependent on your client's configuration.
         #
@@ -394,7 +421,7 @@ module MetronomeSDK
         #
         # @param issued_at [Time] The date the invoice is issued
         #
-        # @param line_items [Array<MetronomeSDK::V1::ContractScheduleProServicesInvoiceParams::LineItem>] Each line requires an amount or both unit_price and quantity.
+        # @param line_items [Array<MetronomeSDK::Models::V1::ContractScheduleProServicesInvoiceParams::LineItem>] Each line requires an amount or both unit_price and quantity.
         #
         # @param netsuite_invoice_header_end [Time] The end date of the invoice header in Netsuite
         #

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

@@ -15,11 +15,11 @@ module MetronomeSDK
         #
         # @param expires_at [Time] The credit grant will only apply to usage or charges dated before this timestamp
         #
-        # @param grant_amount [MetronomeSDK::V1::CreditGrantCreateParams::GrantAmount] the amount of credits granted
+        # @param grant_amount [MetronomeSDK::Models::V1::CreditGrantCreateParams::GrantAmount] the amount of credits granted
         #
         # @param name [String] the name of the credit grant as it will appear on invoices
         #
-        # @param paid_amount [MetronomeSDK::V1::CreditGrantCreateParams::PaidAmount] the amount paid for this credit grant
+        # @param paid_amount [MetronomeSDK::Models::V1::CreditGrantCreateParams::PaidAmount] the amount paid for this credit grant
         #
         # @param priority [Float]
         #
@@ -35,7 +35,7 @@ module MetronomeSDK
         #
         # @param reason [String]
         #
-        # @param rollover_settings [MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings] Configure a rollover for this credit grant so if it expires it rolls over a conf
+        # @param rollover_settings [MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings] Configure a rollover for this credit grant so if it expires it rolls over a conf
         #
         # @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
         #

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

@@ -10,7 +10,7 @@ module MetronomeSDK
         # @overload add_key(enforce_uniqueness:, entity:, key:, request_options: {})
         #
         # @param enforce_uniqueness [Boolean]
-        # @param entity [Symbol, MetronomeSDK::V1::CustomFieldAddKeyParams::Entity]
+        # @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldAddKeyParams::Entity]
         # @param key [String]
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -32,7 +32,7 @@ module MetronomeSDK
         #
         # @overload delete_values(entity:, entity_id:, keys:, request_options: {})
         #
-        # @param entity [Symbol, MetronomeSDK::V1::CustomFieldDeleteValuesParams::Entity]
+        # @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldDeleteValuesParams::Entity]
         # @param entity_id [String]
         # @param keys [Array<String>]
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -57,7 +57,7 @@ module MetronomeSDK
         #
         # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
         #
-        # @param entities [Array<Symbol, MetronomeSDK::V1::CustomFieldListKeysParams::Entity>] Body param: Optional list of entity types to return keys for
+        # @param entities [Array<Symbol, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity>] Body param: Optional list of entity types to return keys for
         #
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -81,7 +81,7 @@ module MetronomeSDK
         #
         # @overload remove_key(entity:, key:, request_options: {})
         #
-        # @param entity [Symbol, MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity]
+        # @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity]
         # @param key [String]
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -110,7 +110,7 @@ module MetronomeSDK
         # @overload set_values(custom_fields:, entity:, entity_id:, request_options: {})
         #
         # @param custom_fields [Hash{Symbol=>String}]
-        # @param entity [Symbol, MetronomeSDK::V1::CustomFieldSetValuesParams::Entity]
+        # @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity]
         # @param entity_id [String]
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -17,7 +17,7 @@ module MetronomeSDK
           #
           # @param customer_id [String] The Metronome ID of the customer
           #
-          # @param plans_or_contracts [Symbol, MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts] When parallel alerts are enabled during migration, this flag denotes whether to
+          # @param plans_or_contracts [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::PlansOrContracts] When parallel alerts are enabled during migration, this flag denotes whether to
           #
           # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -46,7 +46,7 @@ module MetronomeSDK
           #
           # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
           #
-          # @param alert_statuses [Array<Symbol, MetronomeSDK::V1::Customers::AlertListParams::AlertStatus>] Body param: Optionally filter by alert status. If absent, only enabled alerts wi
+          # @param alert_statuses [Array<Symbol, MetronomeSDK::Models::V1::Customers::AlertListParams::AlertStatus>] Body param: Optionally filter by alert status. If absent, only enabled alerts wi
           #
           # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
           #

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

@@ -15,15 +15,15 @@ module MetronomeSDK
           #
           # @param customer_id [String] Path param:
           #
-          # @param billing_provider_type [Symbol, MetronomeSDK::V1::Customers::BillingConfigCreateParams::BillingProviderType] Path param: The billing provider (e.g. stripe)
+          # @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::BillingProviderType] Path param: The billing provider (e.g. stripe)
           #
           # @param billing_provider_customer_id [String] Body param: The customer ID in the billing provider's system. For Azure, this is
           #
           # @param aws_product_code [String] Body param:
           #
-          # @param aws_region [Symbol, MetronomeSDK::V1::Customers::BillingConfigCreateParams::AwsRegion] Body param:
+          # @param aws_region [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::AwsRegion] Body param:
           #
-          # @param stripe_collection_method [Symbol, MetronomeSDK::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod] Body param:
+          # @param stripe_collection_method [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod] Body param:
           #
           # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -55,7 +55,7 @@ module MetronomeSDK
           #
           # @param customer_id [String]
           #
-          # @param billing_provider_type [Symbol, MetronomeSDK::V1::Customers::BillingConfigRetrieveParams::BillingProviderType] The billing provider (e.g. stripe)
+          # @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveParams::BillingProviderType] The billing provider (e.g. stripe)
           #
           # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -87,7 +87,7 @@ module MetronomeSDK
           #
           # @param customer_id [String]
           #
-          # @param billing_provider_type [Symbol, MetronomeSDK::V1::Customers::BillingConfigDeleteParams::BillingProviderType] The billing provider (e.g. stripe)
+          # @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigDeleteParams::BillingProviderType] The billing provider (e.g. stripe)
           #
           # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
           #