orb-billing 0.6.0 → 0.7.0

data/rbi/orb/models/price_evaluate_response.rbi

@@ -8,83 +8,20 @@ module Orb
           T.any(Orb::Models::PriceEvaluateResponse, Orb::Internal::AnyHash)
         end
 
-      sig { returns(T::Array[Orb::Models::PriceEvaluateResponse::Data]) }
+      sig { returns(T::Array[Orb::EvaluatePriceGroup]) }
       attr_accessor :data
 
       sig do
-        params(
-          data: T::Array[Orb::Models::PriceEvaluateResponse::Data::OrHash]
-        ).returns(T.attached_class)
+        params(data: T::Array[Orb::EvaluatePriceGroup::OrHash]).returns(
+          T.attached_class
+        )
       end
       def self.new(data:)
       end
 
-      sig do
-        override.returns(
-          { data: T::Array[Orb::Models::PriceEvaluateResponse::Data] }
-        )
-      end
+      sig { override.returns({ data: T::Array[Orb::EvaluatePriceGroup] }) }
       def to_hash
       end
-
-      class Data < Orb::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Orb::Models::PriceEvaluateResponse::Data,
-              Orb::Internal::AnyHash
-            )
-          end
-
-        # The currency of the price
-        sig { returns(String) }
-        attr_accessor :currency
-
-        # The computed price groups associated with input price.
-        sig { returns(T::Array[Orb::EvaluatePriceGroup]) }
-        attr_accessor :price_groups
-
-        # The index of the inline price
-        sig { returns(T.nilable(Integer)) }
-        attr_accessor :inline_price_index
-
-        # The ID of the price
-        sig { returns(T.nilable(String)) }
-        attr_accessor :price_id
-
-        sig do
-          params(
-            currency: String,
-            price_groups: T::Array[Orb::EvaluatePriceGroup::OrHash],
-            inline_price_index: T.nilable(Integer),
-            price_id: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The currency of the price
-          currency:,
-          # The computed price groups associated with input price.
-          price_groups:,
-          # The index of the inline price
-          inline_price_index: nil,
-          # The ID of the price
-          price_id: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              currency: String,
-              price_groups: T::Array[Orb::EvaluatePriceGroup],
-              inline_price_index: T.nilable(Integer),
-              price_id: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/orb/models.rbi

@@ -23,6 +23,14 @@ module Orb
 
   AmountDiscount = Orb::Models::AmountDiscount
 
+  Beta = Orb::Models::Beta
+
+  BetaCreatePlanVersionParams = Orb::Models::BetaCreatePlanVersionParams
+
+  BetaFetchPlanVersionParams = Orb::Models::BetaFetchPlanVersionParams
+
+  BetaSetDefaultPlanVersionParams = Orb::Models::BetaSetDefaultPlanVersionParams
+
   BillableMetric = Orb::Models::BillableMetric
 
   BillingCycleRelativeDate = Orb::Models::BillingCycleRelativeDate
@@ -158,14 +166,18 @@ module Orb
 
   Plans = Orb::Models::Plans
 
-  PlanSetDefaultVersionParams = Orb::Models::PlanSetDefaultVersionParams
-
   PlanUpdateParams = Orb::Models::PlanUpdateParams
 
+  PlanVersion = Orb::Models::PlanVersion
+
+  PlanVersionPhase = Orb::Models::PlanVersionPhase
+
   Price = Orb::Models::Price
 
   PriceCreateParams = Orb::Models::PriceCreateParams
 
+  PriceEvaluateMultipleParams = Orb::Models::PriceEvaluateMultipleParams
+
   PriceEvaluateParams = Orb::Models::PriceEvaluateParams
 
   PriceFetchParams = Orb::Models::PriceFetchParams

data/rbi/orb/resources/{plans/versions.rbi → beta/external_plan_id.rbi}

@@ -2,50 +2,58 @@
 
 module Orb
   module Resources
-    class Plans
-      class Versions
+    class Beta
+      class ExternalPlanID
         # This API endpoint is in beta and its interface may change. It is recommended for
         # use only in test mode.
         #
         # This endpoint allows the creation of a new plan version for an existing plan.
         sig do
           params(
-            plan_id: String,
+            external_plan_id: String,
             version: Integer,
             add_adjustments:
               T.nilable(
-                T::Array[Orb::Plans::VersionCreateParams::AddAdjustment::OrHash]
+                T::Array[
+                  Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddAdjustment::OrHash
+                ]
               ),
             add_prices:
               T.nilable(
-                T::Array[Orb::Plans::VersionCreateParams::AddPrice::OrHash]
+                T::Array[
+                  Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::OrHash
+                ]
               ),
             remove_adjustments:
               T.nilable(
                 T::Array[
-                  Orb::Plans::VersionCreateParams::RemoveAdjustment::OrHash
+                  Orb::Beta::ExternalPlanIDCreatePlanVersionParams::RemoveAdjustment::OrHash
                 ]
               ),
             remove_prices:
               T.nilable(
-                T::Array[Orb::Plans::VersionCreateParams::RemovePrice::OrHash]
+                T::Array[
+                  Orb::Beta::ExternalPlanIDCreatePlanVersionParams::RemovePrice::OrHash
+                ]
               ),
             replace_adjustments:
               T.nilable(
                 T::Array[
-                  Orb::Plans::VersionCreateParams::ReplaceAdjustment::OrHash
+                  Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplaceAdjustment::OrHash
                 ]
               ),
             replace_prices:
               T.nilable(
-                T::Array[Orb::Plans::VersionCreateParams::ReplacePrice::OrHash]
+                T::Array[
+                  Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::OrHash
+                ]
               ),
             set_as_default: T.nilable(T::Boolean),
             request_options: Orb::RequestOptions::OrHash
-          ).returns(Orb::Models::Plans::VersionCreateResponse)
+          ).returns(Orb::PlanVersion)
         end
