@stuartshay/otel-data-types 1.0.656 → 1.0.666
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 +252 -0
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -606,6 +606,54 @@ export type paths = {
|
|
|
606
606
|
patch?: never;
|
|
607
607
|
trace?: never;
|
|
608
608
|
};
|
|
609
|
+
"/api/v1/garmin/segments/{segment_id}/effort-series": {
|
|
610
|
+
parameters: {
|
|
611
|
+
query?: never;
|
|
612
|
+
header?: never;
|
|
613
|
+
path?: never;
|
|
614
|
+
cookie?: never;
|
|
615
|
+
};
|
|
616
|
+
/**
|
|
617
|
+
* Get Segment Effort Series
|
|
618
|
+
* @description Return one effort's speed/HR series binned by distance along the segment.
|
|
619
|
+
*
|
|
620
|
+
* Bins are normalized to the effort's own traversal; each fraction is the
|
|
621
|
+
* bin midpoint in the open interval between the start and end corridors.
|
|
622
|
+
* Series from different activities are therefore directly comparable at the
|
|
623
|
+
* same fraction despite GPS odometer drift.
|
|
624
|
+
* The effort window is trusted client input from the efforts endpoint and is
|
|
625
|
+
* returned normalized to UTC; an arbitrary window merely aggregates the
|
|
626
|
+
* caller's own read-only track data.
|
|
627
|
+
*/
|
|
628
|
+
get: operations["get_segment_effort_series_api_v1_garmin_segments__segment_id__effort_series_get"];
|
|
629
|
+
put?: never;
|
|
630
|
+
post?: never;
|
|
631
|
+
delete?: never;
|
|
632
|
+
options?: never;
|
|
633
|
+
head?: never;
|
|
634
|
+
patch?: never;
|
|
635
|
+
trace?: never;
|
|
636
|
+
};
|
|
637
|
+
"/api/v1/garmin/segments/{segment_id}/effort-series/batch": {
|
|
638
|
+
parameters: {
|
|
639
|
+
query?: never;
|
|
640
|
+
header?: never;
|
|
641
|
+
path?: never;
|
|
642
|
+
cookie?: never;
|
|
643
|
+
};
|
|
644
|
+
get?: never;
|
|
645
|
+
put?: never;
|
|
646
|
+
/**
|
|
647
|
+
* Get Segment Effort Series Batch
|
|
648
|
+
* @description Return multiple effort series in request order using one database query.
|
|
649
|
+
*/
|
|
650
|
+
post: operations["get_segment_effort_series_batch_api_v1_garmin_segments__segment_id__effort_series_batch_post"];
|
|
651
|
+
delete?: never;
|
|
652
|
+
options?: never;
|
|
653
|
+
head?: never;
|
|
654
|
+
patch?: never;
|
|
655
|
+
trace?: never;
|
|
656
|
+
};
|
|
609
657
|
"/api/v1/gps/unified": {
|
|
610
658
|
parameters: {
|
|
611
659
|
query?: never;
|
|
@@ -3957,6 +4005,119 @@ export type components = {
|
|
|
3957
4005
|
*/
|
|
3958
4006
|
max_heart_rate?: number | null;
|
|
3959
4007
|
};
|
|
4008
|
+
/**
|
|
4009
|
+
* SegmentEffortSeriesBatchItem
|
|
4010
|
+
* @description One effort window requested as part of a batch series lookup.
|
|
4011
|
+
*/
|
|
4012
|
+
SegmentEffortSeriesBatchItem: {
|
|
4013
|
+
/**
|
|
4014
|
+
* Activity Id
|
|
4015
|
+
* @description Garmin activity identifier
|
|
4016
|
+
*/
|
|
4017
|
+
activity_id: string;
|
|
4018
|
+
/**
|
|
4019
|
+
* Effort Start
|
|
4020
|
+
* Format: date-time
|
|
4021
|
+
* @description Effort start timestamp returned by the efforts endpoint
|
|
4022
|
+
*/
|
|
4023
|
+
effort_start: string;
|
|
4024
|
+
/**
|
|
4025
|
+
* Effort End
|
|
4026
|
+
* Format: date-time
|
|
4027
|
+
* @description Effort end timestamp returned by the efforts endpoint
|
|
4028
|
+
*/
|
|
4029
|
+
effort_end: string;
|
|
4030
|
+
};
|
|
4031
|
+
/**
|
|
4032
|
+
* SegmentEffortSeriesBatchRequest
|
|
4033
|
+
* @description Bounded collection of effort windows to bin in one database query.
|
|
4034
|
+
*/
|
|
4035
|
+
SegmentEffortSeriesBatchRequest: {
|
|
4036
|
+
/**
|
|
4037
|
+
* Efforts
|
|
4038
|
+
* @description Effort windows processed and returned in request order
|
|
4039
|
+
*/
|
|
4040
|
+
efforts: components["schemas"]["SegmentEffortSeriesBatchItem"][];
|
|
4041
|
+
/**
|
|
4042
|
+
* Bins
|
|
4043
|
+
* @description Number of distance bins per effort
|
|
4044
|
+
* @default 100
|
|
4045
|
+
*/
|
|
4046
|
+
bins: number;
|
|
4047
|
+
};
|
|
4048
|
+
/**
|
|
4049
|
+
* SegmentEffortSeriesBatchResponse
|
|
4050
|
+
* @description Distance-binned series returned in the same order as the batch request.
|
|
4051
|
+
*/
|
|
4052
|
+
SegmentEffortSeriesBatchResponse: {
|
|
4053
|
+
/**
|
|
4054
|
+
* Items
|
|
4055
|
+
* @description Effort series in request order
|
|
4056
|
+
*/
|
|
4057
|
+
items: components["schemas"]["SegmentEffortSeriesResponse"][];
|
|
4058
|
+
};
|
|
4059
|
+
/**
|
|
4060
|
+
* SegmentEffortSeriesBin
|
|
4061
|
+
* @description One distance bin of an effort's speed/heart-rate series along a segment.
|
|
4062
|
+
*/
|
|
4063
|
+
SegmentEffortSeriesBin: {
|
|
4064
|
+
/**
|
|
4065
|
+
* Index
|
|
4066
|
+
* @description 0-based bin index from segment start
|
|
4067
|
+
*/
|
|
4068
|
+
index: number;
|
|
4069
|
+
/**
|
|
4070
|
+
* Fraction
|
|
4071
|
+
* @description Bin midpoint strictly within (0, 1) of the effort's traversal distance
|
|
4072
|
+
*/
|
|
4073
|
+
fraction: number;
|
|
4074
|
+
/**
|
|
4075
|
+
* Speed Kmh
|
|
4076
|
+
* @description Average speed within the bin in km/h
|
|
4077
|
+
*/
|
|
4078
|
+
speed_kmh?: number | null;
|
|
4079
|
+
/**
|
|
4080
|
+
* Heart Rate
|
|
4081
|
+
* @description Average heart rate within the bin in bpm
|
|
4082
|
+
*/
|
|
4083
|
+
heart_rate?: number | null;
|
|
4084
|
+
};
|
|
4085
|
+
/**
|
|
4086
|
+
* SegmentEffortSeriesResponse
|
|
4087
|
+
* @description A single effort's speed/HR series, binned by normalized distance along the segment.
|
|
4088
|
+
*
|
|
4089
|
+
* ``bins`` always contains exactly ``bin_count`` entries ordered by index;
|
|
4090
|
+
* bins with no samples (GPS gaps, degenerate traversals) carry null metrics.
|
|
4091
|
+
*/
|
|
4092
|
+
SegmentEffortSeriesResponse: {
|
|
4093
|
+
/**
|
|
4094
|
+
* Activity Id
|
|
4095
|
+
* @description Garmin activity identifier
|
|
4096
|
+
*/
|
|
4097
|
+
activity_id: string;
|
|
4098
|
+
/**
|
|
4099
|
+
* Effort Start
|
|
4100
|
+
* Format: date-time
|
|
4101
|
+
* @description UTC timestamp entering the segment start corridor
|
|
4102
|
+
*/
|
|
4103
|
+
effort_start: string;
|
|
4104
|
+
/**
|
|
4105
|
+
* Effort End
|
|
4106
|
+
* Format: date-time
|
|
4107
|
+
* @description UTC timestamp reaching the segment end corridor
|
|
4108
|
+
*/
|
|
4109
|
+
effort_end: string;
|
|
4110
|
+
/**
|
|
4111
|
+
* Bin Count
|
|
4112
|
+
* @description Number of distance bins in the series
|
|
4113
|
+
*/
|
|
4114
|
+
bin_count: number;
|
|
4115
|
+
/**
|
|
4116
|
+
* Bins
|
|
4117
|
+
* @description Distance-ordered bins spanning the traversal
|
|
4118
|
+
*/
|
|
4119
|
+
bins: components["schemas"]["SegmentEffortSeriesBin"][];
|
|
4120
|
+
};
|
|
3960
4121
|
/**
|
|
3961
4122
|
* SegmentEffortsResponse
|
|
3962
4123
|
* @description Ranked efforts for a segment across all matching activities.
|
|
@@ -5279,6 +5440,97 @@ export interface operations {
|
|
|
5279
5440
|
};
|
|
5280
5441
|
};
|
|
5281
5442
|
};
|
|
5443
|
+
get_segment_effort_series_api_v1_garmin_segments__segment_id__effort_series_get: {
|
|
5444
|
+
parameters: {
|
|
5445
|
+
query: {
|
|
5446
|
+
/** @description Garmin activity ID */
|
|
5447
|
+
activity_id: string;
|
|
5448
|
+
/** @description Effort start timestamp, exactly as returned by the efforts endpoint */
|
|
5449
|
+
effort_start: string;
|
|
5450
|
+
/** @description Effort end timestamp, exactly as returned by the efforts endpoint */
|
|
5451
|
+
effort_end: string;
|
|
5452
|
+
/** @description Number of distance bins in the series */
|
|
5453
|
+
bins?: number;
|
|
5454
|
+
};
|
|
5455
|
+
header?: never;
|
|
5456
|
+
path: {
|
|
5457
|
+
/** @description Saved segment ID */
|
|
5458
|
+
segment_id: number;
|
|
5459
|
+
};
|
|
5460
|
+
cookie?: never;
|
|
5461
|
+
};
|
|
5462
|
+
requestBody?: never;
|
|
5463
|
+
responses: {
|
|
5464
|
+
/** @description Successful Response */
|
|
5465
|
+
200: {
|
|
5466
|
+
headers: {
|
|
5467
|
+
[name: string]: unknown;
|
|
5468
|
+
};
|
|
5469
|
+
content: {
|
|
5470
|
+
"application/json": components["schemas"]["SegmentEffortSeriesResponse"];
|
|
5471
|
+
};
|
|
5472
|
+
};
|
|
5473
|
+
/** @description Segment not found */
|
|
5474
|
+
404: {
|
|
5475
|
+
headers: {
|
|
5476
|
+
[name: string]: unknown;
|
|
5477
|
+
};
|
|
5478
|
+
content?: never;
|
|
5479
|
+
};
|
|
5480
|
+
/** @description Validation Error */
|
|
5481
|
+
422: {
|
|
5482
|
+
headers: {
|
|
5483
|
+
[name: string]: unknown;
|
|
5484
|
+
};
|
|
5485
|
+
content: {
|
|
5486
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
5487
|
+
};
|
|
5488
|
+
};
|
|
5489
|
+
};
|
|
5490
|
+
};
|
|
5491
|
+
get_segment_effort_series_batch_api_v1_garmin_segments__segment_id__effort_series_batch_post: {
|
|
5492
|
+
parameters: {
|
|
5493
|
+
query?: never;
|
|
5494
|
+
header?: never;
|
|
5495
|
+
path: {
|
|
5496
|
+
/** @description Saved segment ID */
|
|
5497
|
+
segment_id: number;
|
|
5498
|
+
};
|
|
5499
|
+
cookie?: never;
|
|
5500
|
+
};
|
|
5501
|
+
requestBody: {
|
|
5502
|
+
content: {
|
|
5503
|
+
"application/json": components["schemas"]["SegmentEffortSeriesBatchRequest"];
|
|
5504
|
+
};
|
|
5505
|
+
};
|
|
5506
|
+
responses: {
|
|
5507
|
+
/** @description Successful Response */
|
|
5508
|
+
200: {
|
|
5509
|
+
headers: {
|
|
5510
|
+
[name: string]: unknown;
|
|
5511
|
+
};
|
|
5512
|
+
content: {
|
|
5513
|
+
"application/json": components["schemas"]["SegmentEffortSeriesBatchResponse"];
|
|
5514
|
+
};
|
|
5515
|
+
};
|
|
5516
|
+
/** @description Segment not found */
|
|
5517
|
+
404: {
|
|
5518
|
+
headers: {
|
|
5519
|
+
[name: string]: unknown;
|
|
5520
|
+
};
|
|
5521
|
+
content?: never;
|
|
5522
|
+
};
|
|
5523
|
+
/** @description Validation Error */
|
|
5524
|
+
422: {
|
|
5525
|
+
headers: {
|
|
5526
|
+
[name: string]: unknown;
|
|
5527
|
+
};
|
|
5528
|
+
content: {
|
|
5529
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
5530
|
+
};
|
|
5531
|
+
};
|
|
5532
|
+
};
|
|
5533
|
+
};
|
|
5282
5534
|
list_unified_gps_api_v1_gps_unified_get: {
|
|
5283
5535
|
parameters: {
|
|
5284
5536
|
query?: {
|