orb-billing 0.3.0 → 0.3.1

data/rbi/{lib/orb → orb}/resources/events.rbi

@@ -62,7 +62,7 @@ module Orb
           timestamp: Time,
           customer_id: T.nilable(String),
           external_customer_id: T.nilable(String),
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Models::EventUpdateResponse)
       end
@@ -124,13 +124,7 @@ module Orb
       # - By default, no more than 100 events can be deprecated for a single customer in
       #   a 100 day period. For higher volume updates, consider using the
       #   [event backfill](create-backfill) endpoint.
-      sig do
-        params(
-          event_id: String,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Models::EventDeprecateResponse)
-      end
+      sig { params(event_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::EventDeprecateResponse) }
       def deprecate(event_id, request_options: {}); end
 
       # Orb's event ingestion model and API is designed around two core principles:
@@ -342,7 +336,7 @@ module Orb
           events: T::Array[T.any(Orb::Models::EventIngestParams::Event, Orb::Internal::AnyHash)],
           backfill_id: T.nilable(String),
           debug: T::Boolean,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Models::EventIngestResponse)
       end
@@ -377,7 +371,7 @@ module Orb
           event_ids: T::Array[String],
           timeframe_end: T.nilable(Time),
           timeframe_start: T.nilable(Time),
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Models::EventSearchResponse)
       end

data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi

@@ -13,7 +13,7 @@ module Orb
           name: String,
           quantity: Float,
           start_date: Date,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Models::InvoiceLineItemCreateResponse)
       end

data/rbi/{lib/orb → orb}/resources/invoices.rbi

@@ -24,7 +24,7 @@ module Orb
           memo: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
           will_auto_issue: T::Boolean,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Models::Invoice)
       end
@@ -70,7 +70,7 @@ module Orb
         params(
           invoice_id: String,
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Models::Invoice)
       end
@@ -116,7 +116,7 @@ module Orb
           limit: Integer,
           status: T.nilable(T::Array[Orb::Models::InvoiceListParams::Status::OrSymbol]),
           subscription_id: T.nilable(String),
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Internal::Page[Orb::Models::Invoice])
       end
@@ -151,23 +151,14 @@ module Orb
       ); end
       # This endpoint is used to fetch an [`Invoice`](/core-concepts#invoice) given an
       # identifier.
-      sig do
-        params(
-          invoice_id: String,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Models::Invoice)
-      end
+      sig { params(invoice_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Invoice) }
       def fetch(invoice_id, request_options: {}); end
 
       # This endpoint can be used to fetch the upcoming
       # [invoice](/core-concepts#invoice) for the current billing period given a
       # subscription.
       sig do
-        params(
-          subscription_id: String,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
+        params(subscription_id: String, request_options: Orb::RequestOpts)
           .returns(Orb::Models::InvoiceFetchUpcomingResponse)
       end
       def fetch_upcoming(subscription_id:, request_options: {}); end
@@ -179,11 +170,7 @@ module Orb
       # sending emails, auto-collecting payment, syncing the invoice to external
       # providers, etc).
       sig do
-        params(
-          invoice_id: String,
-          synchronous: T::Boolean,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
+        params(invoice_id: String, synchronous: T::Boolean, request_options: Orb::RequestOpts)
           .returns(Orb::Models::Invoice)
       end
       def issue(
@@ -204,7 +191,7 @@ module Orb
           payment_received_date: Date,
           external_id: T.nilable(String),
           notes: T.nilable(String),
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Models::Invoice)
       end
@@ -220,13 +207,7 @@ module Orb
       ); end
       # This endpoint collects payment for an invoice using the customer's default
       # payment method. This action can only be taken on invoices with status "issued".
-      sig do
-        params(
-          invoice_id: String,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Models::Invoice)
-      end
+      sig { params(invoice_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Invoice) }
       def pay(invoice_id, request_options: {}); end
 
       # This endpoint allows an invoice's status to be set the `void` status. This can
@@ -240,13 +221,7 @@ module Orb
       # If the invoice was used to purchase a credit block, but the invoice is not yet
       # paid, the credit block will be voided. If the invoice was created due to a
       # top-up, the top-up will be disabled.
-      sig do
-        params(
-          invoice_id: String,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Models::Invoice)
-      end
+      sig { params(invoice_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Invoice) }
       def void(invoice_id, request_options: {}); end
 
       # @api private

data/rbi/{lib/orb → orb}/resources/items.rbi

@@ -4,10 +4,7 @@ module Orb
   module Resources
     class Items
       # This endpoint is used to create an [Item](/core-concepts#item).
-      sig do
-        params(name: String, request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash)))
-          .returns(Orb::Models::Item)
-      end
+      sig { params(name: String, request_options: Orb::RequestOpts).returns(Orb::Models::Item) }
       def create(
         # The name of the item.
         name:,
@@ -19,7 +16,7 @@ module Orb
           item_id: String,
           external_connections: T.nilable(T::Array[T.any(Orb::Models::ItemUpdateParams::ExternalConnection, Orb::Internal::AnyHash)]),
           name: T.nilable(String),
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Models::Item)
       end
