orb-billing 0.2.0 → 0.3.0

data/rbi/lib/orb/internal/transport/base_client.rbi

@@ -24,7 +24,14 @@ module Orb
                         )]
               ),
               body: T.nilable(T.anything),
-              unwrap: T.nilable(Symbol),
+              unwrap: T.nilable(
+                T.any(
+                  Symbol,
+                  Integer,
+                  T::Array[T.any(Symbol, Integer)],
+                  T.proc.params(arg0: T.anything).returns(T.anything)
+                )
+              ),
               page: T.nilable(T::Class[Orb::Internal::Type::BasePage[Orb::Internal::Type::BaseModel]]),
               stream: T.nilable(T::Class[T.anything]),
               model: T.nilable(Orb::Internal::Type::Converter::Input),
@@ -90,7 +97,7 @@ module Orb
 
         # @api private
         sig { returns(Orb::Internal::Transport::PooledNetRequester) }
-        attr_accessor :requester
+        attr_reader :requester
 
         # @api private
         sig do
@@ -167,7 +174,14 @@ module Orb
                       )]
             ),
             body: T.nilable(T.anything),
-            unwrap: T.nilable(Symbol),
+            unwrap: T.nilable(
+              T.any(
+                Symbol,
+                Integer,
+                T::Array[T.any(Symbol, Integer)],
+                T.proc.params(arg0: T.anything).returns(T.anything)
+              )
+            ),
             page: T.nilable(T::Class[Orb::Internal::Type::BasePage[Orb::Internal::Type::BaseModel]]),
             stream: T.nilable(T::Class[T.anything]),
             model: T.nilable(Orb::Internal::Type::Converter::Input),

data/rbi/lib/orb/internal/type/array_of.rbi

@@ -32,6 +32,9 @@ module Orb
         sig { params(other: T.anything).returns(T::Boolean) }
         def ==(other); end
 
+        sig { returns(Integer) }
+        def hash; end
+
         # @api private
         sig do
           override

data/rbi/lib/orb/internal/type/base_model.rbi

@@ -111,11 +111,17 @@ module Orb
 
           sig { params(other: T.anything).returns(T::Boolean) }
           def ==(other); end
+
+          sig { returns(Integer) }
+          def hash; end
         end
 
         sig { params(other: T.anything).returns(T::Boolean) }
         def ==(other); end
 
+        sig { returns(Integer) }
+        def hash; end
+
         class << self
           # @api private
           sig do
@@ -176,6 +182,7 @@ module Orb
         def deconstruct_keys(keys); end
 
         class << self
+          # @api private
           sig { params(model: Orb::Internal::Type::BaseModel).returns(Orb::Internal::AnyHash) }
           def walk(model); end
         end
@@ -196,7 +203,6 @@ module Orb
           def inspect(depth: 0); end
         end
 
-        # @api private
         sig { returns(String) }
         def to_s; end
 

data/rbi/lib/orb/internal/type/base_page.rbi

@@ -3,6 +3,8 @@
 module Orb
   module Internal
     module Type
+      # @api private
+      #
       # This module provides a base implementation for paginated responses in the SDK.
       module BasePage
         Elem = type_member(:out)

data/rbi/lib/orb/internal/type/enum.rbi

@@ -22,18 +22,15 @@ module Orb
         sig { overridable.returns(T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)]) }
         def values; end
 
-        # @api private
-        #
-        # Guard against thread safety issues by instantiating `@values`.
-        sig { void }
-        private def finalize!; end
-
         sig { params(other: T.anything).returns(T::Boolean) }
         def ===(other); end
 
         sig { params(other: T.anything).returns(T::Boolean) }
         def ==(other); end
 
+        sig { returns(Integer) }
+        def hash; end
+
         # @api private
         #
         # Unlike with primitives, `Enum` additionally validates that the value is a member

data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi}

@@ -5,8 +5,11 @@ module Orb
     module Type
       # @api private
       #
-      # Either `Pathname` or `StringIO`.
-      class IOLike
+      # Either `Pathname` or `StringIO`, or `IO`, or `Orb::Internal::Type::FileInput`.
+      #
+      # Note: when `IO` is used, all retries are disabled, since many IO` streams are
+      # not rewindable.
+      class FileInput
         extend Orb::Internal::Type::Converter
 
         abstract!

data/rbi/lib/orb/internal/type/hash_of.rbi

@@ -32,6 +32,9 @@ module Orb
         sig { params(other: T.anything).returns(T::Boolean) }
         def ==(other); end
 
+        sig { returns(Integer) }
+        def hash; end
+
         # @api private
         sig do
           override

data/rbi/lib/orb/internal/type/union.rbi

