@chrt-inc/typescript-sdk 1.810.0 → 1.824.0

package/dist/cjs/Client.js

@@ -57,8 +57,8 @@ class ChrtClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
-                "X-Fern-SDK-Version": "1.810.0",
-                "User-Agent": "@chrt-inc/typescript-sdk/1.810.0",
+                "X-Fern-SDK-Version": "1.824.0",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.824.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.d.ts

@@ -65,7 +65,7 @@ export declare class AdHoc {
     listBySessionIdV1(sessionId: string, request?: Chrt.notifications.AdHocListBySessionIdV1Request, requestOptions?: AdHoc.RequestOptions): core.HttpResponsePromise<Chrt.NotificationAdHocListRes>;
     private __listBySessionIdV1;
     /**
-     * Creates a new ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
+     * Creates or returns an existing ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
      *
      * @param {string} orderId
      * @param {Chrt.NotificationIntentAdHocClientCreate1} request

package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.js

@@ -198,7 +198,7 @@ class AdHoc {
         });
     }
     /**
-     * Creates a new ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
+     * Creates or returns an existing ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
      *
      * @param {string} orderId
      * @param {Chrt.NotificationIntentAdHocClientCreate1} request

package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts

@@ -34,7 +34,7 @@ export declare class Drivers {
     constructor(_options?: Drivers.Options);
     get complianceDocuments(): ComplianceDocuments;
     /**
-     * Retrieves driver stats for a time window: overlap-corrected hours worked, total GPS mileage, and mileage restricted to worked task-group intervals. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)
+     * 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)
      *
      * @param {string} driverId
      * @param {Chrt.shipping.DriverStatsReq} request

package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js

@@ -72,7 +72,7 @@ class Drivers {
         return ((_a = this._complianceDocuments) !== null && _a !== void 0 ? _a : (this._complianceDocuments = new Client_js_1.ComplianceDocuments(this._options)));
     }
     /**
-     * Retrieves driver stats for a time window: overlap-corrected hours worked, total GPS mileage, and mileage restricted to worked task-group intervals. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)
+     * 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)
      *
      * @param {string} driverId
      * @param {Chrt.shipping.DriverStatsReq} request

package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriverStatsReq.d.ts

@@ -11,5 +11,4 @@
 export interface DriverStatsReq {
     start_timestamp: string;
     end_timestamp: string;
-    excluded_task_group_ids?: string[];
 }

package/dist/cjs/api/types/DriverAnalyticsDay.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+export interface DriverAnalyticsDay {
+    day: string;
+    /** 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. */
+    observed_mileage_order_in_progress_deduped: number;
+    /** 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. */
+    observed_mileage_order_not_in_progress: number;
+    /** Total observed GPS mileage from all same-day driver ping segments on this UTC day. Cross-midnight segments are dropped. */
+    observed_mileage_total: number;
+    /** Driver self-reported hours and mileage record for this UTC calendar day, if one exists. */
+    self_reported_hours_and_mileage?: Chrt.DriverSelfReportedHoursAndMileage1 | null;
+}

package/dist/cjs/api/types/DriverAnalyticsDay.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/DriverAnalyticsTaskGroup.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+export interface DriverAnalyticsTaskGroup {
+    /** Task group assigned to the driver whose in-progress interval overlaps the requested analytics window. */
+    task_group: Chrt.TaskGroup1;
+    /** 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. */
+    observed_mileage_order_in_progress: number;
+}

package/dist/cjs/api/types/DriverAnalyticsTaskGroup.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/DriverStatsRes.d.ts

@@ -3,14 +3,6 @@
  */
 import * as Chrt from "../index.js";
 export interface DriverStatsRes {
-    task_groups: Chrt.TaskGroup1[];
-    excluded_task_groups: Chrt.TaskGroup1[];
-    /** Summed from task group in-progress intervals merged to eliminate double-counting of overlapping task groups. */
-    deduped_task_group_driver_hours: number;
-    overlapping_task_groups_detected: boolean;
-    /** 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 */
-    total_driver_mileage_tracked?: number | null;
-    /** Total mileage from pings that fall within task group in-progress merged intervals. i.e. excludes pings outside of merged task group time windows */
-    deduped_task_group_driver_mileage_tracked?: number | null;
-    self_reported_hours_and_mileage?: Chrt.DriverSelfReportedHoursAndMileage1[];
+    driver_analytics_days?: Chrt.DriverAnalyticsDay[];
+    driver_analytics_task_groups?: Chrt.DriverAnalyticsTaskGroup[];
 }

