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

data/rbi/lib/onebusaway-sdk/resources/stop_ids_for_agency.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class StopIDsForAgency
+      # Get stop IDs for a specific agency
       sig do
         params(
           agency_id: String,
@@ -10,11 +11,15 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::StopIDsForAgencyListResponse)
       end
-      def list(agency_id, request_options: {})
+      def list(
+        # ID of the agency
+        agency_id,
+        request_options: {}
+      )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/stops_for_agency.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class StopsForAgency
+      # Get stops for a specific agency
       sig do
         params(
           agency_id: String,
@@ -10,11 +11,15 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::StopsForAgencyListResponse)
       end
-      def list(agency_id, request_options: {})
+      def list(
+        # ID of the agency
+        agency_id,
+        request_options: {}
+      )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/stops_for_location.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class StopsForLocation
+      # stops-for-location
       sig do
         params(
           lat: Float,
@@ -15,11 +16,23 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::StopsForLocationListResponse)
       end
-      def list(lat:, lon:, lat_span: nil, lon_span: nil, query: nil, radius: nil, request_options: {})
+      def list(
+        lat:,
+        lon:,
+        # An alternative to radius to set the search bounding box (optional)
+        lat_span: nil,
+        # An alternative to radius to set the search bounding box (optional)
+        lon_span: nil,
+        # A search query string to filter the results
+        query: nil,
+        # The radius in meters to search within
+        radius: nil,
+        request_options: {}
+      )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/stops_for_route.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class StopsForRoute
+      # Get stops for a specific route
       sig do
         params(
           route_id: String,
@@ -12,11 +13,19 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::StopsForRouteListResponse)
       end
-      def list(route_id, include_polylines: nil, time: nil, request_options: {})
+      def list(
+        # ID of the route
+        route_id,
+        # Include polyline elements in the response (default true)
+        include_polylines: nil,
+        # Specify service date (YYYY-MM-DD or epoch) (default today)
+        time: nil,
+        request_options: {}
+      )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/trip.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class Trip
+      # Get details of a specific trip
       sig do
         params(
           trip_id: String,
@@ -10,11 +11,15 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::TripRetrieveResponse)
       end
-      def retrieve(trip_id, request_options: {})
+      def retrieve(
+        # ID of the trip
+        trip_id,
+        request_options: {}
+      )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/trip_details.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class TripDetails
+      # Retrieve Trip Details
       sig do
         params(
           trip_id: String,
@@ -16,18 +17,27 @@ module OnebusawaySDK
           .returns(OnebusawaySDK::Models::TripDetailRetrieveResponse)
       end
       def retrieve(
+        # ID of the trip to retrieve details for.
         trip_id,
+        # Whether to include the full schedule element in the tripDetails section
+        #   (defaults to true).
         include_schedule: nil,
+        # Whether to include the full status element in the tripDetails section (defaults
+        #   to true).
         include_status: nil,
+        # Whether to include the full trip element in the references section (defaults to
+        #   true).
         include_trip: nil,
+        # Service date for the trip as Unix time in milliseconds (optional).
         service_date: nil,
+        # Time parameter to query the system at a specific time (optional).
         time: nil,
         request_options: {}
       )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/trip_for_vehicle.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class TripForVehicle
+      # Retrieve trip for a specific vehicle
       sig do
         params(
           vehicle_id: String,
@@ -15,17 +16,25 @@ module OnebusawaySDK
           .returns(OnebusawaySDK::Models::TripForVehicleRetrieveResponse)
       end
       def retrieve(
+        # ID of the vehicle to retrieve trip details for.
         vehicle_id,
+        # Determines whether full <schedule/> element is included in the <tripDetails/>
+        #   section. Defaults to false.
         include_schedule: nil,
+        # Determines whether the full <status/> element is included in the <tripDetails/>
+        #   section. Defaults to true.
         include_status: nil,
+        # Determines whether full <trip/> element is included in the <references/>
+        #   section. Defaults to false.
         include_trip: nil,
+        # Time parameter to query the system at a specific time (optional).
         time: nil,
         request_options: {}
       )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/trips_for_location.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class TripsForLocation
+      # Retrieve trips for a given location
       sig do
         params(
           lat: Float,
@@ -17,19 +18,28 @@ module OnebusawaySDK
           .returns(OnebusawaySDK::Models::TripsForLocationListResponse)
       end
       def list(
+        # The latitude coordinate of the search center
         lat:,
+        # Latitude span of the search bounding box
         lat_span:,
+        # The longitude coordinate of the search center
         lon:,
+        # Longitude span of the search bounding box
         lon_span:,
+        # Whether to include full schedule elements in the tripDetails section. Defaults
+        #   to false.
         include_schedule: nil,
+        # Whether to include full trip elements in the references section. Defaults to
+        #   false.
         include_trip: nil,
+        # Specific time for the query. Defaults to the current time.
         time: nil,
         request_options: {}
       )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/trips_for_route.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class TripsForRoute
+      # Search for active trips for a specific route.
       sig do
         params(
           route_id: String,
@@ -13,11 +14,22 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::TripsForRouteListResponse)
       end
-      def list(route_id, include_schedule: nil, include_status: nil, time: nil, request_options: {})
+      def list(
+        # The ID of the route.
+        route_id,
+        # Determine whether full schedule elements are included. Defaults to false.
+        include_schedule: nil,
+        # Determine whether full tripStatus elements with real-time information are
+        #   included. Defaults to false.
+        include_status: nil,
+        # Query the system at a specific time. Useful for testing.
+        time: nil,
+        request_options: {}
+      )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/vehicles_for_agency.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class VehiclesForAgency
+      # Get vehicles for a specific agency
       sig do
         params(
           agency_id: String,
@@ -11,11 +12,17 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::VehiclesForAgencyListResponse)
       end
-      def list(agency_id, time: nil, request_options: {})
+      def list(
+        # ID of the agency
+        agency_id,
+        # Specific time for querying the status (timestamp format)
+        time: nil,
+        request_options: {}
+      )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end