Merge pull request #28 from hossain-khan/cleanup/test-name

Cleanup/test and add missing models
hossain-khan · Mar 15, 2024 · 7eb17e7 · 7eb17e7
2 parents c64dc4d + e3b2e34
commit 7eb17e7
Show file tree

Hide file tree

Showing 4 changed files with 351 additions and 28 deletions.
diff --git a/parser/src/main/kotlin/model/Semantic.kt b/parser/src/main/kotlin/model/Semantic.kt
@@ -21,46 +21,76 @@ data class TimelineObjectsProperties(
 
 @JsonClass(generateAdapter = true)
 data class ActivitySegment(
-  /** The start location of the activity */
+  /**
+   * Start location of the activity.
+   */
   @Json(name = "startLocation")
   val startLocation: Location,
-  /** The end location of the activity */
+  /**
+   * End location of the activity.
+   */
   @Json(name = "endLocation")
   val endLocation: Location,
-  /** The duration of the activity */
+  /**
+   * Duration of the activity.
+   * Example: Duration(startTimestamp = "2022-03-03T12:22:24Z", endTimestamp = "2022-03-03T12:43:34Z")
+   */
   @Json(name = "duration")
   val duration: Duration,
-  /** The distance of the activity */
+  /**
+   * Distance traveled during the activity, in meters.
+   * Example: 2640
+   */
   @Json(name = "distance")
   val distance: Int?,
-  /** The type of the activity */
+  /**
+   * Best match activity type. Corresponds to the activity type with the highest probability in activities.
+   * Example: "IN_BUS"
+   */
   @Json(name = "activityType")
   val activityType: String,
-  /** The list of activities */
+  /**
+   * List of all the considered candidate activity types and their probabilities. The sum of all the probabilities is always <= 100.
+   * Example: [Activity(activityType = "IN_BUS", probability = 85.6847882270813), Activity(activityType = "WALKING", probability = 8.418431878089905)]
+   */
   @Json(name = "activities")
   val activities: List<Activity> = emptyList(),
-  /** The confidence of the activity */
+  /**
+   * Confidence that the chosen activity type is correct. One of: `LOW`, `MEDIUM`, `HIGH` or `UNKNOWN_CONFIDENCE`. Activities that have been manually confirmed always have a confidence of `HIGH`.
+   * Example: "HIGH"
+   */
   @Json(name = "confidence")
   val confidence: String,
-  /** The waypoint path of the activity */
   @Json(name = "waypointPath")
   val waypointPath: WaypointPath?,
   /** The simplified raw path of the activity */
   @Json(name = "simplifiedRawPath")
   val simplifiedRawPath: SimplifiedRawPath?,
-  /** The transit path of the activity */
+  /**
+   * Path taken in a public transit system, such as a bus or a metro.
+   * Example: TransitPath(transitStops = [TransitStop(latitudeE7 = 414083140, longitudeE7 = 21704000, placeId = "ChIJWey1zMWipBIRiNQSzpI4EDQ", address = "08025 Barcelona\nEspaña", name = "Sant Antoni Maria Claret-Lepant")], name = "H8", hexRgbColor = "009EE0", linePlaceId = "ChIJQVEUoLuipBIRJO37wI4yyBs", stopTimesInfo = [StopTimeInfo(scheduledDepartureTimestamp = "2022-03-03T12:42:00Z", realtimeDepartureTimestamp = "2022-03-03T12:43:37Z")], source = "INFERRED", confidence = 0.9155850640140931, distanceMeters = 2341.0)
+   */
   @Json(name = "transitPath")
   val transitPath: TransitPath?,
   /** The parking event of the activity */
   @Json(name = "parkingEvent")
   val parkingEvent: ParkingEvent?,
-  /** The edit confirmation status of the activity */
+  /**
+   * Whether the user has manually edited the activity segment. Can be `NOT_CONFIRMED` or `CONFIRMED`.
+   * Example: "CONFIRMED"
+   */
   @Json(name = "editConfirmationStatus")
   val editConfirmationStatus: String?,
-  /** The edit action metadata of the activity */
+  /**
+   * Edit-Action Metadata for this activity segment
+   * Example: EditActionMetadata(lastEditedTimestamp = "2022-03-06T14:13:11.092Z")
+   */
   @Json(name = "editActionMetadata")
   val editActionMetadata: EditActionMetadata?,
-  /** The last edited timestamp of the activity */
+  /**
+   * Last-Edited Timestamp for this activity segment
+   * Example: "2022-03-06T14:13:11.092Z"
+   */
   @Json(name = "lastEditedTimestamp")
   val lastEditedTimestamp: String?,
 )
@@ -86,15 +116,118 @@ data class Location(
 
 @JsonClass(generateAdapter = true)
 data class PlaceVisit(
-  /** Location of the place */
+  /**
+   * Location of the place
+   * Example: Location(latitudeE7 = 414216106, longitudeE7 = 21684775, placeId = "ChIJk_s92NyipBIRUMnDG8Kq2Js")
+   */
   @Json(name = "location")
   val location: Location,
-  /** Duration of the place visit */
+  /**
+   * Latitude coordinate of the location. Degrees multiplied by 10^7 and rounded to the nearest integer, in the range -900000000 to +900000000 (divide value by 10^7 for the usual range -90° to +90°).
+   * Example: 414216106
+   */
+  @Json(name = "centerLatE7")
+  val centerLatE7: Int,
+  /**
+   * Longitude coordinate of the location. Degrees multiplied by 10^7 and rounded to the nearest integer, in the range -1800000000 to +1800000000 (divide value by 10^7 for the usual range -180° to +180°).
+   * Example: 21684775
+   */
+  @Json(name = "centerLngE7")
+  val centerLngE7: Int,
+  /**
+   * Duration of the place visit
+   * Example: Duration(startTimestamp = "2022-03-06T14:13:11.092Z", endTimestamp = "2022-03-06T15:13:11.092Z")
+   */
   @Json(name = "duration")
   val duration: Duration,
-  /** Categorized confidence for this place visit */
+  /**
+   * Categorized confidence for this place visit. One of: `LOW_CONFIDENCE`, `MEDIUM_CONFIDENCE`, `HIGH_CONFIDENCE` or `USER_CONFIRMED`.
+   * Example: "HIGH"
+   */
   @Json(name = "placeConfidence")
   val placeConfidence: String,
+  /**
+   * Visit confidence for this place visit
+   * Example: 95
+   */
+  @Json(name = "visitConfidence")
+  val visitConfidence: Int,
+  /**
+   * Location confidence for this place visit
+   * Example: 71
+   */
+  @Json(name = "locationConfidence")
+  val locationConfidence: Int,
+  /**
+   * Other candidate locations for this place visit
+   * Example: [Location(latitudeE7 = 414216106, longitudeE7 = 21684775, placeId = "ChIJk_s92NyipBIRUMnDG8Kq2Js")]
+   */
+  @Json(name = "otherCandidateLocations")
+  val otherCandidateLocations: List<Location>,
+  /**
+   * Child visits for this place visit
+   * Example: [PlaceVisit(location = Location(latitudeE7 = 414216106, longitudeE7 = 21684775, placeId = "ChIJk_s92NyipBIRUMnDG8Kq2Js"), centerLatE7 = 414216106, centerLngE7 = 21684775, duration = Duration(startTimestamp = "2022-03-06T14:13:11.092Z", endTimestamp = "2022-03-06T15:13:11.092Z"), placeConfidence = "HIGH", visitConfidence = 95, locationConfidence = 71, otherCandidateLocations = [Location(latitudeE7 = 414216106, longitudeE7 = 21684775, placeId = "ChIJk_s92NyipBIRUMnDG8Kq2Js")])]
+   */
+  @Json(name = "childVisits")
+  val childVisits: List<PlaceVisit>?,
+  /**
+   * Section ID for this place visit
+   * Example: "section123"
+   */
+  @Json(name = "sectionId")
+  val sectionId: String?,
+  /**
+   * Simplified raw path for this place visit.
+   */
+  @Json(name = "simplifiedRawPath")
+  val simplifiedRawPath: SimplifiedRawPath?,
+  /**
+   * Level (depth) of this place visit. This value increases by 1 with each recursive access to a [#/$defs/placeVisit/properties/childVisits] entry.
+   * Example: 1
+   */
+  @Json(name = "placeVisitLevel")
+  val placeVisitLevel: Int?,
+  /**
+   * Whether the user has manually edited the place visit. Can be `NOT_CONFIRMED` or `CONFIRMED`.
+   * Example: "CONFIRMED"
+   */
+  @Json(name = "editConfirmationStatus")
+  val editConfirmationStatus: String,
+  /**
+   * Edit-Action Metadata for this place visit
+   * Example: EditActionMetadata(lastEditedTimestamp = "2022-03-06T14:13:11.092Z")
+   */
+  @Json(name = "editActionMetadata")
+  val editActionMetadata: EditActionMetadata?,
+  /**
+   * Last-Edited Timestamp for this place visit
+   * Example: "2022-03-06T14:13:11.092Z"
+   */
+  @Json(name = "lastEditedTimestamp")
+  val lastEditedTimestamp: String?,
+  /**
+   * Place Visit Type for this place visit. Can be `SINGLE_PLACE`.
+   * Example: "SINGLE_PLACE"
+   */
+  @Json(name = "placeVisitType")
+  val placeVisitType: String,
+  /**
+   * Place Visit Importance for this place visit. One of `MAIN` or `TRANSITIONAL`.
+   * Example: "MAIN"
+   */
+  @Json(name = "placeVisitImportance")
+  val placeVisitImportance: String?,
+  /**
+   * Location Assertion Type for this place visit
+   * Example: "AREA"
+   */
+  @Json(name = "locationAssertionType")
+  val locationAssertionType: String?,
+  /**
+   * Checkin for this place visit
+   */
+  @Json(name = "checkin")
+  val checkin: Checkin?,
 )
 
 @JsonClass(generateAdapter = true)
@@ -133,9 +266,70 @@ data class SimplifiedRawPath(
 
 @JsonClass(generateAdapter = true)
 data class TransitPath(
-  /** The transit stops in the transit path */
+  /**
+   * List of locations of the transit stops used.
+   * Example: [TransitStop(latitudeE7 = 414083140, longitudeE7 = 21704000, placeId = "ChIJWey1zMWipBIRiNQSzpI4EDQ", address = "08025 Barcelona\nEspaña", name = "Sant Antoni Maria Claret-Lepant")]
+   */
   @Json(name = "transitStops")
   val transitStops: List<TransitStop>,
+  /**
+   * Name of the transit line.
+   * Example: "H8"
+   */
+  @Json(name = "name")
+  val name: String,
+  /**
+   * Color of the transit line in hexadecimal in the form *RRGGBB*.
+   * Example: "009EE0"
+   */
+  @Json(name = "hexRgbColor")
+  val hexRgbColor: String,
+  /**
+   * Google Maps Place ID of the transit line.
+   * Example: "ChIJQVEUoLuipBIRJO37wI4yyBs"
+   */
+  @Json(name = "linePlaceId")
+  val linePlaceId: String,
+  /**
+   * Time information (departure and arrival times, both real and scheduled) for each transit stop used.
+   * Example: [StopTimeInfo(scheduledDepartureTimestamp = "2022-03-03T12:42:00Z", realtimeDepartureTimestamp = "2022-03-03T12:43:37Z")]
+   */
+  @Json(name = "stopTimesInfo")
+  val stopTimesInfo: List<StopTimeInfo>,
+  /**
+   * Source of the location data of the transit path. Either `BACKFILLED` or `INFERRED`.
+   * Example: "INFERRED"
+   */
+  @Json(name = "source")
+  val source: String,
+  /**
+   * Confidence of the transit path.
+   * Example: 0.9155850640140931
+   */
+  @Json(name = "confidence")
+  val confidence: Double,
+  /**
+   * Distance traveled with the transit path, in meters.
+   * Example: 2341.0
+   */
+  @Json(name = "distanceMeters")
+  val distanceMeters: Double,
+)
+
+@JsonClass(generateAdapter = true)
+data class StopTimeInfo(
+  /**
+   * Scheduled departure timestamp.
+   * Example: "2022-03-03T12:42:00Z"
+   */
+  @Json(name = "scheduledDepartureTimestamp")
+  val scheduledDepartureTimestamp: String,
+  /**
+   * Real-time departure timestamp.
+   * Example: "2022-03-03T12:43:37Z"
+   */
+  @Json(name = "realtimeDepartureTimestamp")
+  val realtimeDepartureTimestamp: String,
 )
 
 @JsonClass(generateAdapter = true)
@@ -170,10 +364,34 @@ data class Checkin(
 
 @JsonClass(generateAdapter = true)
 data class TransitStop(
-  /** The location of the transit stop */
-  @Json(name = "location")
-  val location: Location,
-  /** The name of the transit stop */
+  /**
+   * Latitude coordinate of the transit stop. Degrees multiplied by 10^7 and rounded to the nearest integer, in the range -900000000 to +900000000 (divide value by 10^7 for the usual range -90° to +90°).
+   * Example: 414083140
+   */
+  @Json(name = "latitudeE7")
+  val latitudeE7: Int,
+  /**
+   * Longitude coordinate of the transit stop. Degrees multiplied by 10^7 and rounded to the nearest integer, in the range -1800000000 to +1800000000 (divide value by 10^7 for the usual range -180° to +180°).
+   * Example: 21704000
+   */
+  @Json(name = "longitudeE7")
+  val longitudeE7: Int,
+  /**
+   * Google Maps Place ID of the transit stop.
+   * Example: "ChIJWey1zMWipBIRiNQSzpI4EDQ"
+   */
+  @Json(name = "placeId")
+  val placeId: String,
+  /**
+   * Address of the transit stop.
+   * Example: "08025 Barcelona\nEspaña"
+   */
+  @Json(name = "address")
+  val address: String,
+  /**
+   * Name of the transit stop.
+   * Example: "Sant Antoni Maria Claret-Lepant"
+   */
   @Json(name = "name")
   val name: String,
 )
@@ -193,7 +411,72 @@ data class Point(
 
 @JsonClass(generateAdapter = true)
 data class WaypointPath(
-  /** The waypoints in the waypoint path */
+  /**
+   * Waypoints of the path
+   * Example: [Waypoint(latE7 = 416119834, lngE7 = 21768624), Waypoint(latE7 = 416117012, lngE7 = 21899302), Waypoint(latE7 = 416119262, lngE7 = 21802315)]
+   */
   @Json(name = "waypoints")
-  val waypoints: List<Point>,
+  val waypoints: List<Waypoint>,
+  /**
+   * Source of the location data of the path. Either `BACKFILLED` or `INFERRED`.
+   * Example: "INFERRED"
+   */
+  @Json(name = "source")
+  val source: String,
+  /**
+   * Total distance of the path, in meters.
+   * Example: 396.34176716755843
+   */
+  @Json(name = "distanceMeters")
+  val distanceMeters: Double,
+  /**
+   * Travel mode of the path. Can be `WALK`, `DRIVE`, or `BICYCLE`.
+   * Example: "WALK"
+   */
+  @Json(name = "travelMode")
+  val travelMode: String,
+  /**
+   * Confidence of the path.
+   * Example: 0.7986568220419046
+   */
+  @Json(name = "confidence")
+  val confidence: Double,
+  /**
+   * Road segments of the path.
+   * Example: [RoadSegment(duration = "8s", placeId = "ChIJk_s92NyipBIRUMnDG8Kq2Js")]
+   */
+  @Json(name = "roadSegment")
+  val roadSegment: List<RoadSegment> = emptyList(),
+)
+
+@JsonClass(generateAdapter = true)
+data class RoadSegment(
+  /**
+   * Duration of the road segment.
+   * Example: "8s"
+   */
+  @Json(name = "duration")
+  val duration: String,
+  /**
+   * Google Maps Place ID of the location.
+   * Example: "ChIJk_s92NyipBIRUMnDG8Kq2Js"
+   */
+  @Json(name = "placeId")
+  val placeId: String,
+)
+
+@JsonClass(generateAdapter = true)
+data class Waypoint(
+  /**
+   * Latitude coordinate of the waypoint. Degrees multiplied by 10^7 and rounded to the nearest integer, in the range -900000000 to +900000000 (divide value by 10^7 for the usual range -90° to +90°).
+   * Example: 414216106
+   */
+  @Json(name = "latE7")
+  val latE7: Int,
+  /**
+   * Longitude coordinate of the waypoint. Degrees multiplied by 10^7 and rounded to the nearest integer, in the range -1800000000 to +1800000000 (divide value by 10^7 for the usual range -180° to +180°).
+   * Example: 21684775
+   */
+  @Json(name = "lngE7")
+  val lngE7: Int,
 )