@chrt-inc/typescript-sdk 1.662.1 → 1.676.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/shipping/resources/flights/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/flights/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/client/Client.js +3 -3
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.js +3 -3
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/s3Object/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/s3Object/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.d.ts +18 -2
- package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.js +66 -2
- package/dist/cjs/api/resources/shipping/resources/tasks/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/index.js +1 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/Client.d.ts +50 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/Client.js +133 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/AddExecutorOrgNoteReq.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/AddExecutorOrgNoteReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/index.js +41 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.d.ts +8 -8
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +8 -8
- package/dist/cjs/api/resources/tracking/resources/driver/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tracking/resources/driver/client/Client.js +1 -1
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.js +6 -6
- package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.js +3 -3
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.js +3 -3
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.js +2 -2
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.js +1 -1
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.js +2 -2
- package/dist/cjs/api/types/ListingListingDriverInvitedToBidWebhookPayload.d.ts +16 -0
- package/dist/cjs/api/types/ListingListingDriverInvitedToBidWebhookPayload.js +5 -0
- package/dist/cjs/api/types/ListingListingProviderInvitedToBidWebhookPayload.d.ts +16 -0
- package/dist/cjs/api/types/ListingListingProviderInvitedToBidWebhookPayload.js +5 -0
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.d.ts +5 -1
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.js +4 -0
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.d.ts +4 -1
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.js +3 -0
- package/dist/cjs/api/types/OperationsCaseGroupAssignedWebhookPayload.d.ts +16 -0
- package/dist/cjs/api/types/OperationsCaseGroupAssignedWebhookPayload.js +5 -0
- package/dist/cjs/api/types/OperationsCaseOperatorAssignedWebhookPayload.d.ts +14 -0
- package/dist/cjs/api/types/OperationsCaseOperatorAssignedWebhookPayload.js +5 -0
- package/dist/cjs/api/types/Task1.d.ts +2 -0
- package/dist/cjs/api/types/TaskExecutorOrgNote1.d.ts +11 -0
- package/dist/cjs/api/types/TaskExecutorOrgNote1.js +5 -0
- package/dist/cjs/api/types/TaskStatusEnum1.d.ts +2 -1
- package/dist/cjs/api/types/TaskStatusEnum1.js +1 -0
- package/dist/cjs/api/types/index.d.ts +5 -0
- package/dist/cjs/api/types/index.js +5 -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/shipping/resources/flights/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/flights/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/Client.mjs +3 -3
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.mjs +3 -3
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/s3Object/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/s3Object/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/tasks/client/Client.d.mts +18 -2
- package/dist/esm/api/resources/shipping/resources/tasks/client/Client.mjs +66 -2
- package/dist/esm/api/resources/shipping/resources/tasks/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/Client.d.mts +50 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/Client.mjs +96 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/AddExecutorOrgNoteReq.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/AddExecutorOrgNoteReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/index.mjs +2 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.d.mts +8 -8
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +8 -8
- package/dist/esm/api/resources/tracking/resources/driver/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tracking/resources/driver/client/Client.mjs +1 -1
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.mjs +6 -6
- package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.mjs +3 -3
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.mjs +3 -3
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.mjs +2 -2
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.mjs +1 -1
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.mjs +2 -2
- package/dist/esm/api/types/ListingListingDriverInvitedToBidWebhookPayload.d.mts +16 -0
- package/dist/esm/api/types/ListingListingDriverInvitedToBidWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/ListingListingProviderInvitedToBidWebhookPayload.d.mts +16 -0
- package/dist/esm/api/types/ListingListingProviderInvitedToBidWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.d.mts +5 -1
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.mjs +4 -0
- package/dist/esm/api/types/NotificationEventsForUsersEnum.d.mts +4 -1
- package/dist/esm/api/types/NotificationEventsForUsersEnum.mjs +3 -0
- package/dist/esm/api/types/OperationsCaseGroupAssignedWebhookPayload.d.mts +16 -0
- package/dist/esm/api/types/OperationsCaseGroupAssignedWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/OperationsCaseOperatorAssignedWebhookPayload.d.mts +14 -0
- package/dist/esm/api/types/OperationsCaseOperatorAssignedWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/Task1.d.mts +2 -0
- package/dist/esm/api/types/TaskExecutorOrgNote1.d.mts +11 -0
- package/dist/esm/api/types/TaskExecutorOrgNote1.mjs +4 -0
- package/dist/esm/api/types/TaskStatusEnum1.d.mts +2 -1
- package/dist/esm/api/types/TaskStatusEnum1.mjs +1 -0
- package/dist/esm/api/types/index.d.mts +5 -0
- package/dist/esm/api/types/index.mjs +5 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +175 -37
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
+
var ownKeys = function(o) {
|
|
20
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
+
var ar = [];
|
|
22
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
+
return ar;
|
|
24
|
+
};
|
|
25
|
+
return ownKeys(o);
|
|
26
|
+
};
|
|
27
|
+
return function (mod) {
|
|
28
|
+
if (mod && mod.__esModule) return mod;
|
|
29
|
+
var result = {};
|
|
30
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
+
__setModuleDefault(result, mod);
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
})();
|
|
35
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
36
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
37
|
+
};
|
|
38
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
+
exports.executorOrgNotes = void 0;
|
|
40
|
+
exports.executorOrgNotes = __importStar(require("./executorOrgNotes/index.js"));
|
|
41
|
+
__exportStar(require("./executorOrgNotes/client/requests/index.js"), exports);
|
|
@@ -47,7 +47,7 @@ export declare class Devices {
|
|
|
47
47
|
registerToOrgV1(request: Chrt.tracking.DeviceClientCreate1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<string>;
|
|
48
48
|
private __registerToOrgV1;
|
|
49
49
|
/**
|
|
50
|
-
* Updates a device's type, comments, and/or off_chrt_reference_id. Use __set_to_None flags to explicitly clear Optional fields. | (DeviceClientUpdate1) -> (bool)
|
|
50
|
+
* Updates a device's type, comments, and/or off_chrt_reference_id. Use __set_to_None flags to explicitly clear Optional fields. | auth: api_key | (DeviceClientUpdate1) -> (bool)
|
|
51
51
|
*
|
|
52
52
|
* @param {Chrt.tracking.DeviceClientUpdate1} request
|
|
53
53
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -62,7 +62,7 @@ export declare class Devices {
|
|
|
62
62
|
updateV1(request: Chrt.tracking.DeviceClientUpdate1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
63
63
|
private __updateV1;
|
|
64
64
|
/**
|
|
65
|
-
* Archives a device by setting archived=True. Device must not have an active session — terminate it first. | () -> (bool)
|
|
65
|
+
* Archives a device by setting archived=True. Device must not have an active session — terminate it first. | auth: api_key | () -> (bool)
|
|
66
66
|
*
|
|
67
67
|
* @param {Chrt.tracking.DevicesArchiveV1Request} request
|
|
68
68
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -77,7 +77,7 @@ export declare class Devices {
|
|
|
77
77
|
archiveV1(request: Chrt.tracking.DevicesArchiveV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
78
78
|
private __archiveV1;
|
|
79
79
|
/**
|
|
80
|
-
* Pauses a device and opens a new pause time window. | () -> (bool)
|
|
80
|
+
* Pauses a device and opens a new pause time window. | auth: api_key | () -> (bool)
|
|
81
81
|
*
|
|
82
82
|
* @param {Chrt.tracking.DevicesPauseV1Request} request
|
|
83
83
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -92,7 +92,7 @@ export declare class Devices {
|
|
|
92
92
|
pauseV1(request: Chrt.tracking.DevicesPauseV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
93
93
|
private __pauseV1;
|
|
94
94
|
/**
|
|
95
|
-
* Unpauses a device. Closes the open pause time window. | () -> (bool)
|
|
95
|
+
* Unpauses a device. Closes the open pause time window. | auth: api_key | () -> (bool)
|
|
96
96
|
*
|
|
97
97
|
* @param {Chrt.tracking.DevicesUnpauseV1Request} request
|
|
98
98
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -107,7 +107,7 @@ export declare class Devices {
|
|
|
107
107
|
unpauseV1(request: Chrt.tracking.DevicesUnpauseV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
108
108
|
private __unpauseV1;
|
|
109
109
|
/**
|
|
110
|
-
* Adds and/or removes org_ids from a device's shared_with_org_ids list. Removal overrides addition. | (DevicesUpdateSharedOrgsReq1) -> (bool)
|
|
110
|
+
* Adds and/or removes org_ids from a device's shared_with_org_ids list. Removal overrides addition. | auth: api_key | (DevicesUpdateSharedOrgsReq1) -> (bool)
|
|
111
111
|
*
|
|
112
112
|
* @param {Chrt.tracking.DevicesUpdateSharedOrgsReq1} request
|
|
113
113
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -122,7 +122,7 @@ export declare class Devices {
|
|
|
122
122
|
updateSharedOrgsV1(request: Chrt.tracking.DevicesUpdateSharedOrgsReq1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
123
123
|
private __updateSharedOrgsV1;
|
|
124
124
|
/**
|
|
125
|
-
* Retrieves a single device by its ID with expanded sessions and cargos. Access restricted to the caller's organization or shared organizations. | authz: min_org_role=operator | () -> (DeviceExpandedRes)
|
|
125
|
+
* Retrieves a single device by its ID with expanded sessions and cargos. Access restricted to the caller's organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (DeviceExpandedRes)
|
|
126
126
|
*
|
|
127
127
|
* @param {Chrt.tracking.DevicesGetV1Request} request
|
|
128
128
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -137,7 +137,7 @@ export declare class Devices {
|
|
|
137
137
|
getV1(request: Chrt.tracking.DevicesGetV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<Chrt.DeviceExpandedRes>;
|
|
138
138
|
private __getV1;
|
|
139
139
|
/**
|
|
140
|
-
* Lists devices with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (DeviceListRes)
|
|
140
|
+
* Lists devices with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | auth: api_key | authz: min_org_role=operator | () -> (DeviceListRes)
|
|
141
141
|
*
|
|
142
142
|
* @param {Chrt.tracking.DevicesListV1Request} request
|
|
143
143
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -170,7 +170,7 @@ export declare class Devices {
|
|
|
170
170
|
listV1(request?: Chrt.tracking.DevicesListV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<Chrt.DeviceListRes>;
|
|
171
171
|
private __listV1;
|
|
172
172
|
/**
|
|
173
|
-
* Returns distinct device_mac_address and off_chrt_reference_id values matching the query via case-insensitive regex, searching devices. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])
|
|
173
|
+
* Returns distinct device_mac_address and off_chrt_reference_id values matching the query via case-insensitive regex, searching devices. Use org_scope to restrict to owned, shared, or both (default). | auth: api_key | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])
|
|
174
174
|
*
|
|
175
175
|
* @param {Chrt.tracking.DevicesTypeaheadV1Request} request
|
|
176
176
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -132,7 +132,7 @@ class Devices {
|
|
|
132
132
|
});
|
|
133
133
|
}
|
|
134
134
|
/**
|
|
135
|
-
* Updates a device's type, comments, and/or off_chrt_reference_id. Use __set_to_None flags to explicitly clear Optional fields. | (DeviceClientUpdate1) -> (bool)
|
|
135
|
+
* Updates a device's type, comments, and/or off_chrt_reference_id. Use __set_to_None flags to explicitly clear Optional fields. | auth: api_key | (DeviceClientUpdate1) -> (bool)
|
|
136
136
|
*
|
|
137
137
|
* @param {Chrt.tracking.DeviceClientUpdate1} request
|
|
138
138
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -199,7 +199,7 @@ class Devices {
|
|
|
199
199
|
});
|
|
200
200
|
}
|
|
201
201
|
/**
|
|
202
|
-
* Archives a device by setting archived=True. Device must not have an active session — terminate it first. | () -> (bool)
|
|
202
|
+
* Archives a device by setting archived=True. Device must not have an active session — terminate it first. | auth: api_key | () -> (bool)
|
|
203
203
|
*
|
|
204
204
|
* @param {Chrt.tracking.DevicesArchiveV1Request} request
|
|
205
205
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -263,7 +263,7 @@ class Devices {
|
|
|
263
263
|
});
|
|
264
264
|
}
|
|
265
265
|
/**
|
|
266
|
-
* Pauses a device and opens a new pause time window. | () -> (bool)
|
|
266
|
+
* Pauses a device and opens a new pause time window. | auth: api_key | () -> (bool)
|
|
267
267
|
*
|
|
268
268
|
* @param {Chrt.tracking.DevicesPauseV1Request} request
|
|
269
269
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -327,7 +327,7 @@ class Devices {
|
|
|
327
327
|
});
|
|
328
328
|
}
|
|
329
329
|
/**
|
|
330
|
-
* Unpauses a device. Closes the open pause time window. | () -> (bool)
|
|
330
|
+
* Unpauses a device. Closes the open pause time window. | auth: api_key | () -> (bool)
|
|
331
331
|
*
|
|
332
332
|
* @param {Chrt.tracking.DevicesUnpauseV1Request} request
|
|
333
333
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -391,7 +391,7 @@ class Devices {
|
|
|
391
391
|
});
|
|
392
392
|
}
|
|
393
393
|
/**
|
|
394
|
-
* Adds and/or removes org_ids from a device's shared_with_org_ids list. Removal overrides addition. | (DevicesUpdateSharedOrgsReq1) -> (bool)
|
|
394
|
+
* Adds and/or removes org_ids from a device's shared_with_org_ids list. Removal overrides addition. | auth: api_key | (DevicesUpdateSharedOrgsReq1) -> (bool)
|
|
395
395
|
*
|
|
396
396
|
* @param {Chrt.tracking.DevicesUpdateSharedOrgsReq1} request
|
|
397
397
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -455,7 +455,7 @@ class Devices {
|
|
|
455
455
|
});
|
|
456
456
|
}
|
|
457
457
|
/**
|
|
458
|
-
* Retrieves a single device by its ID with expanded sessions and cargos. Access restricted to the caller's organization or shared organizations. | authz: min_org_role=operator | () -> (DeviceExpandedRes)
|
|
458
|
+
* Retrieves a single device by its ID with expanded sessions and cargos. Access restricted to the caller's organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (DeviceExpandedRes)
|
|
459
459
|
*
|
|
460
460
|
* @param {Chrt.tracking.DevicesGetV1Request} request
|
|
461
461
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -519,7 +519,7 @@ class Devices {
|
|
|
519
519
|
});
|
|
520
520
|
}
|
|
521
521
|
/**
|
|
522
|
-
* Lists devices with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (DeviceListRes)
|
|
522
|
+
* Lists devices with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | auth: api_key | authz: min_org_role=operator | () -> (DeviceListRes)
|
|
523
523
|
*
|
|
524
524
|
* @param {Chrt.tracking.DevicesListV1Request} request
|
|
525
525
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -657,7 +657,7 @@ class Devices {
|
|
|
657
657
|
});
|
|
658
658
|
}
|
|
659
659
|
/**
|
|
660
|
-
* Returns distinct device_mac_address and off_chrt_reference_id values matching the query via case-insensitive regex, searching devices. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])
|
|
660
|
+
* Returns distinct device_mac_address and off_chrt_reference_id values matching the query via case-insensitive regex, searching devices. Use org_scope to restrict to owned, shared, or both (default). | auth: api_key | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])
|
|
661
661
|
*
|
|
662
662
|
* @param {Chrt.tracking.DevicesTypeaheadV1Request} request
|
|
663
663
|
* @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,7 +31,7 @@ export declare class Driver {
|
|
|
31
31
|
protected readonly _options: Driver.Options;
|
|
32
32
|
constructor(_options?: Driver.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos (cargo_by_driver). | (LocationFeature) -> (DriverUpdateRes)
|
|
34
|
+
* Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos (cargo_by_driver). | auth: api_key | (LocationFeature) -> (DriverUpdateRes)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.LocationFeature} request
|
|
37
37
|
* @param {Driver.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class Driver {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos (cargo_by_driver). | (LocationFeature) -> (DriverUpdateRes)
|
|
59
|
+
* Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos (cargo_by_driver). | auth: api_key | (LocationFeature) -> (DriverUpdateRes)
|
|
60
60
|
*
|
|
61
61
|
* @param {Chrt.LocationFeature} request
|
|
62
62
|
* @param {Driver.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -113,7 +113,7 @@ export declare class Sessions {
|
|
|
113
113
|
createSessionV1(request: Chrt.tracking.SessionClientCreate1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<string>;
|
|
114
114
|
private __createSessionV1;
|
|
115
115
|
/**
|
|
116
|
-
* Updates a session's metadata. | (SessionClientUpdate1) -> (bool)
|
|
116
|
+
* Updates a session's metadata. | auth: api_key | (SessionClientUpdate1) -> (bool)
|
|
117
117
|
*
|
|
118
118
|
* @param {Chrt.tracking.SessionClientUpdate1} request
|
|
119
119
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -128,7 +128,7 @@ export declare class Sessions {
|
|
|
128
128
|
updateV1(request: Chrt.tracking.SessionClientUpdate1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
129
129
|
private __updateV1;
|
|
130
130
|
/**
|
|
131
|
-
* Adds and/or removes org_ids from a session's shared_with_org_ids list. Only the owning org may modify sharing. Removal overrides addition. | (SessionsUpdateSharedOrgsReq1) -> (bool)
|
|
131
|
+
* Adds and/or removes org_ids from a session's shared_with_org_ids list. Only the owning org may modify sharing. Removal overrides addition. | auth: api_key | (SessionsUpdateSharedOrgsReq1) -> (bool)
|
|
132
132
|
*
|
|
133
133
|
* @param {Chrt.tracking.SessionsUpdateSharedOrgsReq1} request
|
|
134
134
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -143,7 +143,7 @@ export declare class Sessions {
|
|
|
143
143
|
updateSharedOrgsV1(request: Chrt.tracking.SessionsUpdateSharedOrgsReq1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
144
144
|
private __updateSharedOrgsV1;
|
|
145
145
|
/**
|
|
146
|
-
* Terminates a session. Moves device.active_session_id to device.past_session_ids. | () -> (bool)
|
|
146
|
+
* Terminates a session. Moves device.active_session_id to device.past_session_ids. | auth: api_key | () -> (bool)
|
|
147
147
|
*
|
|
148
148
|
* @param {Chrt.tracking.SessionsTerminateV1Request} request
|
|
149
149
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -158,7 +158,7 @@ export declare class Sessions {
|
|
|
158
158
|
terminateV1(request: Chrt.tracking.SessionsTerminateV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
159
159
|
private __terminateV1;
|
|
160
160
|
/**
|
|
161
|
-
* Adds a flight number and FA flight IDs to an existing session. Creates or reuses a FlightAware alert. | authz: min_org_role=operator | (SessionAddFlightReq1) -> (bool)
|
|
161
|
+
* Adds a flight number and FA flight IDs to an existing session. Creates or reuses a FlightAware alert. | auth: api_key | authz: min_org_role=operator | (SessionAddFlightReq1) -> (bool)
|
|
162
162
|
*
|
|
163
163
|
* @param {Chrt.tracking.SessionAddFlightReq1} request
|
|
164
164
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -175,7 +175,7 @@ export declare class Sessions {
|
|
|
175
175
|
addFlightV1(request: Chrt.tracking.SessionAddFlightReq1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
176
176
|
private __addFlightV1;
|
|
177
177
|
/**
|
|
178
|
-
* Removes a flight number and FA flight IDs from a session. Runs the shared-aware FlightAware unsubscribe cycle before removing. | authz: min_org_role=operator | (SessionRemoveFlightReq1) -> (bool)
|
|
178
|
+
* Removes a flight number and FA flight IDs from a session. Runs the shared-aware FlightAware unsubscribe cycle before removing. | auth: api_key | authz: min_org_role=operator | (SessionRemoveFlightReq1) -> (bool)
|
|
179
179
|
*
|
|
180
180
|
* @param {Chrt.tracking.SessionRemoveFlightReq1} request
|
|
181
181
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -192,7 +192,7 @@ export declare class Sessions {
|
|
|
192
192
|
removeFlightV1(request: Chrt.tracking.SessionRemoveFlightReq1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
193
193
|
private __removeFlightV1;
|
|
194
194
|
/**
|
|
195
|
-
* Fetches current OOOI timestamps from FlightAware for each fa_flight_id on the session and updates flight_status_by_fa_flight_id. Use when the webhook may have left state out of sync. | authz: min_org_role=operator | () -> (bool)
|
|
195
|
+
* Fetches current OOOI timestamps from FlightAware for each fa_flight_id on the session and updates flight_status_by_fa_flight_id. Use when the webhook may have left state out of sync. | auth: api_key | authz: min_org_role=operator | () -> (bool)
|
|
196
196
|
*
|
|
197
197
|
* @param {Chrt.tracking.SessionsSyncFlightStatusV1Request} request
|
|
198
198
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -413,7 +413,7 @@ class Sessions {
|
|
|
413
413
|
});
|
|
414
414
|
}
|
|
415
415
|
/**
|
|
416
|
-
* Updates a session's metadata. | (SessionClientUpdate1) -> (bool)
|
|
416
|
+
* Updates a session's metadata. | auth: api_key | (SessionClientUpdate1) -> (bool)
|
|
417
417
|
*
|
|
418
418
|
* @param {Chrt.tracking.SessionClientUpdate1} request
|
|
419
419
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -480,7 +480,7 @@ class Sessions {
|
|
|
480
480
|
});
|
|
481
481
|
}
|
|
482
482
|
/**
|
|
483
|
-
* Adds and/or removes org_ids from a session's shared_with_org_ids list. Only the owning org may modify sharing. Removal overrides addition. | (SessionsUpdateSharedOrgsReq1) -> (bool)
|
|
483
|
+
* Adds and/or removes org_ids from a session's shared_with_org_ids list. Only the owning org may modify sharing. Removal overrides addition. | auth: api_key | (SessionsUpdateSharedOrgsReq1) -> (bool)
|
|
484
484
|
*
|
|
485
485
|
* @param {Chrt.tracking.SessionsUpdateSharedOrgsReq1} request
|
|
486
486
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -544,7 +544,7 @@ class Sessions {
|
|
|
544
544
|
});
|
|
545
545
|
}
|
|
546
546
|
/**
|
|
547
|
-
* Terminates a session. Moves device.active_session_id to device.past_session_ids. | () -> (bool)
|
|
547
|
+
* Terminates a session. Moves device.active_session_id to device.past_session_ids. | auth: api_key | () -> (bool)
|
|
548
548
|
*
|
|
549
549
|
* @param {Chrt.tracking.SessionsTerminateV1Request} request
|
|
550
550
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -608,7 +608,7 @@ class Sessions {
|
|
|
608
608
|
});
|
|
609
609
|
}
|
|
610
610
|
/**
|
|
611
|
-
* Adds a flight number and FA flight IDs to an existing session. Creates or reuses a FlightAware alert. | authz: min_org_role=operator | (SessionAddFlightReq1) -> (bool)
|
|
611
|
+
* Adds a flight number and FA flight IDs to an existing session. Creates or reuses a FlightAware alert. | auth: api_key | authz: min_org_role=operator | (SessionAddFlightReq1) -> (bool)
|
|
612
612
|
*
|
|
613
613
|
* @param {Chrt.tracking.SessionAddFlightReq1} request
|
|
614
614
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -674,7 +674,7 @@ class Sessions {
|
|
|
674
674
|
});
|
|
675
675
|
}
|
|
676
676
|
/**
|
|
677
|
-
* Removes a flight number and FA flight IDs from a session. Runs the shared-aware FlightAware unsubscribe cycle before removing. | authz: min_org_role=operator | (SessionRemoveFlightReq1) -> (bool)
|
|
677
|
+
* Removes a flight number and FA flight IDs from a session. Runs the shared-aware FlightAware unsubscribe cycle before removing. | auth: api_key | authz: min_org_role=operator | (SessionRemoveFlightReq1) -> (bool)
|
|
678
678
|
*
|
|
679
679
|
* @param {Chrt.tracking.SessionRemoveFlightReq1} request
|
|
680
680
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -740,7 +740,7 @@ class Sessions {
|
|
|
740
740
|
});
|
|
741
741
|
}
|
|
742
742
|
/**
|
|
743
|
-
* Fetches current OOOI timestamps from FlightAware for each fa_flight_id on the session and updates flight_status_by_fa_flight_id. Use when the webhook may have left state out of sync. | authz: min_org_role=operator | () -> (bool)
|
|
743
|
+
* Fetches current OOOI timestamps from FlightAware for each fa_flight_id on the session and updates flight_status_by_fa_flight_id. Use when the webhook may have left state out of sync. | auth: api_key | authz: min_org_role=operator | () -> (bool)
|
|
744
744
|
*
|
|
745
745
|
* @param {Chrt.tracking.SessionsSyncFlightStatusV1Request} request
|
|
746
746
|
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,7 +31,7 @@ export declare class SharingSettings {
|
|
|
31
31
|
protected readonly _options: SharingSettings.Options;
|
|
32
32
|
constructor(_options?: SharingSettings.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Updates the sharing settings for a task group by driver tracking dataset. | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | (TaskGroupByDriverSharingSettingsUpdateReq) -> (TaskGroupByDriverSharingSettings1)
|
|
34
|
+
* Updates the sharing settings for a task group by driver tracking dataset. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | (TaskGroupByDriverSharingSettingsUpdateReq) -> (TaskGroupByDriverSharingSettings1)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.tracking.TaskGroupByDriverSharingSettingsUpdateReq} request
|
|
37
37
|
* @param {SharingSettings.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -47,7 +47,7 @@ export declare class SharingSettings {
|
|
|
47
47
|
taskGroupByDriverSharingSettingsV1(request: Chrt.tracking.TaskGroupByDriverSharingSettingsUpdateReq, requestOptions?: SharingSettings.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupByDriverSharingSettings1>;
|
|
48
48
|
private __taskGroupByDriverSharingSettingsV1;
|
|
49
49
|
/**
|
|
50
|
-
* Updates the sharing settings for a cargo by driver tracking dataset. | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | (CargoByDriverSharingSettingsUpdateReq) -> (CargoByDriverSharingSettings1)
|
|
50
|
+
* Updates the sharing settings for a cargo by driver tracking dataset. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | (CargoByDriverSharingSettingsUpdateReq) -> (CargoByDriverSharingSettings1)
|
|
51
51
|
*
|
|
52
52
|
* @param {Chrt.tracking.CargoByDriverSharingSettingsUpdateReq} request
|
|
53
53
|
* @param {SharingSettings.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -64,7 +64,7 @@ export declare class SharingSettings {
|
|
|
64
64
|
cargoByDriverSettingsV1(request: Chrt.tracking.CargoByDriverSharingSettingsUpdateReq, requestOptions?: SharingSettings.RequestOptions): core.HttpResponsePromise<Chrt.CargoByDriverSharingSettings1>;
|
|
65
65
|
private __cargoByDriverSettingsV1;
|
|
66
66
|
/**
|
|
67
|
-
* Updates the sharing settings for a cargo by device tracking dataset. | authz_personas=[coordinator_org_operators, shipper_org_operators, order_creator_org_operators] | (CargoByDeviceSharingSettingsUpdateReq) -> (CargoByDeviceSharingSettings1)
|
|
67
|
+
* Updates the sharing settings for a cargo by device tracking dataset. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, order_creator_org_operators] | (CargoByDeviceSharingSettingsUpdateReq) -> (CargoByDeviceSharingSettings1)
|
|
68
68
|
*
|
|
69
69
|
* @param {Chrt.tracking.CargoByDeviceSharingSettingsUpdateReq} request
|
|
70
70
|
* @param {SharingSettings.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class SharingSettings {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Updates the sharing settings for a task group by driver tracking dataset. | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | (TaskGroupByDriverSharingSettingsUpdateReq) -> (TaskGroupByDriverSharingSettings1)
|
|
59
|
+
* Updates the sharing settings for a task group by driver tracking dataset. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | (TaskGroupByDriverSharingSettingsUpdateReq) -> (TaskGroupByDriverSharingSettings1)
|
|
60
60
|
*
|
|
61
61
|
* @param {Chrt.tracking.TaskGroupByDriverSharingSettingsUpdateReq} request
|
|
62
62
|
* @param {SharingSettings.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -124,7 +124,7 @@ class SharingSettings {
|
|
|
124
124
|
});
|
|
125
125
|
}
|
|
126
126
|
/**
|
|
127
|
-
* Updates the sharing settings for a cargo by driver tracking dataset. | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | (CargoByDriverSharingSettingsUpdateReq) -> (CargoByDriverSharingSettings1)
|
|
127
|
+
* Updates the sharing settings for a cargo by driver tracking dataset. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | (CargoByDriverSharingSettingsUpdateReq) -> (CargoByDriverSharingSettings1)
|
|
128
128
|
*
|
|
129
129
|
* @param {Chrt.tracking.CargoByDriverSharingSettingsUpdateReq} request
|
|
130
130
|
* @param {SharingSettings.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -190,7 +190,7 @@ class SharingSettings {
|
|
|
190
190
|
});
|
|
191
191
|
}
|
|
192
192
|
/**
|
|
193
|
-
* Updates the sharing settings for a cargo by device tracking dataset. | authz_personas=[coordinator_org_operators, shipper_org_operators, order_creator_org_operators] | (CargoByDeviceSharingSettingsUpdateReq) -> (CargoByDeviceSharingSettings1)
|
|
193
|
+
* Updates the sharing settings for a cargo by device tracking dataset. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, order_creator_org_operators] | (CargoByDeviceSharingSettingsUpdateReq) -> (CargoByDeviceSharingSettings1)
|
|
194
194
|
*
|
|
195
195
|
* @param {Chrt.tracking.CargoByDeviceSharingSettingsUpdateReq} request
|
|
196
196
|
* @param {SharingSettings.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,7 +31,7 @@ export declare class CargoByDevice {
|
|
|
31
31
|
protected readonly _options: CargoByDevice.Options;
|
|
32
32
|
constructor(_options?: CargoByDevice.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Returns the last seen data point for cargo within a task group. Access granted to the order's coordinator/shipper/executor org or the assigned driver, or via public sharing. | () -> (CargoByDeviceDataPoint1 | None)
|
|
34
|
+
* Returns the last seen data point for cargo within a task group. Access granted to the order's coordinator/shipper/executor org or the assigned driver, or via public sharing. | auth: api_key | () -> (CargoByDeviceDataPoint1 | None)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.tracking.timeseries.CargoByDeviceLastSeenV1Request} request
|
|
37
37
|
* @param {CargoByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -47,7 +47,7 @@ export declare class CargoByDevice {
|
|
|
47
47
|
lastSeenV1(request: Chrt.tracking.timeseries.CargoByDeviceLastSeenV1Request, requestOptions?: CargoByDevice.RequestOptions): core.HttpResponsePromise<(Chrt.CargoByDeviceDataPoint1 | null) | undefined>;
|
|
48
48
|
private __lastSeenV1;
|
|
49
49
|
/**
|
|
50
|
-
* Returns up to the specified number of data points for a cargo within a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[CargoByDeviceDataPoint1])
|
|
50
|
+
* Returns up to the specified number of data points for a cargo within a task group, intelligently sampled across the time range. Excludes outliers. | auth: api_key | () -> (list[CargoByDeviceDataPoint1])
|
|
51
51
|
*
|
|
52
52
|
* @param {Chrt.tracking.timeseries.CargoByDeviceDataPointsV1Request} request
|
|
53
53
|
* @param {CargoByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -64,7 +64,7 @@ export declare class CargoByDevice {
|
|
|
64
64
|
dataPointsV1(request: Chrt.tracking.timeseries.CargoByDeviceDataPointsV1Request, requestOptions?: CargoByDevice.RequestOptions): core.HttpResponsePromise<Chrt.CargoByDeviceDataPoint1[]>;
|
|
65
65
|
private __dataPointsV1;
|
|
66
66
|
/**
|
|
67
|
-
* Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (CargoByDeviceMarkOutliersRequest1) -> (CargoByDeviceMarkOutliersResponse1)
|
|
67
|
+
* Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | auth: api_key | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (CargoByDeviceMarkOutliersRequest1) -> (CargoByDeviceMarkOutliersResponse1)
|
|
68
68
|
*
|
|
69
69
|
* @param {Chrt.tracking.timeseries.CargoByDeviceMarkOutliersRequest1} request
|
|
70
70
|
* @param {CargoByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class CargoByDevice {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Returns the last seen data point for cargo within a task group. Access granted to the order's coordinator/shipper/executor org or the assigned driver, or via public sharing. | () -> (CargoByDeviceDataPoint1 | None)
|
|
59
|
+
* Returns the last seen data point for cargo within a task group. Access granted to the order's coordinator/shipper/executor org or the assigned driver, or via public sharing. | auth: api_key | () -> (CargoByDeviceDataPoint1 | None)
|
|
60
60
|
*
|
|
61
61
|
* @param {Chrt.tracking.timeseries.CargoByDeviceLastSeenV1Request} request
|
|
62
62
|
* @param {CargoByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -125,7 +125,7 @@ class CargoByDevice {
|
|
|
125
125
|
});
|
|
126
126
|
}
|
|
127
127
|
/**
|
|
128
|
-
* Returns up to the specified number of data points for a cargo within a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[CargoByDeviceDataPoint1])
|
|
128
|
+
* Returns up to the specified number of data points for a cargo within a task group, intelligently sampled across the time range. Excludes outliers. | auth: api_key | () -> (list[CargoByDeviceDataPoint1])
|
|
129
129
|
*
|
|
130
130
|
* @param {Chrt.tracking.timeseries.CargoByDeviceDataPointsV1Request} request
|
|
131
131
|
* @param {CargoByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -195,7 +195,7 @@ class CargoByDevice {
|
|
|
195
195
|
});
|
|
196
196
|
}
|
|
197
197
|
/**
|
|
198
|
-
* Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (CargoByDeviceMarkOutliersRequest1) -> (CargoByDeviceMarkOutliersResponse1)
|
|
198
|
+
* Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | auth: api_key | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (CargoByDeviceMarkOutliersRequest1) -> (CargoByDeviceMarkOutliersResponse1)
|
|
199
199
|
*
|
|
200
200
|
* @param {Chrt.tracking.timeseries.CargoByDeviceMarkOutliersRequest1} request
|
|
201
201
|
* @param {CargoByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,7 +31,7 @@ export declare class CargoByDriver {
|
|
|
31
31
|
protected readonly _options: CargoByDriver.Options;
|
|
32
32
|
constructor(_options?: CargoByDriver.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Returns the most recent driver location data point for cargo within a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (CargoByDriverDataPoint1 | None)
|
|
34
|
+
* Returns the most recent driver location data point for cargo within a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | auth: api_key | () -> (CargoByDriverDataPoint1 | None)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.tracking.timeseries.CargoByDriverLastSeenV1Request} request
|
|
37
37
|
* @param {CargoByDriver.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -47,7 +47,7 @@ export declare class CargoByDriver {
|
|
|
47
47
|
lastSeenV1(request: Chrt.tracking.timeseries.CargoByDriverLastSeenV1Request, requestOptions?: CargoByDriver.RequestOptions): core.HttpResponsePromise<(Chrt.CargoByDriverDataPoint1 | null) | undefined>;
|
|
48
48
|
private __lastSeenV1;
|
|
49
49
|
/**
|
|
50
|
-
* Returns up to the specified number of data points for a cargo within a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[CargoByDriverDataPoint1])
|
|
50
|
+
* Returns up to the specified number of data points for a cargo within a task group, intelligently sampled across the time range. Excludes outliers. | auth: api_key | () -> (list[CargoByDriverDataPoint1])
|
|
51
51
|
*
|
|
52
52
|
* @param {Chrt.tracking.timeseries.CargoByDriverDataPointsV1Request} request
|
|
53
53
|
* @param {CargoByDriver.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class CargoByDriver {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Returns the most recent driver location data point for cargo within a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (CargoByDriverDataPoint1 | None)
|
|
59
|
+
* Returns the most recent driver location data point for cargo within a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | auth: api_key | () -> (CargoByDriverDataPoint1 | None)
|
|
60
60
|
*
|
|
61
61
|
* @param {Chrt.tracking.timeseries.CargoByDriverLastSeenV1Request} request
|
|
62
62
|
* @param {CargoByDriver.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -125,7 +125,7 @@ class CargoByDriver {
|
|
|
125
125
|
});
|
|
126
126
|
}
|
|
127
127
|
/**
|
|
128
|
-
* Returns up to the specified number of data points for a cargo within a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[CargoByDriverDataPoint1])
|
|
128
|
+
* Returns up to the specified number of data points for a cargo within a task group, intelligently sampled across the time range. Excludes outliers. | auth: api_key | () -> (list[CargoByDriverDataPoint1])
|
|
129
129
|
*
|
|
130
130
|
* @param {Chrt.tracking.timeseries.CargoByDriverDataPointsV1Request} request
|
|
131
131
|
* @param {CargoByDriver.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -64,7 +64,7 @@ export declare class SessionByDevice {
|
|
|
64
64
|
dataPointsV1(request: Chrt.tracking.timeseries.SessionByDeviceDataPointsV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.SessionByDeviceHistoryRes1>;
|
|
65
65
|
private __dataPointsV1;
|
|
66
66
|
/**
|
|
67
|
-
* Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | (SessionByDeviceMarkOutliersRequest1) -> (SessionByDeviceMarkOutliersResponse1)
|
|
67
|
+
* Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | auth: api_key | (SessionByDeviceMarkOutliersRequest1) -> (SessionByDeviceMarkOutliersResponse1)
|
|
68
68
|
*
|
|
69
69
|
* @param {Chrt.tracking.timeseries.SessionByDeviceMarkOutliersRequest1} request
|
|
70
70
|
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -195,7 +195,7 @@ class SessionByDevice {
|
|
|
195
195
|
});
|
|
196
196
|
}
|
|
197
197
|
/**
|
|
198
|
-
* Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | (SessionByDeviceMarkOutliersRequest1) -> (SessionByDeviceMarkOutliersResponse1)
|
|
198
|
+
* Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | auth: api_key | (SessionByDeviceMarkOutliersRequest1) -> (SessionByDeviceMarkOutliersResponse1)
|
|
199
199
|
*
|
|
200
200
|
* @param {Chrt.tracking.timeseries.SessionByDeviceMarkOutliersRequest1} request
|
|
201
201
|
* @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,7 +31,7 @@ export declare class TaskGroupByDriver {
|
|
|
31
31
|
protected readonly _options: TaskGroupByDriver.Options;
|
|
32
32
|
constructor(_options?: TaskGroupByDriver.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Returns the most recent driver location data point for a task group. | authz_personas=[
|
|
34
|
+
* Returns the most recent driver location data point for a task group. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | () -> (TaskGroupByDriverDataPoint1 | None)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.tracking.timeseries.TaskGroupByDriverLastSeenV1Request} request
|
|
37
37
|
* @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -46,7 +46,7 @@ export declare class TaskGroupByDriver {
|
|
|
46
46
|
lastSeenV1(request: Chrt.tracking.timeseries.TaskGroupByDriverLastSeenV1Request, requestOptions?: TaskGroupByDriver.RequestOptions): core.HttpResponsePromise<(Chrt.TaskGroupByDriverDataPoint1 | null) | undefined>;
|
|
47
47
|
private __lastSeenV1;
|
|
48
48
|
/**
|
|
49
|
-
* Returns sampled driver location data points for a task group. Excludes outliers. | authz_personas=[
|
|
49
|
+
* Returns sampled driver location data points for a task group. Excludes outliers. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | () -> (list[TaskGroupByDriverDataPoint1])
|
|
50
50
|
*
|
|
51
51
|
* @param {Chrt.tracking.timeseries.TaskGroupByDriverDataPointsV1Request} request
|
|
52
52
|
* @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class TaskGroupByDriver {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Returns the most recent driver location data point for a task group. | authz_personas=[
|
|
59
|
+
* Returns the most recent driver location data point for a task group. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | () -> (TaskGroupByDriverDataPoint1 | None)
|
|
60
60
|
*
|
|
61
61
|
* @param {Chrt.tracking.timeseries.TaskGroupByDriverLastSeenV1Request} request
|
|
62
62
|
* @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -123,7 +123,7 @@ class TaskGroupByDriver {
|
|
|
123
123
|
});
|
|
124
124
|
}
|
|
125
125
|
/**
|
|
126
|
-
* Returns sampled driver location data points for a task group. Excludes outliers. | authz_personas=[
|
|
126
|
+
* Returns sampled driver location data points for a task group. Excludes outliers. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | () -> (list[TaskGroupByDriverDataPoint1])
|
|
127
127
|
*
|
|
128
128
|
* @param {Chrt.tracking.timeseries.TaskGroupByDriverDataPointsV1Request} request
|
|
129
129
|
* @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export interface ListingListingDriverInvitedToBidWebhookPayload {
|
|
5
|
+
event_type?: "listing.listing.driver_invited_to_bid";
|
|
6
|
+
/** UTC timestamp when the event occurred */
|
|
7
|
+
event_timestamp: string;
|
|
8
|
+
/** The listing the driver was invited to */
|
|
9
|
+
listing_id: string;
|
|
10
|
+
/** The order associated with the listing */
|
|
11
|
+
order_id: string;
|
|
12
|
+
/** The task group associated with the listing */
|
|
13
|
+
task_group_id: string;
|
|
14
|
+
/** Drivers invited to the listing */
|
|
15
|
+
driver_ids: string[];
|
|
16
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export interface ListingListingProviderInvitedToBidWebhookPayload {
|
|
5
|
+
event_type?: "listing.listing.provider_invited_to_bid";
|
|
6
|
+
/** UTC timestamp when the event occurred */
|
|
7
|
+
event_timestamp: string;
|
|
8
|
+
/** The listing the provider org was invited to */
|
|
9
|
+
listing_id: string;
|
|
10
|
+
/** The order associated with the listing */
|
|
11
|
+
order_id: string;
|
|
12
|
+
/** The task group associated with the listing */
|
|
13
|
+
task_group_id: string;
|
|
14
|
+
/** Provider orgs invited to the listing */
|
|
15
|
+
provider_org_ids: string[];
|
|
16
|
+
}
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* Controlled by Groups that admins configure.
|
|
7
7
|
* Individual users in the group can opt out.
|
|
8
8
|
*/
|
|
9
|
-
export type NotificationEventsForOrgsEnum = "shipping.order.staged" | "shipping.order.completed" | "shipping.order.cancelled" | "shipping.task_group.courier_org_assigned" | "shipping.task_group.in_progress" | "shipping.task_group.file_added" | "shipping.task_group.driver_assigned" | "shipping.task_group.message" | "shipping.task_group.tasks_ordering_updated" | "shipping.task_group.flight_info_updated" | "shipping.task.added" | "shipping.task.completed" | "shipping.task.skipped" | "shipping.task.deleted" | "shipping.task.task_artifact_completed" | "billing.statement.opened" | "billing.statement.paid" | "billing.line_item_group.message" | "billing.line_item_group.file_added";
|
|
9
|
+
export type NotificationEventsForOrgsEnum = "shipping.order.staged" | "shipping.order.completed" | "shipping.order.cancelled" | "shipping.task_group.courier_org_assigned" | "shipping.task_group.in_progress" | "shipping.task_group.file_added" | "shipping.task_group.driver_assigned" | "shipping.task_group.message" | "shipping.task_group.tasks_ordering_updated" | "shipping.task_group.flight_info_updated" | "shipping.task.added" | "shipping.task.completed" | "shipping.task.skipped" | "shipping.task.deleted" | "shipping.task.task_artifact_completed" | "listing.listing.driver_invited_to_bid" | "listing.listing.provider_invited_to_bid" | "operations.case.operator_assigned" | "operations.case.group_assigned" | "billing.statement.opened" | "billing.statement.paid" | "billing.line_item_group.message" | "billing.line_item_group.file_added";
|
|
10
10
|
export declare const NotificationEventsForOrgsEnum: {
|
|
11
11
|
readonly ShippingOrderStaged: "shipping.order.staged";
|
|
12
12
|
readonly ShippingOrderCompleted: "shipping.order.completed";
|
|
@@ -23,6 +23,10 @@ export declare const NotificationEventsForOrgsEnum: {
|
|
|
23
23
|
readonly ShippingTaskSkipped: "shipping.task.skipped";
|
|
24
24
|
readonly ShippingTaskDeleted: "shipping.task.deleted";
|
|
25
25
|
readonly ShippingTaskTaskArtifactCompleted: "shipping.task.task_artifact_completed";
|
|
26
|
+
readonly ListingListingDriverInvitedToBid: "listing.listing.driver_invited_to_bid";
|
|
27
|
+
readonly ListingListingProviderInvitedToBid: "listing.listing.provider_invited_to_bid";
|
|
28
|
+
readonly OperationsCaseOperatorAssigned: "operations.case.operator_assigned";
|
|
29
|
+
readonly OperationsCaseGroupAssigned: "operations.case.group_assigned";
|
|
26
30
|
readonly BillingStatementOpened: "billing.statement.opened";
|
|
27
31
|
readonly BillingStatementPaid: "billing.statement.paid";
|
|
28
32
|
readonly BillingLineItemGroupMessage: "billing.line_item_group.message";
|
|
@@ -20,6 +20,10 @@ exports.NotificationEventsForOrgsEnum = {
|
|
|
20
20
|
ShippingTaskSkipped: "shipping.task.skipped",
|
|
21
21
|
ShippingTaskDeleted: "shipping.task.deleted",
|
|
22
22
|
ShippingTaskTaskArtifactCompleted: "shipping.task.task_artifact_completed",
|
|
23
|
+
ListingListingDriverInvitedToBid: "listing.listing.driver_invited_to_bid",
|
|
24
|
+
ListingListingProviderInvitedToBid: "listing.listing.provider_invited_to_bid",
|
|
25
|
+
OperationsCaseOperatorAssigned: "operations.case.operator_assigned",
|
|
26
|
+
OperationsCaseGroupAssigned: "operations.case.group_assigned",
|
|
23
27
|
BillingStatementOpened: "billing.statement.opened",
|
|
24
28
|
BillingStatementPaid: "billing.statement.paid",
|
|
25
29
|
BillingLineItemGroupMessage: "billing.line_item_group.message",
|