@chrt-inc/typescript-sdk 1.1023.0 → 1.1024.0

package/reference.md

@@ -2,7 +2,7 @@
 
 ## ChrtGpt
 
-<details><summary><code>client.chrtGpt.<a href="/src/api/resources/chrtGpt/client/Client.ts">messageV1</a>({ ...params }) -> Chrt.ChrtGptMessageRes</code></summary>
+<details><summary><code>client.chrtGpt.<a href="/src/api/resources/chrtGpt/client/Client.ts">postV1</a>({ ...params }) -> core.Stream&lt;Chrt.ChrtGptEvent&gt;</code></summary>
 <dl>
 <dd>
 
@@ -14,7 +14,7 @@
 <dl>
 <dd>
 
-Sends a message to ChrtGPT and returns its reply, starting a new conversation when no conversation_id is given. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (ChrtGPTMessageReq) -> (ChrtGPTMessageRes)
+Sends a message to ChrtGPT and streams its reply, starting and titling a new conversation when no conversation_id is given. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (ChrtGPTReq) -> (stream[ChrtGPTEvent])
 
 </dd>
 </dl>
@@ -30,9 +30,12 @@ Sends a message to ChrtGPT and returns its reply, starting a new conversation wh
 <dd>
 
 ```typescript
-await client.chrtGpt.messageV1({
+const response = await client.chrtGpt.postV1({
     message: "message",
 });
+for await (const item of response) {
+    console.log(item);
+}
 ```
 
 </dd>
@@ -48,7 +51,7 @@ await client.chrtGpt.messageV1({
 <dl>
 <dd>
 
-**request:** `Chrt.ChrtGptMessageReq`
+**request:** `Chrt.ChrtGptReq`
 
 </dd>
 </dl>
@@ -5198,6 +5201,139 @@ await client.cargoOnFlightIntegrations.cargoai.searchV1("cargo_on_flight_booking
 </dl>
 </details>
 
+## ChrtGpt Conversations
+
+<details><summary><code>client.chrtGpt.conversations.<a href="/src/api/resources/chrtGpt/resources/conversations/client/Client.ts">listV1</a>({ ...params }) -> Chrt.ChrtGptConversationListRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists the caller's ChrtGPT conversations, most recently active first by default. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | () -> (ChrtGPTConversationListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.chrtGpt.conversations.listV1({
+    sort_by: "updated_at",
+    sort_order: "asc",
+    page: 1,
+    page_size: 1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.chrtGpt.ConversationsListV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Conversations.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.chrtGpt.conversations.<a href="/src/api/resources/chrtGpt/resources/conversations/client/Client.ts">getV1</a>(conversationId) -> Chrt.ChrtGptConversationRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Gets one of the caller's ChrtGPT conversations with its history of messages, tool calls, and web searches. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | () -> (ChrtGPTConversationRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.chrtGpt.conversations.getV1("conversation_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**conversationId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Conversations.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Integrations AirWaybills
 
 <details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">confirmationsV1</a>(taskGroupId) -> Chrt.ChampConfirmationReceipt1[]</code></summary>
@@ -14337,6 +14473,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 +14580,7 @@ await client.orgs.connections.listShippersForCoordinatorV1({
     page_size: 1,
     filter_connection_ids: ["filter_connection_ids"],
     filter_connected: true,
+    filter_known_shipper: true,
 });
 ```
 
@@ -16462,6 +16672,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>