@redocly/cli/lib/reunite/api/api-client.d.ts

[@Redocly](https://redocly.com) CLI is your all-in-one API documentation utility. It builds, manages, improves, and quality-checks your API descriptions, all of which comes in handy for various phases of the API Lifecycle. Create your own rulesets to make

import { type FetchWithTimeoutOptions } from '../../utils/fetch-with-timeout.js';
import type { ReadStream } from 'node:fs';
import type { Readable } from 'node:stream';
import type { ListRemotesResponse, PushResponse, UpsertRemoteResponse } from './types.js';
interface BaseApiClient {
    request(url: string, options: FetchWithTimeoutOptions): Promise<Response>;
}
type CommandOption = 'push' | 'push-status';
export type SunsetWarning = {
    sunsetDate: Date;
    isSunsetExpired: boolean;
};
export type SunsetWarningsBuffer = SunsetWarning[];
export declare class ReuniteApiError extends Error {
    status: number;
    constructor(message: string, status: number);
}
export declare class ReuniteApiClient implements BaseApiClient {
    protected command: string;
    sunsetWarnings: SunsetWarningsBuffer;
    constructor(command: string);
    request(url: string, options: FetchWithTimeoutOptions): Promise<Response>;
    private collectSunsetWarning;
    private getSunsetDate;
}
declare class RemotesApi {
    private client;
    private readonly domain;
    private readonly apiKey;
    constructor(client: BaseApiClient, domain: string, apiKey: string);
    protected getParsedResponse<T>(response: Response): Promise<T>;
    getDefaultBranch(organizationId: string, projectId: string): Promise<string>;
    upsert(organizationId: string, projectId: string, remote: {
        mountPath: string;
        mountBranchName: string;
    }): Promise<UpsertRemoteResponse>;
    push(organizationId: string, projectId: string, payload: PushPayload, files: {
        path: string;
        stream: ReadStream | Buffer;
    }[]): Promise<PushResponse>;
    getRemotesList({ organizationId, projectId, mountPath, }: {
        organizationId: string;
        projectId: string;
        mountPath: string;
    }): Promise<ListRemotesResponse>;
    getPush({ organizationId, projectId, pushId, }: {
        organizationId: string;
        projectId: string;
        pushId: string;
    }): Promise<PushResponse>;
}
export declare class ReuniteApi {
    private apiClient;
    private command;
    remotes: RemotesApi;
    constructor({ domain, apiKey, command, }: {
        domain: string;
        apiKey: string;
        command: CommandOption;
    });
    reportSunsetWarnings(): void;
}
export type PushPayload = {
    remoteId: string;
    commit: {
        message: string;
        branchName: string;
        sha?: string;
        url?: string;
        createdAt?: string;
        namespace?: string;
        repository?: string;
        author: {
            name: string;
            email: string;
            image?: string;
        };
    };
    isMainBranch?: boolean;
};
export declare function streamToBuffer(stream: ReadStream | Readable): Promise<Buffer>;
export {};
//# sourceMappingURL=api-client.d.ts.map