orb-billing 0.3.0 → 0.3.2

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

@@ -8,25 +8,24 @@ module Orb
         params(
           currency: String,
           invoice_date: Time,
-          line_items: T::Array[T.any(Orb::Models::InvoiceCreateParams::LineItem, Orb::Internal::AnyHash)],
+          line_items: T::Array[Orb::InvoiceCreateParams::LineItem::OrHash],
           net_terms: Integer,
           customer_id: T.nilable(String),
-          discount: T.nilable(
-            T.any(
-              Orb::Models::PercentageDiscount,
-              Orb::Internal::AnyHash,
-              Orb::Models::TrialDiscount,
-              Orb::Models::UsageDiscount,
-              Orb::Models::AmountDiscount
-            )
-          ),
+          discount:
+            T.nilable(
+              T.any(
+                Orb::PercentageDiscount::OrHash,
+                Orb::TrialDiscount::OrHash,
+                Orb::UsageDiscount::OrHash,
+                Orb::AmountDiscount::OrHash
+              )
+            ),
           external_customer_id: T.nilable(String),
           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))
-        )
-          .returns(Orb::Models::Invoice)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Invoice)
       end
       def create(
         # An ISO 4217 currency string. Must be the same as the customer's currency if it
@@ -60,7 +59,9 @@ module Orb
         # false.
         will_auto_issue: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint allows you to update the `metadata` property on an invoice. If you
       # pass null for the metadata value, it will clear any existing metadata for that
       # invoice.
@@ -70,9 +71,8 @@ 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))
-        )
-          .returns(Orb::Models::Invoice)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Invoice)
       end
       def update(
         invoice_id,
@@ -81,7 +81,9 @@ module Orb
         # by setting `metadata` to `null`.
         metadata: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint returns a list of all [`Invoice`](/core-concepts#invoice)s for an
       # account in a list format.
       #
@@ -102,7 +104,7 @@ module Orb
           amount_lt: T.nilable(String),
           cursor: T.nilable(String),
           customer_id: T.nilable(String),
-          date_type: T.nilable(Orb::Models::InvoiceListParams::DateType::OrSymbol),
+          date_type: T.nilable(Orb::InvoiceListParams::DateType::OrSymbol),
           due_date: T.nilable(Date),
           due_date_window: T.nilable(String),
           due_date_gt: T.nilable(Date),
@@ -114,11 +116,10 @@ module Orb
           invoice_date_lte: T.nilable(Time),
           is_recurring: T.nilable(T::Boolean),
           limit: Integer,
-          status: T.nilable(T::Array[Orb::Models::InvoiceListParams::Status::OrSymbol]),
+          status: T.nilable(T::Array[Orb::InvoiceListParams::Status::OrSymbol]),
           subscription_id: T.nilable(String),
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Internal::Page[Orb::Models::Invoice])
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Internal::Page[Orb::Invoice])
       end
       def list(
         amount: nil,
@@ -148,17 +149,19 @@ module Orb
         status: nil,
         subscription_id: nil,
         request_options: {}
-      ); end
+      )
+      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)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Invoice)
+      end
+      def fetch(invoice_id, request_options: {})
       end
-      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
@@ -166,11 +169,11 @@ module Orb
       sig do
         params(
           subscription_id: String,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Models::InvoiceFetchUpcomingResponse)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::InvoiceFetchUpcomingResponse)
+      end
+      def fetch_upcoming(subscription_id:, request_options: {})
       end
-      def fetch_upcoming(subscription_id:, request_options: {}); end
 
       # This endpoint allows an eligible invoice to be issued manually. This is only
       # possible with invoices where status is `draft`, `will_auto_issue` is false, and
@@ -182,9 +185,8 @@ module Orb
         params(
           invoice_id: String,
           synchronous: T::Boolean,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Models::Invoice)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Invoice)
       end
       def issue(
         invoice_id,
@@ -195,7 +197,9 @@ module Orb
         # present in the provider.
         synchronous: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint allows an invoice's status to be set the `paid` status. This can
       # only be done to invoices that are in the `issued` status.
       sig do
@@ -204,9 +208,8 @@ 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))
-        )
-          .returns(Orb::Models::Invoice)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Invoice)
       end
       def mark_paid(
         invoice_id,
@@ -217,17 +220,19 @@ module Orb
         # An optional note to associate with the payment.
         notes: nil,
         request_options: {}
-      ); end
+      )
+      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)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Invoice)
+      end
+      def pay(invoice_id, request_options: {})
       end
