@chrt-inc/typescript-sdk 1.405.0 → 1.406.1

package/dist/cjs/Client.js

@@ -67,8 +67,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.405.0",
-                "User-Agent": "@chrt-inc/typescript-sdk/1.405.0",
+                "X-Fern-SDK-Version": "1.406.1",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.406.1",
                 "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/taskGroups/client/Client.d.ts

@@ -85,7 +85,7 @@ export declare class TaskGroups {
     updateDriverV1(taskGroupId: string, request: Chrt.UpdateDriverReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __updateDriverV1;
     /**
-     * Removes the driver from a task group (sets driver_id to null). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)
+     * Removes the driver from a task group (sets driver_id to null). Allowed when STAGED or IN_PROGRESS (if no tasks have reached a terminal status). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)
      *
      * @param {string} taskGroupId
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/taskGroups/client/Client.js

@@ -260,7 +260,7 @@ class TaskGroups {
         });
     }
     /**
-     * Removes the driver from a task group (sets driver_id to null). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)
+     * Removes the driver from a task group (sets driver_id to null). Allowed when STAGED or IN_PROGRESS (if no tasks have reached a terminal status). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)
      *
      * @param {string} taskGroupId
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/tracking/resources/devices/client/Client.d.ts

@@ -59,7 +59,7 @@ export declare class Devices {
     updateV1(request?: Chrt.tracking.DevicesUpdateRequest1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
     private __updateV1;
     /**
-     * Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. | () -> (bool)
+     * Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. Deregisters from Shiprec (transfers to deactivate account) before removing from database. | () -> (bool)
      *
      * @param {Chrt.tracking.DevicesDeleteV1Request} request
      * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js

@@ -182,7 +182,7 @@ class Devices {
         });
     }
     /**
-     * Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. | () -> (bool)
+     * Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. Deregisters from Shiprec (transfers to deactivate account) before removing from database. | () -> (bool)
      *
      * @param {Chrt.tracking.DevicesDeleteV1Request} request
      * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class TaskGroupByDriver {
     protected readonly _options: TaskGroupByDriver.Options;
     constructor(_options?: TaskGroupByDriver.Options);
     /**
-     * Returns the most recent driver location data point for a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (TaskGroupByDriverDataPoint1 | None)
+     * Returns the most recent driver location data point for a task group. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | () -> (TaskGroupByDriverDataPoint1 | None)
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverLastSeenV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
@@ -46,7 +46,7 @@ export declare class TaskGroupByDriver {
     lastSeenV1(request: Chrt.tracking.timeseries.TaskGroupByDriverLastSeenV1Request, requestOptions?: TaskGroupByDriver.RequestOptions): core.HttpResponsePromise<(Chrt.TaskGroupByDriverDataPoint1 | null) | undefined>;
     private __lastSeenV1;
     /**
-     * Returns up to the specified number of data points for a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[TaskGroupByDriverDataPoint1])
+     * Returns sampled driver location data points for a task group. Excludes outliers. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | () -> (list[TaskGroupByDriverDataPoint1])
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverDataPointsV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
@@ -62,7 +62,7 @@ export declare class TaskGroupByDriver {
     dataPointsV1(request: Chrt.tracking.timeseries.TaskGroupByDriverDataPointsV1Request, requestOptions?: TaskGroupByDriver.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupByDriverDataPoint1[]>;
     private __dataPointsV1;
     /**
-     * Returns the most recent driver location data point for a public task group. No authentication required if task group has public visibility enabled via sharing settings. | () -> (TaskGroupByDriverDataPoint1 | None)
+     * Returns the most recent driver location data point for a publicly shared task group. No authentication required. | () -> (TaskGroupByDriverDataPoint1 | None)
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverLastSeenPublicV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
@@ -77,7 +77,7 @@ export declare class TaskGroupByDriver {
     lastSeenPublicV1(request: Chrt.tracking.timeseries.TaskGroupByDriverLastSeenPublicV1Request, requestOptions?: TaskGroupByDriver.RequestOptions): core.HttpResponsePromise<(Chrt.TaskGroupByDriverDataPoint1 | null) | undefined>;
     private __lastSeenPublicV1;
     /**
-     * Returns up to the specified number of data points for a public task group, intelligently sampled across the time range. Excludes outliers. No authentication required if task group has public visibility enabled via sharing settings. | () -> (list[TaskGroupByDriverDataPoint1])
+     * Returns sampled driver location data points for a publicly shared task group. Excludes outliers. No authentication required. | () -> (list[TaskGroupByDriverDataPoint1])
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverDataPointsPublicV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.js

@@ -56,7 +56,7 @@ class TaskGroupByDriver {
         this._options = _options;
     }
     /**
-     * Returns the most recent driver location data point for a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (TaskGroupByDriverDataPoint1 | None)
+     * Returns the most recent driver location data point for a task group. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | () -> (TaskGroupByDriverDataPoint1 | None)
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverLastSeenV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
@@ -123,7 +123,7 @@ class TaskGroupByDriver {
         });
     }
     /**
-     * Returns up to the specified number of data points for a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[TaskGroupByDriverDataPoint1])
+     * Returns sampled driver location data points for a task group. Excludes outliers. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | () -> (list[TaskGroupByDriverDataPoint1])
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverDataPointsV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
@@ -191,7 +191,7 @@ class TaskGroupByDriver {
         });
     }
     /**
-     * Returns the most recent driver location data point for a public task group. No authentication required if task group has public visibility enabled via sharing settings. | () -> (TaskGroupByDriverDataPoint1 | None)
+     * Returns the most recent driver location data point for a publicly shared task group. No authentication required. | () -> (TaskGroupByDriverDataPoint1 | None)
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverLastSeenPublicV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
@@ -258,7 +258,7 @@ class TaskGroupByDriver {
         });
     }
     /**
-     * Returns up to the specified number of data points for a public task group, intelligently sampled across the time range. Excludes outliers. No authentication required if task group has public visibility enabled via sharing settings. | () -> (list[TaskGroupByDriverDataPoint1])
+     * Returns sampled driver location data points for a publicly shared task group. Excludes outliers. No authentication required. | () -> (list[TaskGroupByDriverDataPoint1])
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverDataPointsPublicV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.405.0";
+export declare const SDK_VERSION = "1.406.1";

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.405.0";
+exports.SDK_VERSION = "1.406.1";

package/dist/esm/Client.mjs

@@ -31,8 +31,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.405.0",
-                "User-Agent": "@chrt-inc/typescript-sdk/1.405.0",
+                "X-Fern-SDK-Version": "1.406.1",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.406.1",
                 "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/taskGroups/client/Client.d.mts

@@ -85,7 +85,7 @@ export declare class TaskGroups {
     updateDriverV1(taskGroupId: string, request: Chrt.UpdateDriverReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __updateDriverV1;
     /**
-     * Removes the driver from a task group (sets driver_id to null). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)
+     * Removes the driver from a task group (sets driver_id to null). Allowed when STAGED or IN_PROGRESS (if no tasks have reached a terminal status). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)
      *
      * @param {string} taskGroupId
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/taskGroups/client/Client.mjs

@@ -224,7 +224,7 @@ export class TaskGroups {
         });
     }
     /**
-     * Removes the driver from a task group (sets driver_id to null). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)
+     * Removes the driver from a task group (sets driver_id to null). Allowed when STAGED or IN_PROGRESS (if no tasks have reached a terminal status). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)
      *
      * @param {string} taskGroupId
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/tracking/resources/devices/client/Client.d.mts

@@ -59,7 +59,7 @@ export declare class Devices {
     updateV1(request?: Chrt.tracking.DevicesUpdateRequest1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
     private __updateV1;
     /**
-     * Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. | () -> (bool)
+     * Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. Deregisters from Shiprec (transfers to deactivate account) before removing from database. | () -> (bool)
      *
      * @param {Chrt.tracking.DevicesDeleteV1Request} request
      * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs

@@ -146,7 +146,7 @@ export class Devices {
         });
     }
     /**
-     * Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. | () -> (bool)
+     * Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. Deregisters from Shiprec (transfers to deactivate account) before removing from database. | () -> (bool)
      *
      * @param {Chrt.tracking.DevicesDeleteV1Request} request
      * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.d.mts

@@ -31,7 +31,7 @@ export declare class TaskGroupByDriver {
     protected readonly _options: TaskGroupByDriver.Options;
     constructor(_options?: TaskGroupByDriver.Options);
     /**
-     * Returns the most recent driver location data point for a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (TaskGroupByDriverDataPoint1 | None)
+     * Returns the most recent driver location data point for a task group. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | () -> (TaskGroupByDriverDataPoint1 | None)
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverLastSeenV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
@@ -46,7 +46,7 @@ export declare class TaskGroupByDriver {
     lastSeenV1(request: Chrt.tracking.timeseries.TaskGroupByDriverLastSeenV1Request, requestOptions?: TaskGroupByDriver.RequestOptions): core.HttpResponsePromise<(Chrt.TaskGroupByDriverDataPoint1 | null) | undefined>;
     private __lastSeenV1;
     /**
-     * Returns up to the specified number of data points for a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[TaskGroupByDriverDataPoint1])
+     * Returns sampled driver location data points for a task group. Excludes outliers. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | () -> (list[TaskGroupByDriverDataPoint1])
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverDataPointsV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
@@ -62,7 +62,7 @@ export declare class TaskGroupByDriver {
     dataPointsV1(request: Chrt.tracking.timeseries.TaskGroupByDriverDataPointsV1Request, requestOptions?: TaskGroupByDriver.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupByDriverDataPoint1[]>;
     private __dataPointsV1;
     /**
-     * Returns the most recent driver location data point for a public task group. No authentication required if task group has public visibility enabled via sharing settings. | () -> (TaskGroupByDriverDataPoint1 | None)
+     * Returns the most recent driver location data point for a publicly shared task group. No authentication required. | () -> (TaskGroupByDriverDataPoint1 | None)
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverLastSeenPublicV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
@@ -77,7 +77,7 @@ export declare class TaskGroupByDriver {
     lastSeenPublicV1(request: Chrt.tracking.timeseries.TaskGroupByDriverLastSeenPublicV1Request, requestOptions?: TaskGroupByDriver.RequestOptions): core.HttpResponsePromise<(Chrt.TaskGroupByDriverDataPoint1 | null) | undefined>;
     private __lastSeenPublicV1;
     /**
-     * Returns up to the specified number of data points for a public task group, intelligently sampled across the time range. Excludes outliers. No authentication required if task group has public visibility enabled via sharing settings. | () -> (list[TaskGroupByDriverDataPoint1])
+     * Returns sampled driver location data points for a publicly shared task group. Excludes outliers. No authentication required. | () -> (list[TaskGroupByDriverDataPoint1])
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverDataPointsPublicV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.mjs

@@ -20,7 +20,7 @@ export class TaskGroupByDriver {
         this._options = _options;
     }
     /**
-     * Returns the most recent driver location data point for a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (TaskGroupByDriverDataPoint1 | None)
+     * Returns the most recent driver location data point for a task group. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | () -> (TaskGroupByDriverDataPoint1 | None)
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverLastSeenV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
@@ -87,7 +87,7 @@ export class TaskGroupByDriver {
         });
     }
     /**
-     * Returns up to the specified number of data points for a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[TaskGroupByDriverDataPoint1])
+     * Returns sampled driver location data points for a task group. Excludes outliers. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | () -> (list[TaskGroupByDriverDataPoint1])
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverDataPointsV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
@@ -155,7 +155,7 @@ export class TaskGroupByDriver {
         });
     }
     /**
-     * Returns the most recent driver location data point for a public task group. No authentication required if task group has public visibility enabled via sharing settings. | () -> (TaskGroupByDriverDataPoint1 | None)
+     * Returns the most recent driver location data point for a publicly shared task group. No authentication required. | () -> (TaskGroupByDriverDataPoint1 | None)
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverLastSeenPublicV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
@@ -222,7 +222,7 @@ export class TaskGroupByDriver {
         });
     }
     /**
-     * Returns up to the specified number of data points for a public task group, intelligently sampled across the time range. Excludes outliers. No authentication required if task group has public visibility enabled via sharing settings. | () -> (list[TaskGroupByDriverDataPoint1])
+     * Returns sampled driver location data points for a publicly shared task group. Excludes outliers. No authentication required. | () -> (list[TaskGroupByDriverDataPoint1])
      *
      * @param {Chrt.tracking.timeseries.TaskGroupByDriverDataPointsPublicV1Request} request
      * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.405.0";
+export declare const SDK_VERSION = "1.406.1";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.405.0";
+export const SDK_VERSION = "1.406.1";

package/package.json

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

package/reference.md

@@ -3174,7 +3174,7 @@ await client.taskGroups.updateDriverV1("task_group_id", {
 <dl>
 <dd>
 
-Removes the driver from a task group (sets driver_id to null). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)
+Removes the driver from a task group (sets driver_id to null). Allowed when STAGED or IN_PROGRESS (if no tasks have reached a terminal status). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)
 
 </dd>
 </dl>
@@ -13181,7 +13181,7 @@ await client.tracking.devices.updateV1();
 <dl>
 <dd>
 
-Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. | () -> (bool)
+Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. Deregisters from Shiprec (transfers to deactivate account) before removing from database. | () -> (bool)
 
 </dd>
 </dl>
@@ -15510,7 +15510,7 @@ await client.tracking.timeseries.sessionByDevice.dataPointsPublicV1({
 <dl>
 <dd>
 
-Returns the most recent driver location data point for a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (TaskGroupByDriverDataPoint1 | None)
+Returns the most recent driver location data point for a task group. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | () -> (TaskGroupByDriverDataPoint1 | None)
 
 </dd>
 </dl>
@@ -15575,7 +15575,7 @@ await client.tracking.timeseries.taskGroupByDriver.lastSeenV1({
 <dl>
 <dd>
 
-Returns up to the specified number of data points for a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[TaskGroupByDriverDataPoint1])
+Returns sampled driver location data points for a task group. Excludes outliers. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | () -> (list[TaskGroupByDriverDataPoint1])
 
 </dd>
 </dl>
@@ -15641,7 +15641,7 @@ await client.tracking.timeseries.taskGroupByDriver.dataPointsV1({
 <dl>
 <dd>
 
-Returns the most recent driver location data point for a public task group. No authentication required if task group has public visibility enabled via sharing settings. | () -> (TaskGroupByDriverDataPoint1 | None)
+Returns the most recent driver location data point for a publicly shared task group. No authentication required. | () -> (TaskGroupByDriverDataPoint1 | None)
 
 </dd>
 </dl>
@@ -15706,7 +15706,7 @@ await client.tracking.timeseries.taskGroupByDriver.lastSeenPublicV1({
 <dl>
 <dd>
 
-Returns up to the specified number of data points for a public task group, intelligently sampled across the time range. Excludes outliers. No authentication required if task group has public visibility enabled via sharing settings. | () -> (list[TaskGroupByDriverDataPoint1])
+Returns sampled driver location data points for a publicly shared task group. Excludes outliers. No authentication required. | () -> (list[TaskGroupByDriverDataPoint1])
 
 </dd>
 </dl>