orb-billing 0.2.0 → 0.3.1

data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi

@@ -36,14 +36,19 @@ module Orb
           .returns(T.attached_class)
       end
       def self.new(
+        # The currency or custom pricing unit to use.
         currency: nil,
+        # Costs returned are exclusive of `timeframe_end`.
         timeframe_end: nil,
+        # Costs returned are inclusive of `timeframe_start`.
         timeframe_start: nil,
+        # Controls whether Orb returns cumulative costs since the start of the billing
+        # period, or incremental day-by-day costs. If your customer has minimums or
+        # discounts, it's strongly recommended that you use the default cumulative
+        # behavior.
         view_mode: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(
@@ -66,8 +71,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         PERIODIC = T.let(:periodic, Orb::Models::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol)
         CUMULATIVE = T.let(:cumulative, Orb::Models::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol)

data/rbi/orb/models/subscription_fetch_costs_response.rbi

@@ -0,0 +1,221 @@
+# typed: strong
+
+module Orb
+  module Models
+    class SubscriptionFetchCostsResponse < Orb::Internal::Type::BaseModel
+      sig { returns(T::Array[Orb::Models::SubscriptionFetchCostsResponse::Data]) }
+      attr_accessor :data
+
+      sig do
+        params(data: T::Array[T.any(Orb::Models::SubscriptionFetchCostsResponse::Data, Orb::Internal::AnyHash)])
+          .returns(T.attached_class)
+      end
+      def self.new(data:); end
+
+      sig { override.returns({data: T::Array[Orb::Models::SubscriptionFetchCostsResponse::Data]}) }
+      def to_hash; end
+
+      class Data < Orb::Internal::Type::BaseModel
+        sig { returns(T::Array[Orb::Models::SubscriptionFetchCostsResponse::Data::PerPriceCost]) }
+        attr_accessor :per_price_costs
+
+        # Total costs for the timeframe, excluding any minimums and discounts.
+        sig { returns(String) }
+        attr_accessor :subtotal
+
+        sig { returns(Time) }
+        attr_accessor :timeframe_end
+
+        sig { returns(Time) }
+        attr_accessor :timeframe_start
+
+        # Total costs for the timeframe, including any minimums and discounts.
+        sig { returns(String) }
+        attr_accessor :total
+
+        sig do
+          params(
+            per_price_costs: T::Array[T.any(Orb::Models::SubscriptionFetchCostsResponse::Data::PerPriceCost, Orb::Internal::AnyHash)],
+            subtotal: String,
+            timeframe_end: Time,
+            timeframe_start: Time,
+            total: String
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          per_price_costs:,
+          # Total costs for the timeframe, excluding any minimums and discounts.
+          subtotal:,
+          timeframe_end:,
+          timeframe_start:,
+          # Total costs for the timeframe, including any minimums and discounts.
+          total:
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                per_price_costs: T::Array[Orb::Models::SubscriptionFetchCostsResponse::Data::PerPriceCost],
+                subtotal: String,
+                timeframe_end: Time,
+                timeframe_start: Time,
+                total: String
+              }
+            )
+        end
+        def to_hash; end
+
+        class PerPriceCost < Orb::Internal::Type::BaseModel
+          # The price object
+          sig do
+            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
+          attr_accessor :price
+
+          # The price the cost is associated with
+          sig { returns(String) }
+          attr_accessor :price_id
+
+          # Price's contributions for the timeframe, excluding any minimums and discounts.
+          sig { returns(String) }
+          attr_accessor :subtotal
+
+          # Price's contributions for the timeframe, including minimums and discounts.
+          sig { returns(String) }
+          attr_accessor :total
+
+          # The price's quantity for the timeframe
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :quantity
+
+          sig do
+            params(
+              price: T.any(
+                Orb::Models::Price::Unit,
+                Orb::Internal::AnyHash,
+                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
+              ),
+              price_id: String,
+              subtotal: String,
+              total: String,
+              quantity: T.nilable(Float)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # The price object
+            price:,
+            # The price the cost is associated with
+            price_id:,
+            # Price's contributions for the timeframe, excluding any minimums and discounts.
+            subtotal:,
+            # Price's contributions for the timeframe, including minimums and discounts.
+            total:,
+            # The price's quantity for the timeframe
+            quantity: nil
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  price: 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
+                  ),
+                  price_id: String,
+                  subtotal: String,
+                  total: String,
+                  quantity: T.nilable(Float)
+                }
+              )
+          end
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi

@@ -43,7 +43,10 @@ module Orb
           .returns(T.attached_class)
       end
       def self.new(
+        # Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # from the initial request.
         cursor: nil,
+        # The number of items to fetch. Defaults to 20.
         limit: nil,
         start_date_gt: nil,
         start_date_gte: nil,

data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi

@@ -59,8 +59,14 @@ module Orb
           params(id: T.nilable(String), external_plan_id: T.nilable(String), name: T.nilable(String))
             .returns(T.attached_class)
         end
-        def self.new(id:, external_plan_id:, name:); end
-
+        def self.new(
+          id:,
+          # An optional user-defined ID for this plan resource, used throughout the system
+          # as an alias for this Plan. Use this field to identify a plan by an existing
+          # identifier in your system.
+          external_plan_id:,
+          name:
+        ); end
         sig do
           override.returns(
             {

data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi

@@ -64,15 +64,26 @@ module Orb
           .returns(T.attached_class)
       end
       def self.new(
+        # When specified in conjunction with `group_by`, this parameter filters usage to a
+        # single billable metric. Note that both `group_by` and `billable_metric_id` must
+        # be specified together.
         billable_metric_id: nil,
         first_dimension_key: nil,
         first_dimension_value: nil,
+        # This determines the windowing of usage reporting.
         granularity: nil,
+        # Groups per-price usage by the key provided.
         group_by: nil,
         second_dimension_key: nil,
         second_dimension_value: nil,
+        # Usage returned is exclusive of `timeframe_end`.
         timeframe_end: nil,
+        # Usage returned is inclusive of `timeframe_start`.
         timeframe_start: nil,
+        # Controls whether Orb returns cumulative usage since the start of the billing
+        # period, or incremental day-by-day usage. If your customer has minimums or
+        # discounts, it's strongly recommended that you use the default cumulative
+        # behavior.
         view_mode: nil,
         request_options: {}
       ); end
@@ -101,8 +112,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionFetchUsageParams::Granularity) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionFetchUsageParams::Granularity::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         DAY = T.let(:day, Orb::Models::SubscriptionFetchUsageParams::Granularity::TaggedSymbol)
 
@@ -118,8 +128,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionFetchUsageParams::ViewMode::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         PERIODIC = T.let(:periodic, Orb::Models::SubscriptionFetchUsageParams::ViewMode::TaggedSymbol)
         CUMULATIVE = T.let(:cumulative, Orb::Models::SubscriptionFetchUsageParams::ViewMode::TaggedSymbol)

data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi

@@ -59,9 +59,12 @@ module Orb
         created_at_gte: nil,
         created_at_lt: nil,
         created_at_lte: nil,
+        # Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # from the initial request.
         cursor: nil,
         customer_id: nil,
         external_customer_id: nil,
+        # The number of items to fetch. Defaults to 20.
         limit: nil,
         status: nil,
         request_options: {}
@@ -89,8 +92,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionListParams::Status) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionListParams::Status::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         ACTIVE = T.let(:active, Orb::Models::SubscriptionListParams::Status::TaggedSymbol)
         ENDED = T.let(:ended, Orb::Models::SubscriptionListParams::Status::TaggedSymbol)