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

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

import { AllOrFieldOrListOf, ListField, ListFilter, ListRecord, NestedActionsParams, NestedBoardParams, NestedCardsParams, PositionOrFloat, TypedFetch, ValueResponse } from "../typeDefs";
import { Action } from "./Action";
import { BaseResource } from "./BaseResource";
import { Board } from "./Board";
import { Card } from "./Card";
export declare class List extends BaseResource {
    getList(params?: {
        fields?: AllOrFieldOrListOf<ListField>;
    } & NestedActionsParams & NestedBoardParams & NestedCardsParams): TypedFetch<ListRecord>;
    getLists(params?: {
        filter?: ListFilter;
        fields?: AllOrFieldOrListOf<ListField>;
    } & NestedCardsParams): TypedFetch<ListRecord[]>;
    getListsFilteredBy(filter: ListFilter): TypedFetch<ListRecord[]>;
    getFieldValue<T>(field: ListField): TypedFetch<ValueResponse<T>>;
    addList(params: {
        name: string;
        idBoard?: string;
        idListSource?: string;
        pos?: PositionOrFloat;
    }): TypedFetch<ListRecord>;
    updateList(params: {
        name?: string;
        closed?: boolean;
        idBoard?: string;
        pos?: PositionOrFloat;
        subscribed?: boolean;
    }): TypedFetch<ListRecord>;
    updateClosedStatus(value: boolean): TypedFetch<ListRecord>;
    moveToBoard(idBoard: string): TypedFetch<ListRecord>;
    updateName(value: string): TypedFetch<ListRecord>;
    updatePosition(value: PositionOrFloat): TypedFetch<ListRecord>;
    /**
     * Alters the soft limit for number of cards in the list. This is used in conjunction
     * with the List Limits Power-Up which will highlight lists that go over their set limit.
     * @param value A number between 0 and 5000 or "none" to remove the limit.
     */
    updateSoftLimit(value: "none" | number): TypedFetch<ListRecord>;
    updateSubscribed(value: boolean): TypedFetch<ListRecord>;
    archiveAllCards(): TypedFetch<unknown>;
    moveAllCards(params: {
        idBoard: string;
        idList: string;
    }): TypedFetch<unknown>;
    actions(): Action;
    board(): Board;
    cards(): Card;
}