@chrt-inc/typescript-sdk 1.1000.0 → 1.1004.0

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+export interface ContactTypeaheadResult {
+    type: Chrt.ContactTypeaheadFieldEnum;
+    values: Chrt.ContactTypeaheadValue[];
+}

package/dist/cjs/api/types/ContactTypeaheadResult.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/ContactTypeaheadValue.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ContactTypeaheadValue {
+    contact_ids: string[];
+    value: string;
+}

package/dist/cjs/api/types/ContactTypeaheadValue.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/CourieAddressResponse1.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+export interface CourieAddressResponse1 {
+    city?: string | null;
+    country?: string | null;
+    display?: string | null;
+    lngLat?: Chrt.CourieLatLngResponse1 | null;
+    postalCode?: string | null;
+    state?: string | null;
+    streetAddress?: string | null;
+    suite?: string | null;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/CourieAddressResponse1.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/CourieAttemptReasonResponse1.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CourieAttemptReasonResponse1 {
+    code?: string | null;
+    name?: string | null;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/CourieAttemptReasonResponse1.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/CourieCredsLimited1.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The only shape of a Courie credential a user is ever allowed to receive.
+ */
+export interface CourieCredsLimited1 {
+    _id: string;
+    active?: boolean;
+    courier_id: string;
+    created_at_timestamp: string;
+    customer_ids?: string[];
+    high_water_mark_timestamp?: string | null;
+    notes?: string | null;
+    /** Must be a string starting with `org_` */
+    org_id: string;
+    /** Must be a string starting with `user_` */
+    owned_by_user_id: string;
+    /** Must be a string starting with `org_` */
+    provider_org_id: string;
+    schema_version: number;
+    shipping_integration: "courie";
+    updated_at_timestamp: string;
+}

package/dist/cjs/api/types/CourieCredsLimited1.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/CourieCredsListRes.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+export interface CourieCredsListRes {
+    items: Chrt.CourieCredsLimited1[];
+    total_count: number;
+}

package/dist/cjs/api/types/CourieCredsListRes.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/CourieCredsTestRes.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Result of testing whether a stored Courie credential still works.
+ */
+export interface CourieCredsTestRes {
+    failure_reason?: string | null;
+    ok: boolean;
+}

package/dist/cjs/api/types/CourieCredsTestRes.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/CourieCustomFieldResponse1.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CourieCustomFieldResponse1 {
+    name?: string | null;
+    type?: string | null;
+    value?: string | null;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/CourieCustomFieldResponse1.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/CourieDriverAnswerResponse1.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CourieDriverAnswerResponse1 {
+    answer?: string | null;
+    photoUrl?: string | null;
+    question?: string | null;
+    type?: string | null;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/CourieDriverAnswerResponse1.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/CourieDriverResponse1.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CourieDriverResponse1 {
+    firstName?: string | null;
+    lastName?: string | null;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/CourieDriverResponse1.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/CourieLatLngResponse1.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CourieLatLngResponse1 {
+    latitude?: number | null;
+    longitude?: number | null;
+    valid?: boolean | null;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/CourieLatLngResponse1.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/CourieLocationScanResponse1.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CourieLocationScanResponse1 {
+    code?: string | null;
+    scannedAt?: number | null;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/CourieLocationScanResponse1.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/CourieOrder1.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+export interface CourieOrder1 {
+    _id: string;
+    created_at_timestamp: string;
+    integration_order_id: string;
+    mirrored_at_timestamp: string;
+    /** Must be a string starting with `org_` */
+    org_id: string;
+    /** Must be a string starting with `org_` */
+    provider_org_id: string;
+    provider_payload: Chrt.CourieOrderResponse1;
+    provider_payload_hash: string;
+    schema_version: number;
+    shipping_integration: "courie";
+    updated_at_timestamp: string;
+}

package/dist/cjs/api/types/CourieOrder1.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/CourieOrderEventEnum1.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Activity event types.
+ *
+ * NOTE: there is no assignment event, so an order moving to `ASSIGNED` leaves no
+ * trace here and status cannot be reconstructed from this log.
+ */
+export type CourieOrderEventEnum1 = "CREATED" | "PICKED_UP" | "DROPPED_OFF" | "RETURNED_TO_PICK_UP" | "ATTEMPTED" | "COMPLETED";
+export declare const CourieOrderEventEnum1: {
+    readonly Created: "CREATED";
+    readonly PickedUp: "PICKED_UP";
+    readonly DroppedOff: "DROPPED_OFF";
+    readonly ReturnedToPickUp: "RETURNED_TO_PICK_UP";
+    readonly Attempted: "ATTEMPTED";
+    readonly Completed: "COMPLETED";
+};

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

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CourieOrderEventEnum1 = void 0;
+exports.CourieOrderEventEnum1 = {
+    Created: "CREATED",
+    PickedUp: "PICKED_UP",
+    DroppedOff: "DROPPED_OFF",
+    ReturnedToPickUp: "RETURNED_TO_PICK_UP",
+    Attempted: "ATTEMPTED",
+    Completed: "COMPLETED",
+};

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+export interface CourieOrderEventResponse1 {
+    address?: string | null;
+    event: Chrt.CourieOrderEventEnum1;
+    timestamp: string;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/CourieOrderEventResponse1.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/CourieOrderListRes.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+export interface CourieOrderListRes {
+    items: Chrt.CourieOrder1[];
+    total_count: number;
+}

package/dist/cjs/api/types/CourieOrderListRes.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/CourieOrderResponse1.d.ts

@@ -0,0 +1,42 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+/**
+ * One Courie order, as returned by both the list and detail endpoints.
+ *
+ * The list endpoint returns this same complete shape, so the mirror never needs
+ * a per-order detail call.
+ */
+export interface CourieOrderResponse1 {
+    activities?: Chrt.CourieOrderEventResponse1[];
+    customFields?: Chrt.CourieCustomFieldResponse1[];
+    customerCompanyName?: string | null;
+    customerId: string;
+    deliveredAt?: string | null;
+    displayId?: number | null;
+    id: string;
+    numPackages?: number | null;
+    packageDescription?: string | null;
+    packageItems?: Chrt.CouriePackageItemResponse1[];
+    packageSize?: string | null;
+    packageTypeName?: string | null;
+    packageWeightInPounds?: number | null;
+    packages?: Chrt.CouriePackageResponse1[];
+    pickedUpAt?: string | null;
+    proofOfDeliveries?: Chrt.CourieProofOfDeliveryResponse1[];
+    proofOfPickUps?: Chrt.CourieProofOfDeliveryResponse1[];
+    referenceNumber?: string | null;
+    remoteId?: string | null;
+    serviceTypeName?: string | null;
+    shipmentDate?: string | null;
+    shipmentType?: string | null;
+    status: Chrt.CourieOrderStatusEnum1;
+    statusDescription?: string | null;
+    stops?: Chrt.CourieStopResponse1[];
+    trackingNumber?: string | null;
+    trackingUrl?: string | null;
+    vehicleTypeName?: string | null;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/CourieOrderResponse1.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/CourieOrderSortByEnum.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CourieOrderSortByEnum = "mirrored_at_timestamp" | "created_at_timestamp" | "updated_at_timestamp" | "integration_order_id";
+export declare const CourieOrderSortByEnum: {
+    readonly MirroredAtTimestamp: "mirrored_at_timestamp";
+    readonly CreatedAtTimestamp: "created_at_timestamp";
+    readonly UpdatedAtTimestamp: "updated_at_timestamp";
+    readonly IntegrationOrderId: "integration_order_id";
+};

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

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CourieOrderSortByEnum = void 0;
+exports.CourieOrderSortByEnum = {
+    MirroredAtTimestamp: "mirrored_at_timestamp",
+    CreatedAtTimestamp: "created_at_timestamp",
+    UpdatedAtTimestamp: "updated_at_timestamp",
+    IntegrationOrderId: "integration_order_id",
+};

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Courie's own order status.
+ *
+ * The spec documents these only as a bare enum list with no per-value meaning.
+ * `IN_TRANSIT`, `ON_HOLD` and `DELETED` have not been observed live. `unified.py`
+ * derives progress from the pickup milestone rather than this field.
+ */
+export type CourieOrderStatusEnum1 = "CREATED" | "ASSIGNED" | "IN_TRANSIT" | "COMPLETED" | "ATTEMPTED" | "ON_HOLD" | "DELETED" | "FAILED";
+export declare const CourieOrderStatusEnum1: {
+    readonly Created: "CREATED";
+    readonly Assigned: "ASSIGNED";
+    readonly InTransit: "IN_TRANSIT";
+    readonly Completed: "COMPLETED";
+    readonly Attempted: "ATTEMPTED";
+    readonly OnHold: "ON_HOLD";
+    readonly Deleted: "DELETED";
+    readonly Failed: "FAILED";
+};

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

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CourieOrderStatusEnum1 = void 0;
+exports.CourieOrderStatusEnum1 = {
+    Created: "CREATED",
+    Assigned: "ASSIGNED",
+    InTransit: "IN_TRANSIT",
+    Completed: "COMPLETED",
+    Attempted: "ATTEMPTED",
+    OnHold: "ON_HOLD",
+    Deleted: "DELETED",
+    Failed: "FAILED",
+};

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Per-item dimensions and weight.
+ *
+ * Values are **per piece**, not per entry: the spec's `quantity` note says
+ * "quantity 5 with weight 10 is 5 pieces weighing 50 lbs in total". Anything
+ * summing weight must multiply by `quantity` first.
+ */
+export interface CouriePackageItemResponse1 {
+    height?: number | null;
+    length?: number | null;
+    quantity?: number | null;
+    weight?: number | null;
+    width?: number | null;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/CouriePackageItemResponse1.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/CouriePackageResponse1.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CouriePackageResponse1 {
+    reference?: string | null;
+    status?: string | null;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/CouriePackageResponse1.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/CourieProofOfDeliveryResponse1.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CourieProofOfDeliveryResponse1 {
+    signedBy?: string | null;
+    timestamp?: string | null;
+    type?: string | null;
+    url?: string | null;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/CourieProofOfDeliveryResponse1.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/CourieStopAttemptResponse1.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+export interface CourieStopAttemptResponse1 {
+    date?: string | null;
+    reason?: Chrt.CourieAttemptReasonResponse1 | null;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/CourieStopAttemptResponse1.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/CourieStopResponse1.d.ts

@@ -0,0 +1,29 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+/**
+ * One end of a route. Timestamps here are epoch seconds, not ISO strings.
+ */
+export interface CourieStopResponse1 {
+    address?: Chrt.CourieAddressResponse1 | null;
+    attemptedAt?: number | null;
+    attempts?: Chrt.CourieStopAttemptResponse1[];
+    companyName?: string | null;
+    completedAt?: number | null;
+    contactName?: string | null;
+    driver?: Chrt.CourieDriverResponse1 | null;
+    driverAnswers?: Chrt.CourieDriverAnswerResponse1[];
+    driverStopSequenceNumber?: number | null;
+    due?: number | null;
+    instruction?: string | null;
+    locationScans?: Chrt.CourieLocationScanResponse1[];
+    orderId?: string | null;
+    phone?: string | null;
+    ready?: number | null;
+    stopSequenceNumber?: number | null;
+    suite?: string | null;
+    type: Chrt.CourieStopTypeEnum1;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/CourieStopResponse1.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/CourieStopTypeEnum1.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CourieStopTypeEnum1 = "PICK_UP" | "DROP_OFF";
+export declare const CourieStopTypeEnum1: {
+    readonly PickUp: "PICK_UP";
+    readonly DropOff: "DROP_OFF";
+};

package/dist/cjs/api/types/CourieStopTypeEnum1.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.CourieStopTypeEnum1 = void 0;
+exports.CourieStopTypeEnum1 = {
+    PickUp: "PICK_UP",
+    DropOff: "DROP_OFF",
+};

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CxtOrderTypeaheadFieldEnum = "integration_order_id";

package/dist/cjs/api/types/CxtOrderTypeaheadFieldEnum.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/CxtOrderTypeaheadResult.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../index.js";
+export interface CxtOrderTypeaheadResult {
+    type: Chrt.CxtOrderTypeaheadFieldEnum;
+    values: Chrt.CxtOrderTypeaheadValue[];
+}

package/dist/cjs/api/types/CxtOrderTypeaheadResult.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/CxtOrderTypeaheadValue.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CxtOrderTypeaheadValue {
+    cxt_order_ids: string[];
+    value: string;
+}

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

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