-        def create(
-          plan_id,
+        def create_plan_version(
+          external_plan_id,
           # New version number.
           version:,
           # Additional adjustments to be added to the plan.
@@ -74,11 +82,30 @@ module Orb
         sig do
           params(
             version: String,
-            plan_id: String,
+            external_plan_id: String,
             request_options: Orb::RequestOptions::OrHash
-          ).returns(Orb::Models::Plans::VersionRetrieveResponse)
+          ).returns(Orb::PlanVersion)
+        end
+        def fetch_plan_version(version, external_plan_id:, request_options: {})
         end
-        def retrieve(version, plan_id:, request_options: {})
+
+        # This API endpoint is in beta and its interface may change. It is recommended for
+        # use only in test mode.
+        #
+        # This endpoint allows setting the default version of a plan.
+        sig do
+          params(
+            external_plan_id: String,
+            version: Integer,
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(Orb::Plan)
+        end
+        def set_default_plan_version(
+          external_plan_id,
+          # Plan version to set as the default.
+          version:,
+          request_options: {}
+        )
         end
 
         # @api private

data/rbi/orb/resources/beta.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module Orb
+  module Resources
+    class Beta
+      sig { returns(Orb::Resources::Beta::ExternalPlanID) }
+      attr_reader :external_plan_id
+
+      # This API endpoint is in beta and its interface may change. It is recommended for
+      # use only in test mode.
+      #
+      # This endpoint allows the creation of a new plan version for an existing plan.
+      sig do
+        params(
+          plan_id: String,
+          version: Integer,
+          add_adjustments:
+            T.nilable(
+              T::Array[Orb::BetaCreatePlanVersionParams::AddAdjustment::OrHash]
+            ),
+          add_prices:
+            T.nilable(
+              T::Array[Orb::BetaCreatePlanVersionParams::AddPrice::OrHash]
+            ),
+          remove_adjustments:
+            T.nilable(
+              T::Array[
+                Orb::BetaCreatePlanVersionParams::RemoveAdjustment::OrHash
+              ]
+            ),
+          remove_prices:
+            T.nilable(
+              T::Array[Orb::BetaCreatePlanVersionParams::RemovePrice::OrHash]
+            ),
+          replace_adjustments:
+            T.nilable(
+              T::Array[
+                Orb::BetaCreatePlanVersionParams::ReplaceAdjustment::OrHash
+              ]
+            ),
+          replace_prices:
+            T.nilable(
+              T::Array[Orb::BetaCreatePlanVersionParams::ReplacePrice::OrHash]
+            ),
+          set_as_default: T.nilable(T::Boolean),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::PlanVersion)
+      end
+      def create_plan_version(
+        plan_id,
+        # New version number.
+        version:,
+        # Additional adjustments to be added to the plan.
+        add_adjustments: nil,
+        # Additional prices to be added to the plan.
+        add_prices: nil,
+        # Adjustments to be removed from the plan.
+        remove_adjustments: nil,
+        # Prices to be removed from the plan.
+        remove_prices: nil,
+        # Adjustments to be replaced with additional adjustments on the plan.
+        replace_adjustments: nil,
+        # Prices to be replaced with additional prices on the plan.
+        replace_prices: nil,
+        # Set this new plan version as the default
+        set_as_default: nil,
+        request_options: {}
+      )
+      end
+
+      # This API endpoint is in beta and its interface may change. It is recommended for
+      # use only in test mode.
+      #
+      # This endpoint is used to fetch a plan version. It returns the phases, prices,
+      # and adjustments present on this version of the plan.
+      sig do
+        params(
+          version: String,
+          plan_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::PlanVersion)
+      end
+      def fetch_plan_version(version, plan_id:, request_options: {})
+      end
+
+      # This API endpoint is in beta and its interface may change. It is recommended for
+      # use only in test mode.
+      #
+      # This endpoint allows setting the default version of a plan.
+      sig do
+        params(
+          plan_id: String,
+          version: Integer,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Plan)
+      end
+      def set_default_plan_version(
+        plan_id,
+        # Plan version to set as the default.
+        version:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Orb::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/orb/resources/plans/external_plan_id.rbi

@@ -4,9 +4,6 @@ module Orb
   module Resources
     class Plans
       class ExternalPlanID
-        sig { returns(Orb::Resources::Plans::ExternalPlanID::Versions) }
-        attr_reader :versions
-
         # This endpoint can be used to update the `external_plan_id`, and `metadata` of an
         # existing plan.
         #
@@ -58,25 +55,6 @@ module Orb
         def fetch(external_plan_id, request_options: {})
         end
 
-        # This API endpoint is in beta and its interface may change. It is recommended for
-        # use only in test mode.
-        #
-        # This endpoint allows setting the default version of a plan.
-        sig do
-          params(
-            external_plan_id: String,
-            version: Integer,
-            request_options: Orb::RequestOptions::OrHash
-          ).returns(Orb::Plan)
-        end
-        def set_default_version(
-          external_plan_id,
-          # Plan version to set as the default.
-          version:,
-          request_options: {}
-        )
-        end
-
         # @api private
         sig { params(client: Orb::Client).returns(T.attached_class) }
         def self.new(client:)

data/rbi/orb/resources/plans.rbi

@@ -6,9 +6,6 @@ module Orb
       sig { returns(Orb::Resources::Plans::ExternalPlanID) }
       attr_reader :external_plan_id
 
-      sig { returns(Orb::Resources::Plans::Versions) }
-      attr_reader :versions
-
       # This endpoint allows creation of plans including their prices.
       sig do
         params(
@@ -166,25 +163,6 @@ module Orb
       def fetch(plan_id, request_options: {})
       end
 
-      # This API endpoint is in beta and its interface may change. It is recommended for
-      # use only in test mode.
-      #
-      # This endpoint allows setting the default version of a plan.
-      sig do
-        params(
-          plan_id: String,
-          version: Integer,
-          request_options: Orb::RequestOptions::OrHash
-        ).returns(Orb::Plan)
-      end
-      def set_default_version(
-        plan_id,
-        # Plan version to set as the default.
-        version:,
-        request_options: {}
-      )
-      end
-
       # @api private
       sig { params(client: Orb::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/orb/resources/prices.rbi

@@ -183,6 +183,65 @@ module Orb
       )
       end
 
+      # [NOTE] It is recommended to use the `/v1/prices/evaluate` which offers further
+      # functionality, such as multiple prices, inline price definitions, and querying
+      # over preview events.
+      #
+      # This endpoint is used to evaluate the output of a price for a given customer and
+      # time range. It enables filtering and grouping the output using
+      # [computed properties](/extensibility/advanced-metrics#computed-properties),
+      # supporting the following workflows:
+      #
+      # 1. Showing detailed usage and costs to the end customer.
+      # 2. Auditing subtotals on invoice line items.
+      #
+      # For these workflows, the expressiveness of computed properties in both the
+      # filters and grouping is critical. For example, if you'd like to show your
+      # customer their usage grouped by hour and another property, you can do so with
+      # the following `grouping_keys`:
+      # `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`. If you'd
+      # like to examine a customer's usage for a specific property value, you can do so
+      # with the following `filter`:
+      # `my_property = 'foo' AND my_other_property = 'bar'`.
+      #
+      # By default, the start of the time range must be no more than 100 days ago and
+      # the length of the results must be no greater than 1000. Note that this is a POST
+      # endpoint rather than a GET endpoint because it employs a JSON body rather than
+      # query parameters.
+      sig do
+        params(
+          price_id: String,
+          timeframe_end: Time,
+          timeframe_start: Time,
+          customer_id: T.nilable(String),
+          external_customer_id: T.nilable(String),
+          filter: T.nilable(String),
+          grouping_keys: T::Array[String],
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::PriceEvaluateResponse)
+      end
+      def evaluate(
+        price_id,
+        # The exclusive upper bound for event timestamps
+        timeframe_end:,
+        # The inclusive lower bound for event timestamps
+        timeframe_start:,
+        # The ID of the customer to which this evaluation is scoped.
+        customer_id: nil,
+        # The external customer ID of the customer to which this evaluation is scoped.
+        external_customer_id: nil,
+        # A boolean
+        # [computed property](/extensibility/advanced-metrics#computed-properties) used to
+        # filter the underlying billable metric
+        filter: nil,
+        # Properties (or
+        # [computed properties](/extensibility/advanced-metrics#computed-properties)) used
+        # to group the underlying billable metric
+        grouping_keys: nil,
+        request_options: {}
+      )
+      end
+
       # This endpoint is used to evaluate the output of price(s) for a given customer
       # and time range over either ingested events or preview events. It enables
       # filtering and grouping the output using
@@ -218,14 +277,17 @@ module Orb
           timeframe_end: Time,
           timeframe_start: Time,
           customer_id: T.nilable(String),
-          events: T.nilable(T::Array[Orb::PriceEvaluateParams::Event::OrHash]),
+          events:
+            T.nilable(
+              T::Array[Orb::PriceEvaluateMultipleParams::Event::OrHash]
+            ),
           external_customer_id: T.nilable(String),
           price_evaluations:
-            T::Array[Orb::PriceEvaluateParams::PriceEvaluation::OrHash],
+            T::Array[Orb::PriceEvaluateMultipleParams::PriceEvaluation::OrHash],
           request_options: Orb::RequestOptions::OrHash
-        ).returns(Orb::Models::PriceEvaluateResponse)
+        ).returns(Orb::Models::PriceEvaluateMultipleResponse)
       end
-      def evaluate(
+      def evaluate_multiple(
         # The exclusive upper bound for event timestamps
         timeframe_end:,
         # The inclusive lower bound for event timestamps

data/sig/orb/client.rbs

@@ -12,6 +12,8 @@ module Orb
 
     attr_reader top_level: Orb::Resources::TopLevel
 
+    attr_reader beta: Orb::Resources::Beta
+
     attr_reader coupons: Orb::Resources::Coupons
 
     attr_reader credit_notes: Orb::Resources::CreditNotes