onebusaway-sdk 0.1.0.pre.alpha.206 → 0.1.0.pre.alpha.207

data/rbi/lib/onebusaway-sdk/base_client.rbi

@@ -1,6 +1,7 @@
 # typed: strong
 
 module OnebusawaySDK
+  # @api private
   class BaseClient
     abstract!
 
@@ -43,25 +44,41 @@ module OnebusawaySDK
 
     PLATFORM_HEADERS = T::Hash[String, String]
 
-    sig { params(req: OnebusawaySDK::BaseClient::RequestComponentsShape).void }
-    def self.validate!(req)
-    end
-
-    sig do
-      params(status: Integer, headers: T.any(T::Hash[String, String], Net::HTTPHeader)).returns(T::Boolean)
-    end
-    def self.should_retry?(status, headers:)
-    end
-
-    sig do
-      params(
-        request: OnebusawaySDK::BaseClient::RequestInputShape,
-        status: Integer,
-        response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
-      )
-        .returns(OnebusawaySDK::BaseClient::RequestInputShape)
-    end
-    def self.follow_redirect(request, status:, response_headers:)
+    class << self
+      # @api private
+      sig { params(req: OnebusawaySDK::BaseClient::RequestComponentsShape).void }
+      def validate!(req)
+      end
+
+      # @api private
+      sig do
+        params(status: Integer, headers: T.any(T::Hash[String, String], Net::HTTPHeader)).returns(T::Boolean)
+      end
+      def should_retry?(status, headers:)
+      end
+
+      # @api private
+      sig do
+        params(
+          request: OnebusawaySDK::BaseClient::RequestInputShape,
+          status: Integer,
+          response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
+        )
+          .returns(OnebusawaySDK::BaseClient::RequestInputShape)
+      end
+      def follow_redirect(request, status:, response_headers:)
+      end
+
+      # @api private
+      sig do
+        params(
+          status: T.any(Integer, OnebusawaySDK::APIConnectionError),
+          stream: T.nilable(T::Enumerable[String])
+        )
+          .void
+      end
+      def reap_connection!(status, stream:)
+      end
     end
 
     sig { returns(T.anything) }
@@ -72,6 +89,7 @@ module OnebusawaySDK
     def requester=(_)
     end
 
+    # @api private
     sig do
       params(
         base_url: String,
@@ -83,9 +101,9 @@ module OnebusawaySDK
                          T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))],
         idempotency_header: T.nilable(String)
       )
-        .void
+        .returns(T.attached_class)
     end
-    def initialize(
+    def self.new(
       base_url:,
       timeout: 0.0,
       max_retries: 0,
@@ -96,14 +114,17 @@ module OnebusawaySDK
     )
     end
 
+    # @api private
     sig { overridable.returns(T::Hash[String, String]) }
     private def auth_query
     end
 
+    # @api private
     sig { returns(String) }
     private def generate_idempotency_key
     end
 
+    # @api private
     sig do
       overridable
         .params(req: OnebusawaySDK::BaseClient::RequestComponentsShape, opts: T::Hash[Symbol, T.anything])
@@ -112,10 +133,12 @@ module OnebusawaySDK
     private def build_request(req, opts)
     end
 
+    # @api private
     sig { params(headers: T::Hash[String, String], retry_count: Integer).returns(Float) }
     private def retry_delay(headers, retry_count:)
     end
 
+    # @api private
     sig do
       params(
         request: OnebusawaySDK::BaseClient::RequestInputShape,
@@ -128,6 +151,8 @@ module OnebusawaySDK
     private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
     end
 
+    # Execute the request specified by `req`. This is the method that all resource
+    #   methods call into.
     sig do
       params(
         method: Symbol,