onebusaway-sdk 0.1.0.pre.alpha.203

data/lib/onebusaway-sdk/resources/search_for_route.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class SearchForRoute
+      # Search for a route based on its name.
+      #
+      # @param params [OnebusawaySDK::Models::SearchForRouteListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :input The string to search for.
+      #
+      #   @option params [Integer] :max_count The max number of results to return. Defaults to 20.
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::SearchForRouteListResponse]
+      #
+      def list(params)
+        parsed, options = OnebusawaySDK::Models::SearchForRouteListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/where/search/route.json",
+          query: parsed,
+          model: OnebusawaySDK::Models::SearchForRouteListResponse,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/onebusaway-sdk/resources/search_for_stop.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class SearchForStop
+      # Search for a stop based on its name.
+      #
+      # @param params [OnebusawaySDK::Models::SearchForStopListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :input The string to search for.
+      #
+      #   @option params [Integer] :max_count The max number of results to return. Defaults to 20.
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::SearchForStopListResponse]
+      #
+      def list(params)
+        parsed, options = OnebusawaySDK::Models::SearchForStopListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/where/search/stop.json",
+          query: parsed,
+          model: OnebusawaySDK::Models::SearchForStopListResponse,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/onebusaway-sdk/resources/shape.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class Shape
+      # Retrieve a shape (the path traveled by a transit vehicle) by ID.
+      #
+      # @param shape_id [String] The shape ID, encoded directly in the URL
+      #
+      # @param params [OnebusawaySDK::Models::ShapeRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::ShapeRetrieveResponse]
+      #
+      def retrieve(shape_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/where/shape/%0s.json", shape_id],
+          model: OnebusawaySDK::Models::ShapeRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/onebusaway-sdk/resources/stop.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class Stop
+      # Get details of a specific stop
+      #
+      # @param stop_id [String] ID of the stop
+      #
+      # @param params [OnebusawaySDK::Models::StopRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::StopRetrieveResponse]
+      #
+      def retrieve(stop_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/where/stop/%0s.json", stop_id],
+          model: OnebusawaySDK::Models::StopRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class StopIDsForAgency
+      # Get stop IDs for a specific agency
+      #
+      # @param agency_id [String] ID of the agency
+      #
+      # @param params [OnebusawaySDK::Models::StopIDsForAgencyListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::StopIDsForAgencyListResponse]
+      #
+      def list(agency_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/where/stop-ids-for-agency/%0s.json", agency_id],
+          model: OnebusawaySDK::Models::StopIDsForAgencyListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class StopsForAgency
+      # Get stops for a specific agency
+      #
+      # @param agency_id [String] ID of the agency
+      #
+      # @param params [OnebusawaySDK::Models::StopsForAgencyListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::StopsForAgencyListResponse]
+      #
+      def list(agency_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/where/stops-for-agency/%0s.json", agency_id],
+          model: OnebusawaySDK::Models::StopsForAgencyListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class StopsForLocation
+      # stops-for-location
+      #
+      # @param params [OnebusawaySDK::Models::StopsForLocationListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Float] :lat
+      #
+      #   @option params [Float] :lon
+      #
+      #   @option params [Float] :lat_span An alternative to radius to set the search bounding box (optional)
+      #
+      #   @option params [Float] :lon_span An alternative to radius to set the search bounding box (optional)
+      #
+      #   @option params [String] :query A search query string to filter the results
+      #
+      #   @option params [Float] :radius The radius in meters to search within
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::StopsForLocationListResponse]
+      #
+      def list(params)
+        parsed, options = OnebusawaySDK::Models::StopsForLocationListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/where/stops-for-location.json",
+          query: parsed,
+          model: OnebusawaySDK::Models::StopsForLocationListResponse,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class StopsForRoute
+      # Get stops for a specific route
+      #
+      # @param route_id [String] ID of the route
+      #
+      # @param params [OnebusawaySDK::Models::StopsForRouteListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Boolean] :include_polylines Include polyline elements in the response (default true)
+      #
+      #   @option params [String] :time Specify service date (YYYY-MM-DD or epoch) (default today)
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::StopsForRouteListResponse]
+      #
+      def list(route_id, params = {})
+        parsed, options = OnebusawaySDK::Models::StopsForRouteListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/where/stops-for-route/%0s.json", route_id],
+          query: parsed,
+          model: OnebusawaySDK::Models::StopsForRouteListResponse,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class Trip
+      # Get details of a specific trip
+      #
+      # @param trip_id [String] ID of the trip
+      #
+      # @param params [OnebusawaySDK::Models::TripRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::TripRetrieveResponse]
+      #
+      def retrieve(trip_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/where/trip/%0s.json", trip_id],
+          model: OnebusawaySDK::Models::TripRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class TripDetails
+      # Retrieve Trip Details
+      #
+      # @param trip_id [String] ID of the trip to retrieve details for.
+      #
+      # @param params [OnebusawaySDK::Models::TripDetailRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Boolean] :include_schedule Whether to include the full schedule element in the tripDetails section
+      #     (defaults to true).
+      #
+      #   @option params [Boolean] :include_status Whether to include the full status element in the tripDetails section (defaults
+      #     to true).
+      #
+      #   @option params [Boolean] :include_trip Whether to include the full trip element in the references section (defaults to
+      #     true).
+      #
+      #   @option params [Integer] :service_date Service date for the trip as Unix time in milliseconds (optional).
+      #
+      #   @option params [Integer] :time Time parameter to query the system at a specific time (optional).
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::TripDetailRetrieveResponse]
+      #
+      def retrieve(trip_id, params = {})
+        parsed, options = OnebusawaySDK::Models::TripDetailRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/where/trip-details/%0s.json", trip_id],
+          query: parsed,
+          model: OnebusawaySDK::Models::TripDetailRetrieveResponse,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class TripForVehicle
+      # Retrieve trip for a specific vehicle
+      #
+      # @param vehicle_id [String] ID of the vehicle to retrieve trip details for.
+      #
+      # @param params [OnebusawaySDK::Models::TripForVehicleRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Boolean] :include_schedule Determines whether full <schedule/> element is included in the <tripDetails/>
+      #     section. Defaults to false.
+      #
+      #   @option params [Boolean] :include_status Determines whether the full <status/> element is included in the <tripDetails/>
+      #     section. Defaults to true.
+      #
+      #   @option params [Boolean] :include_trip Determines whether full <trip/> element is included in the <references/>
+      #     section. Defaults to false.
+      #
+      #   @option params [Integer] :time Time parameter to query the system at a specific time (optional).
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::TripForVehicleRetrieveResponse]
+      #
+      def retrieve(vehicle_id, params = {})
+        parsed, options = OnebusawaySDK::Models::TripForVehicleRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/where/trip-for-vehicle/%0s.json", vehicle_id],
+          query: parsed,
+          model: OnebusawaySDK::Models::TripForVehicleRetrieveResponse,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class TripsForLocation
+      # Retrieve trips for a given location
+      #
+      # @param params [OnebusawaySDK::Models::TripsForLocationListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Float] :lat The latitude coordinate of the search center
+      #
+      #   @option params [Float] :lat_span Latitude span of the search bounding box
+      #
+      #   @option params [Float] :lon The longitude coordinate of the search center
+      #
+      #   @option params [Float] :lon_span Longitude span of the search bounding box
+      #
+      #   @option params [Boolean] :include_schedule Whether to include full schedule elements in the tripDetails section. Defaults
+      #     to false.
+      #
+      #   @option params [Boolean] :include_trip Whether to include full trip elements in the references section. Defaults to
+      #     false.
+      #
+      #   @option params [Integer] :time Specific time for the query. Defaults to the current time.
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::TripsForLocationListResponse]
+      #
+      def list(params)
+        parsed, options = OnebusawaySDK::Models::TripsForLocationListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/where/trips-for-location.json",
+          query: parsed,
+          model: OnebusawaySDK::Models::TripsForLocationListResponse,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class TripsForRoute
+      # Search for active trips for a specific route.
+      #
+      # @param route_id [String] The ID of the route.
+      #
+      # @param params [OnebusawaySDK::Models::TripsForRouteListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Boolean] :include_schedule Determine whether full schedule elements are included. Defaults to false.
+      #
+      #   @option params [Boolean] :include_status Determine whether full tripStatus elements with real-time information are
+      #     included. Defaults to false.
+      #
+      #   @option params [Integer] :time Query the system at a specific time. Useful for testing.
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::TripsForRouteListResponse]
+      #
+      def list(route_id, params = {})
+        parsed, options = OnebusawaySDK::Models::TripsForRouteListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/where/trips-for-route/%0s.json", route_id],
+          query: parsed,
+          model: OnebusawaySDK::Models::TripsForRouteListResponse,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class VehiclesForAgency
+      # Get vehicles for a specific agency
+      #
+      # @param agency_id [String] ID of the agency
+      #
+      # @param params [OnebusawaySDK::Models::VehiclesForAgencyListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :time Specific time for querying the status (timestamp format)
+      #
+      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [OnebusawaySDK::Models::VehiclesForAgencyListResponse]
+      #
+      def list(agency_id, params = {})
+        parsed, options = OnebusawaySDK::Models::VehiclesForAgencyListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/where/vehicles-for-agency/%0s.json", agency_id],
+          query: parsed,
+          model: OnebusawaySDK::Models::VehiclesForAgencyListResponse,
+          options: options
+        )
+      end
+
+      # @param client [OnebusawaySDK::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end