feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 139
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-77e112caf7b2a2c7b0248b7245b5730bc72ab0ea84ba5d0777e7d0604ae04d26.yml
-openapi_spec_hash: 966568dd08f34db64ba0ebace678268a
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-3c7ee3ec9931aaeeb5e015a598812cde9edc09f114adb8759ef4c2054c90f7dc.yml
+openapi_spec_hash: a14720041156fe4f353449142edacf0d
 config_hash: 3279841440b02d4e8303c961d6983492

lib/orb/models/billable_metric.rb

@@ -41,7 +41,14 @@ class BillableMetric < Orb::Internal::Type::BaseModel
       #   @return [Symbol, Orb::Models::BillableMetric::Status]
       required :status, enum: -> { Orb::BillableMetric::Status }
 
-      # @!method initialize(id:, description:, item:, metadata:, name:, status:)
+      # @!attribute parameter_definitions
+      #
+      #   @return [Array<Hash{Symbol=>Object}>, nil]
+      optional :parameter_definitions,
+               Orb::Internal::Type::ArrayOf[Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]],
+               nil?: true
+
+      # @!method initialize(id:, description:, item:, metadata:, name:, status:, parameter_definitions: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::BillableMetric} for more details.
       #
@@ -60,6 +67,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel
       #   @param name [String]
       #
       #   @param status [Symbol, Orb::Models::BillableMetric::Status]
+      #
+      #   @param parameter_definitions [Array<Hash{Symbol=>Object}>, nil]
 
       # @see Orb::Models::BillableMetric#status
       module Status

lib/orb/models/price_evaluate_multiple_params.rb

@@ -74,6 +74,15 @@ class PriceEvaluation < Orb::Internal::Type::BaseModel
         #   @return [Array<String>, nil]
         optional :grouping_keys, Orb::Internal::Type::ArrayOf[String]
 
+        # @!attribute metric_parameter_overrides
+        #   Optional overrides for parameterized billable metric parameters. If the metric
+        #   has parameter definitions and no overrides are provided, defaults will be used.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metric_parameter_overrides,
+                 Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+                 nil?: true
+
         # @!attribute price
         #   New floating price request body params.
         #
@@ -86,7 +95,7 @@ class PriceEvaluation < Orb::Internal::Type::BaseModel
         #   @return [String, nil]
         optional :price_id, String, nil?: true
 
-        # @!method initialize(external_price_id: nil, filter: nil, grouping_keys: nil, price: nil, price_id: nil)
+        # @!method initialize(external_price_id: nil, filter: nil, grouping_keys: nil, metric_parameter_overrides: nil, price: nil, price_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation} for more details.
         #
@@ -96,6 +105,8 @@ class PriceEvaluation < Orb::Internal::Type::BaseModel
         #
         #   @param grouping_keys [Array<String>] Properties (or [computed properties](/extensibility/advanced-metrics#computed-pr
         #
+        #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Optional overrides for parameterized billable metric parameters. If the metric h
+        #
         #   @param price [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::EventOutput, nil] New floating price request body params.
         #
         #   @param price_id [String, nil] The ID of a price to evaluate that exists in your Orb account.

lib/orb/models/price_evaluate_params.rb

@@ -47,7 +47,16 @@ class PriceEvaluateParams < Orb::Internal::Type::BaseModel
       #   @return [Array<String>, nil]
       optional :grouping_keys, Orb::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(timeframe_end:, timeframe_start:, customer_id: nil, external_customer_id: nil, filter: nil, grouping_keys: nil, request_options: {})
+      # @!attribute metric_parameter_overrides
+      #   Optional overrides for parameterized billable metric parameters. If the metric
+      #   has parameter definitions and no overrides are provided, defaults will be used.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metric_parameter_overrides,
+               Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+               nil?: true
+
+      # @!method initialize(timeframe_end:, timeframe_start:, customer_id: nil, external_customer_id: nil, filter: nil, grouping_keys: nil, metric_parameter_overrides: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PriceEvaluateParams} for more details.
       #
@@ -63,6 +72,8 @@ class PriceEvaluateParams < Orb::Internal::Type::BaseModel
       #
       #   @param grouping_keys [Array<String>] Properties (or [computed properties](/extensibility/advanced-metrics#computed-pr
       #
+      #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Optional overrides for parameterized billable metric parameters. If the metric h
+      #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

lib/orb/models/price_evaluate_preview_events_params.rb

@@ -132,6 +132,15 @@ class PriceEvaluation < Orb::Internal::Type::BaseModel
         #   @return [Array<String>, nil]
         optional :grouping_keys, Orb::Internal::Type::ArrayOf[String]
 
+        # @!attribute metric_parameter_overrides
+        #   Optional overrides for parameterized billable metric parameters. If the metric
+        #   has parameter definitions and no overrides are provided, defaults will be used.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metric_parameter_overrides,
+                 Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+                 nil?: true
+
         # @!attribute price
         #   New floating price request body params.
         #