@@ -28,11 +25,7 @@ module Orb
       # This endpoint returns a list of all Items, ordered in descending order by
       # creation time.
       sig do
-        params(
-          cursor: T.nilable(String),
-          limit: Integer,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
+        params(cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOpts)
           .returns(Orb::Internal::Page[Orb::Models::Item])
       end
       def list(
@@ -44,13 +37,7 @@ module Orb
         request_options: {}
       ); end
       # This endpoint returns an item identified by its item_id.
-      sig do
-        params(
-          item_id: String,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Models::Item)
-      end
+      sig { params(item_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Item) }
       def fetch(item_id, request_options: {}); end
 
       # @api private

data/rbi/{lib/orb → orb}/resources/metrics.rbi

@@ -13,7 +13,7 @@ module Orb
           name: String,
           sql: String,
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Models::BillableMetric)
       end
@@ -39,7 +39,7 @@ module Orb
         params(
           metric_id: String,
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Models::BillableMetric)
       end
@@ -62,7 +62,7 @@ module Orb
           created_at_lte: T.nilable(Time),
           cursor: T.nilable(String),
           limit: Integer,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Internal::Page[Orb::Models::BillableMetric])
       end
@@ -80,13 +80,7 @@ module Orb
       ); end
       # This endpoint is used to list [metrics](/core-concepts#metric). It returns
       # information about the metrics including its name, description, and item.
-      sig do
-        params(
-          metric_id: String,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Models::BillableMetric)
-      end
+      sig { params(metric_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::BillableMetric) }
       def fetch(metric_id, request_options: {}); end
 
       # @api private

data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi

@@ -13,7 +13,7 @@ module Orb
             other_external_plan_id: String,
             external_plan_id: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
-            request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+            request_options: Orb::RequestOpts
           )
             .returns(Orb::Models::Plan)
         end
@@ -45,13 +45,7 @@ module Orb
         # object. The `model_type` field determines the key for the configuration object
         # that is present. A detailed explanation of price types can be found in the
         # [Price schema](/core-concepts#plan-and-price). "
-        sig do
-          params(
-            external_plan_id: String,
-            request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-          )
-            .returns(Orb::Models::Plan)
-        end
+        sig { params(external_plan_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Plan) }
         def fetch(external_plan_id, request_options: {}); end
 
         # @api private

data/rbi/{lib/orb → orb}/resources/plans.rbi

@@ -13,32 +13,32 @@ module Orb
           name: String,
           prices: T::Array[
             T.any(
-              Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice,
+              Orb::Models::PlanCreateParams::Price::Unit,
               Orb::Internal::AnyHash,
-              Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice,
-              Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice
+              Orb::Models::PlanCreateParams::Price::Package,
+              Orb::Models::PlanCreateParams::Price::Matrix,
+              Orb::Models::PlanCreateParams::Price::Tiered,
+              Orb::Models::PlanCreateParams::Price::TieredBps,
+              Orb::Models::PlanCreateParams::Price::Bps,
+              Orb::Models::PlanCreateParams::Price::BulkBps,
+              Orb::Models::PlanCreateParams::Price::Bulk,
+              Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount,
+              Orb::Models::PlanCreateParams::Price::TieredPackage,
+              Orb::Models::PlanCreateParams::Price::TieredWithMinimum,
+              Orb::Models::PlanCreateParams::Price::UnitWithPercent,
+              Orb::Models::PlanCreateParams::Price::PackageWithAllocation,
+              Orb::Models::PlanCreateParams::Price::TieredWithProration,
+              Orb::Models::PlanCreateParams::Price::UnitWithProration,
+              Orb::Models::PlanCreateParams::Price::GroupedAllocation,
+              Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum,
+              Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum,
+              Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName,
+              Orb::Models::PlanCreateParams::Price::BulkWithProration,
+              Orb::Models::PlanCreateParams::Price::GroupedTieredPackage,
+              Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage,
+              Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing,
+              Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing,
+              Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk
             )
           ],
           default_invoice_memo: T.nilable(String),
@@ -46,7 +46,7 @@ module Orb
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
           net_terms: T.nilable(Integer),
           status: Orb::Models::PlanCreateParams::Status::OrSymbol,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Models::Plan)
       end
@@ -83,7 +83,7 @@ module Orb
           plan_id: String,
           external_plan_id: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Models::Plan)
       end
@@ -113,7 +113,7 @@ module Orb
           cursor: T.nilable(String),
           limit: Integer,
           status: Orb::Models::PlanListParams::Status::OrSymbol,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
