bump-cli
Version:
The Bump CLI is used to interact with your API documentation hosted on Bump.sh by using the API of developers.bump.sh
23 lines (22 loc) • 1.3 kB
TypeScript
import { Config } from '@oclif/core';
import { AxiosInstance, AxiosResponse } from 'axios';
import { DiffRequest, DiffResponse, PingResponse, PreviewRequest, PreviewResponse, VersionRequest, VersionResponse, WithDiff } from './models.js';
declare class BumpApi {
protected config?: Config | undefined;
protected readonly client: AxiosInstance;
getDiff: (diffId: string, format: string) => Promise<AxiosResponse<DiffResponse>>;
getPing: () => Promise<AxiosResponse<PingResponse>>;
getVersion: (versionId: string, token: string) => Promise<AxiosResponse<VersionResponse & WithDiff>>;
postDiff: (body: DiffRequest) => Promise<AxiosResponse<DiffResponse>>;
postPreview: (body?: PreviewRequest) => Promise<AxiosResponse<PreviewResponse>>;
postValidation: (body: VersionRequest, token: string) => Promise<AxiosResponse<void>>;
postVersion: (body: VersionRequest, token: string) => Promise<AxiosResponse<VersionResponse>>;
putPreview: (versionId: string, body?: PreviewRequest) => Promise<AxiosResponse<PreviewResponse>>;
private authorizationHeader;
private handleError;
private initializeResponseInterceptor;
constructor(config?: Config | undefined);
}
export { default as APIError } from './error.js';
export { BumpApi };
export * from './models.js';