@chrt-inc/typescript-sdk 1.675.0 → 1.681.0

package/reference.md

@@ -15263,7 +15263,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
 <dl>
 <dd>
 
-Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or RECOVER_FROM_AIRLINE tasks. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators, shipper_org_operators] | () -> (FlightInfoForTaskRes)
+Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or RECOVER_FROM_AIRLINE tasks. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (FlightInfoForTaskRes)
 
 </dd>
 </dl>
@@ -15328,7 +15328,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
 <dl>
 <dd>
 
-Adds a new task artifact to a task. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | (AddTaskArtifactReq) -> (PydanticObjectId)
+Adds a new task artifact to a task. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | (AddTaskArtifactReq) -> (PydanticObjectId)
 
 </dd>
 </dl>
@@ -15405,7 +15405,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
 <dl>
 <dd>
 
-Marks a task artifact as COMPLETED. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | () -> (bool)
+Marks a task artifact as COMPLETED. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
 
 </dd>
 </dl>
@@ -15468,7 +15468,7 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
 <dl>
 <dd>
 
-Marks a task artifact as SKIPPED. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | () -> (bool)
+Marks a task artifact as SKIPPED. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
 
 </dd>
 </dl>
@@ -17252,7 +17252,7 @@ await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
 <dl>
 <dd>
 
-Adds a message to a task group's message log. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (AddMessageReq) -> (bool)
+Adds a message to a task group's message log. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators, shipper_org_operators] | (AddMessageReq) -> (bool)
 
 </dd>
 </dl>
@@ -18506,7 +18506,7 @@ await client.shipping.tasks.updateV1("task_id", {});
 <dl>
 <dd>
 
-Marks a task as COMPLETED. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators] (depending on type) | () -> (bool)
+Marks a task as COMPLETED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
 
 </dd>
 </dl>
@@ -18569,7 +18569,7 @@ await client.shipping.tasks.completeV1("task_id");
 <dl>
 <dd>
 
-Marks a task as SKIPPED. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators] (depending on type) | () -> (bool)
+Marks a task as SKIPPED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
 
 </dd>
 </dl>
@@ -18620,6 +18620,69 @@ await client.shipping.tasks.skipV1("task_id");
 </dl>
 </details>
 
+<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">attemptV1</a>(taskId) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Marks a task as ATTEMPT. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.tasks.attemptV1("task_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Tasks.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">deleteV1</a>(taskId) -> boolean</code></summary>
 <dl>
 <dd>
