@chrt-inc/typescript-sdk 1.1020.0 → 1.1025.0

package/reference.md

@@ -14337,6 +14337,79 @@ await client.orgs.connections.setShipperCoordinatorDefaultDepartmentV1("connecti
 </dl>
 </details>
 
+<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">setShipperCoordinatorKnownShipperV1</a>(connectionId, { ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Sets the coordinator's known-shipper designation for an on- or off-CHRT shipper and records who changed it and when. | authz: allowed_org_types=[provider], min_org_role=operator | (ShipperCoordinatorUpdateKnownShipperReq) -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.connections.setShipperCoordinatorKnownShipperV1("connection_id", {
+    known_shipper: true,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**connectionId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.orgs.ShipperCoordinatorUpdateKnownShipperReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Connections.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listShippersForCoordinatorV1</a>({ ...params }) -> Chrt.ShipperCoordinatorConnectionsForCoordinatorListRes</code></summary>
 <dl>
 <dd>
@@ -14371,6 +14444,7 @@ await client.orgs.connections.listShippersForCoordinatorV1({
     page_size: 1,
     filter_connection_ids: ["filter_connection_ids"],
     filter_connected: true,
+    filter_known_shipper: true,
 });
 ```
 
@@ -16462,6 +16536,262 @@ await client.orgs.connections.shippers.typeaheadV1({
 </dl>
 </details>
 
+## Orgs PublicData S3Object
+
+<details><summary><code>client.orgs.publicData.s3Object.<a href="/src/api/resources/orgs/resources/publicData/resources/s3Object/client/Client.ts">addV1</a>({ ...params }) -> Chrt.OrgPublicDataS3ObjectMetadata1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Uploads a file, such as a logo, to the caller's organization public data. Retains uploaded files; previews require a clean malware scan. | authz: min_org_role=operator | (UploadFile) -> (OrgPublicDataS3ObjectMetadata1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.publicData.s3Object.addV1({
+    file: fs.createReadStream("/path/to/your/file"),
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.orgs.publicData.BodyPostOrgPublicDataS3ObjectAddV1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `S3Object.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.publicData.s3Object.<a href="/src/api/resources/orgs/resources/publicData/resources/s3Object/client/Client.ts">deleteV1</a>(orgPublicDataS3ObjectMetadataId) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Deletes an S3 object and its metadata from the caller's organization public data. | authz: min_org_role=operator | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.publicData.s3Object.deleteV1("org_public_data_s3_object_metadata_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**orgPublicDataS3ObjectMetadataId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `S3Object.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.publicData.s3Object.<a href="/src/api/resources/orgs/resources/publicData/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(orgPublicDataS3ObjectMetadataId) -> Chrt.OrgPublicDataS3ObjectMetadata1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves metadata for an organization public data S3 object. | () -> (OrgPublicDataS3ObjectMetadata1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.publicData.s3Object.getS3ObjectMetadataV1("org_public_data_s3_object_metadata_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**orgPublicDataS3ObjectMetadataId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `S3Object.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.publicData.s3Object.<a href="/src/api/resources/orgs/resources/publicData/resources/s3Object/client/Client.ts">getV1</a>(orgPublicDataS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Streams an organization public data S3 object file from storage. | () -> (binary)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.publicData.s3Object.getV1("org_public_data_s3_object_metadata_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**orgPublicDataS3ObjectMetadataId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `S3Object.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Shipping CargoOnFlightAirWaybills
 
 <details><summary><code>client.shipping.cargoOnFlightAirWaybills.<a href="/src/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/Client.ts">createV1</a>({ ...params }) -> Chrt.CargoOnFlightAirWaybill1</code></summary>
@@ -33592,7 +33922,7 @@ await client.shippingIntegrations.xcelerator.orders.typeaheadV1({
 <dl>
 <dd>
 
-Archives a device by setting archived=True. Device must not have an active session — terminate it first. | auth: api_key | () -> (bool)
+Archives a device without an active session or cargo. Terminate or unlink tracking first. | auth: api_key | () -> (bool)
 
 </dd>
 </dl>
@@ -33645,6 +33975,71 @@ await client.tracking.devices.archiveV1({
 </dl>
 </details>
 
+<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">forCargoV1</a>({ ...params }) -> Chrt.DeviceForCargoRes[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists devices currently or previously linked to a cargo, ordered by MAC address. Access follows the cargo's order. | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | () -> (list[DeviceForCargoRes])
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.devices.forCargoV1({
+    cargo_id: "cargo_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.DevicesForCargoV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Devices.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">getV1</a>({ ...params }) -> Chrt.DeviceExpandedRes</code></summary>
 <dl>
 <dd>
@@ -33710,6 +34105,72 @@ await client.tracking.devices.getV1({
 </dl>
 </details>
 
+<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">linkToCargoV1</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Links an owned device to cargo and activates its tracker. Relinking the same cargo reactivates a stopped tracker. | authz: min_org_role=operator | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators] | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.devices.linkToCargoV1({
+    device_id: "device_id",
+    cargo_id: "cargo_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.DevicesLinkToCargoV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Devices.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DeviceListRes</code></summary>
 <dl>
 <dd>
@@ -33993,6 +34454,71 @@ await client.tracking.devices.typeaheadV1({
 </dl>
 </details>
 
+<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">unlinkFromCargoV1</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Unlinks an owned device from its cargo and deactivates its tracker. Returns false when the device is not linked to cargo. | authz: min_org_role=operator | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.devices.unlinkFromCargoV1({
+    device_id: "device_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.DevicesUnlinkFromCargoV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Devices.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">unpauseV1</a>({ ...params }) -> boolean</code></summary>
 <dl>
 <dd>