@stuartshay/otel-data-types 1.0.280 → 1.0.285

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +310 -6
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -322,6 +322,29 @@ export type paths = {
322
322
  patch?: never;
323
323
  trace?: never;
324
324
  };
325
+ "/api/v1/garmin/activities/{activity_id}/addresses": {
326
+ parameters: {
327
+ query?: never;
328
+ header?: never;
329
+ path?: never;
330
+ cookie?: never;
331
+ };
332
+ /**
333
+ * List Activity Addresses
334
+ * @description Return all reverse-geocoded addresses for a Garmin activity, in timestamp order.
335
+ *
336
+ * Includes start, end, and mid-route waypoints as persisted by the Garmin
337
+ * geocoding pipeline.
338
+ */
339
+ get: operations["list_activity_addresses_api_v1_garmin_activities__activity_id__addresses_get"];
340
+ put?: never;
341
+ post?: never;
342
+ delete?: never;
343
+ options?: never;
344
+ head?: never;
345
+ patch?: never;
346
+ trace?: never;
347
+ };
325
348
  "/api/v1/gps/unified": {
326
349
  parameters: {
327
350
  query?: never;
@@ -524,7 +547,7 @@ export type paths = {
524
547
  };
525
548
  /**
526
549
  * Geocoding Status
527
- * @description Get geocoding coverage statistics.
550
+ * @description Get geocoding coverage statistics for both OwnTracks and Garmin sources.
528
551
  */
529
552
  get: operations["geocoding_status_api_v1_geocoding_status_get"];
530
553
  put?: never;
@@ -546,11 +569,7 @@ export type paths = {
546
569
  put?: never;
547
570
  /**
548
571
  * Trigger Geocoding
549
- * @description Trigger batch reverse-geocoding of un-geocoded location records (auth required).
550
- *
551
- * Fetches the next batch of locations without a geocoded address and calls
552
- * the Pelias reverse-geocoder for each one. Duplicate nearby coordinates
553
- * (within 50 m) that already have a geocoded address are skipped.
572
+ * @description Trigger batch reverse-geocoding of OwnTracks location records (auth required).
554
573
  */
555
574
  post: operations["trigger_geocoding_api_v1_geocoding_trigger_post"];
556
575
  delete?: never;
@@ -559,6 +578,26 @@ export type paths = {
559
578
  patch?: never;
560
579
  trace?: never;
561
580
  };
581
+ "/api/v1/geocoding/trigger/garmin": {
582
+ parameters: {
583
+ query?: never;
584
+ header?: never;
585
+ path?: never;
586
+ cookie?: never;
587
+ };
588
+ get?: never;
589
+ put?: never;
590
+ /**
591
+ * Trigger Garmin Geocoding
592
+ * @description Trigger batch reverse-geocoding of Garmin activity waypoints (auth required).
593
+ */
594
+ post: operations["trigger_garmin_geocoding_api_v1_geocoding_trigger_garmin_post"];
595
+ delete?: never;
596
+ options?: never;
597
+ head?: never;
598
+ patch?: never;
599
+ trace?: never;
600
+ };
562
601
  };
563
602
  export type webhooks = Record<string, never>;
564
603
  export type components = {
@@ -887,6 +926,99 @@ export type components = {
887
926
  */
888
927
  track_point_count?: number | null;
889
928
  };
929
+ /**
930
+ * GarminActivityAddress
931
+ * @description Reverse-geocoded address attached to a Garmin activity waypoint.
932
+ */
933
+ GarminActivityAddress: {
934
+ /**
935
+ * Track Point Id
936
+ * @description garmin_track_points.id this address was geocoded from
937
+ */
938
+ track_point_id: number;
939
+ /**
940
+ * Activity Id
941
+ * @description Parent Garmin activity identifier
942
+ */
943
+ activity_id: string;
944
+ /**
945
+ * Waypoint Kind
946
+ * @description Role of this waypoint: start, end, or mid-route waypoint
947
+ * @enum {string}
948
+ */
949
+ waypoint_kind: "start" | "end" | "waypoint";
950
+ /**
951
+ * Timestamp
952
+ * Format: date-time
953
+ * @description UTC timestamp of the track point this address was derived from
954
+ */
955
+ timestamp: string;
956
+ /**
957
+ * Latitude
958
+ * @description GPS latitude in decimal degrees (WGS 84)
959
+ */
960
+ latitude: number;
961
+ /**
962
+ * Longitude
963
+ * @description GPS longitude in decimal degrees (WGS 84)
964
+ */
965
+ longitude: number;
966
+ /**
967
+ * Display Address
968
+ * @description Full formatted address label from Pelias
969
+ */
970
+ display_address?: string | null;
971
+ /**
972
+ * Street
973
+ * @description Street name
974
+ */
975
+ street?: string | null;
976
+ /**
977
+ * Housenumber
978
+ * @description House or building number
979
+ */
980
+ housenumber?: string | null;
981
+ /**
982
+ * Neighbourhood
983
+ * @description Neighbourhood name
984
+ */
985
+ neighbourhood?: string | null;
986
+ /**
987
+ * Locality
988
+ * @description City or town
989
+ */
990
+ locality?: string | null;
991
+ /**
992
+ * Region
993
+ * @description State or province
994
+ */
995
+ region?: string | null;
996
+ /**
997
+ * Country
998
+ * @description Country name
999
+ */
1000
+ country?: string | null;
1001
+ /**
1002
+ * Postalcode
1003
+ * @description Postal or ZIP code
1004
+ */
1005
+ postalcode?: string | null;
1006
+ /**
1007
+ * Confidence
1008
+ * @description Pelias confidence score (0-1)
1009
+ */
1010
+ confidence?: number | null;
1011
+ /**
1012
+ * Status
1013
+ * @description Geocoding status: success, no_coverage, error, pending
1014
+ */
1015
+ status: string;
1016
+ /**
1017
+ * Geocoded At
1018
+ * @description UTC timestamp when geocoding was performed
1019
+ */
1020
+ geocoded_at?: string | null;
1021
+ };
890
1022
  /**
891
1023
  * GarminActivityTotal
892
1024
  * @description Aggregated Garmin activity totals for a single time bucket (week/month/year).
@@ -1152,6 +1284,8 @@ export type components = {
1152
1284
  * @description UTC timestamp when the record was inserted
1153
1285
  */
1154
1286
  created_at?: string | null;
1287
+ /** @description Reverse-geocoded address for this track point (Garmin pipeline). Only populated for waypoints that have been geocoded. */
1288
+ address?: components["schemas"]["GeocodedAddressSummary"] | null;
1155
1289
  };
1156
1290
  /**
1157
1291
  * GeocodedAddress
@@ -1227,6 +1361,74 @@ export type components = {
1227
1361
  */
1228
1362
  geocoded_at?: string | null;
1229
1363
  };
1364
+ /**
1365
+ * GeocodedAddressSummary
1366
+ * @description Compact address summary embedded in track-point payloads.
1367
+ */
1368
+ GeocodedAddressSummary: {
1369
+ /**
1370
+ * Display Address
1371
+ * @description Full formatted address label from Pelias
1372
+ */
1373
+ display_address?: string | null;
1374
+ /**
1375
+ * Locality
1376
+ * @description City or town
1377
+ */
1378
+ locality?: string | null;
1379
+ /**
1380
+ * Region
1381
+ * @description State or province
1382
+ */
1383
+ region?: string | null;
1384
+ /**
1385
+ * Country
1386
+ * @description Country name
1387
+ */
1388
+ country?: string | null;
1389
+ /**
1390
+ * Waypoint Kind
1391
+ * @description Role of this waypoint (Garmin only)
1392
+ */
1393
+ waypoint_kind?: ("start" | "end" | "waypoint") | null;
1394
+ /**
1395
+ * Status
1396
+ * @description Geocoding status: success, no_coverage, error, pending
1397
+ */
1398
+ status: string;
1399
+ };
1400
+ /**
1401
+ * GeocodingSourceStatus
1402
+ * @description Coverage statistics for a single geocoding source (owntracks or garmin).
1403
+ */
1404
+ GeocodingSourceStatus: {
1405
+ /**
1406
+ * Success
1407
+ * @description Number of successfully geocoded records for this source
1408
+ */
1409
+ success: number;
1410
+ /**
1411
+ * Pending
1412
+ * @description Number of records awaiting geocoding for this source
1413
+ * @default 0
1414
+ */
1415
+ pending: number;
1416
+ /**
1417
+ * No Coverage
1418
+ * @description Number of records outside Pelias coverage area
1419
+ */
1420
+ no_coverage: number;
1421
+ /**
1422
+ * Errors
1423
+ * @description Number of records that failed geocoding
1424
+ */
1425
+ errors: number;
1426
+ /**
1427
+ * Total
1428
+ * @description Total number of geocoded_addresses rows for this source
1429
+ */
1430
+ total: number;
1431
+ };
1230
1432
  /**
1231
1433
  * GeocodingStatus
1232
1434
  * @description Coverage statistics for geocoded location records.
@@ -1276,6 +1478,33 @@ export type components = {
1276
1478
  * @description Percentage of locations with a geocoded address
1277
1479
  */
1278
1480
  coverage_percent: number;
1481
+ /** @description Per-source breakdown of geocoding coverage (owntracks, garmin) */
1482
+ by_source: components["schemas"]["GeocodingStatusBySource"];
1483
+ };
1484
+ /**
1485
+ * GeocodingStatusBySource
1486
+ * @description Per-source breakdown of geocoding coverage.
1487
+ */
1488
+ GeocodingStatusBySource: {
1489
+ /** @description Coverage stats for OwnTracks rows */
1490
+ owntracks: components["schemas"]["GeocodingSourceStatus"];
1491
+ /** @description Coverage stats for Garmin rows */
1492
+ garmin: components["schemas"]["GeocodingSourceStatus"];
1493
+ /**
1494
+ * Garmin Activities Total
1495
+ * @description Total number of Garmin activities (denominator for activity-level coverage)
1496
+ */
1497
+ garmin_activities_total: number;
1498
+ /**
1499
+ * Garmin Activities Geocoded
1500
+ * @description Number of Garmin activities that have at least one address row
1501
+ */
1502
+ garmin_activities_geocoded: number;
1503
+ /**
1504
+ * Garmin Coverage Percent
1505
+ * @description Percentage of Garmin activities with at least one geocoded address
1506
+ */
1507
+ garmin_coverage_percent: number;
1279
1508
  };
