circleci-api
Version:
A Node and Browser client for the CircleCI API, written in TypeScript.
14 lines (13 loc) • 731 B
TypeScript
import { AllProjectsResponse, GitRequiredRequest, FollowProjectResponse, CircleOptions } from "../types";
/**
* All followed projects:
* @see https://circleci.com/docs/api/v1-reference/#projects
* @example GET - /projects
*/
export declare function getAllProjects(token: string, { circleHost }?: CircleOptions): Promise<AllProjectsResponse>;
/**
* Follow a new project. CircleCI will then monitor the project for automatic building of commits.
* @see https://circleci.com/docs/api/v1-reference/#follow-project
* @example POST - /project/:vcs-type/:username/:project/follow
*/
export declare function postFollowNewProject(token: string, { vcs, circleHost }: GitRequiredRequest): Promise<FollowProjectResponse>;