noticebord-client/lib/services/team_notice_service.d.ts

The official Typescript client library for the Noticebord API.

import { Service } from "./service";
import { ListTeamNotice, Paginated, TeamNotice } from "../models";
import { SaveTeamNoticeRequest } from "../requests";
export declare class TeamNoticeService extends Service {
    constructor(token: string, baseUrl: string);
    /**
     * Create a new notice
     *
     * @param {Number} team The team ID
     * @param {SaveTeamNoticeRequest} request The notice to create.
     */
    createTeamNotice(team: number, request: SaveTeamNoticeRequest): Promise<ListTeamNotice>;
    /**
     * Fetch a list of all notices.
     *
     * @param {Number} team The team ID
     */
    fetchTeamNotices(team: number, cursor?: string): Promise<Paginated<TeamNotice>>;
    /**
     * Fetch a single notice by ID
     *
     * @param {Number} team The team ID
     * @param {Number} id The id of the notice to find.
     */
    fetchTeamNotice(team: number, id: number): Promise<TeamNotice>;
    /**
     * Update an existing notice
     *
     * @param {Number} team The team ID
     * @param {number} id The id of the notice to update.
     * @param {SaveTeamNoticeRequest} request The notice to create.
     */
    updateTeamNotice(team: number, id: number, request: SaveTeamNoticeRequest): Promise<TeamNotice>;
    /**
     * Delete an existing notice
     *
     * @param {Number} team The team ID
     * @param {number} id The id of the notice to delete.
     */
    deleteTeamNotice(team: number, id: number): Promise<void>;
}