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

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

@@ -2,8 +2,6 @@
 
 module OnebusawaySDK
   module BasePage
-    abstract!
-
     Elem = type_member(:out)
 
     sig { overridable.returns(T::Boolean) }
@@ -24,16 +22,17 @@ module OnebusawaySDK
 
     alias_method :enum_for, :to_enum
 
+    # @api private
     sig do
       params(
         client: OnebusawaySDK::BaseClient,
         req: OnebusawaySDK::BaseClient::RequestComponentsShape,
         headers: T.any(T::Hash[String, String], Net::HTTPHeader),
-        unwrapped: T.anything
+        page_data: T.anything
       )
         .void
     end
-    def initialize(client:, req:, headers:, unwrapped:)
+    def initialize(client:, req:, headers:, page_data:)
     end
   end
 end

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

@@ -126,10 +126,12 @@ module OnebusawaySDK
     def shape
     end
 
+    # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_query
     end
 
+    # Creates and returns a new client for interacting with the API.
     sig do
       params(
         base_url: T.nilable(String),
@@ -139,11 +141,14 @@ module OnebusawaySDK
         initial_retry_delay: Float,
         max_retry_delay: Float
       )
-        .void
+        .returns(T.attached_class)
     end
-    def initialize(
+    def self.new(
+      # Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
       base_url: nil,
+      # Defaults to `ENV["ONEBUSAWAY_API_KEY"]`
       api_key: ENV["ONEBUSAWAY_API_KEY"],
+      # Max number of retries to attempt after a failed retryable request.
       max_retries: DEFAULT_MAX_RETRIES,
       timeout: DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,

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

@@ -5,6 +5,10 @@ module OnebusawaySDK
     sig { returns(T.nilable(StandardError)) }
     def cause
     end
+
+    sig { params(_: T.nilable(StandardError)).returns(T.nilable(StandardError)) }
+    def cause=(_)
+    end
   end
 
   class ConversionError < OnebusawaySDK::Error
@@ -15,14 +19,27 @@ module OnebusawaySDK
     def url
     end
 
+    sig { params(_: URI::Generic).returns(URI::Generic) }
+    def url=(_)
+    end
+
     sig { returns(T.nilable(Integer)) }
     def status
     end
 
+    sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
+    def status=(_)
+    end
+
     sig { returns(T.nilable(T.anything)) }
     def body
     end
 
+    sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) }
+    def body=(_)
+    end
+
+    # @api private
     sig do
       params(
         url: URI::Generic,
@@ -32,9 +49,9 @@ module OnebusawaySDK
         response: NilClass,
         message: T.nilable(String)
       )
-        .void
+        .returns(T.attached_class)
     end
-    def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+    def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
     end
   end
 
@@ -43,10 +60,19 @@ module OnebusawaySDK
     def status
     end
 
+    sig { params(_: NilClass).void }
+    def status=(_)
+    end
+
     sig { void }
     def body
     end
 
+    sig { params(_: NilClass).void }
+    def body=(_)
+    end
+
+    # @api private
     sig do
       params(
         url: URI::Generic,
@@ -56,13 +82,14 @@ module OnebusawaySDK
         response: NilClass,
         message: T.nilable(String)
       )
-        .void
+        .returns(T.attached_class)
     end
-    def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
+    def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
     end
   end
 
   class APITimeoutError < OnebusawaySDK::APIConnectionError
+    # @api private
     sig do
       params(
         url: URI::Generic,
@@ -72,13 +99,14 @@ module OnebusawaySDK
         response: NilClass,
         message: T.nilable(String)
       )
-        .void
+        .returns(T.attached_class)
     end
-    def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
+    def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
     end
   end
 
   class APIStatusError < OnebusawaySDK::APIError
+    # @api private
     sig do
       params(
         url: URI::Generic,
@@ -97,6 +125,11 @@ module OnebusawaySDK
     def status
     end
 
+    sig { params(_: Integer).returns(Integer) }
+    def status=(_)
+    end
+
+    # @api private
     sig do
       params(
         url: URI::Generic,
@@ -106,9 +139,9 @@ module OnebusawaySDK
         response: NilClass,
         message: T.nilable(String)
       )
-        .void
+        .returns(T.attached_class)
     end
-    def initialize(url:, status:, body:, request:, response:, message: nil)
+    def self.new(url:, status:, body:, request:, response:, message: nil)
     end
   end
 

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

@@ -1,7 +1,7 @@
 # typed: strong
 
 module OnebusawaySDK
+  # @api private
   module Extern
-    abstract!
   end
 end

data/rbi/lib/onebusaway-sdk/models/agencies_with_coverage_list_params.rbi

@@ -6,8 +6,11 @@ module OnebusawaySDK
       extend OnebusawaySDK::RequestParameters::Converter
       include OnebusawaySDK::RequestParameters
 
-      sig { params(request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])).void }
-      def initialize(request_options: {})
+      sig do
+        params(request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything]))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {})
       end
 
       sig { override.returns({request_options: OnebusawaySDK::RequestOptions}) }

