@chrt-inc/typescript-sdk 1.746.0 → 1.751.0

package/reference.md

@@ -17510,6 +17510,69 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
 </dl>
 </details>
 
+<details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightLegsForTaskGroupV1</a>(taskGroupId) -> Chrt.FlightInfoForTaskRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns the ordered list of flight legs for a task group. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (FlightInfoForTaskRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.flights.getFlightLegsForTaskGroupV1("task_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Flights.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Shipping TaskArtifacts
 
 <details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">addToTaskV1</a>(taskId, { ...params }) -> string</code></summary>
@@ -18789,7 +18852,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
 <dl>
 <dd>
 
-Retrieves schedule metadata, generated order count, and live orchestrator status. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
+Retrieves the generated order count and live orchestrator status from Temporal. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
 
 </dd>
 </dl>
@@ -18840,75 +18903,7 @@ await client.shipping.orderSchedules.aboutV1("order_schedule_id");
 </dl>
 </details>
 
-<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">newV1</a>({ ...params }) -> string</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Creates a new draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientCreate1) -> (PydanticObjectId)
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.shipping.orderSchedules.newV1({
-    schema_version: 1,
-    name: "name",
-    order_manifest: {},
-    schedule_spec: {},
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Chrt.shipping.OrderScheduleClientCreate1`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `OrderSchedules.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">updateV1</a>(orderScheduleId, { ...params }) -> boolean</code></summary>
+<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">activateV1</a>(orderScheduleId) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -18920,7 +18915,7 @@ await client.shipping.orderSchedules.newV1({
 <dl>
 <dd>
 
-Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
+Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)
 
 </dd>
 </dl>
@@ -18936,7 +18931,7 @@ Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClient
 <dd>
 
 ```typescript
-await client.shipping.orderSchedules.updateV1("order_schedule_id");
+await client.shipping.orderSchedules.activateV1("order_schedule_id");
 ```
 
 </dd>
@@ -18960,14 +18955,6 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
 <dl>
 <dd>
 
-**request:** `Chrt.shipping.OrderScheduleClientUpdate1`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
 **requestOptions:** `OrderSchedules.RequestOptions`
 
 </dd>
@@ -18979,7 +18966,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
 </dl>
 </details>
 
-<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">takeOwnershipV1</a>(orderScheduleId) -> boolean</code></summary>
+<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">triggerV1</a>(orderScheduleId) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -18991,7 +18978,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
 <dl>
 <dd>
 
-Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
+Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
 
 </dd>
 </dl>
@@ -19007,7 +18994,7 @@ Transfers order schedule workflow ownership to the caller. | authz: min_org_role
 <dd>
 
 ```typescript
-await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
+await client.shipping.orderSchedules.triggerV1("order_schedule_id");
 ```
 
 </dd>
@@ -19042,7 +19029,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
 </dl>
 </details>
 
-<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">activateV1</a>(orderScheduleId) -> boolean</code></summary>
+<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">pauseV1</a>(orderScheduleId) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -19054,7 +19041,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
 <dl>
 <dd>
 
-Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)
+Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
 
 </dd>
 </dl>
@@ -19070,7 +19057,7 @@ Validates a draft order schedule, creates its Temporal orchestrator schedule, an
 <dd>
 
 ```typescript
-await client.shipping.orderSchedules.activateV1("order_schedule_id");
+await client.shipping.orderSchedules.pauseV1("order_schedule_id");
 ```
 
 </dd>
@@ -19168,7 +19155,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
 </dl>
 </details>
 
-<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">pauseV1</a>(orderScheduleId) -> boolean</code></summary>
+<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">takeOwnershipV1</a>(orderScheduleId) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -19180,7 +19167,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
 <dl>
 <dd>
 
-Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
+Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
 
 </dd>
 </dl>
@@ -19196,7 +19183,7 @@ Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
 <dd>
 
 ```typescript
-await client.shipping.orderSchedules.pauseV1("order_schedule_id");
+await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
 ```
 
 </dd>
@@ -19243,7 +19230,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
 <dl>
 <dd>
 
-Archives an order schedule and prevents future runs. | authz: min_org_role=operator | () -> (bool)
+Archives an order schedule and deletes its Temporal schedule, preventing future runs. | authz: min_org_role=operator | () -> (bool)
 
 </dd>
 </dl>
@@ -19294,7 +19281,7 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
 </dl>
 </details>
 
-<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">triggerV1</a>(orderScheduleId) -> boolean</code></summary>
+<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">syncWithOrchestratorV1</a>(orderScheduleId) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -19306,7 +19293,7 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
 <dl>
 <dd>
 
-Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
+Re-syncs the Temporal schedule to match the order schedule's intended status. | authz: min_org_role=operator | () -> (bool)
 
 </dd>
 </dl>
@@ -19322,7 +19309,7 @@ Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (
 <dd>
 
 ```typescript
-await client.shipping.orderSchedules.triggerV1("order_schedule_id");
+await client.shipping.orderSchedules.syncWithOrchestratorV1("order_schedule_id");
 ```
 
 </dd>
@@ -20445,7 +20432,7 @@ await client.shipping.taskGroups.removeExecutorV1("task_group_id");
 <dl>
 <dd>
 
-Sets the flight number and/or fa_flight_ids on a task group. | authz_personas=[lig_owner_operators] | (SetFlightInfoReq) -> (bool)
+Replaces the ordered list of flights on a task group. | authz_personas=[lig_owner_operators] | (SetFlightInfoReq) -> (bool)
 
 </dd>
 </dl>
@@ -20461,7 +20448,15 @@ Sets the flight number and/or fa_flight_ids on a task group. | authz_personas=[l
 <dd>
 
 ```typescript
-await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
+await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {
+    flight_legs: [
+        {
+            schema_version: 1,
+            flight_number: "flight_number",
+            provenance: "manual",
+        },
+    ],
+});
 ```
 
 </dd>
@@ -23163,7 +23158,7 @@ await client.shipping.orderDrafts.taskGroup.addV1({
 <dl>
 <dd>
 
-Sets the flight number and/or fa_flight_ids on a draft task group. | (SetFlightInfoReq) -> (bool)
+Replaces the ordered list of flights on a draft task group. | (SetFlightInfoReq) -> (bool)
 
 </dd>
 </dl>
@@ -23179,7 +23174,15 @@ Sets the flight number and/or fa_flight_ids on a draft task group. | (SetFlightI
 <dd>
 
 ```typescript
-await client.shipping.orderDrafts.taskGroup.setFlightInfoV1("task_group_id", {});
+await client.shipping.orderDrafts.taskGroup.setFlightInfoV1("task_group_id", {
+    flight_legs: [
+        {
+            schema_version: 1,
+            flight_number: "flight_number",
+            provenance: "manual",
+        },
+    ],
+});
 ```
 
 </dd>
@@ -24583,6 +24586,145 @@ await client.shipping.orderDrafts.expanded.listV1({
 </dl>
 </details>
 
+## Shipping OrderSchedules Draft
+
+<details><summary><code>client.shipping.orderSchedules.draft.<a href="/src/api/resources/shipping/resources/orderSchedules/resources/draft/client/Client.ts">newV1</a>({ ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a new draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientCreate1) -> (PydanticObjectId)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.orderSchedules.draft.newV1({
+    schema_version: 1,
+    name: "name",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shipping.orderSchedules.OrderScheduleClientCreate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Draft.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shipping.orderSchedules.draft.<a href="/src/api/resources/shipping/resources/orderSchedules/resources/draft/client/Client.ts">updateV1</a>(orderScheduleId, { ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates a draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.orderSchedules.draft.updateV1("order_schedule_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**orderScheduleId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shipping.orderSchedules.OrderScheduleClientUpdate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Draft.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Shipping OrderSchedules OrderManifest
 
 <details><summary><code>client.shipping.orderSchedules.orderManifest.<a href="/src/api/resources/shipping/resources/orderSchedules/resources/orderManifest/client/Client.ts">validateV1</a>({ ...params }) -> Chrt.OrderManifestValidationResult</code></summary>
@@ -30337,69 +30479,6 @@ await client.users.directoryEntries.deleteV1("directory_entry_id");
 
 ## Utils Dev
 
-<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentPingScheduleV1</a>({ ...params }) -> Chrt.ScheduledPingRes</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Creates or updates a Temporal Schedule that runs the scheduled ping workflow for developer diagnostics. | authz: min_org_role=administrator | (ScheduledPingReq) -> (ScheduledPingRes)
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.utils.dev.postAgentPingScheduleV1();
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Chrt.utils.ScheduledPingReq`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Dev.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 <details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentOpenaiPingV1</a>({ ...params }) -> Chrt.PingOpenAiRes</code></summary>
 <dl>
 <dd>

package/dist/cjs/api/resources/utils/resources/dev/client/requests/ScheduledPingReq.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../../../../../../index.js";
-/**
- * @example
- *     {}
- */
-export interface ScheduledPingReq {
-    message?: string;
-    schedule_spec?: Chrt.ScheduleSpec;
-    catchup_window_seconds?: number;
-}

package/dist/cjs/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type OrderScheduleOrchestratorScheduleStatusEnum1 = "not_created" | "created" | "create_failed" | "sync_failed";
-export declare const OrderScheduleOrchestratorScheduleStatusEnum1: {
-    readonly NotCreated: "not_created";
-    readonly Created: "created";
-    readonly CreateFailed: "create_failed";
-    readonly SyncFailed: "sync_failed";
-};

package/dist/cjs/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.js

@@ -1,12 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrderScheduleOrchestratorScheduleStatusEnum1 = void 0;
-exports.OrderScheduleOrchestratorScheduleStatusEnum1 = {
-    NotCreated: "not_created",
-    Created: "created",
-    CreateFailed: "create_failed",
-    SyncFailed: "sync_failed",
-};

package/dist/cjs/api/types/ScheduleSpec.d.ts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../index.js";
-export interface ScheduleSpec {
-    calendars?: Chrt.ScheduleCalendarSpec[];
-    intervals?: Chrt.ScheduleIntervalSpec[];
-    cron_expressions?: string[];
-    skip?: Chrt.ScheduleCalendarSpec[];
-    start_at?: string | null;
-    end_at?: string | null;
-    jitter?: string | null;
-    time_zone_name?: string | null;
-}

package/dist/cjs/api/types/ScheduledPingRes.d.ts

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../index.js";
-export interface ScheduledPingRes {
-    schedule_id: string;
-    ping_id: string;
-    message: string;
-    workflow_name: string;
-    workflow_id: string;
-    task_queue: string;
-    schedule_spec: Chrt.ScheduleSpec;
-    catchup_window_seconds: number;
-    created: boolean;
-    next_action_times: string[];
-}

package/dist/esm/api/resources/utils/resources/dev/client/requests/ScheduledPingReq.d.mts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../../../../../../index.mjs";
-/**
- * @example
- *     {}
- */
-export interface ScheduledPingReq {
-    message?: string;
-    schedule_spec?: Chrt.ScheduleSpec;
-    catchup_window_seconds?: number;
-}

package/dist/esm/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.d.mts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type OrderScheduleOrchestratorScheduleStatusEnum1 = "not_created" | "created" | "create_failed" | "sync_failed";
-export declare const OrderScheduleOrchestratorScheduleStatusEnum1: {
-    readonly NotCreated: "not_created";
-    readonly Created: "created";
-    readonly CreateFailed: "create_failed";
-    readonly SyncFailed: "sync_failed";
-};

package/dist/esm/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.mjs

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export const OrderScheduleOrchestratorScheduleStatusEnum1 = {
-    NotCreated: "not_created",
-    Created: "created",
-    CreateFailed: "create_failed",
-    SyncFailed: "sync_failed",
-};

package/dist/esm/api/types/ScheduleSpec.d.mts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../index.mjs";
-export interface ScheduleSpec {
-    calendars?: Chrt.ScheduleCalendarSpec[];
-    intervals?: Chrt.ScheduleIntervalSpec[];
-    cron_expressions?: string[];
-    skip?: Chrt.ScheduleCalendarSpec[];
-    start_at?: string | null;
-    end_at?: string | null;
-    jitter?: string | null;
-    time_zone_name?: string | null;
-}