canny-api-js/build/module/lib/Tags.d.ts

Unofficial node API wrapper for Canny's API (https://canny.io/).

import { AxiosInstance } from 'axios';
interface ICannyTagsListArgs {
    /** The id of the board you'd like to fetch tags for. */
    boardID: string;
    /** The number of tags you'd like to fetch. Defaults to 10 if not specified. */
    limit?: number;
    /** The number of tags you'd like to skip before starting to fetch. Defaults to 0 if not specified. */
    skip?: number;
}
interface ICannyTagsListResponse {
    hasMore: boolean;
    tags: ICannyTag[];
}
interface ICannyTagsCreateArgs {
    /** The unique identifier of the board the tag should be created for. */
    boardID: string;
    /** The name of the tag. */
    name: string;
}
export default class Tags {
    static TAGS_RETRIEVE_ROUTE: string;
    static TAGS_LIST_ROUTE: string;
    static TAGS_CREATE_ROUTE: string;
    private axios;
    constructor(axios: AxiosInstance);
    retrieve(id: string): Promise<ICannyTag>;
    list(args?: ICannyTagsListArgs): Promise<ICannyTagsListResponse>;
    create(args: ICannyTagsCreateArgs): Promise<ICannyTag>;
}
export {};