@onboardbase/cli
Version:
[](https://www.npmjs.com/package/@onboardbase/cli) [](https://www.npmjs.com/package/@onboardbase/cli) [ • 4.52 kB
TypeScript
import { Axios } from "axios";
import { IAuthenticateTokenResult } from "./types/auth";
export interface IAPIEnvironment {
id: string;
title: string;
member: boolean;
secretVersion: number;
}
export interface IAPIProjectEnvironment {
id: string;
title: string;
member: boolean;
}
export interface IAPISecret {
id: string;
key: string;
keySha: string;
value: string;
comment: string;
member: true;
user: {
email: string;
};
environment: IAPIEnvironment;
project: IAPIProjectEnvironment;
mergeRequest: boolean;
createdDate: boolean;
}
export declare class HTTPService {
private apiHost;
createRecommendation(accessToken: string, environmentId: string, secrets: {
key: string;
value: string;
}[], comment?: string): Promise<any>;
getCliEnvironment(project: string, environment: string, accessToken: string): Promise<any>;
fetchSecrets(project: string, environment: string, accessToken: string): Promise<any>;
downloadSecretsForRecommendation(localSecrets: Record<string, any>, recommendationProject: string, environmentToRecommendUpdateFor: string, accessToken: string): Promise<any[]>;
teamMateSignup(options: {
userId: any;
name: any;
authCode: any;
confirmationCode: string;
accessToken: string;
}): Promise<any>;
getTeamMateByCode(accessToken: string, confirmationCode: string): Promise<any>;
createProject(accessToken: any, title: any, description: string, environment?: string): Promise<void>;
signup(input: {
name: any;
email: any;
teamName: string;
authCode: any;
}): Promise<any>;
createShareLogs({ receiverId, receiverEmail, senderId, senderEmail, secrets, accessToken, }: {
receiverEmail: any;
receiverId: any;
senderEmail: string;
senderId: string;
secrets: string[];
accessToken: string;
}): Promise<any>;
fetchProjectTeammates(project: any, accessToken: string): Promise<any>;
getCurrentUser(accessToken: string): Promise<any>;
revokeAuthToken(token: any): Promise<any>;
getAuthToken(pollingCode: any): Promise<any>;
generateAuthCode(fingerprint: string, hostOS: string, hostname: string, hostARCH: string): Promise<any>;
static instance: Axios;
constructor(apiHost?: string);
checkEnvironmentAccess(accessToken: string, environmentId: string, revalidate?: boolean): Promise<any>;
getShareLogsQuery(userId: string): string;
getShareLogs(accessToken: string, userId: string): Promise<Array<{
id: string;
senderId: string;
senderEmail: string;
secrets: string[];
}>>;
getAcknowledgeShareLogsQuery(shareLogId: string): string;
acknowledgeShareLogs(accessToken: string, shareLogId: string): Promise<void>;
private _createGetSecretsQuery;
getSecrets(input: {
accessToken: string;
project: string;
environment: string;
}): Promise<IAPISecret[]>;
createFetchSecretQuery(token: string, publicKey: string): string;
makeOnboardbaseRequest(config: {
accessToken?: string;
query: string;
variables?: Record<string, any>;
headers?: Record<string, any>;
metricsName: string;
customErrMsg?: string;
returnErrorResponse?: boolean;
}): Promise<any>;
getAuthInfoFromDeviceToken({ token, publicKey, }: {
token: string;
publicKey: string;
}): Promise<IAuthenticateTokenResult | null>;
checkProjectAccess(accessToken: string, projectName: string): Promise<any>;
getEnvironmentVersion({ project, environment, accessToken, }: {
accessToken: string;
project: string;
environment: string;
}): Promise<any>;
fetchProjects(accessToken: string): Promise<{
id: string;
title: string;
member: boolean;
environments: {
list: {
title: string;
id: string;
member: boolean;
}[];
};
}[]>;
fetchSingleProject(accessToken: string, project: string): Promise<{
id: string;
environments: {
list: {
title: string;
id: string;
member: boolean;
}[];
};
}[]>;
createEnvironment(accessToken: string, project: string, environment: string): Promise<{
title: string;
id: string;
}>;
}