orb-billing 0.3.0 → 0.3.2

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

@@ -6,6 +6,8 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+
       # The currency or custom pricing unit to use.
       sig { returns(T.nilable(String)) }
       attr_accessor :currency
@@ -22,7 +24,11 @@ module Orb
       # 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.
-      sig { returns(T.nilable(Orb::Models::SubscriptionFetchCostsParams::ViewMode::OrSymbol)) }
+      sig do
+        returns(
+          T.nilable(Orb::SubscriptionFetchCostsParams::ViewMode::OrSymbol)
+        )
+      end
       attr_accessor :view_mode
 
       sig do
@@ -30,10 +36,10 @@ module Orb
           currency: T.nilable(String),
           timeframe_end: T.nilable(Time),
           timeframe_start: T.nilable(Time),
-          view_mode: T.nilable(Orb::Models::SubscriptionFetchCostsParams::ViewMode::OrSymbol),
-          request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          view_mode:
+            T.nilable(Orb::SubscriptionFetchCostsParams::ViewMode::OrSymbol),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
         # The currency or custom pricing unit to use.
@@ -48,20 +54,23 @@ module Orb
         # behavior.
         view_mode: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              currency: T.nilable(String),
-              timeframe_end: T.nilable(Time),
-              timeframe_start: T.nilable(Time),
-              view_mode: T.nilable(Orb::Models::SubscriptionFetchCostsParams::ViewMode::OrSymbol),
-              request_options: Orb::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            currency: T.nilable(String),
+            timeframe_end: T.nilable(Time),
+            timeframe_start: T.nilable(Time),
+            view_mode:
+              T.nilable(Orb::SubscriptionFetchCostsParams::ViewMode::OrSymbol),
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       # 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
@@ -70,14 +79,30 @@ module Orb
       module ViewMode
         extend Orb::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode) }
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::SubscriptionFetchCostsParams::ViewMode)
+          end
         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)
+        PERIODIC =
+          T.let(
+            :periodic,
+            Orb::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol
+          )
+        CUMULATIVE =
+          T.let(
+            :cumulative,
+            Orb::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol
+          )
 