package/dist/cjs/api/types/index.d.ts

@@ -146,6 +146,8 @@ export * from "./DirectoryEntry1.js";
 export * from "./DirectoryEntryListRes.js";
 export * from "./DirectoryEntrySortByEnum.js";
 export * from "./Driver1.js";
+export * from "./DriverAnalyticsDay.js";
+export * from "./DriverAnalyticsTaskGroup.js";
 export * from "./DriverBiddingGroup1.js";
 export * from "./DriverBiddingGroupListRes.js";
 export * from "./DriverBiddingGroupSortByEnum.js";

package/dist/cjs/api/types/index.js

@@ -162,6 +162,8 @@ __exportStar(require("./DirectoryEntry1.js"), exports);
 __exportStar(require("./DirectoryEntryListRes.js"), exports);
 __exportStar(require("./DirectoryEntrySortByEnum.js"), exports);
 __exportStar(require("./Driver1.js"), exports);
+__exportStar(require("./DriverAnalyticsDay.js"), exports);
+__exportStar(require("./DriverAnalyticsTaskGroup.js"), exports);
 __exportStar(require("./DriverBiddingGroup1.js"), exports);
 __exportStar(require("./DriverBiddingGroupListRes.js"), exports);
 __exportStar(require("./DriverBiddingGroupSortByEnum.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.810.0";
+export declare const SDK_VERSION = "1.824.0";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.810.0";
+exports.SDK_VERSION = "1.824.0";

package/dist/esm/Client.mjs

@@ -21,8 +21,8 @@ export class ChrtClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
-                "X-Fern-SDK-Version": "1.810.0",
-                "User-Agent": "@chrt-inc/typescript-sdk/1.810.0",
+                "X-Fern-SDK-Version": "1.824.0",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.824.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.d.mts

@@ -65,7 +65,7 @@ export declare class AdHoc {
     listBySessionIdV1(sessionId: string, request?: Chrt.notifications.AdHocListBySessionIdV1Request, requestOptions?: AdHoc.RequestOptions): core.HttpResponsePromise<Chrt.NotificationAdHocListRes>;
     private __listBySessionIdV1;
     /**
-     * Creates a new ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
+     * Creates or returns an existing ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
      *
      * @param {string} orderId
      * @param {Chrt.NotificationIntentAdHocClientCreate1} request

package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.mjs

@@ -162,7 +162,7 @@ export class AdHoc {
         });
     }
     /**
-     * Creates a new ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
+     * Creates or returns an existing ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
      *
      * @param {string} orderId
      * @param {Chrt.NotificationIntentAdHocClientCreate1} request

package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts

@@ -34,7 +34,7 @@ export declare class Drivers {
     constructor(_options?: Drivers.Options);
     get complianceDocuments(): ComplianceDocuments;
     /**
-     * Retrieves driver stats for a time window: overlap-corrected hours worked, total GPS mileage, and mileage restricted to worked task-group intervals. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)
+     * 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)
      *
      * @param {string} driverId
      * @param {Chrt.shipping.DriverStatsReq} request

package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs

@@ -36,7 +36,7 @@ export class Drivers {
         return ((_a = this._complianceDocuments) !== null && _a !== void 0 ? _a : (this._complianceDocuments = new ComplianceDocuments(this._options)));
     }
     /**
-     * Retrieves driver stats for a time window: overlap-corrected hours worked, total GPS mileage, and mileage restricted to worked task-group intervals. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)
+     * 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)
      *
      * @param {string} driverId
      * @param {Chrt.shipping.DriverStatsReq} request

package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriverStatsReq.d.mts

@@ -11,5 +11,4 @@
 export interface DriverStatsReq {
     start_timestamp: string;
     end_timestamp: string;
-    excluded_task_group_ids?: string[];
 }

package/dist/esm/api/types/DriverAnalyticsDay.d.mts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.mjs";
+export interface DriverAnalyticsDay {
+    day: string;
+    /** 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. */
+    observed_mileage_order_in_progress_deduped: number;
+    /** 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. */
+    observed_mileage_order_not_in_progress: number;
+    /** Total observed GPS mileage from all same-day driver ping segments on this UTC day. Cross-midnight segments are dropped. */
+    observed_mileage_total: number;
+    /** Driver self-reported hours and mileage record for this UTC calendar day, if one exists. */
+    self_reported_hours_and_mileage?: Chrt.DriverSelfReportedHoursAndMileage1 | null;
+}

package/dist/esm/api/types/DriverAnalyticsDay.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/DriverAnalyticsTaskGroup.d.mts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.mjs";
+export interface DriverAnalyticsTaskGroup {
+    /** Task group assigned to the driver whose in-progress interval overlaps the requested analytics window. */
+    task_group: Chrt.TaskGroup1;
+    /** 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. */
+    observed_mileage_order_in_progress: number;
+}

package/dist/esm/api/types/DriverAnalyticsTaskGroup.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/DriverStatsRes.d.mts

@@ -3,14 +3,6 @@
  */
 import * as Chrt from "../index.mjs";
 export interface DriverStatsRes {
-    task_groups: Chrt.TaskGroup1[];
-    excluded_task_groups: Chrt.TaskGroup1[];
-    /** Summed from task group in-progress intervals merged to eliminate double-counting of overlapping task groups. */
-    deduped_task_group_driver_hours: number;
-    overlapping_task_groups_detected: boolean;
-    /** 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 */
-    total_driver_mileage_tracked?: number | null;
-    /** Total mileage from pings that fall within task group in-progress merged intervals. i.e. excludes pings outside of merged task group time windows */
-    deduped_task_group_driver_mileage_tracked?: number | null;
-    self_reported_hours_and_mileage?: Chrt.DriverSelfReportedHoursAndMileage1[];
+    driver_analytics_days?: Chrt.DriverAnalyticsDay[];
+    driver_analytics_task_groups?: Chrt.DriverAnalyticsTaskGroup[];
 }

package/dist/esm/api/types/index.d.mts

@@ -146,6 +146,8 @@ export * from "./DirectoryEntry1.mjs";
 export * from "./DirectoryEntryListRes.mjs";
 export * from "./DirectoryEntrySortByEnum.mjs";
 export * from "./Driver1.mjs";
+export * from "./DriverAnalyticsDay.mjs";
+export * from "./DriverAnalyticsTaskGroup.mjs";
 export * from "./DriverBiddingGroup1.mjs";
 export * from "./DriverBiddingGroupListRes.mjs";
 export * from "./DriverBiddingGroupSortByEnum.mjs";

package/dist/esm/api/types/index.mjs

@@ -146,6 +146,8 @@ export * from "./DirectoryEntry1.mjs";
 export * from "./DirectoryEntryListRes.mjs";
 export * from "./DirectoryEntrySortByEnum.mjs";
 export * from "./Driver1.mjs";
+export * from "./DriverAnalyticsDay.mjs";
+export * from "./DriverAnalyticsTaskGroup.mjs";
 export * from "./DriverBiddingGroup1.mjs";
 export * from "./DriverBiddingGroupListRes.mjs";
 export * from "./DriverBiddingGroupSortByEnum.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.810.0";
+export declare const SDK_VERSION = "1.824.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.810.0";
+export const SDK_VERSION = "1.824.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chrt-inc/typescript-sdk",
-    "version": "1.810.0",
+    "version": "1.824.0",
     "private": false,
     "repository": "github:chrt-inc/typescript-sdk",
     "type": "commonjs",

package/reference.md

@@ -9885,7 +9885,7 @@ await client.notifications.adHoc.listBySessionIdV1("session_id", {
 <dl>
 <dd>
 
-Creates a new ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
+Creates or returns an existing ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
 
 </dd>
 </dl>
@@ -17570,7 +17570,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
 <dl>
 <dd>
 
-Retrieves driver stats for a time window: overlap-corrected hours worked, total GPS mileage, and mileage restricted to worked task-group intervals. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)
+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)
 
 </dd>
 </dl>