@stuartshay/otel-data-types 1.0.97 → 1.0.107

package/index.d.ts

@@ -410,6 +410,7 @@ export type components = {
     schemas: {
         /**
          * DailyActivitySummary
+         * @description Per-day aggregate combining OwnTracks location stats and Garmin activity metrics.
          * @example {
          *       "activity_date": "2026-02-11",
          *       "avg_accuracy": 4.89,
@@ -426,43 +427,84 @@ export type components = {
          *     }
          */
         DailyActivitySummary: {
-            /** Activity Date */
+            /**
+             * Activity Date
+             * @description Calendar date in YYYY-MM-DD format
+             */
             activity_date?: string | null;
-            /** Owntracks Device */
+            /**
+             * Owntracks Device
+             * @description OwnTracks device that reported data for this day
+             */
             owntracks_device?: string | null;
-            /** Owntracks Points */
+            /**
+             * Owntracks Points
+             * @description Number of OwnTracks GPS points recorded
+             */
             owntracks_points?: number | null;
-            /** Min Battery */
+            /**
+             * Min Battery
+             * @description Lowest device battery percentage observed
+             */
             min_battery?: number | null;
-            /** Max Battery */
+            /**
+             * Max Battery
+             * @description Highest device battery percentage observed
+             */
             max_battery?: number | null;
-            /** Avg Accuracy */
+            /**
+             * Avg Accuracy
+             * @description Mean horizontal GPS accuracy in meters
+             */
             avg_accuracy?: number | null;
-            /** Garmin Sport */
+            /**
+             * Garmin Sport
+             * @description Garmin sport type for activities on this day
+             */
             garmin_sport?: string | null;
-            /** Garmin Activities */
+            /**
+             * Garmin Activities
+             * @description Number of Garmin activities recorded
+             */
             garmin_activities?: number | null;
-            /** Total Distance Km */
+            /**
+             * Total Distance Km
+             * @description Combined Garmin activity distance in km
+             */
             total_distance_km?: number | null;
-            /** Total Duration Seconds */
+            /**
+             * Total Duration Seconds
+             * @description Combined Garmin activity duration in seconds
+             */
             total_duration_seconds?: number | null;
-            /** Avg Heart Rate */
+            /**
+             * Avg Heart Rate
+             * @description Mean heart rate across Garmin activities in BPM
+             */
             avg_heart_rate?: number | null;
-            /** Total Calories */
+            /**
+             * Total Calories
+             * @description Total calories burned across Garmin activities
+             */
             total_calories?: number | null;
         };
         /**
          * DeviceInfo
+         * @description Distinct OwnTracks device identifier.
          * @example {
          *       "device_id": "iphone_stuart"
          *     }
          */
         DeviceInfo: {
-            /** Device Id */
+            /**
+             * Device Id
+             * @description OwnTracks device identifier
+             */
             device_id: string;
         };
         /**
          * DistanceResult
+         * @description Geodesic distance calculation result between two geographic points.
          * @example {
          *       "distance_meters": 5309.71,
          *       "from_lat": 40.7128,
@@ -472,19 +514,35 @@ export type components = {
          *     }
          */
         DistanceResult: {
-            /** Distance Meters */
+            /**
+             * Distance Meters
+             * @description Geodesic distance between the two points in meters
+             */
             distance_meters: number;
-            /** From Lat */
+            /**
+             * From Lat
+             * @description Origin latitude in decimal degrees
+             */
             from_lat: number;
-            /** From Lon */
+            /**
+             * From Lon
+             * @description Origin longitude in decimal degrees
+             */
             from_lon: number;
-            /** To Lat */
+            /**
+             * To Lat
+             * @description Destination latitude in decimal degrees
+             */
             to_lat: number;
-            /** To Lon */
+            /**
+             * To Lon
+             * @description Destination longitude in decimal degrees
+             */
             to_lon: number;
         };
         /**
          * GarminActivity
+         * @description Summary of a Garmin Connect activity parsed from a FIT file.
          * @example {
          *       "activity_id": "20932993811",
          *       "avg_cadence": 78,
@@ -516,63 +574,145 @@ export type components = {
          *     }
          */
         GarminActivity: {
-            /** Activity Id */
+            /**
+             * Activity Id
+             * @description Garmin Connect activity identifier
+             */
             activity_id: string;
-            /** Sport */
+            /**
+             * Sport
+             * @description Primary sport type (e.g. cycling, running)
+             */
             sport: string;
-            /** Sub Sport */
+            /**
+             * Sub Sport
+             * @description Sub-sport classification (e.g. road, trail)
+             */
             sub_sport?: string | null;
-            /** Start Time */
+            /**
+             * Start Time
+             * @description Activity start time in UTC
+             */
             start_time?: string | null;
-            /** End Time */
+            /**
+             * End Time
+             * @description Activity end time in UTC
+             */
             end_time?: string | null;
-            /** Distance Km */
+            /**
+             * Distance Km
+             * @description Total distance in kilometres
+             */
             distance_km?: number | null;
-            /** Duration Seconds */
+            /**
+             * Duration Seconds
+             * @description Active duration in seconds (excludes pauses)
+             */
             duration_seconds?: number | null;
-            /** Avg Heart Rate */
+            /**
+             * Avg Heart Rate
+             * @description Average heart rate in beats per minute
+             */
             avg_heart_rate?: number | null;
-            /** Max Heart Rate */
+            /**
+             * Max Heart Rate
+             * @description Maximum heart rate in beats per minute
+             */
             max_heart_rate?: number | null;
-            /** Avg Cadence */
+            /**
+             * Avg Cadence
+             * @description Average cadence in RPM
+             */
             avg_cadence?: number | null;
-            /** Max Cadence */
+            /**
+             * Max Cadence
+             * @description Maximum cadence in RPM
+             */
             max_cadence?: number | null;
-            /** Calories */
+            /**
+             * Calories
+             * @description Total calories burned
+             */
             calories?: number | null;
-            /** Avg Speed Kmh */
+            /**
+             * Avg Speed Kmh
+             * @description Average speed in km/h
+             */
             avg_speed_kmh?: number | null;
-            /** Max Speed Kmh */
+            /**
+             * Max Speed Kmh
+             * @description Maximum speed in km/h
+             */
             max_speed_kmh?: number | null;
-            /** Total Ascent M */
+            /**
+             * Total Ascent M
+             * @description Total elevation gain in meters
+             */
             total_ascent_m?: number | null;
-            /** Total Descent M */
+            /**
+             * Total Descent M
+             * @description Total elevation loss in meters
+             */
             total_descent_m?: number | null;
-            /** Total Distance */
+            /**
+             * Total Distance
+             * @description Raw total distance in meters from FIT file
+             */
             total_distance?: number | null;
-            /** Avg Pace */
+            /**
+             * Avg Pace
+             * @description Average pace in minutes per kilometre
+             */
             avg_pace?: number | null;
-            /** Device Manufacturer */
+            /**
+             * Device Manufacturer
+             * @description Device manufacturer (e.g. garmin)
+             */
             device_manufacturer?: string | null;
-            /** Avg Temperature C */
+            /**
+             * Avg Temperature C
+             * @description Average ambient temperature in degrees C
+             */
             avg_temperature_c?: number | null;
-            /** Min Temperature C */
+            /**
+             * Min Temperature C
+             * @description Minimum ambient temperature in degrees C
+             */
             min_temperature_c?: number | null;
-            /** Max Temperature C */
+            /**
+             * Max Temperature C
+             * @description Maximum ambient temperature in degrees C
+             */
             max_temperature_c?: number | null;
-            /** Total Elapsed Time */
+            /**
+             * Total Elapsed Time
+             * @description Total elapsed time in seconds (includes pauses)
+             */
             total_elapsed_time?: number | null;
-            /** Total Timer Time */
+            /**
+             * Total Timer Time
+             * @description Total timer time in seconds (active recording)
+             */
             total_timer_time?: number | null;
-            /** Created At */
+            /**
+             * Created At
+             * @description UTC timestamp when the record was inserted
+             */
             created_at?: string | null;
-            /** Uploaded At */
+            /**
+             * Uploaded At
+             * @description UTC timestamp when the FIT file was uploaded
+             */
             uploaded_at?: string | null;
-            /** Track Point Count */
+            /**
+             * Track Point Count
+             * @description Number of GPS track points in this activity
+             */
             track_point_count?: number | null;
         };
         /**
          * GarminChartPoint
+         * @description Lightweight track point optimised for time-series chart rendering.
          * @example {
          *       "altitude": 12.4,
          *       "cadence": 80,
@@ -589,27 +729,53 @@ export type components = {
             /**
              * Timestamp
              * Format: date-time
+             * @description UTC timestamp of the data point
              */
             timestamp: string;
-            /** Altitude */
+            /**
+             * Altitude
+             * @description Elevation above sea level in meters
+             */
             altitude?: number | null;
-            /** Distance From Start Km */
+            /**
+             * Distance From Start Km
+             * @description Cumulative distance from activity start in km
+             */
             distance_from_start_km?: number | null;
-            /** Speed Kmh */
+            /**
+             * Speed Kmh
+             * @description Instantaneous speed in km/h
+             */
             speed_kmh?: number | null;
-            /** Heart Rate */
+            /**
+             * Heart Rate
+             * @description Heart rate in beats per minute
+             */
             heart_rate?: number | null;
-            /** Cadence */
+            /**
+             * Cadence
+             * @description Pedal/step cadence in RPM
+             */
             cadence?: number | null;
-            /** Temperature C */
+            /**
+             * Temperature C
+             * @description Ambient temperature in degrees C
+             */
             temperature_c?: number | null;
-            /** Latitude */
+            /**
+             * Latitude
+             * @description GPS latitude in decimal degrees (WGS 84)
+             */
             latitude: number;
-            /** Longitude */
+            /**
+             * Longitude
+             * @description GPS longitude in decimal degrees (WGS 84)
+             */
             longitude: number;
         };
         /**
          * GarminTrackPoint
+         * @description Individual GPS track point within a Garmin activity.
          * @example {
          *       "activity_id": "20932993811",
          *       "altitude": 12.4,
@@ -626,32 +792,66 @@ export type components = {
          *     }
          */
         GarminTrackPoint: {
-            /** Id */
+            /**
+             * Id
+             * @description Unique track point record identifier
+             */
             id: number;
-            /** Activity Id */
+            /**
+             * Activity Id
+             * @description Parent Garmin activity identifier
+             */
             activity_id: string;
-            /** Latitude */
+            /**
+             * Latitude
+             * @description GPS latitude in decimal degrees (WGS 84)
+             */
             latitude: number;
-            /** Longitude */
+            /**
+             * Longitude
+             * @description GPS longitude in decimal degrees (WGS 84)
+             */
             longitude: number;
             /**
              * Timestamp
              * Format: date-time
+             * @description UTC timestamp of the track point recording
              */
             timestamp: string;
-            /** Altitude */
+            /**
+             * Altitude
+             * @description Elevation above sea level in meters
+             */
             altitude?: number | null;
-            /** Distance From Start Km */
+            /**
+             * Distance From Start Km
+             * @description Cumulative distance from activity start in km
+             */
             distance_from_start_km?: number | null;
-            /** Speed Kmh */
+            /**
+             * Speed Kmh
+             * @description Instantaneous speed in km/h
+             */
             speed_kmh?: number | null;
-            /** Heart Rate */
+            /**
+             * Heart Rate
+             * @description Heart rate in beats per minute
+             */
             heart_rate?: number | null;
-            /** Cadence */
+            /**
+             * Cadence
+             * @description Pedal/step cadence in RPM
+             */
             cadence?: number | null;
-            /** Temperature C */
+            /**
+             * Temperature C
+             * @description Ambient temperature in degrees C
+             */
             temperature_c?: number | null;
-            /** Created At */
+            /**
+             * Created At
+             * @description UTC timestamp when the record was inserted
+             */
             created_at?: string | null;
         };
         /** HTTPValidationError */
@@ -661,6 +861,7 @@ export type components = {
         };
         /**
          * Location
+         * @description GPS location recorded by the OwnTracks mobile app.
          * @example {
          *       "accuracy": 7,
          *       "altitude": 4,
@@ -678,55 +879,106 @@ export type components = {
          *     }
          */
         Location: {
-            /** Id */
+            /**
+             * Id
+             * @description Unique location record identifier
+             */
             id: number;
-            /** Device Id */
+            /**
+             * Device Id
+             * @description OwnTracks device identifier (e.g. iphone_stuart)
+             */
             device_id: string;
-            /** Tid */
+            /**
+             * Tid
+             * @description Two-character tracker ID set in the OwnTracks app
+             */
             tid?: string | null;
-            /** Latitude */
+            /**
+             * Latitude
+             * @description GPS latitude in decimal degrees (WGS 84)
+             */
             latitude: number;
-            /** Longitude */
+            /**
+             * Longitude
+             * @description GPS longitude in decimal degrees (WGS 84)
+             */
             longitude: number;
-            /** Accuracy */
+            /**
+             * Accuracy
+             * @description Horizontal accuracy of the GPS fix in meters
+             */
             accuracy?: number | null;
-            /** Altitude */
+            /**
+             * Altitude
+             * @description Altitude above sea level in meters
+             */
             altitude?: number | null;
-            /** Velocity */
+            /**
+             * Velocity
+             * @description Device velocity in km/h at time of report
+             */
             velocity?: number | null;
-            /** Battery */
+            /**
+             * Battery
+             * @description Device battery level as a percentage (0-100)
+             */
             battery?: number | null;
-            /** Battery Status */
+            /**
+             * Battery Status
+             * @description Battery charging state (0=unknown, 1=unplugged, 2=charging, 3=full)
+             */
             battery_status?: number | null;
-            /** Connection Type */
+            /**
+             * Connection Type
+             * @description Network connection type (w=WiFi, m=mobile)
+             */
             connection_type?: string | null;
-            /** Trigger */
+            /**
+             * Trigger
+             * @description What triggered this location report (p=ping, c=circular, t=timer)
+             */
             trigger?: string | null;
             /**
              * Timestamp
              * Format: date-time
+             * @description UTC timestamp when the device recorded the location
              */
             timestamp: string;
-            /** Created At */
+            /**
+             * Created At
+             * @description UTC timestamp when the record was inserted into the database
+             */
             created_at?: string | null;
         };
         /**
          * LocationCount
+         * @description Aggregate location count with optional filter context.
          * @example {
          *       "count": 45883,
          *       "device_id": "iphone_stuart"
          *     }
          */
         LocationCount: {
-            /** Count */
+            /**
+             * Count
+             * @description Total number of location records matching the filter
+             */
             count: number;
-            /** Date */
+            /**
+             * Date
+             * @description Date filter applied (YYYY-MM-DD), if any
+             */
             date?: string | null;
-            /** Device Id */
+            /**
+             * Device Id
+             * @description Device ID filter applied, if any
+             */
             device_id?: string | null;
         };
         /**
          * LocationDetail
+         * @description Full location detail including the original OwnTracks JSON payload.
          * @example {
          *       "accuracy": 7,
          *       "altitude": 4,
@@ -752,44 +1004,88 @@ export type components = {
          *     }
          */
         LocationDetail: {
-            /** Id */
+            /**
+             * Id
+             * @description Unique location record identifier
+             */
             id: number;
-            /** Device Id */
+            /**
+             * Device Id
+             * @description OwnTracks device identifier (e.g. iphone_stuart)
+             */
             device_id: string;
-            /** Tid */
+            /**
+             * Tid
+             * @description Two-character tracker ID set in the OwnTracks app
+             */
             tid?: string | null;
-            /** Latitude */
+            /**
+             * Latitude
+             * @description GPS latitude in decimal degrees (WGS 84)
+             */
             latitude: number;
-            /** Longitude */
+            /**
+             * Longitude
+             * @description GPS longitude in decimal degrees (WGS 84)
+             */
             longitude: number;
-            /** Accuracy */
+            /**
+             * Accuracy
+             * @description Horizontal accuracy of the GPS fix in meters
+             */
             accuracy?: number | null;
-            /** Altitude */
+            /**
+             * Altitude
+             * @description Altitude above sea level in meters
+             */
             altitude?: number | null;
-            /** Velocity */
+            /**
+             * Velocity
+             * @description Device velocity in km/h at time of report
+             */
             velocity?: number | null;
-            /** Battery */
+            /**
+             * Battery
+             * @description Device battery level as a percentage (0-100)
+             */
             battery?: number | null;
-            /** Battery Status */
+            /**
+             * Battery Status
+             * @description Battery charging state (0=unknown, 1=unplugged, 2=charging, 3=full)
+             */
             battery_status?: number | null;
-            /** Connection Type */
+            /**
+             * Connection Type
+             * @description Network connection type (w=WiFi, m=mobile)
+             */
             connection_type?: string | null;
-            /** Trigger */
+            /**
+             * Trigger
+             * @description What triggered this location report (p=ping, c=circular, t=timer)
+             */
             trigger?: string | null;
             /**
              * Timestamp
              * Format: date-time
+             * @description UTC timestamp when the device recorded the location
              */
             timestamp: string;
-            /** Created At */
+            /**
+             * Created At
+             * @description UTC timestamp when the record was inserted into the database
+             */
             created_at?: string | null;
-            /** Raw Payload */
+            /**
+             * Raw Payload
+             * @description Original OwnTracks JSON payload as received from the MQTT broker
+             */
             raw_payload?: {
                 [key: string]: unknown;
             } | null;
         };
         /**
          * NearbyPoint
+         * @description GPS point found within a spatial proximity search.
          * @example {
          *       "distance_meters": 0.4,
          *       "id": 35144,
@@ -800,68 +1096,133 @@ export type components = {
          *     }
          */
         NearbyPoint: {
-            /** Source */
+            /**
+             * Source
+             * @description Data source: 'owntracks' or 'garmin'
+             */
             source: string;
-            /** Id */
+            /**
+             * Id
+             * @description Record identifier in the source table
+             */
             id: number;
-            /** Latitude */
+            /**
+             * Latitude
+             * @description GPS latitude in decimal degrees (WGS 84)
+             */
             latitude: number;
-            /** Longitude */
+            /**
+             * Longitude
+             * @description GPS longitude in decimal degrees (WGS 84)
+             */
             longitude: number;
-            /** Distance Meters */
+            /**
+             * Distance Meters
+             * @description Distance from the search center point in meters
+             */
             distance_meters: number;
             /**
              * Timestamp
              * Format: date-time
+             * @description UTC timestamp of the GPS recording
              */
             timestamp: string;
         };
         /** PaginatedResponse[GarminActivity] */
         PaginatedResponse_GarminActivity_: {
-            /** Items */
+            /**
+             * Items
+             * @description List of items in the current page
+             */
             items: components["schemas"]["GarminActivity"][];
-            /** Total */
+            /**
+             * Total
+             * @description Total number of items matching the query
+             */
             total: number;
-            /** Limit */
+            /**
+             * Limit
+             * @description Maximum number of items per page
+             */
             limit: number;
-            /** Offset */
+            /**
+             * Offset
+             * @description Number of items skipped from the start
+             */
             offset: number;
         };
         /** PaginatedResponse[GarminTrackPoint] */
         PaginatedResponse_GarminTrackPoint_: {
-            /** Items */
+            /**
+             * Items
+             * @description List of items in the current page
+             */
             items: components["schemas"]["GarminTrackPoint"][];
-            /** Total */
+            /**
+             * Total
+             * @description Total number of items matching the query
+             */
             total: number;
-            /** Limit */
+            /**
+             * Limit
+             * @description Maximum number of items per page
+             */
             limit: number;
-            /** Offset */
+            /**
+             * Offset
+             * @description Number of items skipped from the start
+             */
             offset: number;
         };
         /** PaginatedResponse[Location] */
         PaginatedResponse_Location_: {
-            /** Items */
+            /**
+             * Items
+             * @description List of items in the current page
+             */
             items: components["schemas"]["Location"][];
-            /** Total */
+            /**
+             * Total
+             * @description Total number of items matching the query
+             */
             total: number;
-            /** Limit */
+            /**
+             * Limit
+             * @description Maximum number of items per page
+             */
             limit: number;
-            /** Offset */
+            /**
+             * Offset
+             * @description Number of items skipped from the start
+             */
             offset: number;
         };
         /** PaginatedResponse[UnifiedGpsPoint] */
         PaginatedResponse_UnifiedGpsPoint_: {
-            /** Items */
+            /**
+             * Items
+             * @description List of items in the current page
+             */
             items: components["schemas"]["UnifiedGpsPoint"][];
-            /** Total */
+            /**
+             * Total
+             * @description Total number of items matching the query
+             */
             total: number;
-            /** Limit */
+            /**
+             * Limit
+             * @description Maximum number of items per page
+             */
             limit: number;
-            /** Offset */
+            /**
+             * Offset
+             * @description Number of items skipped from the start
+             */
             offset: number;
         };
         /**
          * ReferenceLocation
+         * @description Named geographic reference point used for spatial queries (e.g. home, office).
          * @example {
          *       "created_at": "2026-02-03T22:49:07+00:00",
          *       "description": "Primary apartment - 40m radius",
@@ -874,28 +1235,51 @@ export type components = {
          *     }
          */
         ReferenceLocation: {
-            /** Id */
+            /**
+             * Id
+             * @description Unique reference location identifier
+             */
             id: number;
-            /** Name */
+            /**
+             * Name
+             * @description Short, unique name for the location (e.g. home, office)
+             */
             name: string;
-            /** Latitude */
+            /**
+             * Latitude
+             * @description GPS latitude in decimal degrees (WGS 84)
+             */
             latitude: number;
-            /** Longitude */
+            /**
+             * Longitude
+             * @description GPS longitude in decimal degrees (WGS 84)
+             */
             longitude: number;
             /**
              * Radius Meters
+             * @description Geofence radius in meters for proximity queries
              * @default 50
              */
             radius_meters: number;
-            /** Description */
+            /**
+             * Description
+             * @description Optional human-readable description of the location
+             */
             description?: string | null;
-            /** Created At */
+            /**
+             * Created At
+             * @description UTC timestamp when the record was created
+             */
             created_at?: string | null;
-            /** Updated At */
+            /**
+             * Updated At
+             * @description UTC timestamp when the record was last updated
+             */
             updated_at?: string | null;
         };
         /**
          * ReferenceLocationCreate
+         * @description Request body for creating a new reference location.
          * @example {
          *       "description": "Downtown office building",
          *       "latitude": 40.7128,
@@ -905,54 +1289,91 @@ export type components = {
          *     }
          */
         ReferenceLocationCreate: {
-            /** Name */
+            /**
+             * Name
+             * @description Short, unique name for the location (e.g. home, office)
+             */
             name: string;
-            /** Latitude */
+            /**
+             * Latitude
+             * @description GPS latitude in decimal degrees (WGS 84)
+             */
             latitude: number;
-            /** Longitude */
+            /**
+             * Longitude
+             * @description GPS longitude in decimal degrees (WGS 84)
+             */
             longitude: number;
             /**
              * Radius Meters
+             * @description Geofence radius in meters for proximity queries
              * @default 50
              */
             radius_meters: number;
-            /** Description */
+            /**
+             * Description
+             * @description Optional human-readable description of the location
+             */
             description?: string | null;
         };
         /**
          * ReferenceLocationUpdate
+         * @description Request body for partially updating a reference location. All fields are optional.
          * @example {
          *       "description": "Updated radius for office building",
          *       "radius_meters": 75
          *     }
          */
         ReferenceLocationUpdate: {
-            /** Name */
+            /**
+             * Name
+             * @description Updated location name
+             */
             name?: string | null;
-            /** Latitude */
+            /**
+             * Latitude
+             * @description Updated GPS latitude in decimal degrees
+             */
             latitude?: number | null;
-            /** Longitude */
+            /**
+             * Longitude
+             * @description Updated GPS longitude in decimal degrees
+             */
             longitude?: number | null;
-            /** Radius Meters */
+            /**
+             * Radius Meters
+             * @description Updated geofence radius in meters
+             */
             radius_meters?: number | null;
-            /** Description */
+            /**
+             * Description
+             * @description Updated description text
+             */
             description?: string | null;
         };
         /**
          * SportInfo
+         * @description Sport type with its activity count.
          * @example {
          *       "activity_count": 20,
          *       "sport": "cycling"
          *     }
          */
         SportInfo: {
-            /** Sport */
+            /**
+             * Sport
+             * @description Sport type name (e.g. cycling, running)
+             */
             sport: string;
-            /** Activity Count */
+            /**
+             * Activity Count
+             * @description Number of activities for this sport
+             */
             activity_count: number;
         };
         /**
          * UnifiedGpsPoint
+         * @description Single GPS data point from the unified view combining OwnTracks and Garmin sources.
          * @example {
          *       "accuracy": 7,
          *       "battery": 100,
@@ -965,28 +1386,56 @@ export type components = {
          *     }
          */
         UnifiedGpsPoint: {
-            /** Source */
+            /**
+             * Source
+             * @description Data source: 'owntracks' or 'garmin'
+             */
             source: string;
-            /** Identifier */
+            /**
+             * Identifier
+             * @description Device or activity identifier from the source
+             */
             identifier: string;
-            /** Latitude */
+            /**
+             * Latitude
+             * @description GPS latitude in decimal degrees (WGS 84)
+             */
             latitude: number;
-            /** Longitude */
+            /**
+             * Longitude
+             * @description GPS longitude in decimal degrees (WGS 84)
+             */
             longitude: number;
             /**
              * Timestamp
              * Format: date-time
+             * @description UTC timestamp of the GPS recording
              */
             timestamp: string;
-            /** Accuracy */
+            /**
+             * Accuracy
+             * @description Horizontal GPS accuracy in meters (OwnTracks only)
+             */
             accuracy?: number | null;
-            /** Battery */
+            /**
+             * Battery
+             * @description Device battery percentage (OwnTracks only)
+             */
             battery?: number | null;
-            /** Speed Kmh */
+            /**
+             * Speed Kmh
+             * @description Instantaneous speed in km/h (Garmin only)
+             */
             speed_kmh?: number | null;
-            /** Heart Rate */
+            /**
+             * Heart Rate
+             * @description Heart rate in BPM (Garmin only)
+             */
             heart_rate?: number | null;
-            /** Created At */
+            /**
+             * Created At
+             * @description UTC timestamp when the record was inserted
+             */
             created_at?: string | null;
         };
         /** ValidationError */
@@ -1004,6 +1453,7 @@ export type components = {
         };
         /**
          * WithinReferenceResult
+         * @description GPS points found within a named reference location's geofence radius.
          * @example {
          *       "points": [
          *         {
@@ -1021,13 +1471,25 @@ export type components = {
          *     }
          */
         WithinReferenceResult: {
-            /** Reference Name */
+            /**
+             * Reference Name
+             * @description Name of the reference location searched
+             */
             reference_name: string;
-            /** Radius Meters */
+            /**
+             * Radius Meters
+             * @description Geofence radius used for the search in meters
+             */
             radius_meters: number;
-            /** Total Points */
+            /**
+             * Total Points
+             * @description Number of GPS points found within the radius
+             */
             total_points: number;
-            /** Points */
+            /**
+             * Points
+             * @description GPS points within the radius, sorted by distance
+             */
             points: components["schemas"]["NearbyPoint"][];
         };
     };
