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

data/rbi/onebusaway_sdk/models.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module OnebusawaySDK
+  AgenciesWithCoverageListParams =
+    OnebusawaySDK::Models::AgenciesWithCoverageListParams
+
+  AgencyRetrieveParams = OnebusawaySDK::Models::AgencyRetrieveParams
+
+  ArrivalAndDepartureListParams =
+    OnebusawaySDK::Models::ArrivalAndDepartureListParams
+
+  ArrivalAndDepartureRetrieveParams =
+    OnebusawaySDK::Models::ArrivalAndDepartureRetrieveParams
+
+  BlockRetrieveParams = OnebusawaySDK::Models::BlockRetrieveParams
+
+  ConfigRetrieveParams = OnebusawaySDK::Models::ConfigRetrieveParams
+
+  CurrentTimeRetrieveParams = OnebusawaySDK::Models::CurrentTimeRetrieveParams
+
+  References = OnebusawaySDK::Models::References
+
+  ReportProblemWithStopRetrieveParams =
+    OnebusawaySDK::Models::ReportProblemWithStopRetrieveParams
+
+  ReportProblemWithTripRetrieveParams =
+    OnebusawaySDK::Models::ReportProblemWithTripRetrieveParams
+
+  ResponseWrapper = OnebusawaySDK::Models::ResponseWrapper
+
+  RouteIDsForAgencyListParams =
+    OnebusawaySDK::Models::RouteIDsForAgencyListParams
+
+  RouteRetrieveParams = OnebusawaySDK::Models::RouteRetrieveParams
+
+  RoutesForAgencyListParams = OnebusawaySDK::Models::RoutesForAgencyListParams
+
+  RoutesForLocationListParams =
+    OnebusawaySDK::Models::RoutesForLocationListParams
+
+  ScheduleForRouteRetrieveParams =
+    OnebusawaySDK::Models::ScheduleForRouteRetrieveParams
+
+  ScheduleForStopRetrieveParams =
+    OnebusawaySDK::Models::ScheduleForStopRetrieveParams
+
+  SearchForRouteListParams = OnebusawaySDK::Models::SearchForRouteListParams
+
+  SearchForStopListParams = OnebusawaySDK::Models::SearchForStopListParams
+
+  ShapeRetrieveParams = OnebusawaySDK::Models::ShapeRetrieveParams
+
+  StopIDsForAgencyListParams = OnebusawaySDK::Models::StopIDsForAgencyListParams
+
+  StopRetrieveParams = OnebusawaySDK::Models::StopRetrieveParams
+
+  StopsForAgencyListParams = OnebusawaySDK::Models::StopsForAgencyListParams
+
+  StopsForLocationListParams = OnebusawaySDK::Models::StopsForLocationListParams
+
+  StopsForRouteListParams = OnebusawaySDK::Models::StopsForRouteListParams
+
+  TripDetailRetrieveParams = OnebusawaySDK::Models::TripDetailRetrieveParams
+
+  TripForVehicleRetrieveParams =
+    OnebusawaySDK::Models::TripForVehicleRetrieveParams
+
+  TripRetrieveParams = OnebusawaySDK::Models::TripRetrieveParams
+
+  TripsForLocationListParams = OnebusawaySDK::Models::TripsForLocationListParams
+
+  TripsForRouteListParams = OnebusawaySDK::Models::TripsForRouteListParams
+
+  VehiclesForAgencyListParams =
+    OnebusawaySDK::Models::VehiclesForAgencyListParams
+end