+          request_options: Orb::RequestOpts
         )
           .returns(Orb::Internal::Page[Orb::Models::Plan])
       end
@@ -148,13 +148,7 @@ module Orb
       #
       # Orb supports plan phases, also known as contract ramps. For plans with phases,
       # the serialized prices refer to all prices across all phases.
-      sig do
-        params(
-          plan_id: String,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Models::Plan)
-      end
+      sig { params(plan_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Plan) }
       def fetch(plan_id, request_options: {}); end
 
       # @api private

data/rbi/orb/resources/prices/external_price_id.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Orb
+  module Resources
+    class Prices
+      class ExternalPriceID
+        # This endpoint allows you to update the `metadata` property on a price. If you
+        # pass null for the metadata value, it will clear any existing metadata for that
+        # price.
+        sig do
+          params(
+            external_price_id: String,
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            request_options: Orb::RequestOpts
+          )
+            .returns(
+              T.any(
+                Orb::Models::Price::Unit,
+                Orb::Models::Price::Package,
+                Orb::Models::Price::Matrix,
+                Orb::Models::Price::Tiered,
+                Orb::Models::Price::TieredBps,
+                Orb::Models::Price::Bps,
+                Orb::Models::Price::BulkBps,
+                Orb::Models::Price::Bulk,
+                Orb::Models::Price::ThresholdTotalAmount,
+                Orb::Models::Price::TieredPackage,
+                Orb::Models::Price::GroupedTiered,
+                Orb::Models::Price::TieredWithMinimum,
+                Orb::Models::Price::TieredPackageWithMinimum,
+                Orb::Models::Price::PackageWithAllocation,
+                Orb::Models::Price::UnitWithPercent,
+                Orb::Models::Price::MatrixWithAllocation,
+                Orb::Models::Price::TieredWithProration,
+                Orb::Models::Price::UnitWithProration,
+                Orb::Models::Price::GroupedAllocation,
+                Orb::Models::Price::GroupedWithProratedMinimum,
+                Orb::Models::Price::GroupedWithMeteredMinimum,
+                Orb::Models::Price::MatrixWithDisplayName,
+                Orb::Models::Price::BulkWithProration,
+                Orb::Models::Price::GroupedTieredPackage,
+                Orb::Models::Price::MaxGroupTieredPackage,
+                Orb::Models::Price::ScalableMatrixWithUnitPricing,
+                Orb::Models::Price::ScalableMatrixWithTieredPricing,
+                Orb::Models::Price::CumulativeGroupedBulk
+              )
+            )
+        end
+        def update(
+          external_price_id,
+          # User-specified key/value pairs for the resource. Individual keys can be removed
+          # by setting the value to `null`, and the entire metadata mapping can be cleared
+          # by setting `metadata` to `null`.
+          metadata: nil,
+          request_options: {}
+        ); end
+        # This endpoint returns a price given an external price id. See the
+        # [price creation API](/api-reference/price/create-price) for more information
+        # about external price aliases.
+        sig do
+          params(external_price_id: String, request_options: Orb::RequestOpts)
+            .returns(
+              T.any(
+                Orb::Models::Price::Unit,
+                Orb::Models::Price::Package,
+                Orb::Models::Price::Matrix,
+                Orb::Models::Price::Tiered,
+                Orb::Models::Price::TieredBps,
+                Orb::Models::Price::Bps,
+                Orb::Models::Price::BulkBps,
+                Orb::Models::Price::Bulk,
+                Orb::Models::Price::ThresholdTotalAmount,
+                Orb::Models::Price::TieredPackage,
+                Orb::Models::Price::GroupedTiered,
+                Orb::Models::Price::TieredWithMinimum,
+                Orb::Models::Price::TieredPackageWithMinimum,
+                Orb::Models::Price::PackageWithAllocation,
+                Orb::Models::Price::UnitWithPercent,
+                Orb::Models::Price::MatrixWithAllocation,
+                Orb::Models::Price::TieredWithProration,
+                Orb::Models::Price::UnitWithProration,
+                Orb::Models::Price::GroupedAllocation,
+                Orb::Models::Price::GroupedWithProratedMinimum,
+                Orb::Models::Price::GroupedWithMeteredMinimum,
+                Orb::Models::Price::MatrixWithDisplayName,
+                Orb::Models::Price::BulkWithProration,
+                Orb::Models::Price::GroupedTieredPackage,
+                Orb::Models::Price::MaxGroupTieredPackage,
+                Orb::Models::Price::ScalableMatrixWithUnitPricing,
+                Orb::Models::Price::ScalableMatrixWithTieredPricing,
+                Orb::Models::Price::CumulativeGroupedBulk
+              )
+            )
+        end
+        def fetch(external_price_id, request_options: {}); end
+
+        # @api private
+        sig { params(client: Orb::Client).returns(T.attached_class) }
+        def self.new(client:); end
+      end
+    end
+  end
+end