@axivoy/api 1.47.0 → 1.49.0
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/dist/generated/schema.d.ts +135 -1
- package/package.json +1 -1
|
@@ -4678,7 +4678,7 @@ export interface paths {
|
|
|
4678
4678
|
put?: never;
|
|
4679
4679
|
/**
|
|
4680
4680
|
* Driver live status
|
|
4681
|
-
* @description For each driver: is the truck moving or stopped (from GPS) and what the driver's log says (Driving, On duty, Off duty, Sleeper, Yard move, Personal conveyance, ELD app offline), with drive, shift and week hours left, an active violation flag and any disagreement between truck and log. No coordinates.
|
|
4681
|
+
* @description For each driver: is the truck moving or stopped (from GPS) and what the driver's log says (Driving, On duty, Off duty, Sleeper, Yard move, Personal conveyance, ELD app offline), with drive, shift and week hours left, the clock left now and when he is ready again while resting, an active violation flag and any disagreement between truck and log. For a driver on a load with a Live ETA: road time, clock left at arrival and the margin against the next stop's appointment, and, where the tenant has split sleeper suggestions on and he is at risk of being late, whether a split sleeper would get him there on time (a suggestion; the driver decides when he rests). No coordinates.
|
|
4682
4682
|
*
|
|
4683
4683
|
* Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
|
|
4684
4684
|
*/
|
|
@@ -53120,6 +53120,140 @@ export interface operations {
|
|
|
53120
53120
|
* @description When the hours were last read from the ELD.
|
|
53121
53121
|
*/
|
|
53122
53122
|
as_of?: string | null;
|
|
53123
|
+
/** @description Clock left now: the smallest of drive, shift and week left, carried from as_of to now. */
|
|
53124
|
+
drive_available_seconds?: number | null;
|
|
53125
|
+
/** @description drive, shift or week: the clock that ends first. */
|
|
53126
|
+
drive_limited_by?: string | null;
|
|
53127
|
+
/** @description The limiting clock is burning now, so drive_available_seconds falls one second per second. */
|
|
53128
|
+
clock_running?: boolean | null;
|
|
53129
|
+
/** @description violation, resting or break_due: the one alert the screens show. */
|
|
53130
|
+
hos_alert?: string | null;
|
|
53131
|
+
/**
|
|
53132
|
+
* Format: date-time
|
|
53133
|
+
* @description While he rests and needs a milestone: when his hours cover the road to the stop (or let him drive at all without a load).
|
|
53134
|
+
*/
|
|
53135
|
+
ready_at?: string | null;
|
|
53136
|
+
/** @description break, reset, after_midnight or restart. */
|
|
53137
|
+
ready_reason?: string | null;
|
|
53138
|
+
/** @description Set while he is in a rest stretch or taking a needed break. */
|
|
53139
|
+
rest?: {
|
|
53140
|
+
/**
|
|
53141
|
+
* Format: date-time
|
|
53142
|
+
* @description When this rest began.
|
|
53143
|
+
*/
|
|
53144
|
+
started_at?: string | null;
|
|
53145
|
+
/** @description Log statuses in this rest, in order. */
|
|
53146
|
+
statuses: unknown[];
|
|
53147
|
+
/**
|
|
53148
|
+
* Format: date-time
|
|
53149
|
+
* @description When the 30-minute break completes.
|
|
53150
|
+
*/
|
|
53151
|
+
break_done_at?: string | null;
|
|
53152
|
+
/**
|
|
53153
|
+
* Format: date-time
|
|
53154
|
+
* @description Property only: when this rest would complete a split sleeper pair.
|
|
53155
|
+
*/
|
|
53156
|
+
split_at?: string | null;
|
|
53157
|
+
/**
|
|
53158
|
+
* Format: date-time
|
|
53159
|
+
* @description When a full reset completes.
|
|
53160
|
+
*/
|
|
53161
|
+
reset_at?: string | null;
|
|
53162
|
+
/**
|
|
53163
|
+
* Format: date-time
|
|
53164
|
+
* @description Property rulesets that name it: when a 34-hour restart completes.
|
|
53165
|
+
*/
|
|
53166
|
+
restart_at?: string | null;
|
|
53167
|
+
/** @description Week hours that come back at the next midnight in the home terminal zone. */
|
|
53168
|
+
hours_back_after_midnight_seconds?: number | null;
|
|
53169
|
+
} | null;
|
|
53170
|
+
/** @description Qualifying rest stretches since the last full reset; null when no split is in use or the ledger is behind the clocks. */
|
|
53171
|
+
split_sleeper?: {
|
|
53172
|
+
/** @description sleeper or off_duty. */
|
|
53173
|
+
status: string;
|
|
53174
|
+
/**
|
|
53175
|
+
* Format: date-time
|
|
53176
|
+
* @description When the stretch began.
|
|
53177
|
+
*/
|
|
53178
|
+
started_at: string;
|
|
53179
|
+
/**
|
|
53180
|
+
* Format: date-time
|
|
53181
|
+
* @description When it ended; null while open.
|
|
53182
|
+
*/
|
|
53183
|
+
ended_at?: string | null;
|
|
53184
|
+
/** @description Length in minutes. */
|
|
53185
|
+
minutes: number;
|
|
53186
|
+
}[] | null;
|
|
53187
|
+
/** @description Set for a driver on an in-progress load with a Live ETA. */
|
|
53188
|
+
arrival?: {
|
|
53189
|
+
/** @description The in-progress load. */
|
|
53190
|
+
load_id?: number | null;
|
|
53191
|
+
/** @description The next stop. */
|
|
53192
|
+
stop_id?: number | null;
|
|
53193
|
+
/** @description live, stopped, on_site, off_route or stale. */
|
|
53194
|
+
eta_state: string;
|
|
53195
|
+
/**
|
|
53196
|
+
* Format: date-time
|
|
53197
|
+
* @description Projected arrival.
|
|
53198
|
+
*/
|
|
53199
|
+
eta_at?: string | null;
|
|
53200
|
+
/** @description Road time to the stop. */
|
|
53201
|
+
road_seconds?: number | null;
|
|
53202
|
+
/** @description Hours left at arrival; negative when he runs out first. */
|
|
53203
|
+
clock_left_seconds?: number | null;
|
|
53204
|
+
/** @description Stopped while his limiting clock still runs. */
|
|
53205
|
+
clock_dropping: boolean;
|
|
53206
|
+
/** @description appointment, window or none. */
|
|
53207
|
+
appointment_kind: string;
|
|
53208
|
+
/**
|
|
53209
|
+
* Format: date-time
|
|
53210
|
+
* @description The instant the on-time rule judges against.
|
|
53211
|
+
*/
|
|
53212
|
+
expected_at?: string | null;
|
|
53213
|
+
/** @description Projected arrival minus expected_at in minutes; negative is early. */
|
|
53214
|
+
minutes_vs_appointment?: number | null;
|
|
53215
|
+
/** @description early, on_time or late; null without an appointment or a trustworthy arrival. */
|
|
53216
|
+
on_time?: string | null;
|
|
53217
|
+
/** @description Split sleeper suggestion, set only when the tenant setting is on and he is at risk of being late. A suggestion to talk through with the driver; he decides when he rests. */
|
|
53218
|
+
split_plan?: {
|
|
53219
|
+
/** @description The plan to the stop, in order; empty when there is no plan. */
|
|
53220
|
+
steps: {
|
|
53221
|
+
/** @description drive or rest. */
|
|
53222
|
+
kind: string;
|
|
53223
|
+
/** @description For a rest: sleeper or off_duty. */
|
|
53224
|
+
status?: string | null;
|
|
53225
|
+
/**
|
|
53226
|
+
* Format: date-time
|
|
53227
|
+
* @description When the step starts.
|
|
53228
|
+
*/
|
|
53229
|
+
starts_at: string;
|
|
53230
|
+
/** @description Length in minutes. */
|
|
53231
|
+
minutes: number;
|
|
53232
|
+
}[];
|
|
53233
|
+
/**
|
|
53234
|
+
* Format: date-time
|
|
53235
|
+
* @description Arrival with the plan.
|
|
53236
|
+
*/
|
|
53237
|
+
arrives_at?: string | null;
|
|
53238
|
+
/** @description Plan arrival minus expected_at in minutes; negative is early. */
|
|
53239
|
+
minutes_vs_appointment?: number | null;
|
|
53240
|
+
/** @description Hours left at arrival with the plan. */
|
|
53241
|
+
clock_left_seconds?: number | null;
|
|
53242
|
+
/** @description The other half of the pair, taken after unloading. */
|
|
53243
|
+
rest_after_stop_minutes?: number | null;
|
|
53244
|
+
/**
|
|
53245
|
+
* Format: date-time
|
|
53246
|
+
* @description Arrival without a split (with a full reset where his clock ends).
|
|
53247
|
+
*/
|
|
53248
|
+
full_reset_arrives_at?: string | null;
|
|
53249
|
+
/** @description no_plan (no split arrives on time) or hours_not_confirmed (Axivoy's replay of his hours does not match the ELD's, or has not checked the latest snapshot). */
|
|
53250
|
+
not_suggested_reason?: string | null;
|
|
53251
|
+
/** @description With hours_not_confirmed: drive, shift or week, the figure that differed most. */
|
|
53252
|
+
unconfirmed_figure?: string | null;
|
|
53253
|
+
/** @description Axivoy minus the ELD for that figure. */
|
|
53254
|
+
unconfirmed_difference_seconds?: number | null;
|
|
53255
|
+
} | null;
|
|
53256
|
+
} | null;
|
|
53123
53257
|
/** @description True on a tombstone (the row was deleted or recycled); other fields are absent. */
|
|
53124
53258
|
deleted?: boolean | null;
|
|
53125
53259
|
}[];
|