data/rbi/onebusaway_sdk/request_options.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module OnebusawaySDK
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < OnebusawaySDK::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias do
+        T.any(OnebusawaySDK::RequestOptions, OnebusawaySDK::Internal::AnyHash)
+      end
+
+    # @api private
+    sig { params(opts: OnebusawaySDK::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig do
+      params(values: OnebusawaySDK::Internal::AnyHash).returns(T.attached_class)
+    end
+    def self.new(values = {})
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/agencies_with_coverage.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class AgenciesWithCoverage
+      # Returns a list of all transit agencies currently supported by OneBusAway along
+      # with the center of their coverage area.
+      sig do
+        params(request_options: OnebusawaySDK::RequestOptions::OrHash).returns(
+          OnebusawaySDK::Models::AgenciesWithCoverageListResponse
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/agency.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class Agency
+      # Retrieve information for a specific transit agency identified by its unique ID.
+      sig do
+        params(
+          agency_id: String,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::Models::AgencyRetrieveResponse)
+      end
+      def retrieve(
+        # The ID of the transit agency.
+        agency_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/arrival_and_departure.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class ArrivalAndDeparture
+      # arrival-and-departure-for-stop
+      sig do
+        params(
+          stop_id: String,
+          service_date: Integer,
+          trip_id: String,
+          stop_sequence: Integer,
+          time: Integer,
+          vehicle_id: String,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse)
+      end
+      def retrieve(
+        stop_id,
+        service_date:,
+        trip_id:,
+        stop_sequence: nil,
+        time: nil,
+        vehicle_id: nil,
+        request_options: {}
+      )
+      end
+
+      # arrivals-and-departures-for-stop
+      sig do
+        params(
+          stop_id: String,
+          minutes_after: Integer,
+          minutes_before: Integer,
+          time: Time,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::Models::ArrivalAndDepartureListResponse)
+      end
+      def list(
+        stop_id,
+        # Include vehicles arriving or departing in the next n minutes.
+        minutes_after: nil,
+        # Include vehicles having arrived or departed in the previous n minutes.
+        minutes_before: nil,
+        # The specific time for querying the system status.
+        time: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/block.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class Block
+      # Get details of a specific block by ID
+      sig do
+        params(
+          block_id: String,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::Models::BlockRetrieveResponse)
+      end
+      def retrieve(
+        # ID of the block
+        block_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/config.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class Config
+      # config
+      sig do
+        params(request_options: OnebusawaySDK::RequestOptions::OrHash).returns(
+          OnebusawaySDK::Models::ConfigRetrieveResponse
+        )
+      end
+      def retrieve(request_options: {})
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/current_time.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class CurrentTime
+      # current-time
+      sig do
+        params(request_options: OnebusawaySDK::RequestOptions::OrHash).returns(
+          OnebusawaySDK::Models::CurrentTimeRetrieveResponse
+        )
+      end
+      def retrieve(request_options: {})
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/report_problem_with_stop.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class ReportProblemWithStop
+      # Submit a user-generated problem report for a stop
+      sig do
+        params(
+          stop_id: String,
+          code:
+            OnebusawaySDK::ReportProblemWithStopRetrieveParams::Code::OrSymbol,
+          user_comment: String,
+          user_lat: Float,
+          user_location_accuracy: Float,
+          user_lon: Float,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::ResponseWrapper)
+      end
+      def retrieve(
+        # The ID of the stop
+        stop_id,
+        # A string code identifying the nature of the problem
+        code: nil,
+        # Additional comment text supplied by the user describing the problem
+        user_comment: nil,
+        # The reporting user’s current latitude
+        user_lat: nil,
+        # The reporting user’s location accuracy, in meters
+        user_location_accuracy: nil,
+        # The reporting user’s current longitude
+        user_lon: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/report_problem_with_trip.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class ReportProblemWithTrip
+      # Submit a user-generated problem report for a particular trip.
+      sig do
+        params(
+          trip_id: String,
+          code:
+            OnebusawaySDK::ReportProblemWithTripRetrieveParams::Code::OrSymbol,
+          service_date: Integer,
+          stop_id: String,
+          user_comment: String,
+          user_lat: Float,
+          user_location_accuracy: Float,
+          user_lon: Float,
+          user_on_vehicle: T::Boolean,
+          user_vehicle_number: String,
+          vehicle_id: String,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::ResponseWrapper)
+      end
+      def retrieve(
+        # The ID of the trip
+        trip_id,
+        # A string code identifying the nature of the problem
+        code: nil,
+        # The service date of the trip
+        service_date: nil,
+        # A stop ID indicating where the user is experiencing the problem
+        stop_id: nil,
+        # Additional comment text supplied by the user describing the problem
+        user_comment: nil,
+        # The reporting user’s current latitude
+        user_lat: nil,
+        # The reporting user’s location accuracy, in meters
+        user_location_accuracy: nil,
+        # The reporting user’s current longitude
+        user_lon: nil,
+        # Indicator if the user is on the transit vehicle experiencing the problem
+        user_on_vehicle: nil,
+        # The vehicle number, as reported by the user
+        user_vehicle_number: nil,
+        # The vehicle actively serving the trip
+        vehicle_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/route.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class Route
+      # Retrieve information for a specific route identified by its unique ID.
+      sig do
+        params(
+          route_id: String,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::Models::RouteRetrieveResponse)
+      end
+      def retrieve(
+        # The ID of the route.
+        route_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/route_ids_for_agency.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class RouteIDsForAgency
+      # Get route IDs for a specific agency
+      sig do
+        params(
+          agency_id: String,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::Models::RouteIDsForAgencyListResponse)
+      end
+      def list(
+        # ID of the agency
+        agency_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/routes_for_agency.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class RoutesForAgency
+      # Retrieve the list of all routes for a particular agency by id
+      sig do
+        params(
+          agency_id: String,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::Models::RoutesForAgencyListResponse)
+      end
+      def list(
+        # The id of the agency
+        agency_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/routes_for_location.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class RoutesForLocation
+      # routes-for-location
+      sig do
+        params(
+          lat: Float,
+          lon: Float,
+          lat_span: Float,
+          lon_span: Float,
+          query: String,
+          radius: Float,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::Models::RoutesForLocationListResponse)
+      end
+      def list(
+        lat:,
+        lon:,
+        lat_span: nil,
+        lon_span: nil,
+        query: nil,
+        radius: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/schedule_for_route.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class ScheduleForRoute
+      # Retrieve the full schedule for a route on a particular day
+      sig do
+        params(
+          route_id: String,
+          date: Date,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::Models::ScheduleForRouteRetrieveResponse)
+      end
+      def retrieve(
+        # The route id to request the schedule for
+        route_id,
+        # The date for which you want to request a schedule in the format YYYY-MM-DD
+        # (optional, defaults to current date)
+        date: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/schedule_for_stop.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class ScheduleForStop
+      # Get schedule for a specific stop
+      sig do
+        params(
+          stop_id: String,
+          date: Date,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::Models::ScheduleForStopRetrieveResponse)
+      end
+      def retrieve(
+        # The stop id to request the schedule for, encoded directly in the URL
+        stop_id,
+        # The date for which you want to request a schedule in the format YYYY-MM-DD
+        # (optional, defaults to the current date)
+        date: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/search_for_route.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class SearchForRoute
+      # Search for a route based on its name.
+      sig do
+        params(
+          input: String,
+          max_count: Integer,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::Models::SearchForRouteListResponse)
+      end
+      def list(
+        # The string to search for.
+        input:,
+        # The max number of results to return. Defaults to 20.
+        max_count: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/search_for_stop.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class SearchForStop
+      # Search for a stop based on its name.
+      sig do
+        params(
+          input: String,
+          max_count: Integer,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::Models::SearchForStopListResponse)
+      end
+      def list(
+        # The string to search for.
+        input:,
+        # The max number of results to return. Defaults to 20.
+        max_count: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/onebusaway_sdk/resources/shape.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module OnebusawaySDK
+  module Resources
+    class Shape
+      # Retrieve a shape (the path traveled by a transit vehicle) by ID.
+      sig do
+        params(
+          shape_id: String,
+          request_options: OnebusawaySDK::RequestOptions::OrHash
+        ).returns(OnebusawaySDK::Models::ShapeRetrieveResponse)
+      end
+      def retrieve(
+        # The shape ID, encoded directly in the URL
+        shape_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end