@chrt-inc/typescript-sdk 1.861.0 → 1.863.0

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

@@ -1,276 +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";
-import { S3Objects } from "../resources/s3Objects/client/Client.js";
-export declare namespace Cases {
-    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 Cases {
-    protected readonly _options: Cases.Options;
-    protected _s3Objects: S3Objects | undefined;
-    constructor(_options?: Cases.Options);
-    get s3Objects(): S3Objects;
-    /**
-     * Appends a message to a case. | authz: min_org_role=operator | (CaseAddMessageReq) -> (bool)
-     *
-     * @param {string} caseId
-     * @param {Chrt.operations.CaseAddMessageReq} request
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.addMessageV1("case_id", {
-     *         message: "message"
-     *     })
-     */
-    addMessageV1(caseId: string, request: Chrt.operations.CaseAddMessageReq, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __addMessageV1;
-    /**
-     * Adds operator(s) to a case. | authz: min_org_role=operator | (CaseAssignReq) -> (bool)
-     *
-     * @param {string} caseId
-     * @param {Chrt.operations.CaseAssignReq} request
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.assignV1("case_id", {
-     *         operator_user_ids: ["operator_user_ids"]
-     *     })
-     */
-    assignV1(caseId: string, request: Chrt.operations.CaseAssignReq, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __assignV1;
-    /**
-     * Retrieves the case for a given shipping order. | authz: min_org_role=operator | () -> (Case1)
-     *
-     * @param {string} orderId
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.getByOrderV1("order_id")
-     */
-    getByOrderV1(orderId: string, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<Chrt.Case1>;
-    private __getByOrderV1;
-    /**
-     * Retrieves the case for a given order ID, short ID, or off-chrt reference ID. | authz: min_org_role=operator | () -> (Case1)
-     *
-     * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.getByOrderRefV1("order_ref")
-     */
-    getByOrderRefV1(orderRef: string, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<Chrt.Case1>;
-    private __getByOrderRefV1;
-    /**
-     * Retrieves the case for a given order short ID. | authz: min_org_role=operator | () -> (Case1)
-     *
-     * @param {string} orderShortId
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.getByOrderShortIdV1("order_short_id")
-     */
-    getByOrderShortIdV1(orderShortId: string, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<Chrt.Case1>;
-    private __getByOrderShortIdV1;
-    /**
-     * Deletes a message from a case. | authz: min_org_role=operator | () -> (bool)
-     *
-     * @param {string} caseId
-     * @param {string} messageId
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.deleteMessageV1("case_id", "message_id")
-     */
-    deleteMessageV1(caseId: string, messageId: string, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __deleteMessageV1;
-    /**
-     * Lists the dispatcher Case view by exact case tag with related order and party data. | authz: min_org_role=operator | () -> (CasesExpandedListRes)
-     *
-     * @param {Chrt.operations.CasesExpandedListV1Request} request
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.expandedListV1({
-     *         filter_case_tag: "filter_case_tag",
-     *         page: 1,
-     *         page_size: 1
-     *     })
-     */
-    expandedListV1(request: Chrt.operations.CasesExpandedListV1Request, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<Chrt.CasesExpandedListRes>;
-    private __expandedListV1;
-    /**
-     * Lists cases for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (CaseListRes)
-     *
-     * @param {Chrt.operations.CasesListV1Request} request
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.listV1({
-     *         sort_by: "created_at",
-     *         sort_order: "asc",
-     *         page: 1,
-     *         page_size: 1,
-     *         filter_assigned_user_id: "filter_assigned_user_id",
-     *         filter_unassigned: true
-     *     })
-     */
-    listV1(request?: Chrt.operations.CasesListV1Request, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<Chrt.CaseListRes>;
-    private __listV1;
-    /**
-     * Sets the case's operator billing-review status. | authz: min_org_role=operator | (CaseSetBillingReviewStatusReq) -> (bool)
-     *
-     * @param {string} caseId
-     * @param {Chrt.operations.CaseSetBillingReviewStatusReq} request
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.setBillingReviewStatusV1("case_id", {
-     *         billing_review_status: "not_started"
-     *     })
-     */
-    setBillingReviewStatusV1(caseId: string, request: Chrt.operations.CaseSetBillingReviewStatusReq, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __setBillingReviewStatusV1;
-    /**
-     * Returns the department this case's order would map to from the shipper connection — a non-binding default for the UI. Department is never auto-applied; the frontend applies it explicitly via the update route. | authz: min_org_role=operator | () -> (PydanticObjectId | None)
-     *
-     * @param {string} caseId
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.getSuggestedDepartmentV1("case_id")
-     */
-    getSuggestedDepartmentV1(caseId: string, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<(string | null) | undefined>;
-    private __getSuggestedDepartmentV1;
-    /**
-     * Adds a task list to apply when the order is staged. | authz: min_org_role=operator | (UTCDatetime | None) -> (bool)
-     *
-     * @param {string} caseId
-     * @param {string} taskListId
-     * @param {string | null} request
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.addTaskListToApplyAtOrderStagingV1("case_id", "task_list_id", "2024-01-15T09:30:00Z")
-     */
-    addTaskListToApplyAtOrderStagingV1(caseId: string, taskListId: string, request?: string | null, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __addTaskListToApplyAtOrderStagingV1;
-    /**
-     * Removes a pending staging task list to apply from a draft order case. | authz: min_org_role=operator | () -> (bool)
-     *
-     * @param {string} caseId
-     * @param {string} taskListId
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.removeTaskListToApplyAtOrderStagingV1("case_id", "task_list_id")
-     */
-    removeTaskListToApplyAtOrderStagingV1(caseId: string, taskListId: string, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __removeTaskListToApplyAtOrderStagingV1;
-    /**
-     * Returns distinct case_tag values matching the query via case-insensitive regex for the caller's organization. | authz: min_org_role=operator | () -> (list[CaseTypeaheadResult])
-     *
-     * @param {Chrt.operations.CasesTypeaheadV1Request} request
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.typeaheadV1({
-     *         query: "query",
-     *         limit: 1
-     *     })
-     */
-    typeaheadV1(request: Chrt.operations.CasesTypeaheadV1Request, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<Chrt.CaseTypeaheadResult[]>;
-    private __typeaheadV1;
-    /**
-     * Removes operator(s) from a case. | authz: min_org_role=operator | (CaseUnassignReq) -> (bool)
-     *
-     * @param {string} caseId
-     * @param {Chrt.operations.CaseUnassignReq} request
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.unassignV1("case_id", {
-     *         operator_user_ids: ["operator_user_ids"]
-     *     })
-     */
-    unassignV1(caseId: string, request: Chrt.operations.CaseUnassignReq, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __unassignV1;
-    /**
-     * Retrieves a single case. | authz: min_org_role=operator | () -> (Case1)
-     *
-     * @param {string} caseId
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.getV1("case_id")
-     */
-    getV1(caseId: string, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<Chrt.Case1>;
-    private __getV1;
-    /**
-     * Updates a case's department and tag. | authz: min_org_role=operator | (CaseClientUpdate1) -> (bool)
-     *
-     * @param {string} caseId
-     * @param {Chrt.operations.CaseClientUpdate1} request
-     * @param {Cases.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.operations.cases.updateV1("case_id")
-     */
-    updateV1(caseId: string, request?: Chrt.operations.CaseClientUpdate1, requestOptions?: Cases.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __updateV1;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
-}