orb-billing 0.3.2 → 0.4.0

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/orb.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
 require "English"
 require "cgi"
 require "date"
@@ -15,6 +16,7 @@ require "set"
 require "stringio"
 require "time"
 require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
 
 # We already ship the preferred sorbet manifests in the package itself.
 # `tapioca` currently does not offer us a way to opt out of unnecessary compilation.

data/rbi/orb/internal/page.rbi

@@ -19,7 +19,8 @@ module Orb
       end
 
       class PaginationMetadata < Orb::Internal::Type::BaseModel
-        OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+        OrHash =
+          T.type_alias { T.any(PaginationMetadata, Orb::Internal::AnyHash) }
 
         sig { returns(T::Boolean) }
         attr_accessor :has_more

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

@@ -5,9 +5,11 @@ module Orb
     module Transport
       # @api private
       class BaseClient
+        extend Orb::Internal::Util::SorbetRuntimeSupport
+
         abstract!
 
-        RequestComponentsShape =
+        RequestComponents =
           T.type_alias do
             {
               method: Symbol,
@@ -53,7 +55,7 @@ module Orb
             }
           end
 
-        RequestInputShape =
+        RequestInput =
           T.type_alias do
             {
               method: Symbol,
@@ -74,7 +76,7 @@ module Orb
           # @api private
           sig do
             params(
-              req: Orb::Internal::Transport::BaseClient::RequestComponentsShape
+              req: Orb::Internal::Transport::BaseClient::RequestComponents
             ).void
           end
           def validate!(req)
@@ -93,10 +95,10 @@ module Orb
           # @api private
           sig do
             params(
-              request: Orb::Internal::Transport::BaseClient::RequestInputShape,
+              request: Orb::Internal::Transport::BaseClient::RequestInput,
               status: Integer,
               response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
-            ).returns(Orb::Internal::Transport::BaseClient::RequestInputShape)
+            ).returns(Orb::Internal::Transport::BaseClient::RequestInput)
           end
           def follow_redirect(request, status:, response_headers:)
           end
@@ -112,6 +114,27 @@ module Orb
           end
         end
 
+        sig { returns(URI::Generic) }
+        attr_reader :base_url
+
+        sig { returns(Float) }
+        attr_reader :timeout
+
+        sig { returns(Integer) }
+        attr_reader :max_retries
+
+        sig { returns(Float) }
+        attr_reader :initial_retry_delay
+
+        sig { returns(Float) }
+        attr_reader :max_retry_delay
+
+        sig { returns(T::Hash[String, String]) }
+        attr_reader :headers
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_header
+
         # @api private
         sig { returns(Orb::Internal::Transport::PooledNetRequester) }
         attr_reader :requester
@@ -163,10 +186,10 @@ module Orb
         sig do
           overridable
             .params(
-              req: Orb::Internal::Transport::BaseClient::RequestComponentsShape,
+              req: Orb::Internal::Transport::BaseClient::RequestComponents,
               opts: Orb::Internal::AnyHash
             )
-            .returns(Orb::Internal::Transport::BaseClient::RequestInputShape)
+            .returns(Orb::Internal::Transport::BaseClient::RequestInput)
         end
         private def build_request(req, opts)
         end
