@chrt-inc/typescript-sdk 1.692.0 → 1.702.0

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

@@ -0,0 +1,150 @@
+/**
+ * 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>;
+}