trello-for-wolves/lib/resources/Checklist.d.ts

Node.js wrapper for Trello API...for wolves.

import { AllOrFieldOrListOf, AllOrNone, CheckItemField, ChecklistField, ChecklistRecord, NestedActionsParams, NestedBoardParams, NestedCardsParams, NestedChecklistsParams, PositionOrFloat, TypedFetch, ValueResponse } from "../typeDefs";
import { BaseResource } from "./BaseResource";
import { Board } from "./Board";
import { Card } from "./Card";
import { CheckItem } from "./CheckItem";
declare type GetChecklistsParams = {
    fields?: AllOrFieldOrListOf<ChecklistField>;
    filter?: AllOrNone;
    checkItems?: AllOrNone;
    checkItemFields?: AllOrFieldOrListOf<CheckItemField>;
} | NestedChecklistsParams;
/**
 * Checklists are lists on boards that have items that can be completed or
 * "checked off".
 * @see https://developers.trello.com/reference#checklist
 * @class
 */
export declare class Checklist extends BaseResource {
    getChecklist(params?: {
        fields?: AllOrFieldOrListOf<ChecklistField>;
        checkItems?: AllOrNone;
        checkItemFields?: AllOrFieldOrListOf<CheckItemField>;
    } & NestedActionsParams & NestedBoardParams & NestedCardsParams): TypedFetch<ChecklistRecord>;
    getChecklists(params?: GetChecklistsParams & NestedActionsParams & NestedBoardParams): TypedFetch<ChecklistRecord[]>;
    getFieldValue<T>(field: ChecklistField): TypedFetch<ValueResponse<T>>;
    addChecklist(params: {
        idCard?: string;
        name?: string;
        pos?: PositionOrFloat;
        idChecklistSource?: string;
    }): TypedFetch<ChecklistRecord>;
    updateChecklist(params: {
        name?: string;
        pos?: PositionOrFloat;
    }): TypedFetch<ChecklistRecord>;
    updateName(value: string): TypedFetch<ChecklistRecord>;
    updatePosition(value: PositionOrFloat): TypedFetch<ChecklistRecord>;
    deleteChecklist(): TypedFetch<unknown>;
    board(): Board;
    cards(): Card;
    checkItem(idCheckItem: string): CheckItem;
    checkItems(idCheckItem?: string): CheckItem;
}
export {};