@@ -148,7 +157,7 @@ class PriceEvaluation < Orb::Internal::Type::BaseModel
         #   @return [String, nil]
         optional :price_id, String, nil?: true
 
-        # @!method initialize(external_price_id: nil, filter: nil, grouping_keys: nil, price: nil, price_id: nil)
+        # @!method initialize(external_price_id: nil, filter: nil, grouping_keys: nil, metric_parameter_overrides: nil, price: nil, price_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation} for more
         #   details.
@@ -159,6 +168,8 @@ class PriceEvaluation < Orb::Internal::Type::BaseModel
         #
         #   @param grouping_keys [Array<String>] Properties (or [computed properties](/extensibility/advanced-metrics#computed-pr
         #
+        #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Optional overrides for parameterized billable metric parameters. If the metric h
+        #
         #   @param price [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::EventOutput, nil] New floating price request body params.
         #
         #   @param price_id [String, nil] The ID of a price to evaluate that exists in your Orb account.

lib/orb/models/price_interval.rb

@@ -89,7 +89,16 @@ class PriceInterval < Orb::Internal::Type::BaseModel
       #   @return [Array<String>, nil]
       required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
 
-      # @!method initialize(id:, billing_cycle_day:, can_defer_billing:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:)
+      # @!attribute metric_parameter_overrides
+      #   Override values for parameterized billable metric variables. Keys are parameter
+      #   names, values are the override values.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metric_parameter_overrides,
+               Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+               nil?: true
+
+      # @!method initialize(id:, billing_cycle_day:, can_defer_billing:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:, metric_parameter_overrides: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PriceInterval} for more details.
       #
@@ -118,6 +127,8 @@ class PriceInterval < Orb::Internal::Type::BaseModel
       #   @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
       #
       #   @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
+      #
+      #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Override values for parameterized billable metric variables. Keys are parameter
     end
   end
 end

lib/orb/models/subscription_create_params.rb

@@ -422,6 +422,15 @@ class AddPrice < Orb::Internal::Type::BaseModel
         #   @return [String, nil]
         optional :maximum_amount, String, nil?: true
 
+        # @!attribute metric_parameter_overrides
+        #   Override values for parameterized billable metric variables. Keys are parameter
+        #   names, values are the override values.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metric_parameter_overrides,
+                 Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+                 nil?: true
+
         # @!attribute minimum_amount
         #   @deprecated
         #
@@ -457,7 +466,7 @@ class AddPrice < Orb::Internal::Type::BaseModel
         #   @return [Time, nil]
         optional :start_date, Time, nil?: true
 
-        # @!method initialize(allocation_price: nil, discounts: nil, end_date: nil, external_price_id: nil, maximum_amount: nil, minimum_amount: nil, plan_phase_order: nil, price: nil, price_id: nil, start_date: nil)
+        # @!method initialize(allocation_price: nil, discounts: nil, end_date: nil, external_price_id: nil, maximum_amount: nil, metric_parameter_overrides: nil, minimum_amount: nil, plan_phase_order: nil, price: nil, price_id: nil, start_date: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::SubscriptionCreateParams::AddPrice} for more details.
         #
@@ -471,6 +480,8 @@ class AddPrice < Orb::Internal::Type::BaseModel
         #
         #   @param maximum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for
         #
+        #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Override values for parameterized billable metric variables. Keys are parameter
+        #
         #   @param minimum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for
         #
         #   @param plan_phase_order [Integer, nil] The phase to add this price to.
@@ -2085,6 +2096,15 @@ class ReplacePrice < Orb::Internal::Type::BaseModel
         #   @return [String, nil]
         optional :maximum_amount, String, nil?: true
 
+        # @!attribute metric_parameter_overrides
+        #   Override values for parameterized billable metric variables. Keys are parameter
+        #   names, values are the override values.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metric_parameter_overrides,
+                 Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+                 nil?: true
+
         # @!attribute minimum_amount
         #   @deprecated
         #
@@ -2106,7 +2126,7 @@ class ReplacePrice < Orb::Internal::Type::BaseModel
         #   @return [String, nil]
         optional :price_id, String, nil?: true
 
-        # @!method initialize(replaces_price_id:, allocation_price: nil, discounts: nil, external_price_id: nil, fixed_price_quantity: nil, maximum_amount: nil, minimum_amount: nil, price: nil, price_id: nil)
+        # @!method initialize(replaces_price_id:, allocation_price: nil, discounts: nil, external_price_id: nil, fixed_price_quantity: nil, maximum_amount: nil, metric_parameter_overrides: nil, minimum_amount: nil, price: nil, price_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::SubscriptionCreateParams::ReplacePrice} for more details.
         #
@@ -2122,6 +2142,8 @@ class ReplacePrice < Orb::Internal::Type::BaseModel
         #
         #   @param maximum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for
         #
+        #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Override values for parameterized billable metric variables. Keys are parameter
+        #
         #   @param minimum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for
         #
         #   @param price [Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::Percent, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::EventOutput, nil] New subscription price request body params.