@@ -184,7 +207,7 @@ module Orb
         # @api private
         sig do
           params(
-            request: Orb::Internal::Transport::BaseClient::RequestInputShape,
+            request: Orb::Internal::Transport::BaseClient::RequestInput,
             redirect_count: Integer,
             retry_count: Integer,
             send_retry_header: T::Boolean

data/rbi/orb/internal/transport/pooled_net_requester.rbi

@@ -5,7 +5,9 @@ module Orb
     module Transport
       # @api private
       class PooledNetRequester
-        RequestShape =
+        extend Orb::Internal::Util::SorbetRuntimeSupport
+
+        Request =
           T.type_alias do
             {
               method: Symbol,
@@ -34,8 +36,7 @@ module Orb
           # @api private
           sig do
             params(
-              request:
-                Orb::Internal::Transport::PooledNetRequester::RequestShape,
+              request: Orb::Internal::Transport::PooledNetRequester::Request,
               blk: T.proc.params(arg0: String).void
             ).returns([Net::HTTPGenericRequest, T.proc.void])
           end
@@ -57,7 +58,7 @@ module Orb
         # @api private
         sig do
           params(
-            request: Orb::Internal::Transport::PooledNetRequester::RequestShape
+            request: Orb::Internal::Transport::PooledNetRequester::Request
           ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
         end
         def execute(request)

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

@@ -5,10 +5,11 @@ module Orb
     module Type
       class BaseModel
         extend Orb::Internal::Type::Converter
+        extend Orb::Internal::Util::SorbetRuntimeSupport
 
         abstract!
 
-        KnownFieldShape =
+        KnownField =
           T.type_alias do
             {
               mode: T.nilable(Symbol),
@@ -17,19 +18,27 @@ module Orb
             }
           end
 
-        OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+        OrHash =
+          T.type_alias do
+            T.any(Orb::Internal::Type::BaseModel, Orb::Internal::AnyHash)
+          end
 
         class << self
           # @api private
           #
           # Assumes superclass fields are totally defined before fields are accessed /
           # defined on subclasses.
+          sig { params(child: T.self_type).void }
+          def inherited(child)
+          end
+
+          # @api private
           sig do
             returns(
               T::Hash[
                 Symbol,
                 T.all(
-                  Orb::Internal::Type::BaseModel::KnownFieldShape,
+                  Orb::Internal::Type::BaseModel::KnownField,
                   {
                     type_fn:
                       T.proc.returns(Orb::Internal::Type::Converter::Input)
@@ -47,7 +56,7 @@ module Orb
               T::Hash[
                 Symbol,
                 T.all(
-                  Orb::Internal::Type::BaseModel::KnownFieldShape,
+                  Orb::Internal::Type::BaseModel::KnownField,
                   { type: Orb::Internal::Type::Converter::Input }
                 )
               ]
@@ -183,6 +192,18 @@ module Orb
           end
         end
 
+        class << self
+          # @api private
+          sig do
+            params(
+              model: Orb::Internal::Type::BaseModel,
+              convert: T::Boolean
+            ).returns(Orb::Internal::AnyHash)
+          end
+          def recursively_to_h(model, convert:)
+          end
+        end
+
         # Returns the raw value associated with the given key, if found. Otherwise, nil is
         # returned.
         #
@@ -217,6 +238,12 @@ module Orb
         def to_hash
         end
 
+        # In addition to the behaviour of `#to_h`, this method will recursively call
+        # `#to_h` on nested models.
+        sig { overridable.returns(Orb::Internal::AnyHash) }
+        def deep_to_h
+        end
+
         sig do
           params(keys: T.nilable(T::Array[Symbol])).returns(
             Orb::Internal::AnyHash
@@ -225,17 +252,6 @@ module Orb
         def deconstruct_keys(keys)
         end
 
-        class << self
-          # @api private
-          sig do
-            params(model: Orb::Internal::Type::BaseModel).returns(
-              Orb::Internal::AnyHash
-            )
-          end
-          def walk(model)
-          end
-        end
-
         sig { params(a: T.anything).returns(String) }
         def to_json(*a)
         end

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

@@ -29,7 +29,7 @@ module Orb
         sig do
           params(
             client: Orb::Internal::Transport::BaseClient,
-            req: Orb::Internal::Transport::BaseClient::RequestComponentsShape,
+            req: Orb::Internal::Transport::BaseClient::RequestComponents,
             headers: T.any(T::Hash[String, String], Net::HTTPHeader),
             page_data: T.anything
           ).void

data/rbi/orb/internal/type/converter.rbi

@@ -5,6 +5,8 @@ module Orb
     module Type
       # @api private
       module Converter
+        extend Orb::Internal::Util::SorbetRuntimeSupport
+
         Input =
           T.type_alias do
             T.any(Orb::Internal::Type::Converter, T::Class[T.anything])

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

@@ -17,6 +17,7 @@ module Orb
       # values safely.
       module Enum
         include Orb::Internal::Type::Converter
+        include Orb::Internal::Util::SorbetRuntimeSupport
 
         # All of the valid Symbol values for this enum.
         sig do

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

@@ -6,6 +6,7 @@ module Orb
       # @api private
       module Union
         include Orb::Internal::Type::Converter
+        include Orb::Internal::Util::SorbetRuntimeSupport
 
         # @api private
         #

data/rbi/orb/internal/util.rbi

@@ -4,6 +4,8 @@ module Orb
   module Internal
     # @api private
     module Util
+      extend Orb::Internal::Util::SorbetRuntimeSupport
+
       # @api private
       sig { returns(Float) }
       def self.monotonic_secs
@@ -168,7 +170,7 @@ module Orb
         end
       end
 
-      ParsedUriShape =
+      ParsedUri =
         T.type_alias do
           {
             scheme: T.nilable(String),
@@ -183,7 +185,7 @@ module Orb
         # @api private
         sig do
           params(url: T.any(URI::Generic, String)).returns(
-            Orb::Internal::Util::ParsedUriShape
+            Orb::Internal::Util::ParsedUri
           )
         end
         def parse_uri(url)
@@ -191,9 +193,7 @@ module Orb
 
         # @api private
         sig do
-          params(parsed: Orb::Internal::Util::ParsedUriShape).returns(
-            URI::Generic
-          )
+          params(parsed: Orb::Internal::Util::ParsedUri).returns(URI::Generic)
         end
         def unparse_uri(parsed)
         end
@@ -201,8 +201,8 @@ module Orb
         # @api private
         sig do
           params(
-            lhs: Orb::Internal::Util::ParsedUriShape,
-            rhs: Orb::Internal::Util::ParsedUriShape
+            lhs: Orb::Internal::Util::ParsedUri,
+            rhs: Orb::Internal::Util::ParsedUri
           ).returns(URI::Generic)
         end
         def join_parsed_uri(lhs, rhs)
@@ -419,6 +419,27 @@ module Orb
         def decode_sse(lines)
         end
       end
+
+      # @api private
+      module SorbetRuntimeSupport
+        class MissingSorbetRuntimeError < ::RuntimeError
+        end
+
+        # @api private
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        private def sorbet_runtime_constants
+        end
+
+        # @api private
+        sig { params(name: Symbol).void }
+        def const_missing(name)
+        end
+
+        # @api private
+        sig { params(name: Symbol, blk: T.proc.returns(T.anything)).void }
+        def define_sorbet_constant!(name, &blk)
+        end
+      end
     end
   end
 end

data/rbi/orb/internal.rbi

@@ -2,6 +2,8 @@
 
 module Orb
   module Internal
+    extend Orb::Internal::Util::SorbetRuntimeSupport
+
     # Due to the current WIP status of Shapes support in Sorbet, types referencing
     # this alias might be refined in the future.
     AnyHash = T.type_alias { T::Hash[Symbol, T.anything] }

data/rbi/orb/models/alert.rbi

@@ -3,7 +3,7 @@
 module Orb
   module Models
     class Alert < Orb::Internal::Type::BaseModel
-      OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+      OrHash = T.type_alias { T.any(Orb::Alert, Orb::Internal::AnyHash) }
 
       # Also referred to as alert_id in this documentation.
       sig { returns(String) }
@@ -124,7 +124,8 @@ module Orb
       end
 
       class Customer < Orb::Internal::Type::BaseModel
-        OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+        OrHash =
+          T.type_alias { T.any(Orb::Alert::Customer, Orb::Internal::AnyHash) }
 
         sig { returns(String) }
         attr_accessor :id
@@ -151,7 +152,8 @@ module Orb
       end
 
       class Metric < Orb::Internal::Type::BaseModel
-        OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+        OrHash =
+          T.type_alias { T.any(Orb::Alert::Metric, Orb::Internal::AnyHash) }
 
         sig { returns(String) }
         attr_accessor :id
@@ -167,7 +169,8 @@ module Orb
       end
 
       class Plan < Orb::Internal::Type::BaseModel
-        OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+        OrHash =
+          T.type_alias { T.any(Orb::Alert::Plan, Orb::Internal::AnyHash) }
 
         sig { returns(T.nilable(String)) }
         attr_accessor :id
@@ -219,7 +222,10 @@ module Orb
       end
 
       class Subscription < Orb::Internal::Type::BaseModel
-        OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+        OrHash =
+          T.type_alias do
+            T.any(Orb::Alert::Subscription, Orb::Internal::AnyHash)
+          end
 
         sig { returns(String) }
         attr_accessor :id
@@ -235,7 +241,8 @@ module Orb
       end
 
       class Threshold < Orb::Internal::Type::BaseModel
-        OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+        OrHash =
+          T.type_alias { T.any(Orb::Alert::Threshold, Orb::Internal::AnyHash) }
 
         # 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

data/rbi/orb/models/alert_create_for_customer_params.rbi

@@ -6,7 +6,10 @@ 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) }
+      OrHash =
+        T.type_alias do
+          T.any(Orb::AlertCreateForCustomerParams, Orb::Internal::AnyHash)
+        end
 
       # The case sensitive currency or custom pricing unit to use for this alert.
       sig { returns(String) }
@@ -96,7 +99,13 @@ module Orb
       end
 
       class Threshold < Orb::Internal::Type::BaseModel
-        OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::AlertCreateForCustomerParams::Threshold,
+              Orb::Internal::AnyHash
+            )
+          end
 
         # 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

data/rbi/orb/models/alert_create_for_external_customer_params.rbi

@@ -6,7 +6,13 @@ 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) }
+      OrHash =
+        T.type_alias do
+          T.any(
+            Orb::AlertCreateForExternalCustomerParams,
+            Orb::Internal::AnyHash
+          )
+        end
 
       # The case sensitive currency or custom pricing unit to use for this alert.
       sig { returns(String) }
@@ -104,7 +110,13 @@ module Orb
       end
 
       class Threshold < Orb::Internal::Type::BaseModel
-        OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::AlertCreateForExternalCustomerParams::Threshold,
+              Orb::Internal::AnyHash
+            )
+          end
 
         # 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

data/rbi/orb/models/alert_create_for_subscription_params.rbi

@@ -6,7 +6,10 @@ 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) }
+      OrHash =
+        T.type_alias do
+          T.any(Orb::AlertCreateForSubscriptionParams, Orb::Internal::AnyHash)
+        end
 
       # The thresholds that define the values at which the alert will be triggered.
       sig do
@@ -57,7 +60,13 @@ module Orb
       end
 
       class Threshold < Orb::Internal::Type::BaseModel
-        OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::AlertCreateForSubscriptionParams::Threshold,
+              Orb::Internal::AnyHash
+            )
+          end
 
         # 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