@@ -45,6 +45,9 @@ module Orb
         sig { params(other: T.anything).returns(T::Boolean) }
         def ==(other); end
 
+        sig { returns(Integer) }
+        def hash; end
+
         # @api private
         sig do
           override.params(

data/rbi/lib/orb/internal/util.rbi

@@ -68,13 +68,19 @@ module Orb
         sig do
           params(
             data: T.any(Orb::Internal::AnyHash, T::Array[T.anything], T.anything),
-            pick: T.nilable(T.any(Symbol, Integer, T::Array[T.any(Symbol, Integer)])),
-            sentinel: T.nilable(T.anything),
+            pick: T.nilable(
+              T.any(
+                Symbol,
+                Integer,
+                T::Array[T.any(Symbol, Integer)],
+                T.proc.params(arg0: T.anything).returns(T.anything)
+              )
+            ),
             blk: T.nilable(T.proc.returns(T.anything))
           )
             .returns(T.nilable(T.anything))
         end
-        def dig(data, pick, sentinel = nil, &blk); end
+        def dig(data, pick, &blk); end
       end
 
       class << self
@@ -140,22 +146,6 @@ module Orb
         def normalized_headers(*headers); end
       end
 
-      # @api private
-      class SerializationAdapter
-        sig { returns(T.any(Pathname, IO)) }
-        attr_reader :inner
-
-        sig { params(a: T.anything).returns(String) }
-        def to_json(*a); end
-
-        sig { params(a: T.anything).returns(String) }
-        def to_yaml(*a); end
-
-        # @api private
-        sig { params(inner: T.any(Pathname, IO)).returns(T.attached_class) }
-        def self.new(inner); end
-      end
-
       # @api private
       #
       # An adapter that satisfies the IO interface required by `::IO.copy_stream`
@@ -192,7 +182,22 @@ module Orb
         def writable_enum(&blk); end
       end
 
+      JSON_CONTENT = T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
+      JSONL_CONTENT = T.let(%r{^application/(?:x-)?jsonl}, Regexp)
+
       class << self
+        # @api private
+        sig do
+          params(
+            y: Enumerator::Yielder,
+            val: T.anything,
+            closing: T::Array[T.proc.void],
+            content_type: T.nilable(String)
+          )
+            .void
+        end
+        private def write_multipart_content(y, val:, closing:, content_type: nil); end
+
         # @api private
         sig do
           params(

data/rbi/lib/orb/internal.rbi

@@ -1,7 +1,6 @@
 # typed: strong
 
 module Orb
-  # @api private
   module Internal
     # Due to the current WIP status of Shapes support in Sorbet, types referencing
     # this alias might be refined in the future.

data/rbi/lib/orb/models/alert.rbi

@@ -77,19 +77,28 @@ module Orb
           .returns(T.attached_class)
       end
       def self.new(
+        # Also referred to as alert_id in this documentation.
         id:,
+        # The creation time of the resource in Orb.
         created_at:,
+        # The name of the currency the credit balance or invoice cost is denominated in.
         currency:,
+        # The customer the alert applies to.
         customer:,
+        # Whether the alert is enabled or disabled.
         enabled:,
+        # The metric the alert applies to.
         metric:,
+        # The plan the alert applies to.
         plan:,
+        # The subscription the alert applies to.
         subscription:,
+        # The thresholds that define the conditions under which the alert will be
+        # triggered.
         thresholds:,
+        # The type of alert. This must be a valid alert type.
         type:
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(
@@ -162,8 +171,15 @@ module Orb
           )
             .returns(T.attached_class)
         end
-        def self.new(id:, external_plan_id:, name:, plan_version:); 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:,
+          plan_version:
+        ); end
         sig do
           override
             .returns(
@@ -200,8 +216,12 @@ module Orb
         # Thresholds are used to define the conditions under which an alert will be
         # triggered.
         sig { params(value: Float).returns(T.attached_class) }
-        def self.new(value:); end
-
+        def self.new(
+          # The value at which an alert will fire. For credit balance alerts, the alert will
+          # fire at or below this value. For usage and cost alerts, the alert will fire at
+          # or above this value.
+          value:
+        ); end
         sig { override.returns({value: Float}) }
         def to_hash; end
       end
@@ -211,7 +231,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Alert::Type) }
-        OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Alert::Type::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         CREDIT_BALANCE_DEPLETED = T.let(:credit_balance_depleted, Orb::Models::Alert::Type::TaggedSymbol)
         CREDIT_BALANCE_DROPPED = T.let(:credit_balance_dropped, Orb::Models::Alert::Type::TaggedSymbol)

data/rbi/lib/orb/models/alert_create_for_customer_params.rbi

@@ -27,8 +27,15 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(currency:, type:, thresholds: nil, request_options: {}); end
-
+      def self.new(
+        # The case sensitive currency or custom pricing unit to use for this alert.
+        currency:,
+        # The type of alert to create. This must be a valid alert type.
+        type:,
+        # The thresholds that define the values at which the alert will be triggered.
+        thresholds: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(
@@ -47,8 +54,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AlertCreateForCustomerParams::Type) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         CREDIT_BALANCE_DEPLETED =
           T.let(:credit_balance_depleted, Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol)
@@ -71,8 +77,12 @@ module Orb
         # Thresholds are used to define the conditions under which an alert will be
         # triggered.
         sig { params(value: Float).returns(T.attached_class) }
-        def self.new(value:); end
-
+        def self.new(
+          # The value at which an alert will fire. For credit balance alerts, the alert will
+          # fire at or below this value. For usage and cost alerts, the alert will fire at
+          # or above this value.
+          value:
+        ); end
         sig { override.returns({value: Float}) }
         def to_hash; end
       end

data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi

@@ -29,8 +29,15 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(currency:, type:, thresholds: nil, request_options: {}); end
-
+      def self.new(
+        # The case sensitive currency or custom pricing unit to use for this alert.
+        currency:,
+        # The type of alert to create. This must be a valid alert type.
+        type:,
+        # The thresholds that define the values at which the alert will be triggered.
+        thresholds: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(
@@ -49,8 +56,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         CREDIT_BALANCE_DEPLETED =
           T.let(:credit_balance_depleted, Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol)
@@ -73,8 +79,12 @@ module Orb
         # Thresholds are used to define the conditions under which an alert will be
         # triggered.
         sig { params(value: Float).returns(T.attached_class) }
-        def self.new(value:); end
-
+        def self.new(
+          # The value at which an alert will fire. For credit balance alerts, the alert will
+          # fire at or below this value. For usage and cost alerts, the alert will fire at
+          # or above this value.
+          value:
+        ); end
         sig { override.returns({value: Float}) }
         def to_hash; end
       end

data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi

@@ -27,8 +27,15 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(thresholds:, type:, metric_id: nil, request_options: {}); end
-
+      def self.new(
+        # The thresholds that define the values at which the alert will be triggered.
+        thresholds:,
+        # The type of alert to create. This must be a valid alert type.
+        type:,
+        # The metric to track usage for.
+        metric_id: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(
@@ -52,8 +59,12 @@ module Orb
         # Thresholds are used to define the conditions under which an alert will be
         # triggered.
         sig { params(value: Float).returns(T.attached_class) }
-        def self.new(value:); end
-
+        def self.new(
+          # The value at which an alert will fire. For credit balance alerts, the alert will
+          # fire at or below this value. For usage and cost alerts, the alert will fire at
+          # or above this value.
+          value:
+        ); end
         sig { override.returns({value: Float}) }
         def to_hash; end
       end
@@ -63,8 +74,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::AlertCreateForSubscriptionParams::Type::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         USAGE_EXCEEDED =
           T.let(:usage_exceeded, Orb::Models::AlertCreateForSubscriptionParams::Type::TaggedSymbol)

data/rbi/lib/orb/models/alert_disable_params.rbi

@@ -17,8 +17,11 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(subscription_id: nil, request_options: {}); end
-
+      def self.new(
+        # Used to update the status of a plan alert scoped to this subscription_id
+        subscription_id: nil,
+        request_options: {}
+      ); end
       sig { override.returns({subscription_id: T.nilable(String), request_options: Orb::RequestOptions}) }
       def to_hash; end
     end

data/rbi/lib/orb/models/alert_enable_params.rbi

@@ -17,8 +17,11 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(subscription_id: nil, request_options: {}); end
-
+      def self.new(
+        # Used to update the status of a plan alert scoped to this subscription_id
+        subscription_id: nil,
+        request_options: {}
+      ); end
       sig { override.returns({subscription_id: T.nilable(String), request_options: Orb::RequestOptions}) }
       def to_hash; end
     end

data/rbi/lib/orb/models/alert_list_params.rbi

@@ -62,10 +62,16 @@ 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,
+        # Fetch alerts scoped to this customer_id
         customer_id: nil,
+        # Fetch alerts scoped to this external_customer_id
         external_customer_id: nil,
+        # The number of items to fetch. Defaults to 20.
         limit: nil,
+        # Fetch alerts scoped to this subscription_id
         subscription_id: nil,
         request_options: {}
       ); end

data/rbi/lib/orb/models/alert_update_params.rbi

@@ -17,8 +17,11 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(thresholds:, request_options: {}); end
-
+      def self.new(
+        # The thresholds that define the values at which the alert will be triggered.
+        thresholds:,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(
@@ -37,8 +40,12 @@ module Orb
         # Thresholds are used to define the conditions under which an alert will be
         # triggered.
         sig { params(value: Float).returns(T.attached_class) }
-        def self.new(value:); end
-
+        def self.new(
+          # The value at which an alert will fire. For credit balance alerts, the alert will
+          # fire at or below this value. For usage and cost alerts, the alert will fire at
+          # or above this value.
+          value:
+        ); end
         sig { override.returns({value: Float}) }
         def to_hash; end
       end

data/rbi/lib/orb/models/amount_discount.rbi

@@ -27,8 +27,15 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(amount_discount:, applies_to_price_ids:, discount_type:, reason: nil); end
-
+      def self.new(
+        # Only available if discount_type is `amount`.
+        amount_discount:,
+        # List of price_ids that this discount applies to. For plan/plan phase discounts,
+        # this can be a subset of prices.
+        applies_to_price_ids:,
+        discount_type:,
+        reason: nil
+      ); end
       sig do
         override
           .returns(
@@ -46,8 +53,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AmountDiscount::DiscountType) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::AmountDiscount::DiscountType::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         AMOUNT = T.let(:amount, Orb::Models::AmountDiscount::DiscountType::TaggedSymbol)
 

data/rbi/lib/orb/models/billable_metric.rbi

@@ -45,8 +45,21 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(id:, description:, item:, metadata:, name:, status:); end
-
+      def self.new(
+        id:,
+        description:,
+        # The Item resource represents a sellable product or good. Items are associated
+        # with all line items, billable metrics, and prices and are used for defining
+        # external sync behavior for invoices and tax calculation purposes.
+        item:,
+        # User specified key-value pairs for the resource. If not present, this defaults
+        # to an empty dictionary. 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:,
+        name:,
+        status:
+      ); end
       sig do
         override
           .returns(
@@ -66,7 +79,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::BillableMetric::Status) }
-        OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::BillableMetric::Status::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         ACTIVE = T.let(:active, Orb::Models::BillableMetric::Status::TaggedSymbol)
         DRAFT = T.let(:draft, Orb::Models::BillableMetric::Status::TaggedSymbol)

data/rbi/lib/orb/models/billing_cycle_relative_date.rbi

@@ -6,7 +6,7 @@ module Orb
       extend Orb::Internal::Type::Enum
 
       TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::BillingCycleRelativeDate) }
-      OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::BillingCycleRelativeDate::TaggedSymbol) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
 
       START_OF_TERM = T.let(:start_of_term, Orb::Models::BillingCycleRelativeDate::TaggedSymbol)
       END_OF_TERM = T.let(:end_of_term, Orb::Models::BillingCycleRelativeDate::TaggedSymbol)

data/rbi/lib/orb/models/coupon.rbi

@@ -51,16 +51,23 @@ module Orb
           .returns(T.attached_class)
       end
       def self.new(
+        # Also referred to as coupon_id in this documentation.
         id:,
+        # An archived coupon can no longer be redeemed. Active coupons will have a value
+        # of null for `archived_at`; this field will be non-null for archived coupons.
         archived_at:,
         discount:,
+        # This allows for a coupon's discount to apply for a limited time (determined in
+        # months); a `null` value here means "unlimited time".
         duration_in_months:,
+        # The maximum number of redemptions allowed for this coupon before it is
+        # exhausted; `null` here means "unlimited".
         max_redemptions:,
+        # This string can be used to redeem this coupon for a given subscription.
         redemption_code:,
+        # The number of times this coupon has been redeemed.
         times_redeemed:
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/orb/models/coupon_create_params.rbi

@@ -46,13 +46,16 @@ module Orb
       end
       def self.new(
         discount:,
+        # This string can be used to redeem this coupon for a given subscription.
         redemption_code:,
+        # This allows for a coupon's discount to apply for a limited time (determined in
+        # months); a `null` value here means "unlimited time".
         duration_in_months: nil,
+        # The maximum number of redemptions allowed for this coupon before it is
+        # exhausted;`null` here means "unlimited".
         max_redemptions: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/orb/models/coupon_list_params.rbi

@@ -37,9 +37,19 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {})
-      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,
+        # Filter to coupons matching this redemption code.
+        redemption_code: nil,
+        # Show archived coupons as well (by default, this endpoint only returns active
+        # coupons).
+        show_archived: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/orb/models/coupons/subscription_list_params.rbi

@@ -27,8 +27,14 @@ module Orb
           )
             .returns(T.attached_class)
         end
-        def self.new(cursor: nil, limit: nil, request_options: {}); 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,
+          request_options: {}
+        ); end
         sig do
           override.returns({cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOptions})
         end