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

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

import { AllOrFieldOrListOf, BoardActionType, BoardField, BoardFilter, BoardPermissionLevel, BoardPluginRecord, BoardRecord, BoardStarsFilter, CardAging, ColorName, GroupPermission, Invitation, KeepFromSourceField, NestedActionsParams, NestedCardsParams, NestedChecklistsParams, NestedCustomFieldsParams, NestedLabelsParams, NestedListsParams, NestedMembershipsParams, NestedMembersInvitedParams, NestedMembersParams, NestedNotificationsParams, NestedOrganizationParams, PermissionLevel, PowerUp, TypedFetch, ValueResponse } from "../typeDefs";
import { Action } from "./Action";
import { BaseResource } from "./BaseResource";
import { BoardMyPrefs } from "./BoardMyPrefs";
import { BoardPref } from "./BoardPref";
import { BoardStar } from "./BoardStar";
import { Card } from "./Card";
import { Checklist } from "./Checklist";
import { CustomField } from "./CustomField";
import { Label } from "./Label";
import { List } from "./List";
import { Member } from "./Member";
import { Membership } from "./Membership";
import { Organization } from "./Organization";
import { Plugin } from "./Plugin";
/**
 * Boards are fundamental to Trello. A board may belong to 0 or 1 teams and can
 * have 0 or more lists.
 * @see https://developers.trello.com/reference#boards-2
 * @class
 */
export declare class Board extends BaseResource {
    getBoard(params?: {
        boardStars?: BoardStarsFilter;
        cardPluginData?: boolean;
        fields?: AllOrFieldOrListOf<BoardField>;
        pluginData?: boolean;
        organizationPluginData?: boolean;
        myPrefs?: boolean;
        tags?: boolean;
    } & NestedActionsParams & NestedCardsParams & NestedChecklistsParams & NestedCustomFieldsParams & NestedLabelsParams & NestedListsParams & NestedMembersParams & NestedMembersInvitedParams & NestedMembershipsParams & NestedNotificationsParams & NestedOrganizationParams): TypedFetch<BoardRecord>;
    getBoards(params?: {
        filter?: BoardFilter;
        fields?: AllOrFieldOrListOf<BoardField>;
    } & NestedActionsParams & NestedListsParams & NestedMembershipsParams & NestedOrganizationParams): TypedFetch<BoardRecord[]>;
    getBoardsFilteredBy(filter: BoardFilter): TypedFetch<unknown>;
    getFieldValue<T>(field: BoardField): TypedFetch<ValueResponse<T>>;
    getBoardPlugins(): TypedFetch<BoardPluginRecord[]>;
    getTags(): TypedFetch<unknown>;
    /**
     * This method can be used before moving a board into a paid organization to
     * see if the board contains members that aren't already paid for in the
     * organization.
     * @see https://developers.trello.com/reference#organizationsidnewbillableguestsidboard
     */
    getIfHasNewBillableGuests(): TypedFetch<unknown>;
    addBoard(params: {
        name: string;
        defaultLabels?: boolean;
        defaultLists?: boolean;
        desc?: string;
        idOrganization?: string;
        idBoardSource?: string;
        keepFromSource?: AllOrFieldOrListOf<KeepFromSourceField>;
        powerUps?: AllOrFieldOrListOf<PowerUp>;
        prefs?: {
            permissionLevel?: PermissionLevel;
            voting?: GroupPermission;
            comments?: GroupPermission;
            invitations?: Invitation;
            selfJoin?: boolean;
            cardCovers?: boolean;
            background?: string;
            cardAging?: CardAging;
        };
    }): TypedFetch<BoardRecord>;
    enableBoardPlugin(idPlugin: string): TypedFetch<unknown>;
    enablePowerUp(value: PowerUp): TypedFetch<unknown>;
    addTag(value: string): TypedFetch<unknown>;
    generateCalendarKey(): TypedFetch<unknown>;
    generateEmailKey(): TypedFetch<unknown>;
    markAsViewed(): TypedFetch<unknown>;
    updateBoard(params: {
        name?: string;
        desc?: string;
        closed?: boolean;
        subscribed?: boolean;
        idOrganization?: string;
        prefs?: {
            permissionLevel?: BoardPermissionLevel;
            selfJoin?: boolean;
            cardCovers?: boolean;
            hideVotes?: boolean;
            invitations?: Invitation;
            voting?: GroupPermission;
            comments?: GroupPermission;
            background?: string;
            cardAging?: CardAging;
            calendarFeedEnabled?: boolean;
        };
        labelNames?: {
            green?: string;
            yellow?: string;
            orange?: string;
            red?: string;
            purple?: string;
            blue?: string;
        };
    }): TypedFetch<unknown>;
    updateClosedStatus(value: boolean): TypedFetch<unknown>;
    updateDescription(value: string): TypedFetch<unknown>;
    moveToOrganization(organizationId: string): TypedFetch<unknown>;
    updateLabelNameForColor(labelColor: ColorName, labelName: string): TypedFetch<unknown>;
    updateName(value: string): TypedFetch<unknown>;
    updateSubscribed(value: boolean): TypedFetch<unknown>;
    deleteBoard(): TypedFetch<unknown>;
    disableBoardPlugin(idPlugin: string): TypedFetch<unknown>;
    disablePowerUp(powerUp: PowerUp): TypedFetch<unknown>;
    actions(idAction?: string): Action<BoardActionType>;
    boardStars(idBoardStar?: string): BoardStar;
    cards(idCard?: string): Card;
    checklists(idChecklist?: string): Checklist;
    customFields(): CustomField;
    labels(idLabel?: string): Label;
    lists(idList?: string): List;
    members(idMember?: string): Member;
    membersInvited(): Member;
    memberships(idMembership?: string): Membership;
    myPrefs(): BoardMyPrefs;
    organization(): Organization;
    plugins(): Plugin;
    prefs(): BoardPref;
}