data/rbi/orb/models/alert_disable_params.rbi

@@ -6,7 +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) }
+      OrHash =
+        T.type_alias { T.any(Orb::AlertDisableParams, Orb::Internal::AnyHash) }
 
       # Used to update the status of a plan alert scoped to this subscription_id
       sig { returns(T.nilable(String)) }

data/rbi/orb/models/alert_enable_params.rbi

@@ -6,7 +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) }
+      OrHash =
+        T.type_alias { T.any(Orb::AlertEnableParams, Orb::Internal::AnyHash) }
 
       # Used to update the status of a plan alert scoped to this subscription_id
       sig { returns(T.nilable(String)) }

data/rbi/orb/models/alert_list_params.rbi

@@ -6,7 +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) }
+      OrHash =
+        T.type_alias { T.any(Orb::AlertListParams, Orb::Internal::AnyHash) }
 
       sig { returns(T.nilable(Time)) }
       attr_accessor :created_at_gt

data/rbi/orb/models/alert_retrieve_params.rbi

@@ -6,7 +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) }
+      OrHash =
+        T.type_alias { T.any(Orb::AlertRetrieveParams, Orb::Internal::AnyHash) }
 
       sig do
         params(request_options: Orb::RequestOptions::OrHash).returns(

data/rbi/orb/models/alert_update_params.rbi

@@ -6,7 +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) }
+      OrHash =
+        T.type_alias { T.any(Orb::AlertUpdateParams, Orb::Internal::AnyHash) }
 
       # The thresholds that define the values at which the alert will be triggered.
       sig { returns(T::Array[Orb::AlertUpdateParams::Threshold]) }
