attio-js/dist/commonjs/sdk/lists.d.ts

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

import { ClientSDK, RequestOptions } from "../lib/sdks.js";
import { GetV2ListsResponse } from "../models/operations/getv2lists.js";
import { GetV2ListsListRequest, GetV2ListsListResponse } from "../models/operations/getv2listslist.js";
import { PatchV2ListsListRequest, PatchV2ListsListResponse } from "../models/operations/patchv2listslist.js";
import { PostV2ListsRequest, PostV2ListsResponse } from "../models/operations/postv2lists.js";
export declare class Lists extends ClientSDK {
    /**
     * List all lists
     *
     * @remarks
     * List all lists that your access token has access to. lists are returned in the order that they are sorted in the sidebar.
     *
     * Required scopes: `list_configuration:read`.
     */
    listAll(options?: RequestOptions): Promise<GetV2ListsResponse>;
    /**
     * Create a list
     *
     * @remarks
     * Creates a new list.
     *
     * Once you have your list, add attributes to it using the [Create attribute](/reference/post_v2-target-identifier-attributes) API, and add records to it using the [Add records to list](/reference/post_v2-lists-list-entries) API.
     *
     * New lists must specify which records can be added with the `parent_object` parameter which accepts either an object slug or an object ID. Permissions for the list are controlled with the `workspace_access` and `workspace_member_access` parameters.
     *
     * Please note that new 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.
     *
     * Required scopes: `list_configuration:read-write`.
     */
    create(request: PostV2ListsRequest, options?: RequestOptions): Promise<PostV2ListsResponse>;
    /**
     * Get a list
     *
     * @remarks
     * Gets a single list in your workspace that your access token has access to.
     *
     * Required scopes: `list_configuration:read`.
     */
    get(request: GetV2ListsListRequest, options?: RequestOptions): Promise<GetV2ListsListResponse>;
    /**
     * 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`.
     */
    update(request: PatchV2ListsListRequest, options?: RequestOptions): Promise<PatchV2ListsListResponse>;
}
//# sourceMappingURL=lists.d.ts.map