1280
1509
  /**
1281
1510
  * GeocodingTriggerResponse
@@ -2527,6 +2756,45 @@ export interface operations {
2527
2756
  };
2528
2757
  };
2529
2758
  };
2759
+ list_activity_addresses_api_v1_garmin_activities__activity_id__addresses_get: {
2760
+ parameters: {
2761
+ query?: never;
2762
+ header?: never;
2763
+ path: {
2764
+ /** @description Garmin activity ID */
2765
+ activity_id: string;
2766
+ };
2767
+ cookie?: never;
2768
+ };
2769
+ requestBody?: never;
2770
+ responses: {
2771
+ /** @description Successful Response */
2772
+ 200: {
2773
+ headers: {
2774
+ [name: string]: unknown;
2775
+ };
2776
+ content: {
2777
+ "application/json": components["schemas"]["GarminActivityAddress"][];
2778
+ };
2779
+ };
2780
+ /** @description Activity not found */
2781
+ 404: {
2782
+ headers: {
2783
+ [name: string]: unknown;
2784
+ };
2785
+ content?: never;
2786
+ };
2787
+ /** @description Validation Error */
2788
+ 422: {
2789
+ headers: {
2790
+ [name: string]: unknown;
2791
+ };
2792
+ content: {
2793
+ "application/json": components["schemas"]["HTTPValidationError"];
2794
+ };
2795
+ };
2796
+ };
2797
+ };
2530
2798
  list_unified_gps_api_v1_gps_unified_get: {
2531
2799
  parameters: {
2532
2800
  query?: {
@@ -2958,4 +3226,40 @@ export interface operations {
2958
3226
  };
2959
3227
  };
2960
3228
  };
3229
+ trigger_garmin_geocoding_api_v1_geocoding_trigger_garmin_post: {
3230
+ parameters: {
3231
+ query?: {
3232
+ /** @description Number of Garmin activities to process in this batch */
3233
+ batch_size?: number;
3234
+ /** @description Approximate spacing between mid-route waypoints in kilometres */
3235
+ waypoint_spacing_km?: number;
3236
+ /** @description Re-process activities with at least one no_coverage waypoint */
3237
+ retry_failed?: boolean;
3238
+ };
3239
+ header?: never;
3240
+ path?: never;
3241
+ cookie?: never;
3242
+ };
3243
+ requestBody?: never;
3244
+ responses: {
3245
+ /** @description Successful Response */
3246
+ 200: {
3247
+ headers: {
3248
+ [name: string]: unknown;
3249
+ };
3250
+ content: {
3251
+ "application/json": components["schemas"]["GeocodingTriggerResponse"];
3252
+ };
3253
+ };
3254
+ /** @description Validation Error */
3255
+ 422: {
3256
+ headers: {
3257
+ [name: string]: unknown;
3258
+ };
3259
+ content: {
3260
+ "application/json": components["schemas"]["HTTPValidationError"];
3261
+ };
3262
+ };
3263
+ };
3264
+ };
2961
3265
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stuartshay/otel-data-types",
3
- "version": "1.0.280",
3
+ "version": "1.0.285",
4
4
  "description": "TypeScript types for otel-data-api — Auto-generated from OpenAPI 3.1 specification",
5
5
  "types": "index.d.ts",
6
6
  "exports": {