diff --git a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ArrivalAndDepartureListParams.kt b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ArrivalAndDepartureListParams.kt index b322956..f87d6db 100644 --- a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ArrivalAndDepartureListParams.kt +++ b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ArrivalAndDepartureListParams.kt @@ -22,10 +22,13 @@ constructor( fun stopId(): String = stopId + /** Include vehicles arriving or departing in the next n minutes. */ fun minutesAfter(): Optional = Optional.ofNullable(minutesAfter) + /** Include vehicles having arrived or departed in the previous n minutes. */ fun minutesBefore(): Optional = Optional.ofNullable(minutesBefore) + /** The specific time for querying the system status. */ fun time(): Optional = Optional.ofNullable(time) fun _additionalHeaders(): Headers = additionalHeaders diff --git a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ReportProblemWithStopRetrieveParams.kt b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ReportProblemWithStopRetrieveParams.kt index f5ddb96..07dbe77 100644 --- a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ReportProblemWithStopRetrieveParams.kt +++ b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ReportProblemWithStopRetrieveParams.kt @@ -26,14 +26,19 @@ constructor( fun stopId(): String = stopId + /** A string code identifying the nature of the problem */ fun code(): Optional = Optional.ofNullable(code) + /** Additional comment text supplied by the user describing the problem */ fun userComment(): Optional = Optional.ofNullable(userComment) + /** The reporting user’s current latitude */ fun userLat(): Optional = Optional.ofNullable(userLat) + /** The reporting user’s location accuracy, in meters */ fun userLocationAccuracy(): Optional = Optional.ofNullable(userLocationAccuracy) + /** The reporting user’s current longitude */ fun userLon(): Optional = Optional.ofNullable(userLon) fun _additionalHeaders(): Headers = additionalHeaders diff --git a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ReportProblemWithTripRetrieveParams.kt b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ReportProblemWithTripRetrieveParams.kt index 961bb1b..6d0e87a 100644 --- a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ReportProblemWithTripRetrieveParams.kt +++ b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ReportProblemWithTripRetrieveParams.kt @@ -31,24 +31,34 @@ constructor( fun tripId(): String = tripId + /** A string code identifying the nature of the problem */ fun code(): Optional = Optional.ofNullable(code) + /** The service date of the trip */ fun serviceDate(): Optional = Optional.ofNullable(serviceDate) + /** A stop ID indicating where the user is experiencing the problem */ fun stopId(): Optional = Optional.ofNullable(stopId) + /** Additional comment text supplied by the user describing the problem */ fun userComment(): Optional = Optional.ofNullable(userComment) + /** The reporting user’s current latitude */ fun userLat(): Optional = Optional.ofNullable(userLat) + /** The reporting user’s location accuracy, in meters */ fun userLocationAccuracy(): Optional = Optional.ofNullable(userLocationAccuracy) + /** The reporting user’s current longitude */ fun userLon(): Optional = Optional.ofNullable(userLon) + /** Indicator if the user is on the transit vehicle experiencing the problem */ fun userOnVehicle(): Optional = Optional.ofNullable(userOnVehicle) + /** The vehicle number, as reported by the user */ fun userVehicleNumber(): Optional = Optional.ofNullable(userVehicleNumber) + /** The vehicle actively serving the trip */ fun vehicleId(): Optional = Optional.ofNullable(vehicleId) fun _additionalHeaders(): Headers = additionalHeaders diff --git a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ScheduleForRouteRetrieveParams.kt b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ScheduleForRouteRetrieveParams.kt index 35954aa..daacc53 100644 --- a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ScheduleForRouteRetrieveParams.kt +++ b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ScheduleForRouteRetrieveParams.kt @@ -19,6 +19,10 @@ constructor( fun routeId(): String = routeId + /** + * The date for which you want to request a schedule in the format YYYY-MM-DD (optional, + * defaults to current date) + */ fun date(): Optional = Optional.ofNullable(date) fun _additionalHeaders(): Headers = additionalHeaders diff --git a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ScheduleForStopRetrieveParams.kt b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ScheduleForStopRetrieveParams.kt index cb6f935..f33d2c8 100644 --- a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ScheduleForStopRetrieveParams.kt +++ b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/ScheduleForStopRetrieveParams.kt @@ -19,6 +19,10 @@ constructor( fun stopId(): String = stopId + /** + * The date for which you want to request a schedule in the format YYYY-MM-DD (optional, + * defaults to the current date) + */ fun date(): Optional = Optional.ofNullable(date) fun _additionalHeaders(): Headers = additionalHeaders diff --git a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/SearchForRouteListParams.kt b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/SearchForRouteListParams.kt index 02347a2..e7084d4 100644 --- a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/SearchForRouteListParams.kt +++ b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/SearchForRouteListParams.kt @@ -16,8 +16,10 @@ constructor( private val additionalQueryParams: QueryParams, ) { + /** The string to search for. */ fun input(): String = input + /** The max number of results to return. Defaults to 20. */ fun maxCount(): Optional = Optional.ofNullable(maxCount) fun _additionalHeaders(): Headers = additionalHeaders diff --git a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/SearchForStopListParams.kt b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/SearchForStopListParams.kt index 55a6e79..5de1fb8 100644 --- a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/SearchForStopListParams.kt +++ b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/SearchForStopListParams.kt @@ -16,8 +16,10 @@ constructor( private val additionalQueryParams: QueryParams, ) { + /** The string to search for. */ fun input(): String = input + /** The max number of results to return. Defaults to 20. */ fun maxCount(): Optional = Optional.ofNullable(maxCount) fun _additionalHeaders(): Headers = additionalHeaders diff --git a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/StopsForLocationListParams.kt b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/StopsForLocationListParams.kt index 7b09c87..1da3e8f 100644 --- a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/StopsForLocationListParams.kt +++ b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/StopsForLocationListParams.kt @@ -24,12 +24,16 @@ constructor( fun lon(): Double = lon + /** An alternative to radius to set the search bounding box (optional) */ fun latSpan(): Optional = Optional.ofNullable(latSpan) + /** An alternative to radius to set the search bounding box (optional) */ fun lonSpan(): Optional = Optional.ofNullable(lonSpan) + /** A search query string to filter the results */ fun query(): Optional = Optional.ofNullable(query) + /** The radius in meters to search within */ fun radius(): Optional = Optional.ofNullable(radius) fun _additionalHeaders(): Headers = additionalHeaders diff --git a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/StopsForRouteListParams.kt b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/StopsForRouteListParams.kt index 4f2998a..7dcf9a4 100644 --- a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/StopsForRouteListParams.kt +++ b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/StopsForRouteListParams.kt @@ -19,8 +19,10 @@ constructor( fun routeId(): String = routeId + /** Include polyline elements in the response (default true) */ fun includePolylines(): Optional = Optional.ofNullable(includePolylines) + /** Specify service date (YYYY-MM-DD or epoch) (default today) */ fun time(): Optional = Optional.ofNullable(time) fun _additionalHeaders(): Headers = additionalHeaders diff --git a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripDetailRetrieveParams.kt b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripDetailRetrieveParams.kt index 4c7c3e3..d51762c 100644 --- a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripDetailRetrieveParams.kt +++ b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripDetailRetrieveParams.kt @@ -22,14 +22,21 @@ constructor( fun tripId(): String = tripId + /** + * Whether to include the full schedule element in the tripDetails section (defaults to true). + */ fun includeSchedule(): Optional = Optional.ofNullable(includeSchedule) + /** Whether to include the full status element in the tripDetails section (defaults to true). */ fun includeStatus(): Optional = Optional.ofNullable(includeStatus) + /** Whether to include the full trip element in the references section (defaults to true). */ fun includeTrip(): Optional = Optional.ofNullable(includeTrip) + /** Service date for the trip as Unix time in milliseconds (optional). */ fun serviceDate(): Optional = Optional.ofNullable(serviceDate) + /** Time parameter to query the system at a specific time (optional). */ fun time(): Optional = Optional.ofNullable(time) fun _additionalHeaders(): Headers = additionalHeaders diff --git a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripForVehicleRetrieveParams.kt b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripForVehicleRetrieveParams.kt index 57401e2..80e1fe0 100644 --- a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripForVehicleRetrieveParams.kt +++ b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripForVehicleRetrieveParams.kt @@ -21,12 +21,25 @@ constructor( fun vehicleId(): String = vehicleId + /** + * Determines whether full element is included in the section. + * Defaults to false. + */ fun includeSchedule(): Optional = Optional.ofNullable(includeSchedule) + /** + * Determines whether the full element is included in the section. + * Defaults to true. + */ fun includeStatus(): Optional = Optional.ofNullable(includeStatus) + /** + * Determines whether full element is included in the section. Defaults to + * false. + */ fun includeTrip(): Optional = Optional.ofNullable(includeTrip) + /** Time parameter to query the system at a specific time (optional). */ fun time(): Optional = Optional.ofNullable(time) fun _additionalHeaders(): Headers = additionalHeaders diff --git a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripsForLocationListParams.kt b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripsForLocationListParams.kt index e819ee8..90ed900 100644 --- a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripsForLocationListParams.kt +++ b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripsForLocationListParams.kt @@ -21,18 +21,25 @@ constructor( private val additionalQueryParams: QueryParams, ) { + /** The latitude coordinate of the search center */ fun lat(): Double = lat + /** Latitude span of the search bounding box */ fun latSpan(): Double = latSpan + /** The longitude coordinate of the search center */ fun lon(): Double = lon + /** Longitude span of the search bounding box */ fun lonSpan(): Double = lonSpan + /** Whether to include full schedule elements in the tripDetails section. Defaults to false. */ fun includeSchedule(): Optional = Optional.ofNullable(includeSchedule) + /** Whether to include full trip elements in the references section. Defaults to false. */ fun includeTrip(): Optional = Optional.ofNullable(includeTrip) + /** Specific time for the query. Defaults to the current time. */ fun time(): Optional = Optional.ofNullable(time) fun _additionalHeaders(): Headers = additionalHeaders diff --git a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripsForRouteListParams.kt b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripsForRouteListParams.kt index 562eb3c..12d2d35 100644 --- a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripsForRouteListParams.kt +++ b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/TripsForRouteListParams.kt @@ -20,10 +20,16 @@ constructor( fun routeId(): String = routeId + /** Determine whether full schedule elements are included. Defaults to false. */ fun includeSchedule(): Optional = Optional.ofNullable(includeSchedule) + /** + * Determine whether full tripStatus elements with real-time information are included. Defaults + * to false. + */ fun includeStatus(): Optional = Optional.ofNullable(includeStatus) + /** Query the system at a specific time. Useful for testing. */ fun time(): Optional = Optional.ofNullable(time) fun _additionalHeaders(): Headers = additionalHeaders diff --git a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/VehiclesForAgencyListParams.kt b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/VehiclesForAgencyListParams.kt index b7d39fa..959a68a 100644 --- a/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/VehiclesForAgencyListParams.kt +++ b/onebusaway-sdk-java-core/src/main/kotlin/org/onebusaway/models/VehiclesForAgencyListParams.kt @@ -18,6 +18,7 @@ constructor( fun agencyId(): String = agencyId + /** Specific time for querying the status (timestamp format) */ fun time(): Optional = Optional.ofNullable(time) fun _additionalHeaders(): Headers = additionalHeaders