-        sig { override.returns(T::Array[Orb::Models::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol]) }
-        def self.values; end
+        sig do
+          override.returns(
+            T::Array[Orb::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
       end
     end
   end

data/rbi/orb/models/subscription_fetch_costs_response.rbi

@@ -0,0 +1,252 @@
+# typed: strong
+
+module Orb
+  module Models
+    class SubscriptionFetchCostsResponse < Orb::Internal::Type::BaseModel
+      OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+
+      sig do
+        returns(T::Array[Orb::Models::SubscriptionFetchCostsResponse::Data])
+      end
+      attr_accessor :data
+
+      sig do
+        params(
+          data:
+            T::Array[Orb::Models::SubscriptionFetchCostsResponse::Data::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(data:)
+      end
+
+      sig do
+        override.returns(
+          { data: T::Array[Orb::Models::SubscriptionFetchCostsResponse::Data] }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Orb::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+
+        sig do
+          returns(
+            T::Array[
+              Orb::Models::SubscriptionFetchCostsResponse::Data::PerPriceCost
+            ]
+          )
+        end
+        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[
+                Orb::Models::SubscriptionFetchCostsResponse::Data::PerPriceCost::OrHash
+              ],
+            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
+          OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+
+          # The price object
+          sig do
+            returns(
+              T.any(
+                Orb::Price::Unit,
+                Orb::Price::Package,
+                Orb::Price::Matrix,
+                Orb::Price::Tiered,
+                Orb::Price::TieredBps,
+                Orb::Price::Bps,
+                Orb::Price::BulkBps,
+                Orb::Price::Bulk,
+                Orb::Price::ThresholdTotalAmount,
+                Orb::Price::TieredPackage,
+                Orb::Price::GroupedTiered,
+                Orb::Price::TieredWithMinimum,
+                Orb::Price::TieredPackageWithMinimum,
+                Orb::Price::PackageWithAllocation,
+                Orb::Price::UnitWithPercent,
+                Orb::Price::MatrixWithAllocation,
+                Orb::Price::TieredWithProration,
+                Orb::Price::UnitWithProration,
+                Orb::Price::GroupedAllocation,
+                Orb::Price::GroupedWithProratedMinimum,
+                Orb::Price::GroupedWithMeteredMinimum,
+                Orb::Price::MatrixWithDisplayName,
+                Orb::Price::BulkWithProration,
+                Orb::Price::GroupedTieredPackage,
+                Orb::Price::MaxGroupTieredPackage,
+                Orb::Price::ScalableMatrixWithUnitPricing,
+                Orb::Price::ScalableMatrixWithTieredPricing,
+                Orb::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::Price::Unit::OrHash,
+                  Orb::Price::Package::OrHash,
+                  Orb::Price::Matrix::OrHash,
+                  Orb::Price::Tiered::OrHash,
+                  Orb::Price::TieredBps::OrHash,
+                  Orb::Price::Bps::OrHash,
+                  Orb::Price::BulkBps::OrHash,
+                  Orb::Price::Bulk::OrHash,
+                  Orb::Price::ThresholdTotalAmount::OrHash,
+                  Orb::Price::TieredPackage::OrHash,
+                  Orb::Price::GroupedTiered::OrHash,
+                  Orb::Price::TieredWithMinimum::OrHash,
+                  Orb::Price::TieredPackageWithMinimum::OrHash,
+                  Orb::Price::PackageWithAllocation::OrHash,
+                  Orb::Price::UnitWithPercent::OrHash,
+                  Orb::Price::MatrixWithAllocation::OrHash,
+                  Orb::Price::TieredWithProration::OrHash,
+                  Orb::Price::UnitWithProration::OrHash,
+                  Orb::Price::GroupedAllocation::OrHash,
+                  Orb::Price::GroupedWithProratedMinimum::OrHash,
+                  Orb::Price::GroupedWithMeteredMinimum::OrHash,
+                  Orb::Price::MatrixWithDisplayName::OrHash,
+                  Orb::Price::BulkWithProration::OrHash,
+                  Orb::Price::GroupedTieredPackage::OrHash,
+                  Orb::Price::MaxGroupTieredPackage::OrHash,
+                  Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
+                  Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
+                  Orb::Price::CumulativeGroupedBulk::OrHash
+                ),
+              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::Price::Unit,
+                    Orb::Price::Package,
+                    Orb::Price::Matrix,
+                    Orb::Price::Tiered,
+                    Orb::Price::TieredBps,
+                    Orb::Price::Bps,
+                    Orb::Price::BulkBps,
+                    Orb::Price::Bulk,
+                    Orb::Price::ThresholdTotalAmount,
+                    Orb::Price::TieredPackage,
+                    Orb::Price::GroupedTiered,
+                    Orb::Price::TieredWithMinimum,
+                    Orb::Price::TieredPackageWithMinimum,
+                    Orb::Price::PackageWithAllocation,
+                    Orb::Price::UnitWithPercent,
+                    Orb::Price::MatrixWithAllocation,
+                    Orb::Price::TieredWithProration,
+                    Orb::Price::UnitWithProration,
+                    Orb::Price::GroupedAllocation,
+                    Orb::Price::GroupedWithProratedMinimum,
+                    Orb::Price::GroupedWithMeteredMinimum,
+                    Orb::Price::MatrixWithDisplayName,
+                    Orb::Price::BulkWithProration,
+                    Orb::Price::GroupedTieredPackage,
+                    Orb::Price::MaxGroupTieredPackage,
+                    Orb::Price::ScalableMatrixWithUnitPricing,
+                    Orb::Price::ScalableMatrixWithTieredPricing,
+                    Orb::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/orb/models/subscription_fetch_params.rbi

@@ -0,0 +1,24 @@
+# typed: strong
+
+module Orb
+  module Models
+    class SubscriptionFetchParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+
+      sig do
+        params(request_options: Orb::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

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

@@ -6,6 +6,8 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+
       # Cursor for pagination. This can be populated by the `next_cursor` value returned
       # from the initial request.
       sig { returns(T.nilable(String)) }
@@ -38,9 +40,8 @@ module Orb
           start_date_gte: T.nilable(Time),
           start_date_lt: T.nilable(Time),
           start_date_lte: T.nilable(Time),
-          request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
         # Cursor for pagination. This can be populated by the `next_cursor` value returned
@@ -53,22 +54,24 @@ module Orb
         start_date_lt: nil,
         start_date_lte: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              cursor: T.nilable(String),
-              limit: Integer,
-              start_date_gt: T.nilable(Time),
-              start_date_gte: T.nilable(Time),
-              start_date_lt: T.nilable(Time),
-              start_date_lte: T.nilable(Time),
-              request_options: Orb::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            cursor: T.nilable(String),
+            limit: Integer,
+            start_date_gt: T.nilable(Time),
+            start_date_gte: T.nilable(Time),
+            start_date_lt: T.nilable(Time),
+            start_date_lte: T.nilable(Time),
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

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

@@ -3,6 +3,8 @@
 module Orb
   module Models
     class SubscriptionFetchScheduleResponse < Orb::Internal::Type::BaseModel
+      OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+
       sig { returns(Time) }
       attr_accessor :created_at
 
@@ -12,7 +14,11 @@ module Orb
       sig { returns(Orb::Models::SubscriptionFetchScheduleResponse::Plan) }
       attr_reader :plan
 
-      sig { params(plan: T.any(Orb::Models::SubscriptionFetchScheduleResponse::Plan, Orb::Internal::AnyHash)).void }
+      sig do
+        params(
+          plan: Orb::Models::SubscriptionFetchScheduleResponse::Plan::OrHash
+        ).void
+      end
       attr_writer :plan
 
       sig { returns(Time) }
@@ -22,27 +28,29 @@ module Orb
         params(
           created_at: Time,
           end_date: T.nilable(Time),
-          plan: T.any(Orb::Models::SubscriptionFetchScheduleResponse::Plan, Orb::Internal::AnyHash),
+          plan: Orb::Models::SubscriptionFetchScheduleResponse::Plan::OrHash,
           start_date: Time
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.new(created_at:, end_date:, plan:, start_date:)
       end
-      def self.new(created_at:, end_date:, plan:, start_date:); end
 
       sig do
-        override
-          .returns(
-            {
-              created_at: Time,
-              end_date: T.nilable(Time),
-              plan: Orb::Models::SubscriptionFetchScheduleResponse::Plan,
-              start_date: Time
-            }
-          )
+        override.returns(
+          {
+            created_at: Time,
+            end_date: T.nilable(Time),
+            plan: Orb::Models::SubscriptionFetchScheduleResponse::Plan,
+            start_date: Time
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       class Plan < Orb::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+
         sig { returns(T.nilable(String)) }
         attr_accessor :id
 
@@ -56,8 +64,11 @@ module Orb
         attr_accessor :name
 
         sig do
-          params(id: T.nilable(String), external_plan_id: T.nilable(String), name: T.nilable(String))
-            .returns(T.attached_class)
+          params(
+            id: T.nilable(String),
+            external_plan_id: T.nilable(String),
+            name: T.nilable(String)
+          ).returns(T.attached_class)
         end
         def self.new(
           id:,
@@ -66,7 +77,9 @@ module Orb
           # identifier in your system.
           external_plan_id:,
           name:
-        ); end
+        )
+        end
+
         sig do
           override.returns(
             {
@@ -76,7 +89,8 @@ module Orb
             }
           )
         end
-        def to_hash; end
+        def to_hash
+        end
       end
     end
   end