-      def pay(invoice_id, request_options: {}); end
 
       # This endpoint allows an invoice's status to be set the `void` status. This can
       # only be done to invoices that are in the `issued` status.
@@ -243,15 +248,16 @@ module Orb
       sig do
         params(
           invoice_id: String,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Models::Invoice)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Invoice)
+      end
+      def void(invoice_id, request_options: {})
       end
-      def void(invoice_id, request_options: {}); end
 
       # @api private
       sig { params(client: Orb::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

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

@@ -5,25 +5,37 @@ module Orb
     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)
+        params(
+          name: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Item)
       end
       def create(
         # The name of the item.
         name:,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint can be used to update properties on the Item.
       sig do
         params(
           item_id: String,
-          external_connections: T.nilable(T::Array[T.any(Orb::Models::ItemUpdateParams::ExternalConnection, Orb::Internal::AnyHash)]),
+          external_connections:
+            T.nilable(
+              T::Array[Orb::ItemUpdateParams::ExternalConnection::OrHash]
+            ),
           name: T.nilable(String),
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Models::Item)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Item)
+      end
+      def update(
+        item_id,
+        external_connections: nil,
+        name: nil,
+        request_options: {}
+      )
       end
-      def update(item_id, external_connections: nil, name: nil, request_options: {}); end
 
       # This endpoint returns a list of all Items, ordered in descending order by
       # creation time.
@@ -31,9 +43,8 @@ module Orb
         params(
           cursor: T.nilable(String),
           limit: Integer,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Internal::Page[Orb::Models::Item])
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Internal::Page[Orb::Item])
       end
       def list(
         # Cursor for pagination. This can be populated by the `next_cursor` value returned
@@ -42,20 +53,23 @@ module Orb
         # The number of items to fetch. Defaults to 20.
         limit: nil,
         request_options: {}
-      ); end
+      )
+      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)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Item)
+      end
+      def fetch(item_id, request_options: {})
       end
-      def fetch(item_id, request_options: {}); end
 
       # @api private
       sig { params(client: Orb::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

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

@@ -13,9 +13,8 @@ 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))
-        )
-          .returns(Orb::Models::BillableMetric)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::BillableMetric)
       end
       def create(
         # A description of the metric.
@@ -31,7 +30,9 @@ module Orb
         # by setting `metadata` to `null`.
         metadata: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint allows you to update the `metadata` property on a metric. If you
       # pass `null` for the metadata value, it will clear any existing metadata for that
       # invoice.
@@ -39,9 +40,8 @@ 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))
-        )
-          .returns(Orb::Models::BillableMetric)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::BillableMetric)
       end
       def update(
         metric_id,
@@ -50,7 +50,9 @@ module Orb
         # by setting `metadata` to `null`.
         metadata: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint is used to fetch [metric](/core-concepts##metric) details given a
       # metric identifier. It returns information about the metrics including its name,
       # description, and item.
@@ -62,9 +64,8 @@ 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))
-        )
-          .returns(Orb::Internal::Page[Orb::Models::BillableMetric])
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Internal::Page[Orb::BillableMetric])
       end
       def list(
         created_at_gt: nil,
@@ -77,21 +78,24 @@ module Orb
         # The number of items to fetch. Defaults to 20.
         limit: nil,
         request_options: {}
-      ); end
+      )
+      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)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::BillableMetric)
+      end
+      def fetch(metric_id, request_options: {})
       end
