@chrt-inc/typescript-sdk 1.807.0 → 1.824.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/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriverStatsReq.d.ts +0 -1
- package/dist/cjs/api/types/DriverAnalyticsDay.d.ts +15 -0
- package/dist/cjs/api/types/DriverAnalyticsDay.js +5 -0
- package/dist/cjs/api/types/DriverAnalyticsTaskGroup.d.ts +10 -0
- package/dist/cjs/api/types/DriverAnalyticsTaskGroup.js +5 -0
- package/dist/cjs/api/types/DriverStatsRes.d.ts +2 -10
- package/dist/cjs/api/types/FlightConnectionLeg.d.ts +2 -2
- package/dist/cjs/api/types/index.d.ts +2 -0
- package/dist/cjs/api/types/index.js +2 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriverStatsReq.d.mts +0 -1
- package/dist/esm/api/types/DriverAnalyticsDay.d.mts +15 -0
- package/dist/esm/api/types/DriverAnalyticsDay.mjs +4 -0
- package/dist/esm/api/types/DriverAnalyticsTaskGroup.d.mts +10 -0
- package/dist/esm/api/types/DriverAnalyticsTaskGroup.mjs +4 -0
- package/dist/esm/api/types/DriverStatsRes.d.mts +2 -10
- package/dist/esm/api/types/FlightConnectionLeg.d.mts +2 -2
- package/dist/esm/api/types/index.d.mts +2 -0
- package/dist/esm/api/types/index.mjs +2 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +2 -2
package/dist/cjs/Client.js
CHANGED
|
@@ -57,8 +57,8 @@ class ChrtClient {
|
|
|
57
57
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
58
58
|
"X-Fern-Language": "JavaScript",
|
|
59
59
|
"X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
|
|
60
|
-
"X-Fern-SDK-Version": "1.
|
|
61
|
-
"User-Agent": "@chrt-inc/typescript-sdk/1.
|
|
60
|
+
"X-Fern-SDK-Version": "1.824.0",
|
|
61
|
+
"User-Agent": "@chrt-inc/typescript-sdk/1.824.0",
|
|
62
62
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
63
63
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
64
64
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -65,7 +65,7 @@ export declare class AdHoc {
|
|
|
65
65
|
listBySessionIdV1(sessionId: string, request?: Chrt.notifications.AdHocListBySessionIdV1Request, requestOptions?: AdHoc.RequestOptions): core.HttpResponsePromise<Chrt.NotificationAdHocListRes>;
|
|
66
66
|
private __listBySessionIdV1;
|
|
67
67
|
/**
|
|
68
|
-
* Creates
|
|
68
|
+
* Creates or returns an existing ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
|
|
69
69
|
*
|
|
70
70
|
* @param {string} orderId
|
|
71
71
|
* @param {Chrt.NotificationIntentAdHocClientCreate1} request
|
|
@@ -198,7 +198,7 @@ class AdHoc {
|
|
|
198
198
|
});
|
|
199
199
|
}
|
|
200
200
|
/**
|
|
201
|
-
* Creates
|
|
201
|
+
* Creates or returns an existing ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
|
|
202
202
|
*
|
|
203
203
|
* @param {string} orderId
|
|
204
204
|
* @param {Chrt.NotificationIntentAdHocClientCreate1} request
|
|
@@ -34,7 +34,7 @@ export declare class Drivers {
|
|
|
34
34
|
constructor(_options?: Drivers.Options);
|
|
35
35
|
get complianceDocuments(): ComplianceDocuments;
|
|
36
36
|
/**
|
|
37
|
-
* Retrieves driver
|
|
37
|
+
* Retrieves driver analytics for a time window. Daily rows are clipped to the requested UTC window; task-group rows include full in-progress mileage for task groups whose in-progress interval overlaps the requested window. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)
|
|
38
38
|
*
|
|
39
39
|
* @param {string} driverId
|
|
40
40
|
* @param {Chrt.shipping.DriverStatsReq} request
|
|
@@ -72,7 +72,7 @@ class Drivers {
|
|
|
72
72
|
return ((_a = this._complianceDocuments) !== null && _a !== void 0 ? _a : (this._complianceDocuments = new Client_js_1.ComplianceDocuments(this._options)));
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
|
-
* Retrieves driver
|
|
75
|
+
* Retrieves driver analytics for a time window. Daily rows are clipped to the requested UTC window; task-group rows include full in-progress mileage for task groups whose in-progress interval overlaps the requested window. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)
|
|
76
76
|
*
|
|
77
77
|
* @param {string} driverId
|
|
78
78
|
* @param {Chrt.shipping.DriverStatsReq} request
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../index.js";
|
|
5
|
+
export interface DriverAnalyticsDay {
|
|
6
|
+
day: string;
|
|
7
|
+
/** Observed GPS mileage from same-day driver ping segments fetched inside merged task-group in-progress intervals. Cross-interval and cross-midnight segments are dropped. */
|
|
8
|
+
observed_mileage_order_in_progress_deduped: number;
|
|
9
|
+
/** Observed GPS mileage remaining after subtracting order in-progress mileage from total on this UTC day. Includes off-clock segments and cross-interval boundary segments. */
|
|
10
|
+
observed_mileage_order_not_in_progress: number;
|
|
11
|
+
/** Total observed GPS mileage from all same-day driver ping segments on this UTC day. Cross-midnight segments are dropped. */
|
|
12
|
+
observed_mileage_total: number;
|
|
13
|
+
/** Driver self-reported hours and mileage record for this UTC calendar day, if one exists. */
|
|
14
|
+
self_reported_hours_and_mileage?: Chrt.DriverSelfReportedHoursAndMileage1 | null;
|
|
15
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../index.js";
|
|
5
|
+
export interface DriverAnalyticsTaskGroup {
|
|
6
|
+
/** Task group assigned to the driver whose in-progress interval overlaps the requested analytics window. */
|
|
7
|
+
task_group: Chrt.TaskGroup1;
|
|
8
|
+
/** Observed GPS mileage for this task group from tracking.task_group_by_driver_timeseries across the full task-group in-progress interval, excluding outlier points. This can include mileage outside the requested analytics window when the task group overlaps the window but starts before it or ends after it. */
|
|
9
|
+
observed_mileage_order_in_progress: number;
|
|
10
|
+
}
|
|
@@ -3,14 +3,6 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as Chrt from "../index.js";
|
|
5
5
|
export interface DriverStatsRes {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
/** Summed from task group in-progress intervals merged to eliminate double-counting of overlapping task groups. */
|
|
9
|
-
deduped_task_group_driver_hours: number;
|
|
10
|
-
overlapping_task_groups_detected: boolean;
|
|
11
|
-
/** Total mileage recorded for this driver across all tracked pings that fall within the requested query window. Independent of task group filtering or deduplication. i.e. includes pings inside and outside of task group time windows */
|
|
12
|
-
total_driver_mileage_tracked?: number | null;
|
|
13
|
-
/** Total mileage from pings that fall within task group in-progress merged intervals. i.e. excludes pings outside of merged task group time windows */
|
|
14
|
-
deduped_task_group_driver_mileage_tracked?: number | null;
|
|
15
|
-
self_reported_hours_and_mileage?: Chrt.DriverSelfReportedHoursAndMileage1[];
|
|
6
|
+
driver_analytics_days?: Chrt.DriverAnalyticsDay[];
|
|
7
|
+
driver_analytics_task_groups?: Chrt.DriverAnalyticsTaskGroup[];
|
|
16
8
|
}
|
|
@@ -15,8 +15,8 @@ export interface FlightConnectionLeg {
|
|
|
15
15
|
destination_time_zone?: string | null;
|
|
16
16
|
destination_latitude?: number | null;
|
|
17
17
|
destination_longitude?: number | null;
|
|
18
|
-
|
|
19
|
-
|
|
18
|
+
departure_time_utc?: string | null;
|
|
19
|
+
arrival_time_utc?: string | null;
|
|
20
20
|
equipment_name?: string | null;
|
|
21
21
|
is_codeshare?: boolean | null;
|
|
22
22
|
}
|
|
@@ -146,6 +146,8 @@ export * from "./DirectoryEntry1.js";
|
|
|
146
146
|
export * from "./DirectoryEntryListRes.js";
|
|
147
147
|
export * from "./DirectoryEntrySortByEnum.js";
|
|
148
148
|
export * from "./Driver1.js";
|
|
149
|
+
export * from "./DriverAnalyticsDay.js";
|
|
150
|
+
export * from "./DriverAnalyticsTaskGroup.js";
|
|
149
151
|
export * from "./DriverBiddingGroup1.js";
|
|
150
152
|
export * from "./DriverBiddingGroupListRes.js";
|
|
151
153
|
export * from "./DriverBiddingGroupSortByEnum.js";
|
|
@@ -162,6 +162,8 @@ __exportStar(require("./DirectoryEntry1.js"), exports);
|
|
|
162
162
|
__exportStar(require("./DirectoryEntryListRes.js"), exports);
|
|
163
163
|
__exportStar(require("./DirectoryEntrySortByEnum.js"), exports);
|
|
164
164
|
__exportStar(require("./Driver1.js"), exports);
|
|
165
|
+
__exportStar(require("./DriverAnalyticsDay.js"), exports);
|
|
166
|
+
__exportStar(require("./DriverAnalyticsTaskGroup.js"), exports);
|
|
165
167
|
__exportStar(require("./DriverBiddingGroup1.js"), exports);
|
|
166
168
|
__exportStar(require("./DriverBiddingGroupListRes.js"), exports);
|
|
167
169
|
__exportStar(require("./DriverBiddingGroupSortByEnum.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.824.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/Client.mjs
CHANGED
|
@@ -21,8 +21,8 @@ export class ChrtClient {
|
|
|
21
21
|
this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
|
|
22
22
|
"X-Fern-Language": "JavaScript",
|
|
23
23
|
"X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
|
|
24
|
-
"X-Fern-SDK-Version": "1.
|
|
25
|
-
"User-Agent": "@chrt-inc/typescript-sdk/1.
|
|
24
|
+
"X-Fern-SDK-Version": "1.824.0",
|
|
25
|
+
"User-Agent": "@chrt-inc/typescript-sdk/1.824.0",
|
|
26
26
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
27
27
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
28
28
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -65,7 +65,7 @@ export declare class AdHoc {
|
|
|
65
65
|
listBySessionIdV1(sessionId: string, request?: Chrt.notifications.AdHocListBySessionIdV1Request, requestOptions?: AdHoc.RequestOptions): core.HttpResponsePromise<Chrt.NotificationAdHocListRes>;
|
|
66
66
|
private __listBySessionIdV1;
|
|
67
67
|
/**
|
|
68
|
-
* Creates
|
|
68
|
+
* Creates or returns an existing ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
|
|
69
69
|
*
|
|
70
70
|
* @param {string} orderId
|
|
71
71
|
* @param {Chrt.NotificationIntentAdHocClientCreate1} request
|
|
@@ -162,7 +162,7 @@ export class AdHoc {
|
|
|
162
162
|
});
|
|
163
163
|
}
|
|
164
164
|
/**
|
|
165
|
-
* Creates
|
|
165
|
+
* Creates or returns an existing ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
|
|
166
166
|
*
|
|
167
167
|
* @param {string} orderId
|
|
168
168
|
* @param {Chrt.NotificationIntentAdHocClientCreate1} request
|
|
@@ -34,7 +34,7 @@ export declare class Drivers {
|
|
|
34
34
|
constructor(_options?: Drivers.Options);
|
|
35
35
|
get complianceDocuments(): ComplianceDocuments;
|
|
36
36
|
/**
|
|
37
|
-
* Retrieves driver
|
|
37
|
+
* Retrieves driver analytics for a time window. Daily rows are clipped to the requested UTC window; task-group rows include full in-progress mileage for task groups whose in-progress interval overlaps the requested window. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)
|
|
38
38
|
*
|
|
39
39
|
* @param {string} driverId
|
|
40
40
|
* @param {Chrt.shipping.DriverStatsReq} request
|
|
@@ -36,7 +36,7 @@ export class Drivers {
|
|
|
36
36
|
return ((_a = this._complianceDocuments) !== null && _a !== void 0 ? _a : (this._complianceDocuments = new ComplianceDocuments(this._options)));
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
|
-
* Retrieves driver
|
|
39
|
+
* Retrieves driver analytics for a time window. Daily rows are clipped to the requested UTC window; task-group rows include full in-progress mileage for task groups whose in-progress interval overlaps the requested window. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)
|
|
40
40
|
*
|
|
41
41
|
* @param {string} driverId
|
|
42
42
|
* @param {Chrt.shipping.DriverStatsReq} request
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../index.mjs";
|
|
5
|
+
export interface DriverAnalyticsDay {
|
|
6
|
+
day: string;
|
|
7
|
+
/** Observed GPS mileage from same-day driver ping segments fetched inside merged task-group in-progress intervals. Cross-interval and cross-midnight segments are dropped. */
|
|
8
|
+
observed_mileage_order_in_progress_deduped: number;
|
|
9
|
+
/** Observed GPS mileage remaining after subtracting order in-progress mileage from total on this UTC day. Includes off-clock segments and cross-interval boundary segments. */
|
|
10
|
+
observed_mileage_order_not_in_progress: number;
|
|
11
|
+
/** Total observed GPS mileage from all same-day driver ping segments on this UTC day. Cross-midnight segments are dropped. */
|
|
12
|
+
observed_mileage_total: number;
|
|
13
|
+
/** Driver self-reported hours and mileage record for this UTC calendar day, if one exists. */
|
|
14
|
+
self_reported_hours_and_mileage?: Chrt.DriverSelfReportedHoursAndMileage1 | null;
|
|
15
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../index.mjs";
|
|
5
|
+
export interface DriverAnalyticsTaskGroup {
|
|
6
|
+
/** Task group assigned to the driver whose in-progress interval overlaps the requested analytics window. */
|
|
7
|
+
task_group: Chrt.TaskGroup1;
|
|
8
|
+
/** Observed GPS mileage for this task group from tracking.task_group_by_driver_timeseries across the full task-group in-progress interval, excluding outlier points. This can include mileage outside the requested analytics window when the task group overlaps the window but starts before it or ends after it. */
|
|
9
|
+
observed_mileage_order_in_progress: number;
|
|
10
|
+
}
|
|
@@ -3,14 +3,6 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as Chrt from "../index.mjs";
|
|
5
5
|
export interface DriverStatsRes {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
/** Summed from task group in-progress intervals merged to eliminate double-counting of overlapping task groups. */
|
|
9
|
-
deduped_task_group_driver_hours: number;
|
|
10
|
-
overlapping_task_groups_detected: boolean;
|
|
11
|
-
/** Total mileage recorded for this driver across all tracked pings that fall within the requested query window. Independent of task group filtering or deduplication. i.e. includes pings inside and outside of task group time windows */
|
|
12
|
-
total_driver_mileage_tracked?: number | null;
|
|
13
|
-
/** Total mileage from pings that fall within task group in-progress merged intervals. i.e. excludes pings outside of merged task group time windows */
|
|
14
|
-
deduped_task_group_driver_mileage_tracked?: number | null;
|
|
15
|
-
self_reported_hours_and_mileage?: Chrt.DriverSelfReportedHoursAndMileage1[];
|
|
6
|
+
driver_analytics_days?: Chrt.DriverAnalyticsDay[];
|
|
7
|
+
driver_analytics_task_groups?: Chrt.DriverAnalyticsTaskGroup[];
|
|
16
8
|
}
|
|
@@ -15,8 +15,8 @@ export interface FlightConnectionLeg {
|
|
|
15
15
|
destination_time_zone?: string | null;
|
|
16
16
|
destination_latitude?: number | null;
|
|
17
17
|
destination_longitude?: number | null;
|
|
18
|
-
|
|
19
|
-
|
|
18
|
+
departure_time_utc?: string | null;
|
|
19
|
+
arrival_time_utc?: string | null;
|
|
20
20
|
equipment_name?: string | null;
|
|
21
21
|
is_codeshare?: boolean | null;
|
|
22
22
|
}
|
|
@@ -146,6 +146,8 @@ export * from "./DirectoryEntry1.mjs";
|
|
|
146
146
|
export * from "./DirectoryEntryListRes.mjs";
|
|
147
147
|
export * from "./DirectoryEntrySortByEnum.mjs";
|
|
148
148
|
export * from "./Driver1.mjs";
|
|
149
|
+
export * from "./DriverAnalyticsDay.mjs";
|
|
150
|
+
export * from "./DriverAnalyticsTaskGroup.mjs";
|
|
149
151
|
export * from "./DriverBiddingGroup1.mjs";
|
|
150
152
|
export * from "./DriverBiddingGroupListRes.mjs";
|
|
151
153
|
export * from "./DriverBiddingGroupSortByEnum.mjs";
|
|
@@ -146,6 +146,8 @@ export * from "./DirectoryEntry1.mjs";
|
|
|
146
146
|
export * from "./DirectoryEntryListRes.mjs";
|
|
147
147
|
export * from "./DirectoryEntrySortByEnum.mjs";
|
|
148
148
|
export * from "./Driver1.mjs";
|
|
149
|
+
export * from "./DriverAnalyticsDay.mjs";
|
|
150
|
+
export * from "./DriverAnalyticsTaskGroup.mjs";
|
|
149
151
|
export * from "./DriverBiddingGroup1.mjs";
|
|
150
152
|
export * from "./DriverBiddingGroupListRes.mjs";
|
|
151
153
|
export * from "./DriverBiddingGroupSortByEnum.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.824.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.
|
|
1
|
+
export const SDK_VERSION = "1.824.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -9885,7 +9885,7 @@ await client.notifications.adHoc.listBySessionIdV1("session_id", {
|
|
|
9885
9885
|
<dl>
|
|
9886
9886
|
<dd>
|
|
9887
9887
|
|
|
9888
|
-
Creates
|
|
9888
|
+
Creates or returns an existing ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
|
|
9889
9889
|
|
|
9890
9890
|
</dd>
|
|
9891
9891
|
</dl>
|
|
@@ -17570,7 +17570,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
17570
17570
|
<dl>
|
|
17571
17571
|
<dd>
|
|
17572
17572
|
|
|
17573
|
-
Retrieves driver
|
|
17573
|
+
Retrieves driver analytics for a time window. Daily rows are clipped to the requested UTC window; task-group rows include full in-progress mileage for task groups whose in-progress interval overlaps the requested window. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)
|
|
17574
17574
|
|
|
17575
17575
|
</dd>
|
|
17576
17576
|
</dl>
|