@stuartshay/otel-data-types 1.0.187 → 1.0.193
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.
- package/index.d.ts +261 -0
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -431,6 +431,50 @@ export type paths = {
|
|
|
431
431
|
patch?: never;
|
|
432
432
|
trace?: never;
|
|
433
433
|
};
|
|
434
|
+
"/api/v1/geocoding/status": {
|
|
435
|
+
parameters: {
|
|
436
|
+
query?: never;
|
|
437
|
+
header?: never;
|
|
438
|
+
path?: never;
|
|
439
|
+
cookie?: never;
|
|
440
|
+
};
|
|
441
|
+
/**
|
|
442
|
+
* Geocoding Status
|
|
443
|
+
* @description Get geocoding coverage statistics.
|
|
444
|
+
*/
|
|
445
|
+
get: operations["geocoding_status_api_v1_geocoding_status_get"];
|
|
446
|
+
put?: never;
|
|
447
|
+
post?: never;
|
|
448
|
+
delete?: never;
|
|
449
|
+
options?: never;
|
|
450
|
+
head?: never;
|
|
451
|
+
patch?: never;
|
|
452
|
+
trace?: never;
|
|
453
|
+
};
|
|
454
|
+
"/api/v1/geocoding/trigger": {
|
|
455
|
+
parameters: {
|
|
456
|
+
query?: never;
|
|
457
|
+
header?: never;
|
|
458
|
+
path?: never;
|
|
459
|
+
cookie?: never;
|
|
460
|
+
};
|
|
461
|
+
get?: never;
|
|
462
|
+
put?: never;
|
|
463
|
+
/**
|
|
464
|
+
* Trigger Geocoding
|
|
465
|
+
* @description Trigger batch reverse-geocoding of un-geocoded location records (auth required).
|
|
466
|
+
*
|
|
467
|
+
* Fetches the next batch of locations without a geocoded address and calls
|
|
468
|
+
* the Pelias reverse-geocoder for each one. Duplicate nearby coordinates
|
|
469
|
+
* (within 50 m) that already have a geocoded address are skipped.
|
|
470
|
+
*/
|
|
471
|
+
post: operations["trigger_geocoding_api_v1_geocoding_trigger_post"];
|
|
472
|
+
delete?: never;
|
|
473
|
+
options?: never;
|
|
474
|
+
head?: never;
|
|
475
|
+
patch?: never;
|
|
476
|
+
trace?: never;
|
|
477
|
+
};
|
|
434
478
|
};
|
|
435
479
|
export type webhooks = Record<string, never>;
|
|
436
480
|
export type components = {
|
|
@@ -936,6 +980,156 @@ export type components = {
|
|
|
936
980
|
*/
|
|
937
981
|
created_at?: string | null;
|
|
938
982
|
};
|
|
983
|
+
/**
|
|
984
|
+
* GeocodedAddress
|
|
985
|
+
* @description Reverse-geocoded address components from Pelias.
|
|
986
|
+
* @example {
|
|
987
|
+
* "confidence": 0.95,
|
|
988
|
+
* "country": "United States",
|
|
989
|
+
* "display_address": "123 Main St, Hoboken, NJ 07030",
|
|
990
|
+
* "geocoded_at": "2026-02-12T08:10:55+00:00",
|
|
991
|
+
* "housenumber": "123",
|
|
992
|
+
* "locality": "Hoboken",
|
|
993
|
+
* "neighbourhood": "Downtown",
|
|
994
|
+
* "postalcode": "07030",
|
|
995
|
+
* "region": "New Jersey",
|
|
996
|
+
* "status": "success",
|
|
997
|
+
* "street": "Main St"
|
|
998
|
+
* }
|
|
999
|
+
*/
|
|
1000
|
+
GeocodedAddress: {
|
|
1001
|
+
/**
|
|
1002
|
+
* Display Address
|
|
1003
|
+
* @description Full formatted address label from Pelias
|
|
1004
|
+
*/
|
|
1005
|
+
display_address?: string | null;
|
|
1006
|
+
/**
|
|
1007
|
+
* Street
|
|
1008
|
+
* @description Street name
|
|
1009
|
+
*/
|
|
1010
|
+
street?: string | null;
|
|
1011
|
+
/**
|
|
1012
|
+
* Housenumber
|
|
1013
|
+
* @description House or building number
|
|
1014
|
+
*/
|
|
1015
|
+
housenumber?: string | null;
|
|
1016
|
+
/**
|
|
1017
|
+
* Neighbourhood
|
|
1018
|
+
* @description Neighbourhood name
|
|
1019
|
+
*/
|
|
1020
|
+
neighbourhood?: string | null;
|
|
1021
|
+
/**
|
|
1022
|
+
* Locality
|
|
1023
|
+
* @description City or town
|
|
1024
|
+
*/
|
|
1025
|
+
locality?: string | null;
|
|
1026
|
+
/**
|
|
1027
|
+
* Region
|
|
1028
|
+
* @description State or province
|
|
1029
|
+
*/
|
|
1030
|
+
region?: string | null;
|
|
1031
|
+
/**
|
|
1032
|
+
* Country
|
|
1033
|
+
* @description Country name
|
|
1034
|
+
*/
|
|
1035
|
+
country?: string | null;
|
|
1036
|
+
/**
|
|
1037
|
+
* Postalcode
|
|
1038
|
+
* @description Postal or ZIP code
|
|
1039
|
+
*/
|
|
1040
|
+
postalcode?: string | null;
|
|
1041
|
+
/**
|
|
1042
|
+
* Confidence
|
|
1043
|
+
* @description Pelias confidence score (0-1)
|
|
1044
|
+
*/
|
|
1045
|
+
confidence?: number | null;
|
|
1046
|
+
/**
|
|
1047
|
+
* Status
|
|
1048
|
+
* @description Geocoding status: success, no_coverage, error, pending
|
|
1049
|
+
*/
|
|
1050
|
+
status: string;
|
|
1051
|
+
/**
|
|
1052
|
+
* Geocoded At
|
|
1053
|
+
* @description UTC timestamp when geocoding was performed
|
|
1054
|
+
*/
|
|
1055
|
+
geocoded_at?: string | null;
|
|
1056
|
+
};
|
|
1057
|
+
/**
|
|
1058
|
+
* GeocodingStatus
|
|
1059
|
+
* @description Coverage statistics for geocoded location records.
|
|
1060
|
+
* @example {
|
|
1061
|
+
* "coverage_percent": 26.67,
|
|
1062
|
+
* "errors": 100,
|
|
1063
|
+
* "geocoded": 12000,
|
|
1064
|
+
* "no_coverage": 400,
|
|
1065
|
+
* "pending": 33000,
|
|
1066
|
+
* "success": 11500,
|
|
1067
|
+
* "total_locations": 45000
|
|
1068
|
+
* }
|
|
1069
|
+
*/
|
|
1070
|
+
GeocodingStatus: {
|
|
1071
|
+
/**
|
|
1072
|
+
* Total Locations
|
|
1073
|
+
* @description Total number of OwnTracks location records
|
|
1074
|
+
*/
|
|
1075
|
+
total_locations: number;
|
|
1076
|
+
/**
|
|
1077
|
+
* Geocoded
|
|
1078
|
+
* @description Number of locations with a geocoded address (any status)
|
|
1079
|
+
*/
|
|
1080
|
+
geocoded: number;
|
|
1081
|
+
/**
|
|
1082
|
+
* Success
|
|
1083
|
+
* @description Number of successfully geocoded locations
|
|
1084
|
+
*/
|
|
1085
|
+
success: number;
|
|
1086
|
+
/**
|
|
1087
|
+
* Pending
|
|
1088
|
+
* @description Number of locations awaiting geocoding
|
|
1089
|
+
*/
|
|
1090
|
+
pending: number;
|
|
1091
|
+
/**
|
|
1092
|
+
* No Coverage
|
|
1093
|
+
* @description Number of locations outside Pelias coverage area
|
|
1094
|
+
*/
|
|
1095
|
+
no_coverage: number;
|
|
1096
|
+
/**
|
|
1097
|
+
* Errors
|
|
1098
|
+
* @description Number of locations that failed geocoding
|
|
1099
|
+
*/
|
|
1100
|
+
errors: number;
|
|
1101
|
+
/**
|
|
1102
|
+
* Coverage Percent
|
|
1103
|
+
* @description Percentage of locations with a geocoded address
|
|
1104
|
+
*/
|
|
1105
|
+
coverage_percent: number;
|
|
1106
|
+
};
|
|
1107
|
+
/**
|
|
1108
|
+
* GeocodingTriggerResponse
|
|
1109
|
+
* @description Result of triggering a batch geocoding operation.
|
|
1110
|
+
* @example {
|
|
1111
|
+
* "processed": 100,
|
|
1112
|
+
* "remaining": 32900,
|
|
1113
|
+
* "skipped_dedup": 35
|
|
1114
|
+
* }
|
|
1115
|
+
*/
|
|
1116
|
+
GeocodingTriggerResponse: {
|
|
1117
|
+
/**
|
|
1118
|
+
* Processed
|
|
1119
|
+
* @description Number of records processed in this batch
|
|
1120
|
+
*/
|
|
1121
|
+
processed: number;
|
|
1122
|
+
/**
|
|
1123
|
+
* Remaining
|
|
1124
|
+
* @description Number of records still awaiting geocoding
|
|
1125
|
+
*/
|
|
1126
|
+
remaining: number;
|
|
1127
|
+
/**
|
|
1128
|
+
* Skipped Dedup
|
|
1129
|
+
* @description Number of records skipped via proximity deduplication
|
|
1130
|
+
*/
|
|
1131
|
+
skipped_dedup: number;
|
|
1132
|
+
};
|
|
939
1133
|
/** HTTPValidationError */
|
|
940
1134
|
HTTPValidationError: {
|
|
941
1135
|
/** Detail */
|
|
@@ -952,6 +1146,7 @@ export type components = {
|
|
|
952
1146
|
* "connection_type": "w",
|
|
953
1147
|
* "created_at": "2026-02-12T08:10:55+00:00",
|
|
954
1148
|
* "device_id": "iphone_stuart",
|
|
1149
|
+
* "display_address": "123 Main St, Hoboken, NJ 07030",
|
|
955
1150
|
* "id": 101160,
|
|
956
1151
|
* "latitude": 40.736238,
|
|
957
1152
|
* "longitude": -74.039405,
|
|
@@ -1032,6 +1227,11 @@ export type components = {
|
|
|
1032
1227
|
* @description UTC timestamp when the record was inserted into the database
|
|
1033
1228
|
*/
|
|
1034
1229
|
created_at?: string | null;
|
|
1230
|
+
/**
|
|
1231
|
+
* Display Address
|
|
1232
|
+
* @description Short formatted address from reverse geocoding (e.g. '123 Main St, Hoboken')
|
|
1233
|
+
*/
|
|
1234
|
+
display_address?: string | null;
|
|
1035
1235
|
};
|
|
1036
1236
|
/**
|
|
1037
1237
|
* LocationCount
|
|
@@ -1157,6 +1357,11 @@ export type components = {
|
|
|
1157
1357
|
* @description UTC timestamp when the record was inserted into the database
|
|
1158
1358
|
*/
|
|
1159
1359
|
created_at?: string | null;
|
|
1360
|
+
/**
|
|
1361
|
+
* Display Address
|
|
1362
|
+
* @description Short formatted address from reverse geocoding (e.g. '123 Main St, Hoboken')
|
|
1363
|
+
*/
|
|
1364
|
+
display_address?: string | null;
|
|
1160
1365
|
/**
|
|
1161
1366
|
* Raw Payload
|
|
1162
1367
|
* @description Original OwnTracks JSON payload as received from the MQTT broker
|
|
@@ -1164,6 +1369,8 @@ export type components = {
|
|
|
1164
1369
|
raw_payload?: {
|
|
1165
1370
|
[key: string]: unknown;
|
|
1166
1371
|
} | null;
|
|
1372
|
+
/** @description Full reverse-geocoded address components from Pelias */
|
|
1373
|
+
address?: components["schemas"]["GeocodedAddress"] | null;
|
|
1167
1374
|
};
|
|
1168
1375
|
/**
|
|
1169
1376
|
* NearbyPoint
|
|
@@ -2377,4 +2584,58 @@ export interface operations {
|
|
|
2377
2584
|
};
|
|
2378
2585
|
};
|
|
2379
2586
|
};
|
|
2587
|
+
geocoding_status_api_v1_geocoding_status_get: {
|
|
2588
|
+
parameters: {
|
|
2589
|
+
query?: never;
|
|
2590
|
+
header?: never;
|
|
2591
|
+
path?: never;
|
|
2592
|
+
cookie?: never;
|
|
2593
|
+
};
|
|
2594
|
+
requestBody?: never;
|
|
2595
|
+
responses: {
|
|
2596
|
+
/** @description Successful Response */
|
|
2597
|
+
200: {
|
|
2598
|
+
headers: {
|
|
2599
|
+
[name: string]: unknown;
|
|
2600
|
+
};
|
|
2601
|
+
content: {
|
|
2602
|
+
"application/json": components["schemas"]["GeocodingStatus"];
|
|
2603
|
+
};
|
|
2604
|
+
};
|
|
2605
|
+
};
|
|
2606
|
+
};
|
|
2607
|
+
trigger_geocoding_api_v1_geocoding_trigger_post: {
|
|
2608
|
+
parameters: {
|
|
2609
|
+
query?: {
|
|
2610
|
+
/** @description Number of locations to geocode in this batch */
|
|
2611
|
+
batch_size?: number;
|
|
2612
|
+
/** @description Re-process records with status no_coverage */
|
|
2613
|
+
retry_failed?: boolean;
|
|
2614
|
+
};
|
|
2615
|
+
header?: never;
|
|
2616
|
+
path?: never;
|
|
2617
|
+
cookie?: never;
|
|
2618
|
+
};
|
|
2619
|
+
requestBody?: never;
|
|
2620
|
+
responses: {
|
|
2621
|
+
/** @description Successful Response */
|
|
2622
|
+
200: {
|
|
2623
|
+
headers: {
|
|
2624
|
+
[name: string]: unknown;
|
|
2625
|
+
};
|
|
2626
|
+
content: {
|
|
2627
|
+
"application/json": components["schemas"]["GeocodingTriggerResponse"];
|
|
2628
|
+
};
|
|
2629
|
+
};
|
|
2630
|
+
/** @description Validation Error */
|
|
2631
|
+
422: {
|
|
2632
|
+
headers: {
|
|
2633
|
+
[name: string]: unknown;
|
|
2634
|
+
};
|
|
2635
|
+
content: {
|
|
2636
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2637
|
+
};
|
|
2638
|
+
};
|
|
2639
|
+
};
|
|
2640
|
+
};
|
|
2380
2641
|
}
|