@@ -37,7 +38,10 @@ module Orb
       end
 
       class Threshold < Orb::Internal::Type::BaseModel
-        OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+        OrHash =
+          T.type_alias do
+            T.any(Orb::AlertUpdateParams::Threshold, Orb::Internal::AnyHash)
+          end
 
         # 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

data/rbi/orb/models/amount_discount.rbi

@@ -3,7 +3,8 @@
 module Orb
   module Models
     class AmountDiscount < Orb::Internal::Type::BaseModel
-      OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+      OrHash =
+        T.type_alias { T.any(Orb::AmountDiscount, Orb::Internal::AnyHash) }
 
       # Only available if discount_type is `amount`.
       sig { returns(String) }

data/rbi/orb/models/billable_metric.rbi

@@ -3,7 +3,8 @@
 module Orb
   module Models
     class BillableMetric < Orb::Internal::Type::BaseModel
-      OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+      OrHash =
+        T.type_alias { T.any(Orb::BillableMetric, Orb::Internal::AnyHash) }
 
       sig { returns(String) }
       attr_accessor :id

data/rbi/orb/models/coupon.rbi

@@ -3,7 +3,7 @@
 module Orb
   module Models
     class Coupon < Orb::Internal::Type::BaseModel
-      OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+      OrHash = T.type_alias { T.any(Orb::Coupon, Orb::Internal::AnyHash) }
 
       # Also referred to as coupon_id in this documentation.
       sig { returns(String) }

data/rbi/orb/models/coupon_archive_params.rbi

@@ -6,7 +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) }
+      OrHash =
+        T.type_alias { T.any(Orb::CouponArchiveParams, Orb::Internal::AnyHash) }
 
       sig do
         params(request_options: Orb::RequestOptions::OrHash).returns(

data/rbi/orb/models/coupon_create_params.rbi

@@ -6,7 +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) }
+      OrHash =
+        T.type_alias { T.any(Orb::CouponCreateParams, Orb::Internal::AnyHash) }
 
       sig do
         returns(
@@ -89,7 +90,13 @@ module Orb
           end
 
         class Percentage < Orb::Internal::Type::BaseModel
-          OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::CouponCreateParams::Discount::Percentage,
+                Orb::Internal::AnyHash
+              )
+            end
 
           sig { returns(Symbol) }
           attr_accessor :discount_type
@@ -115,7 +122,13 @@ module Orb
         end
 
         class Amount < Orb::Internal::Type::BaseModel
-          OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::CouponCreateParams::Discount::Amount,
+                Orb::Internal::AnyHash
+              )
+            end
 
           sig { returns(String) }
           attr_accessor :amount_discount