@@ -20438,7 +20501,7 @@ await client.shipping.orders.expanded.typeaheadV1({
 <dl>
 <dd>
 
-Retrieves the metadata for a task artifact S3 object, including blurhash for placeholder loading. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (TaskArtifactS3ObjectMetadata1)
+Retrieves the metadata for a task artifact S3 object, including blurhash for placeholder loading. | authz_personas=[driver_for_executor, executor_org_operators, shipper_org_operators, coordinator_org_operators] | () -> (TaskArtifactS3ObjectMetadata1)
 
 </dd>
 </dl>
@@ -20501,7 +20564,7 @@ await client.shipping.taskArtifacts.s3Object.getS3ObjectMetadataV1("task_artifac
 <dl>
 <dd>
 
-Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)
+Streams a task artifact S3 object file from storage. | authz_personas=[driver_for_executor, executor_org_operators, shipper_org_operators, coordinator_org_operators] | () -> (binary)
 
 </dd>
 </dl>
@@ -20564,7 +20627,7 @@ await client.shipping.taskArtifacts.s3Object.getV1("task_artifact_s3_object_meta
 <dl>
 <dd>
 
-Uploads a file (image, PDF, etc.) to a task artifact. Automatic blurhash generation for images. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
+Uploads a file (image, PDF, etc.) to a task artifact. Automatic blurhash generation for images. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
 
 </dd>
 </dl>
@@ -20956,7 +21019,7 @@ await client.shipping.taskGroups.s3Object.getV1("task_group_s3_object_metadata_i
 <dl>
 <dd>
 
-Uploads a file (image, PDF, etc.) to a task group. Automatic blurhash generation for images. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
+Uploads a file (image, PDF, etc.) to a task group. Automatic blurhash generation for images. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
 
 </dd>
 </dl>
@@ -21605,6 +21668,81 @@ await client.shipping.taskGroups.expanded.typeaheadV1({
 </dl>
 </details>
 
+## Shipping Tasks ExecutorOrgNotes
+
+<details><summary><code>client.shipping.tasks.executorOrgNotes.<a href="/src/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/Client.ts">addV1</a>(taskId, { ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Adds an executor-side note to a task. | authz_personas=[driver_for_executor, executor_org_operators] | (AddExecutorOrgNoteReq) -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.tasks.executorOrgNotes.addV1("task_id", {
+    note: "note",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shipping.tasks.AddExecutorOrgNoteReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ExecutorOrgNotes.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Tracking Devices
 
 <details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">registerToOrgV1</a>({ ...params }) -> string</code></summary>
@@ -21685,7 +21823,7 @@ await client.tracking.devices.registerToOrgV1({
 <dl>
 <dd>
 
-Updates a device's type, comments, and/or off_chrt_reference_id. Use \_\_set_to_None flags to explicitly clear Optional fields. | (DeviceClientUpdate1) -> (bool)
+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)
 
 </dd>
 </dl>
@@ -21750,7 +21888,7 @@ await client.tracking.devices.updateV1({
 <dl>
 <dd>
 
-Archives a device by setting archived=True. Device must not have an active session — terminate it first. | () -> (bool)
+Archives a device by setting archived=True. Device must not have an active session — terminate it first. | auth: api_key | () -> (bool)
 
 </dd>
 </dl>
@@ -21815,7 +21953,7 @@ await client.tracking.devices.archiveV1({
 <dl>
 <dd>
 
-Pauses a device and opens a new pause time window. | () -> (bool)
+Pauses a device and opens a new pause time window. | auth: api_key | () -> (bool)
 
 </dd>
 </dl>
@@ -21880,7 +22018,7 @@ await client.tracking.devices.pauseV1({
 <dl>
 <dd>
 
-Unpauses a device. Closes the open pause time window. | () -> (bool)
+Unpauses a device. Closes the open pause time window. | auth: api_key | () -> (bool)
 
 </dd>
 </dl>
@@ -21945,7 +22083,7 @@ await client.tracking.devices.unpauseV1({
 <dl>
 <dd>
 
-Adds and/or removes org_ids from a device's shared_with_org_ids list. Removal overrides addition. | (DevicesUpdateSharedOrgsReq1) -> (bool)
+Adds and/or removes org_ids from a device's shared_with_org_ids list. Removal overrides addition. | auth: api_key | (DevicesUpdateSharedOrgsReq1) -> (bool)
 
 </dd>
 </dl>
@@ -22010,7 +22148,7 @@ await client.tracking.devices.updateSharedOrgsV1({
 <dl>
 <dd>
 
-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)
+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)
 
 </dd>
 </dl>
@@ -22075,7 +22213,7 @@ await client.tracking.devices.getV1({
 <dl>
 <dd>
 
-Lists devices with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (DeviceListRes)
+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)
 
 </dd>
 </dl>
@@ -22158,7 +22296,7 @@ await client.tracking.devices.listV1({
 <dl>
 <dd>
 
-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])
+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])
 
 </dd>
 </dl>
@@ -22227,7 +22365,7 @@ await client.tracking.devices.typeaheadV1({
 <dl>
 <dd>
 
-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)
+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)
 
 </dd>
 </dl>
@@ -22585,7 +22723,7 @@ await client.tracking.sessions.createSessionV1({
 <dl>
 <dd>
 
-Updates a session's metadata. | (SessionClientUpdate1) -> (bool)
+Updates a session's metadata. | auth: api_key | (SessionClientUpdate1) -> (bool)
 
 </dd>
 </dl>
@@ -22650,7 +22788,7 @@ await client.tracking.sessions.updateV1({
 <dl>
 <dd>
 
-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)
+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)
 
 </dd>
 </dl>
@@ -22715,7 +22853,7 @@ await client.tracking.sessions.updateSharedOrgsV1({
 <dl>
 <dd>
 
-Terminates a session. Moves device.active_session_id to device.past_session_ids. | () -> (bool)
+Terminates a session. Moves device.active_session_id to device.past_session_ids. | auth: api_key | () -> (bool)
 
 </dd>
 </dl>
@@ -22780,7 +22918,7 @@ await client.tracking.sessions.terminateV1({
 <dl>
 <dd>
 
-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)
+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)
 
 </dd>
 </dl>
@@ -22847,7 +22985,7 @@ await client.tracking.sessions.addFlightV1({
 <dl>
 <dd>
 
-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)
+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)
 
 </dd>
 </dl>
@@ -22914,7 +23052,7 @@ await client.tracking.sessions.removeFlightV1({
 <dl>
 <dd>
 
-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)
+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)
 
 </dd>
 </dl>
@@ -22981,7 +23119,7 @@ await client.tracking.sessions.syncFlightStatusV1({
 <dl>
 <dd>
 
-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)
+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)
 
 </dd>
 </dl>
@@ -23047,7 +23185,7 @@ await client.tracking.sharingSettings.taskGroupByDriverSharingSettingsV1({
 <dl>
 <dd>
 
-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)
+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)
 
 </dd>
 </dl>
@@ -23114,7 +23252,7 @@ await client.tracking.sharingSettings.cargoByDriverSettingsV1({
 <dl>
 <dd>
 
-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)
+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)
 
 </dd>
 </dl>
@@ -23247,7 +23385,7 @@ await client.tracking.sharingSettings.getSettingsV1("order_ref");
 <dl>
 <dd>
 
-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)
+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)
 
 </dd>
 </dl>
@@ -23313,7 +23451,7 @@ await client.tracking.timeseries.cargoByDevice.lastSeenV1({
 <dl>
 <dd>
 
-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])
+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])
 
 </dd>
 </dl>
@@ -23380,7 +23518,7 @@ await client.tracking.timeseries.cargoByDevice.dataPointsV1({
 <dl>
 <dd>
 
-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)
+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)
 
 </dd>
 </dl>
@@ -23581,7 +23719,7 @@ await client.tracking.timeseries.cargoByDevice.dataPointsPublicV1({
 <dl>
 <dd>
 
-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)
+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)
 
 </dd>
 </dl>
@@ -23647,7 +23785,7 @@ await client.tracking.timeseries.cargoByDriver.lastSeenV1({
 <dl>
 <dd>
 
-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])
+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])
 
 </dd>
 </dl>
@@ -23982,7 +24120,7 @@ await client.tracking.timeseries.sessionByDevice.dataPointsV1({
 <dl>
 <dd>
 
-Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | (SessionByDeviceMarkOutliersRequest1) -> (SessionByDeviceMarkOutliersResponse1)
+Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | auth: api_key | (SessionByDeviceMarkOutliersRequest1) -> (SessionByDeviceMarkOutliersResponse1)
 
 </dd>
 </dl>
@@ -24183,7 +24321,7 @@ await client.tracking.timeseries.sessionByDevice.dataPointsPublicV1({
 <dl>
 <dd>
 
-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)
+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)
 
 </dd>
 </dl>
@@ -24248,7 +24386,7 @@ await client.tracking.timeseries.taskGroupByDriver.lastSeenV1({
 <dl>
 <dd>
 
-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])
+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])
 
 </dd>
 </dl>