@@ -1090,10 +1552,13 @@ export interface operations {
                 date_from?: string | null;
                 /** @description Filter to date (YYYY-MM-DD) */
                 date_to?: string | null;
+                /** @description Maximum number of locations to return per page */
                 limit?: number;
+                /** @description Number of locations to skip for pagination */
                 offset?: number;
                 /** @description Sort column (id, device_id, timestamp, created_at, battery, accuracy) */
                 sort?: string;
+                /** @description Sort direction: asc (oldest first) or desc (newest first) */
                 order?: "asc" | "desc";
             };
             header?: never;
@@ -1181,6 +1646,7 @@ export interface operations {
             query?: never;
             header?: never;
             path: {
+                /** @description Unique location record ID */
                 location_id: number;
             };
             cookie?: never;
@@ -1216,10 +1682,13 @@ export interface operations {
                 date_from?: string | null;
                 /** @description Filter to date (YYYY-MM-DD) */
                 date_to?: string | null;
+                /** @description Maximum number of activities to return per page */
                 limit?: number;
+                /** @description Number of activities to skip for pagination */
                 offset?: number;
                 /** @description Sort column (start_time, distance_km, duration_seconds, sport, created_at) */
                 sort?: string;
+                /** @description Sort direction: asc (oldest first) or desc (newest first) */
                 order?: "asc" | "desc";
             };
             header?: never;
@@ -1310,10 +1779,13 @@ export interface operations {
     list_track_points_api_v1_garmin_activities__activity_id__tracks_get: {
         parameters: {
             query?: {
+                /** @description Maximum number of track points to return per page */
                 limit?: number;
+                /** @description Number of track points to skip for pagination */
                 offset?: number;
                 /** @description Sort column (timestamp, altitude, speed_kmh, heart_rate, created_at) */
                 sort?: string;
+                /** @description Sort direction: asc (earliest first) or desc (latest first) */
                 order?: "asc" | "desc";
                 /** @description Douglas-Peucker simplification tolerance in degrees. When set, returns the full route simplified via PostGIS ST_Simplify, ignoring limit/offset. Recommended: 0.00001 (~1m), 0.00005 (~5m). */
                 simplify?: number | null;
@@ -1402,8 +1874,11 @@ export interface operations {
                 date_from?: string | null;
                 /** @description Filter to date (YYYY-MM-DD) */
                 date_to?: string | null;
+                /** @description Maximum number of GPS points to return per page */
                 limit?: number;
+                /** @description Number of GPS points to skip for pagination */
                 offset?: number;
+                /** @description Sort direction: asc (oldest first) or desc (newest first) */
                 order?: "asc" | "desc";
             };
             header?: never;
@@ -1439,6 +1914,7 @@ export interface operations {
                 date_from?: string | null;
                 /** @description Filter to date (YYYY-MM-DD) */
                 date_to?: string | null;
+                /** @description Maximum number of daily summaries to return */
                 limit?: number;
             };
             header?: never;
@@ -1525,6 +2001,7 @@ export interface operations {
             query?: never;
             header?: never;
             path: {
+                /** @description Unique reference location ID */
                 location_id: number;
             };
             cookie?: never;
@@ -1556,6 +2033,7 @@ export interface operations {
             query?: never;
             header?: never;
             path: {
+                /** @description Unique reference location ID */
                 location_id: number;
             };
             cookie?: never;
@@ -1591,6 +2069,7 @@ export interface operations {
             query?: never;
             header?: never;
             path: {
+                /** @description Unique reference location ID */
                 location_id: number;
             };
             cookie?: never;
@@ -1626,6 +2105,7 @@ export interface operations {
                 radius_meters?: number;
                 /** @description Filter by source: owntracks or garmin */
                 source?: string | null;
+                /** @description Maximum number of nearby points to return */
                 limit?: number;
             };
             header?: never;
@@ -1697,6 +2177,7 @@ export interface operations {
             query?: {
                 /** @description Filter by source: owntracks or garmin */
                 source?: string | null;
+                /** @description Maximum number of points to return within the reference area */
                 limit?: number;
             };
             header?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stuartshay/otel-data-types",
-    "version": "1.0.97",
+    "version": "1.0.107",
     "description": "TypeScript types for otel-data-api — Auto-generated from OpenAPI 3.1 specification",
     "types": "index.d.ts",
     "exports": {