data/rbi/lib/onebusaway-sdk/models/agencies_with_coverage_list_response.rbi

@@ -14,8 +14,8 @@ module OnebusawaySDK
       def data=(_)
       end
 
-      sig { params(data: OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data).void }
-      def initialize(data:)
+      sig { params(data: OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data).returns(T.attached_class) }
+      def self.new(data:)
       end
 
       sig { override.returns({data: OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data}) }
@@ -56,9 +56,9 @@ module OnebusawaySDK
             list: T::Array[OnebusawaySDK::Models::AgenciesWithCoverageListResponse::Data::List],
             references: OnebusawaySDK::Models::References
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(limit_exceeded:, list:, references:)
+        def self.new(limit_exceeded:, list:, references:)
         end
 
         sig do
@@ -115,8 +115,11 @@ module OnebusawaySDK
           def lon_span=(_)
           end
 
-          sig { params(agency_id: String, lat: Float, lat_span: Float, lon: Float, lon_span: Float).void }
-          def initialize(agency_id:, lat:, lat_span:, lon:, lon_span:)
+          sig do
+            params(agency_id: String, lat: Float, lat_span: Float, lon: Float, lon_span: Float)
+              .returns(T.attached_class)
+          end
+          def self.new(agency_id:, lat:, lat_span:, lon:, lon_span:)
           end
 
           sig do

data/rbi/lib/onebusaway-sdk/models/agency_retrieve_params.rbi

@@ -6,8 +6,11 @@ module OnebusawaySDK
       extend OnebusawaySDK::RequestParameters::Converter
       include OnebusawaySDK::RequestParameters
 
-      sig { params(request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])).void }
-      def initialize(request_options: {})
+      sig do
+        params(request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything]))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {})
       end
 
       sig { override.returns({request_options: OnebusawaySDK::RequestOptions}) }

data/rbi/lib/onebusaway-sdk/models/agency_retrieve_response.rbi

@@ -14,8 +14,8 @@ module OnebusawaySDK
       def data=(_)
       end
 
-      sig { params(data: OnebusawaySDK::Models::AgencyRetrieveResponse::Data).void }
-      def initialize(data:)
+      sig { params(data: OnebusawaySDK::Models::AgencyRetrieveResponse::Data).returns(T.attached_class) }
+      def self.new(data:)
       end
 
       sig { override.returns({data: OnebusawaySDK::Models::AgencyRetrieveResponse::Data}) }
@@ -56,9 +56,9 @@ module OnebusawaySDK
             limit_exceeded: T::Boolean,
             references: OnebusawaySDK::Models::References
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(entry:, limit_exceeded:, references:)
+        def self.new(entry:, limit_exceeded:, references:)
         end
 
         sig do
@@ -168,9 +168,9 @@ module OnebusawaySDK
               phone: String,
               private_service: T::Boolean
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(
+          def self.new(
             id:,
             name:,
             timezone:,

data/rbi/lib/onebusaway-sdk/models/arrival_and_departure_list_params.rbi

@@ -6,6 +6,7 @@ module OnebusawaySDK
       extend OnebusawaySDK::RequestParameters::Converter
       include OnebusawaySDK::RequestParameters
 
+      # Include vehicles arriving or departing in the next n minutes.
       sig { returns(T.nilable(Integer)) }
       def minutes_after
       end
@@ -14,6 +15,7 @@ module OnebusawaySDK
       def minutes_after=(_)
       end
 
+      # Include vehicles having arrived or departed in the previous n minutes.
       sig { returns(T.nilable(Integer)) }
       def minutes_before
       end
@@ -22,6 +24,7 @@ module OnebusawaySDK
       def minutes_before=(_)
       end
 
+      # The specific time for querying the system status.
       sig { returns(T.nilable(Time)) }
       def time
       end
@@ -37,9 +40,9 @@ module OnebusawaySDK
           time: Time,
           request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(minutes_after: nil, minutes_before: nil, time: nil, request_options: {})
+      def self.new(minutes_after: nil, minutes_before: nil, time: nil, request_options: {})
       end
 
       sig do