attio-js/dist/commonjs/funcs/listsUpdate.d.ts

Developer-friendly & type-safe JS/TS SDK based on the official OpenAPI spec of Attio.

import { AttioCore } from "../core.js";
import { RequestOptions } from "../lib/sdks.js";
import { APIError } from "../models/errors/apierror.js";
import { GetV2ListsListNotFoundError, PostV2ListsInvalidRequestError } from "../models/errors/getv2objectsobject.js";
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import { PatchV2ListsListRequest, PatchV2ListsListResponse } from "../models/operations/patchv2listslist.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
 * Update a list
 *
 * @remarks
 * Updates an existing list. Permissions for the list are controlled with the `workspace_access` and `workspace_member_access` parameters. Please note that lists must have either `workspace_access` set to `"full-access"` or one or more element of `workspace_member_access` with a `"full-access"` level. It is also possible to receive a `403` billing error if your workspace is not on a plan that supports either advanced workspace or workspace member level access for lists. Changing the parent object of a list is not possible through the API as it can have unintended side-effects that should be considered carefully. If you wish to carry out a parent object change you should do so through the UI.
 *
 * Required scopes: `list_configuration:read-write`.
 */
export declare function listsUpdate(client: AttioCore, request: PatchV2ListsListRequest, options?: RequestOptions): APIPromise<Result<PatchV2ListsListResponse, PostV2ListsInvalidRequestError | GetV2ListsListNotFoundError | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
//# sourceMappingURL=listsUpdate.d.ts.map