-      def fetch(metric_id, request_options: {}); end
 
       # @api private
       sig { params(client: Orb::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

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

@@ -13,9 +13,8 @@ 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))
-          )
-            .returns(Orb::Models::Plan)
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(Orb::Plan)
         end
         def update(
           other_external_plan_id,
@@ -28,7 +27,9 @@ module Orb
           # by setting `metadata` to `null`.
           metadata: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # This endpoint is used to fetch [plan](/core-concepts##plan-and-price) details
         # given an external_plan_id identifier. It returns information about the prices
         # included in the plan and their configuration, as well as the product that the
@@ -48,15 +49,16 @@ module Orb
         sig do
           params(
             external_plan_id: String,
-            request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-          )
-            .returns(Orb::Models::Plan)
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(Orb::Plan)
+        end
+        def fetch(external_plan_id, request_options: {})
         end
-        def fetch(external_plan_id, request_options: {}); end
 
         # @api private
         sig { params(client: Orb::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

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

@@ -11,44 +11,43 @@ module Orb
         params(
           currency: String,
           name: String,
-          prices: T::Array[
-            T.any(
-              Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice,
-              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
-            )
-          ],
+          prices:
+            T::Array[
+              T.any(
+                Orb::PlanCreateParams::Price::Unit::OrHash,
+                Orb::PlanCreateParams::Price::Package::OrHash,
+                Orb::PlanCreateParams::Price::Matrix::OrHash,
+                Orb::PlanCreateParams::Price::Tiered::OrHash,
+                Orb::PlanCreateParams::Price::TieredBps::OrHash,
+                Orb::PlanCreateParams::Price::Bps::OrHash,
+                Orb::PlanCreateParams::Price::BulkBps::OrHash,
+                Orb::PlanCreateParams::Price::Bulk::OrHash,
+                Orb::PlanCreateParams::Price::ThresholdTotalAmount::OrHash,
+                Orb::PlanCreateParams::Price::TieredPackage::OrHash,
+                Orb::PlanCreateParams::Price::TieredWithMinimum::OrHash,
+                Orb::PlanCreateParams::Price::UnitWithPercent::OrHash,
+                Orb::PlanCreateParams::Price::PackageWithAllocation::OrHash,
+                Orb::PlanCreateParams::Price::TieredWithProration::OrHash,
+                Orb::PlanCreateParams::Price::UnitWithProration::OrHash,
+                Orb::PlanCreateParams::Price::GroupedAllocation::OrHash,
+                Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::OrHash,
+                Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::OrHash,
+                Orb::PlanCreateParams::Price::MatrixWithDisplayName::OrHash,
+                Orb::PlanCreateParams::Price::BulkWithProration::OrHash,
+                Orb::PlanCreateParams::Price::GroupedTieredPackage::OrHash,
+                Orb::PlanCreateParams::Price::MaxGroupTieredPackage::OrHash,
+                Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::OrHash,
+                Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::OrHash,
+                Orb::PlanCreateParams::Price::CumulativeGroupedBulk::OrHash
+              )
+            ],
           default_invoice_memo: T.nilable(String),
           external_plan_id: T.nilable(String),
           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))
-        )
-          .returns(Orb::Models::Plan)
+          status: Orb::PlanCreateParams::Status::OrSymbol,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Plan)
       end
       def create(
         # An ISO 4217 currency string for invoices generated by subscriptions on this
@@ -73,7 +72,9 @@ module Orb
         # this defaults to active.
         status: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint can be used to update the `external_plan_id`, and `metadata` of an
       # existing plan.
       #
@@ -83,9 +84,8 @@ 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))
-        )
-          .returns(Orb::Models::Plan)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Plan)
       end
       def update(
         plan_id,
@@ -98,7 +98,9 @@ module Orb
         # by setting `metadata` to `null`.
         metadata: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint returns a list of all [plans](/core-concepts#plan-and-price) for
       # an account in a list format. The list of plans is ordered starting from the most
       # recently created plan. The response also includes
@@ -112,10 +114,9 @@ module Orb
           created_at_lte: T.nilable(Time),
           cursor: T.nilable(String),
           limit: Integer,
-          status: Orb::Models::PlanListParams::Status::OrSymbol,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Internal::Page[Orb::Models::Plan])
+          status: Orb::PlanListParams::Status::OrSymbol,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Internal::Page[Orb::Plan])
       end
       def list(
         created_at_gt: nil,
@@ -130,7 +131,9 @@ module Orb
         # The plan status to filter to ('active', 'archived', or 'draft').
         status: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint is used to fetch [plan](/core-concepts#plan-and-price) details
       # given a plan identifier. It returns information about the prices included in the
       # plan and their configuration, as well as the product that the plan is attached
@@ -151,15 +154,16 @@ module Orb
       sig do
         params(
           plan_id: String,
-          request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
-        )
-          .returns(Orb::Models::Plan)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Plan)
+      end
+      def fetch(plan_id, request_options: {})
       end
-      def fetch(plan_id, request_options: {}); end
 
       # @api private
       sig { params(client: Orb::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end