@chrt-inc/typescript-sdk 1.718.0 → 1.723.0

package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseChecksApplyChecklistReq.d.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         checklist_id: "checklist_id"
- *     }
- */
-export interface CaseChecksApplyChecklistReq {
-    checklist_id: string;
-}

package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseChecksRecordImageAnalysisResultsReq.d.ts

@@ -1,15 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../../../../../../index.js";
-/**
- * @example
- *     {
- *         results: {
- *             "key": "not_started"
- *         }
- *     }
- */
-export interface CaseChecksRecordImageAnalysisResultsReq {
-    results: Record<string, Chrt.CheckStatusEnum>;
-}

package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseNeedsActionReq.d.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         needs_action: true
- *     }
- */
-export interface CaseNeedsActionReq {
-    needs_action: boolean;
-}

package/dist/cjs/api/resources/operations/resources/checklists/client/Client.d.ts

@@ -1,150 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../../../environments.js";
-import * as core from "../../../../../../core/index.js";
-import * as Chrt from "../../../../../index.js";
-export declare namespace Checklists {
-    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 Checklists {
-    protected readonly _options: Checklists.Options;
-    constructor(_options?: Checklists.Options);
-    /**
-     * Lists Checklists for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (ChecklistListRes)
-     *
-     * @param {Chrt.operations.ChecklistsListV1Request} request
-     * @param {Checklists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.checklists.listV1({
-     *         sort_by: "created_at_timestamp",
-     *         sort_order: "asc",
-     *         page: 1,
-     *         page_size: 1,
-     *         filter_archived: true
-     *     })
-     */
-    listV1(request?: Chrt.operations.ChecklistsListV1Request, requestOptions?: Checklists.RequestOptions): core.HttpResponsePromise<Chrt.ChecklistListRes>;
-    private __listV1;
-    /**
-     * Retrieves a single Checklist by id. | authz: min_org_role=operator | () -> (Checklist1)
-     *
-     * @param {string} checklistId
-     * @param {Checklists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.checklists.getV1("checklist_id")
-     */
-    getV1(checklistId: string, requestOptions?: Checklists.RequestOptions): core.HttpResponsePromise<Chrt.Checklist1>;
-    private __getV1;
-    /**
-     * Updates scalar fields (name, description) on a Checklist. | authz: min_org_role=operator | (ChecklistClientUpdate1) -> (bool)
-     *
-     * @param {string} checklistId
-     * @param {Chrt.operations.ChecklistClientUpdate1} request
-     * @param {Checklists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.checklists.updateV1("checklist_id")
-     */
-    updateV1(checklistId: string, request?: Chrt.operations.ChecklistClientUpdate1, requestOptions?: Checklists.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __updateV1;
-    /**
-     * Creates a new Checklist for the caller's organization. | authz: min_org_role=operator | (ChecklistClientCreate1) -> (PydanticObjectId)
-     *
-     * @param {Chrt.operations.ChecklistClientCreate1} request
-     * @param {Checklists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.checklists.createV1({
-     *         schema_version: 1,
-     *         name: "name"
-     *     })
-     */
-    createV1(request: Chrt.operations.ChecklistClientCreate1, requestOptions?: Checklists.RequestOptions): core.HttpResponsePromise<string>;
-    private __createV1;
-    /**
-     * Adds checks to a Checklist. Idempotent for identical checks. | authz: min_org_role=operator | (ChecklistChecksAdd1) -> (bool)
-     *
-     * @param {string} checklistId
-     * @param {Chrt.operations.ChecklistChecksAdd1} request
-     * @param {Checklists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.checklists.addChecksV1("checklist_id")
-     */
-    addChecksV1(checklistId: string, request?: Chrt.operations.ChecklistChecksAdd1, requestOptions?: Checklists.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __addChecksV1;
-    /**
-     * Removes entries from a Checklist's `checks` list by CheckEnum. | authz: min_org_role=operator | (ChecklistChecksRemove1) -> (bool)
-     *
-     * @param {string} checklistId
-     * @param {Chrt.operations.ChecklistChecksRemove1} request
-     * @param {Checklists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.checklists.removeChecksV1("checklist_id")
-     */
-    removeChecksV1(checklistId: string, request?: Chrt.operations.ChecklistChecksRemove1, requestOptions?: Checklists.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __removeChecksV1;
-    /**
-     * Soft-deletes a Checklist by setting `archived=True`. Existing Cases that applied this Checklist are unaffected (copy-on-write). | authz: min_org_role=operator | () -> (bool)
-     *
-     * @param {string} checklistId
-     * @param {Checklists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.checklists.archiveV1("checklist_id")
-     */
-    archiveV1(checklistId: string, requestOptions?: Checklists.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __archiveV1;
-    /**
-     * Restores an archived Checklist by setting `archived=False`. | authz: min_org_role=operator | () -> (bool)
-     *
-     * @param {string} checklistId
-     * @param {Checklists.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.checklists.unarchiveV1("checklist_id")
-     */
-    unarchiveV1(checklistId: string, requestOptions?: Checklists.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __unarchiveV1;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
-}

package/dist/cjs/api/resources/operations/resources/checklists/client/requests/ChecklistChecksRemove1.d.ts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../../../../../../index.js";
-/**
- * @example
- *     {}
- */
-export interface ChecklistChecksRemove1 {
-    checks?: Chrt.CheckEnum[];
-}

package/dist/cjs/api/resources/operations/resources/checklists/client/requests/index.d.ts

@@ -1,5 +0,0 @@
-export { type ChecklistsListV1Request } from "./ChecklistsListV1Request.js";
-export { type ChecklistClientUpdate1 } from "./ChecklistClientUpdate1.js";
-export { type ChecklistClientCreate1 } from "./ChecklistClientCreate1.js";
-export { type ChecklistChecksAdd1 } from "./ChecklistChecksAdd1.js";
-export { type ChecklistChecksRemove1 } from "./ChecklistChecksRemove1.js";

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

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../index.js";
-export interface CaseChecksDisableReq {
-    check: Chrt.CheckEnum;
-}

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

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../index.js";
-export interface CaseChecksDismissReq {
-    check: Chrt.CheckEnum;
-    entity_id: string;
-}

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

@@ -1,27 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../index.js";
-/**
- * Denormalized summary cache for `Case.checks` plus applied-Checklist log.
- *
- * Embedded at `Case.checks_summary`. Rewritten on every mutation of
- * `Case.checks` (or `applied_checklist_ids`) so the operator dashboard
- * can filter / sort / count Cases without scanning the `checks` array.
- * Dismissed checks are excluded from every cache field.
- *
- * `OperationsEventEnum` is exported alongside this model because the
- * Case-level event log (forthcoming) will key off the same vocabulary;
- * keeping the import here documents the shared dependency.
- */
-export interface CaseChecksSummary1 {
-    schema_version: number;
-    applied_checklist_ids?: string[];
-    success_count?: number;
-    failure_count?: number;
-    unsure_count?: number;
-    error_count?: number;
-    failure_check_keys?: Chrt.CheckEnum[];
-    unsure_check_keys?: Chrt.CheckEnum[];
-    error_check_keys?: Chrt.CheckEnum[];
-}

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

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type CaseStatusEnum = "open" | "in_progress" | "closed";
-export declare const CaseStatusEnum: {
-    readonly Open: "open";
-    readonly InProgress: "in_progress";
-    readonly Closed: "closed";
-};

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

@@ -1,11 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CaseStatusEnum = void 0;
-exports.CaseStatusEnum = {
-    Open: "open",
-    InProgress: "in_progress",
-    Closed: "closed",
-};

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

@@ -1,33 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../index.js";
-/**
- * One evaluation of a check against a specific event-entity instance.
- *
- * Embedded as a list element on `Case.checks`. Uniqueness on the Case
- * is `(check, entity_id)` — each Checklist'd check fans out into one
- * `Check1` per event-entity it fires against. `entity_id` is whatever
- * identifies the unique "instance of this event" — `order_id` for
- * `order.*` events (1× per Case), `task_group_id` for
- * `task_group.driver_assigned`, `task_artifact_id` for
- * `task_artifact.*`, `task_id` for `task.completed`. See
- * `CheckEnum`'s docstring for the per-event mapping.
- *
- * The workflow that runs the check writes `status` and
- * `completed_at_timestamp` back when it finishes. Operators dismiss a
- * specific run (one `(check, entity_id)`) by transitioning its
- * `status` to `DISMISSED`; dismissing does *not* affect future runs
- * of the same check on different `entity_id`s. `DISMISSED` is just
- * another status, not a side-flag, so workflows can short-circuit
- * with a single predicate and the dashboard cache counts naturally
- * exclude it. The *who* / *when* of every status transition lives in
- * the forthcoming Case event log, not on `Check1`.
- */
-export interface Check1 {
-    schema_version: number;
-    check: Chrt.CheckEnum;
-    entity_id: string;
-    status?: Chrt.CheckStatusEnum;
-    completed_at_timestamp?: string | null;
-}

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

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

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

@@ -1,46 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * *What* is being verified.
- *
- * Each member is a single, narrowly-scoped check that runs on a specific
- * `OperationsEventEnum`, encoded in the `event` property (backed by
- * `_CHECK_EVENT_MAP` below) — never stored separately, or the two can drift.
- *
- * Each `Check1` evaluation is keyed by `(check, entity_id)` on a Case;
- * `entity_id` is the id of the entity in the event's `Domain.Entity.Action`
- * slug:
- *
- * | Event                                  | entity_id        |
- * |----------------------------------------|------------------|
- * | shipping.order.*                       | order_id         |
- * | shipping.task_group.driver_assigned    | task_group_id    |
- * | shipping.task.completed                | task_id          |
- * | shipping.task_artifact.*               | task_artifact_id |
- *
- * `entity_type` is intentionally not stored — it's a strict function of
- * `check.event.entity` (same drift-avoidance rationale as the removed
- * `event` field). If you ever need it to differ (e.g. a check fires on
- * `task.completed` but is logically about the parent task_group), the
- * first answer is adding the right event; the escape hatch is promoting
- * `entity_type` to its own `_CHECK_ENTITY_MAP`.
- */
-export type CheckEnum = "shipping.order.placed.order_details_reviewed" | "shipping.order.staged.flight_task_groups_have_flights" | "shipping.order.staged.flight_task_groups_have_cargo" | "shipping.order.staged.recipient_contacts_present" | "shipping.task_group.driver_assigned.license_valid" | "shipping.task_group.driver_assigned.insurance_valid" | "shipping.task_group.driver_assigned.employment_classification_eligible" | "shipping.task_group.driver_assigned.vehicle_type_compatible" | "shipping.task_artifact.image_uploaded.cargo_visible" | "shipping.task_artifact.image_uploaded.matches_cargo_description" | "shipping.task_artifact.image_uploaded.satisfies_delivery_instructions" | "shipping.task_artifact.barcode_scanned.expected_values_match" | "shipping.task.completed.eta_within_window" | "shipping.task.completed.completed_within_window" | "shipping.order.completed.wait_time_submitted";
-export declare const CheckEnum: {
-    readonly ShippingOrderPlacedOrderDetailsReviewed: "shipping.order.placed.order_details_reviewed";
-    readonly ShippingOrderStagedFlightTaskGroupsHaveFlights: "shipping.order.staged.flight_task_groups_have_flights";
-    readonly ShippingOrderStagedFlightTaskGroupsHaveCargo: "shipping.order.staged.flight_task_groups_have_cargo";
-    readonly ShippingOrderStagedRecipientContactsPresent: "shipping.order.staged.recipient_contacts_present";
-    readonly ShippingTaskGroupDriverAssignedLicenseValid: "shipping.task_group.driver_assigned.license_valid";
-    readonly ShippingTaskGroupDriverAssignedInsuranceValid: "shipping.task_group.driver_assigned.insurance_valid";
-    readonly ShippingTaskGroupDriverAssignedEmploymentClassificationEligible: "shipping.task_group.driver_assigned.employment_classification_eligible";
-    readonly ShippingTaskGroupDriverAssignedVehicleTypeCompatible: "shipping.task_group.driver_assigned.vehicle_type_compatible";
-    readonly ShippingTaskArtifactImageUploadedCargoVisible: "shipping.task_artifact.image_uploaded.cargo_visible";
-    readonly ShippingTaskArtifactImageUploadedMatchesCargoDescription: "shipping.task_artifact.image_uploaded.matches_cargo_description";
-    readonly ShippingTaskArtifactImageUploadedSatisfiesDeliveryInstructions: "shipping.task_artifact.image_uploaded.satisfies_delivery_instructions";
-    readonly ShippingTaskArtifactBarcodeScannedExpectedValuesMatch: "shipping.task_artifact.barcode_scanned.expected_values_match";
-    readonly ShippingTaskCompletedEtaWithinWindow: "shipping.task.completed.eta_within_window";
-    readonly ShippingTaskCompletedCompletedWithinWindow: "shipping.task.completed.completed_within_window";
-    readonly ShippingOrderCompletedWaitTimeSubmitted: "shipping.order.completed.wait_time_submitted";
-};

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

@@ -1,23 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CheckEnum = void 0;
-exports.CheckEnum = {
-    ShippingOrderPlacedOrderDetailsReviewed: "shipping.order.placed.order_details_reviewed",
-    ShippingOrderStagedFlightTaskGroupsHaveFlights: "shipping.order.staged.flight_task_groups_have_flights",
-    ShippingOrderStagedFlightTaskGroupsHaveCargo: "shipping.order.staged.flight_task_groups_have_cargo",
-    ShippingOrderStagedRecipientContactsPresent: "shipping.order.staged.recipient_contacts_present",
-    ShippingTaskGroupDriverAssignedLicenseValid: "shipping.task_group.driver_assigned.license_valid",
-    ShippingTaskGroupDriverAssignedInsuranceValid: "shipping.task_group.driver_assigned.insurance_valid",
-    ShippingTaskGroupDriverAssignedEmploymentClassificationEligible: "shipping.task_group.driver_assigned.employment_classification_eligible",
-    ShippingTaskGroupDriverAssignedVehicleTypeCompatible: "shipping.task_group.driver_assigned.vehicle_type_compatible",
-    ShippingTaskArtifactImageUploadedCargoVisible: "shipping.task_artifact.image_uploaded.cargo_visible",
-    ShippingTaskArtifactImageUploadedMatchesCargoDescription: "shipping.task_artifact.image_uploaded.matches_cargo_description",
-    ShippingTaskArtifactImageUploadedSatisfiesDeliveryInstructions: "shipping.task_artifact.image_uploaded.satisfies_delivery_instructions",
-    ShippingTaskArtifactBarcodeScannedExpectedValuesMatch: "shipping.task_artifact.barcode_scanned.expected_values_match",
-    ShippingTaskCompletedEtaWithinWindow: "shipping.task.completed.eta_within_window",
-    ShippingTaskCompletedCompletedWithinWindow: "shipping.task.completed.completed_within_window",
-    ShippingOrderCompletedWaitTimeSubmitted: "shipping.order.completed.wait_time_submitted",
-};

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

@@ -1,32 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Lifecycle + stoplight outcome of a single check on a Case.
- *
- * ```
- * NOT_STARTED  →  IN_PROGRESS  →  SUCCESS | UNSURE | FAILURE | ERROR
- *     ↑                                         ↓
- *     └────────── undismiss ────────── DISMISSED ── dismiss (from any status)
- * ```
- *
- * - `UNSURE` — yellow stoplight; signal borderline (e.g. vision confidence
- *   on the edge). Counts as "needs attention" in roll-ups, filterable
- *   separately for triage.
- * - `ERROR` — workflow couldn't produce a measurement (distinct from
- *   `FAILURE` so broken pipelines are triaged separately from data issues).
- * - `DISMISSED` — operator override; excludes from needs-attention
- *   roll-ups *and* from event re-runs. The prior stoplight outcome is
- *   intentionally lost on `Check1` — the Case event log (forthcoming)
- *   holds the full status-transition history.
- */
-export type CheckStatusEnum = "not_started" | "in_progress" | "success" | "unsure" | "failure" | "error" | "dismissed";
-export declare const CheckStatusEnum: {
-    readonly NotStarted: "not_started";
-    readonly InProgress: "in_progress";
-    readonly Success: "success";
-    readonly Unsure: "unsure";
-    readonly Failure: "failure";
-    readonly Error: "error";
-    readonly Dismissed: "dismissed";
-};

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

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

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

@@ -1,15 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../index.js";
-/**
- * One check entry declared in a Checklist.
- *
- * Names a single catalog check; the event it fires on is derivable as
- * `entry.check.event` (see `CheckEnum.event`). Checklist-application
- * logic copies each `ChecklistCheck1` into the target Case as a `Check1`
- * in `NOT_STARTED` status.
- */
-export interface ChecklistCheck1 {
-    check: Chrt.CheckEnum;
-}

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

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

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

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

package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseChecksApplyChecklistReq.d.mts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         checklist_id: "checklist_id"
- *     }
- */
-export interface CaseChecksApplyChecklistReq {
-    checklist_id: string;
-}

package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseChecksRecordImageAnalysisResultsReq.d.mts

@@ -1,15 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../../../../../../index.mjs";
-/**
- * @example
- *     {
- *         results: {
- *             "key": "not_started"
- *         }
- *     }
- */
-export interface CaseChecksRecordImageAnalysisResultsReq {
-    results: Record<string, Chrt.CheckStatusEnum>;
-}

package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseNeedsActionReq.d.mts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         needs_action: true
- *     }
- */
-export interface CaseNeedsActionReq {
-    needs_action: boolean;
-}