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

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

import { CustomFieldOptionRecord, CustomFieldRecord, CustomFieldType, NestedActionsParams, PositionOrFloat, TypedFetch } from "../typeDefs";
import { BaseResource } from "./BaseResource";
import { CustomFieldOption } from "./CustomFieldOption";
/**
 * Custom Fields are extra bits of structured data attached to cards when our
 * users need a bit more than what Trello provides. To use them users need to
 * enable the Custom Fields Power-Up.
 * @see https://developers.trello.com/reference#custom-fields
 * @class
 */
export declare class CustomField extends BaseResource {
    getCustomField(params?: NestedActionsParams): TypedFetch<CustomFieldRecord>;
    getCustomFields(params?: NestedActionsParams): TypedFetch<CustomFieldRecord[]>;
    addCustomField(params: {
        name: string;
        pos: PositionOrFloat;
        type: CustomFieldType;
        displayCardFront?: boolean;
        options?: CustomFieldOptionRecord[];
    }): TypedFetch<CustomFieldRecord>;
    updateCustomField(params: {
        name?: string;
        pos?: PositionOrFloat;
        displayCardFront?: boolean;
    }): TypedFetch<CustomFieldRecord>;
    deleteCustomField(): TypedFetch<unknown>;
    options(idOption?: string): CustomFieldOption;
}