@chrt-inc/typescript-sdk 1.732.0 → 1.734.0

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Event `additionalInformation` (notifications, delivery, transfer).
+ */
+export interface CargoAiTrackAndTraceAdditionalInformation {
+    receivedFromName?: string | null;
+    notificationToName?: string | null;
+    deliveryToName?: string | null;
+    transferredToCarrier?: string | null;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+/**
+ * The `alerts` object — early warning signals on shipment execution.
+ */
+export interface CargoAiTrackAndTraceAlert {
+    level?: Chrt.CargoAiTrackAndTraceAlertLevelEnum | null;
+    message?: string | null;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Early-warning signal level on shipment execution (alerts.level).
+ */
+export type CargoAiTrackAndTraceAlertLevelEnum = "OK" | "WATCH" | "AT_RISK";
+export declare const CargoAiTrackAndTraceAlertLevelEnum: {
+    readonly Ok: "OK";
+    readonly Watch: "WATCH";
+    readonly AtRisk: "AT_RISK";
+};

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

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CargoAiTrackAndTraceAlertLevelEnum = void 0;
+exports.CargoAiTrackAndTraceAlertLevelEnum = {
+    Ok: "OK",
+    Watch: "WATCH",
+    AtRisk: "AT_RISK",
+};

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

@@ -0,0 +1,33 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+/**
+ * A single tracking event (BKD, RCS, DEP, ARR, RCF, NFD, DLV, ...).
+ */
+export interface CargoAiTrackAndTraceEvent {
+    code?: string | null;
+    description?: string | null;
+    eventDate?: string | null;
+    eventLocation?: string | null;
+    eventLocationCoord?: string | null;
+    flight?: Chrt.CargoAiTrackAndTraceFlight | null;
+    weight?: string | null;
+    volume?: string | null;
+    pieces?: string | null;
+    additionalInformation?: Chrt.CargoAiTrackAndTraceAdditionalInformation | null;
+    eventUlds?: Chrt.CargoAiTrackAndTraceUld[];
+    isPlanned?: boolean | null;
+    distance?: string | null;
+    origin?: string | null;
+    destination?: string | null;
+    time?: string | null;
+    flightNumber?: string | null;
+    scheduledDepartureDate?: string | null;
+    carbonEmission?: string | null;
+    originCoord?: string | null;
+    destinationCoord?: string | null;
+    isPredicted?: boolean | null;
+    predictedEventDate?: string | null;
+    predictedEventDateP90?: string | null;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+/**
+ * The `flight` object nested inside a tracking event.
+ */
+export interface CargoAiTrackAndTraceFlight {
+    number?: string | null;
+    origin?: string | null;
+    destination?: string | null;
+    originCoord?: string | null;
+    destinationCoord?: string | null;
+    date?: string | null;
+    scheduledDeparture?: string | null;
+    estimatedDeparture?: string | null;
+    actualDeparture?: string | null;
+    scheduledArrival?: string | null;
+    estimatedArrival?: string | null;
+    actualArrival?: string | null;
+    carbonEmission?: string | null;
+    distance?: string | null;
+    duration?: string | null;
+    flightUlds?: Chrt.CargoAiTrackAndTraceUld[];
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CargoAiTrackAndTraceSubscription1 {
+    schema_version: number;
+    _id: string;
+    /** IATA Air Waybill number: 3-digit airline prefix + 8-digit serial, e.g. '020-12345678'. */
+    awb: string;
+    /** Must be a string starting with `user_` */
+    created_by_user_id: string;
+    /** Must be a string starting with `org_` */
+    created_by_org_id: string;
+    subscribed_emails?: string[];
+    tracking_update_ids?: string[];
+    subscribed_at: string;
+    active_until: string;
+    last_update_received_at?: string | null;
+    created_at: string;
+    updated_at: string;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * ULD details attached to an event (`eventUlds`) or flight (`flightUlds`).
+ */
+export interface CargoAiTrackAndTraceUld {
+    pieces?: string | null;
+    uld?: string | null;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+export interface CargoAiTrackAndTraceUpdate1 {
+    schemaVersion?: number;
+    /** IATA Air Waybill number: 3-digit airline prefix + 8-digit serial, e.g. '020-12345678'. */
+    awb: string;
+    origin?: string | null;
+    destination?: string | null;
+    status?: string | null;
+    weight?: string | null;
+    pieces?: string | null;
+    volume?: string | null;
+    carbonEmission?: string | null;
+    alerts?: Chrt.CargoAiTrackAndTraceAlert | null;
+    oldEvents?: Chrt.CargoAiTrackAndTraceEvent[];
+    newEvents?: Chrt.CargoAiTrackAndTraceEvent[];
+    events?: Chrt.CargoAiTrackAndTraceEvent[];
+    _id: string;
+    receivedAt: string;
+    source: Chrt.CargoAiTrackAndTraceUpdateSourceEnum;
+    /** Must be a string starting with `user_` */
+    polledByUserId?: string | null;
+    /** Must be a string starting with `org_` */
+    polledByOrgId?: string | null;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CargoAiTrackAndTraceUpdateSourceEnum = "webhook" | "poll";
+export declare const CargoAiTrackAndTraceUpdateSourceEnum: {
+    readonly Webhook: "webhook";
+    readonly Poll: "poll";
+};

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

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CargoAiTrackAndTraceUpdateSourceEnum = void 0;
+exports.CargoAiTrackAndTraceUpdateSourceEnum = {
+    Webhook: "webhook",
+    Poll: "poll",
+};

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CargoAiTrackAndTraceWebhookResponse {
+    success: boolean;
+    message: string;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -13,4 +13,6 @@ export interface CargoClientCreate1 {
     turnable?: boolean | null;
     stackable?: boolean | null;
     description?: string | null;
+    /** IATA Air Waybill number: 3-digit airline prefix + 8-digit serial, e.g. '020-12345678'. */
+    awb_number?: string | null;
 }

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

@@ -12,6 +12,8 @@ export interface CargoClientUpdate1 {
     turnable?: boolean | null;
     stackable?: boolean | null;
     description?: string | null;
+    /** IATA Air Waybill number: 3-digit airline prefix + 8-digit serial, e.g. '020-12345678'. */
+    awb_number?: string | null;
     quantity__set_to_None?: boolean;
     weight_pounds__set_to_None?: boolean;
     length_inches__set_to_None?: boolean;
@@ -20,4 +22,5 @@ export interface CargoClientUpdate1 {
     turnable__set_to_None?: boolean;
     stackable__set_to_None?: boolean;
     description__set_to_None?: boolean;
+    awb_number__set_to_None?: boolean;
 }

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

@@ -5,6 +5,7 @@ import * as Chrt from "../index.js";
 export interface TaskGroupExpanded {
     task_group: Chrt.TaskGroup1;
     tasks_expanded?: Chrt.TaskExpanded[] | null;
+    awb_numbers?: string[] | null;
     driver?: Chrt.Driver1 | null;
     /** Must be a string starting with `org_` */
     executor_org_id?: string | null;

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

@@ -26,6 +26,16 @@ export * from "./BillingStatementPaidWebhookPayload.js";
 export * from "./Caller.js";
 export * from "./CallerCredentialTypeEnum.js";
 export * from "./Cargo1.js";
+export * from "./CargoAiTrackAndTraceAdditionalInformation.js";
+export * from "./CargoAiTrackAndTraceAlert.js";
+export * from "./CargoAiTrackAndTraceAlertLevelEnum.js";
+export * from "./CargoAiTrackAndTraceEvent.js";
+export * from "./CargoAiTrackAndTraceFlight.js";
+export * from "./CargoAiTrackAndTraceSubscription1.js";
+export * from "./CargoAiTrackAndTraceUld.js";
+export * from "./CargoAiTrackAndTraceUpdate1.js";
+export * from "./CargoAiTrackAndTraceUpdateSourceEnum.js";
+export * from "./CargoAiTrackAndTraceWebhookResponse.js";
 export * from "./CargoByDeviceDataPoint1.js";
 export * from "./CargoByDeviceDataPointMetadata1.js";
 export * from "./CargoByDeviceMarkOutliersResponse1.js";

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

@@ -42,6 +42,16 @@ __exportStar(require("./BillingStatementPaidWebhookPayload.js"), exports);
 __exportStar(require("./Caller.js"), exports);
 __exportStar(require("./CallerCredentialTypeEnum.js"), exports);
 __exportStar(require("./Cargo1.js"), exports);
+__exportStar(require("./CargoAiTrackAndTraceAdditionalInformation.js"), exports);
+__exportStar(require("./CargoAiTrackAndTraceAlert.js"), exports);
+__exportStar(require("./CargoAiTrackAndTraceAlertLevelEnum.js"), exports);
+__exportStar(require("./CargoAiTrackAndTraceEvent.js"), exports);
+__exportStar(require("./CargoAiTrackAndTraceFlight.js"), exports);
+__exportStar(require("./CargoAiTrackAndTraceSubscription1.js"), exports);
+__exportStar(require("./CargoAiTrackAndTraceUld.js"), exports);
+__exportStar(require("./CargoAiTrackAndTraceUpdate1.js"), exports);
+__exportStar(require("./CargoAiTrackAndTraceUpdateSourceEnum.js"), exports);
+__exportStar(require("./CargoAiTrackAndTraceWebhookResponse.js"), exports);
 __exportStar(require("./CargoByDeviceDataPoint1.js"), exports);
 __exportStar(require("./CargoByDeviceDataPointMetadata1.js"), exports);
 __exportStar(require("./CargoByDeviceMarkOutliersResponse1.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.732.0";
+export declare const SDK_VERSION = "1.734.0";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.732.0";
+exports.SDK_VERSION = "1.734.0";

package/dist/esm/Client.mjs

@@ -20,8 +20,8 @@ export class ChrtClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
-                "X-Fern-SDK-Version": "1.732.0",
-                "User-Agent": "@chrt-inc/typescript-sdk/1.732.0",
+                "X-Fern-SDK-Version": "1.734.0",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.734.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/api/resources/integrations/client/Client.d.mts

@@ -4,6 +4,7 @@
 import * as environments from "../../../../environments.mjs";
 import * as core from "../../../../core/index.mjs";
 import { AirWaybills } from "../resources/airWaybills/client/Client.mjs";
+import { CargoaiTrackAndTrace } from "../resources/cargoaiTrackAndTrace/client/Client.mjs";
 import { WebcargoBookings } from "../resources/webcargoBookings/client/Client.mjs";
 import { WebcargoEmbed } from "../resources/webcargoEmbed/client/Client.mjs";
 export declare namespace Integrations {
@@ -20,10 +21,12 @@ export declare namespace Integrations {
 export declare class Integrations {
     protected readonly _options: Integrations.Options;
     protected _airWaybills: AirWaybills | undefined;
+    protected _cargoaiTrackAndTrace: CargoaiTrackAndTrace | undefined;
     protected _webcargoBookings: WebcargoBookings | undefined;
     protected _webcargoEmbed: WebcargoEmbed | undefined;
     constructor(_options?: Integrations.Options);
     get airWaybills(): AirWaybills;
+    get cargoaiTrackAndTrace(): CargoaiTrackAndTrace;
     get webcargoBookings(): WebcargoBookings;
     get webcargoEmbed(): WebcargoEmbed;
 }

package/dist/esm/api/resources/integrations/client/Client.mjs

@@ -2,6 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import { AirWaybills } from "../resources/airWaybills/client/Client.mjs";
+import { CargoaiTrackAndTrace } from "../resources/cargoaiTrackAndTrace/client/Client.mjs";
 import { WebcargoBookings } from "../resources/webcargoBookings/client/Client.mjs";
 import { WebcargoEmbed } from "../resources/webcargoEmbed/client/Client.mjs";
 export class Integrations {
@@ -12,6 +13,10 @@ export class Integrations {
         var _a;
         return ((_a = this._airWaybills) !== null && _a !== void 0 ? _a : (this._airWaybills = new AirWaybills(this._options)));
     }
+    get cargoaiTrackAndTrace() {
+        var _a;
+        return ((_a = this._cargoaiTrackAndTrace) !== null && _a !== void 0 ? _a : (this._cargoaiTrackAndTrace = new CargoaiTrackAndTrace(this._options)));
+    }
     get webcargoBookings() {
         var _a;
         return ((_a = this._webcargoBookings) !== null && _a !== void 0 ? _a : (this._webcargoBookings = new WebcargoBookings(this._options)));

package/dist/esm/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.d.mts

@@ -0,0 +1,101 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as Chrt from "../../../../../index.mjs";
+export declare namespace CargoaiTrackAndTrace {
+    interface Options {
+        environment?: core.Supplier<environments.ChrtEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class CargoaiTrackAndTrace {
+    protected readonly _options: CargoaiTrackAndTrace.Options;
+    constructor(_options?: CargoaiTrackAndTrace.Options);
+    /**
+     * Retrieves the stored CargoAi tracking subscription for an AWB. | authz: order participant | () -> (CargoAiTrackAndTraceSubscription1)
+     *
+     * @param {string} awb
+     * @param {CargoaiTrackAndTrace.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.integrations.cargoaiTrackAndTrace.subscriptionV1("awb")
+     */
+    subscriptionV1(awb: string, requestOptions?: CargoaiTrackAndTrace.RequestOptions): core.HttpResponsePromise<Chrt.CargoAiTrackAndTraceSubscription1>;
+    private __subscriptionV1;
+    /**
+     * Retrieves stored CargoAi tracking updates for an AWB, latest first (the first item is the current state). | authz: order participant | () -> (list[CargoAiTrackAndTraceUpdate1])
+     *
+     * @param {string} awb
+     * @param {CargoaiTrackAndTrace.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.integrations.cargoaiTrackAndTrace.updatesV1("awb")
+     */
+    updatesV1(awb: string, requestOptions?: CargoaiTrackAndTrace.RequestOptions): core.HttpResponsePromise<Chrt.CargoAiTrackAndTraceUpdate1[]>;
+    private __updatesV1;
+    /**
+     * Lists CargoAi tracking subscriptions for the AWBs recorded on a task group. | authz: order participant | () -> (list[CargoAiTrackAndTraceSubscription1])
+     *
+     * @param {string} taskGroupId
+     * @param {CargoaiTrackAndTrace.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.integrations.cargoaiTrackAndTrace.subscriptionsByTaskGroupV1("task_group_id")
+     */
+    subscriptionsByTaskGroupV1(taskGroupId: string, requestOptions?: CargoaiTrackAndTrace.RequestOptions): core.HttpResponsePromise<Chrt.CargoAiTrackAndTraceSubscription1[]>;
+    private __subscriptionsByTaskGroupV1;
+    /**
+     * Starts CargoAi Track & Trace URL + e-mail updates for an AWB (which must already be recorded on a flight leg). Idempotent: re-subscribing a still-live AWB returns the existing subscription without calling CargoAi again. | authz: order participant operator | (CargoAiTrackAndTraceSubscribeReq) -> (CargoAiTrackAndTraceSubscription1)
+     *
+     * @param {Chrt.integrations.CargoAiTrackAndTraceSubscribeReq} request
+     * @param {CargoaiTrackAndTrace.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.integrations.cargoaiTrackAndTrace.subscribeV1({
+     *         awb: "awb"
+     *     })
+     */
+    subscribeV1(request: Chrt.integrations.CargoAiTrackAndTraceSubscribeReq, requestOptions?: CargoaiTrackAndTrace.RequestOptions): core.HttpResponsePromise<Chrt.CargoAiTrackAndTraceSubscription1>;
+    private __subscribeV1;
+    /**
+     * Polls CargoAi for the current tracking snapshot of an AWB and stores it as a new update (source=poll). No subscription required — any order participant can poll on demand. | authz: order participant | () -> (CargoAiTrackAndTraceUpdate1)
+     *
+     * @param {string} awb
+     * @param {CargoaiTrackAndTrace.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.integrations.cargoaiTrackAndTrace.refreshV1("awb")
+     */
+    refreshV1(awb: string, requestOptions?: CargoaiTrackAndTrace.RequestOptions): core.HttpResponsePromise<Chrt.CargoAiTrackAndTraceUpdate1>;
+    private __refreshV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}