@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/api/service/EBGConnectionService.d.ts

Endevor Bridge for Git plug-in for Zowe CLI

import { ApiResponse, CreateEndevorConnectionPayload, EBGRestService, EndevorConnectionResponse, RenameConnectionPayload, UpdateEndevorCredentialsPayload } from "@broadcom/endevor-bridge-for-git-rest-api";
export declare class EBGConnectionService {
    /**
     * Lists connections
     * @return list of IEndevorConnection
     * @param ebgService
     */
    static listConnections(ebgService: EBGRestService): Promise<EndevorConnectionResponse[]>;
    /**
     * Lists connections
     * @param ebgService
     * @param name
     * @return list of IEndevorConnection
     */
    static getConnection(ebgService: EBGRestService, name: string): Promise<EndevorConnectionResponse[]>;
    /**
     * Create new connections
     * @param ebgService
     * @param payload - base URL, configuration, connection name
     * @return API response
     */
    static createConnection(ebgService: EBGRestService, payload: CreateEndevorConnectionPayload): Promise<ApiResponse>;
    /**
     * Deletes a connections
     *
     * @param ebgService
     * @param connection connection ID
     * @return API response
     */
    static deleteConnection(ebgService: EBGRestService, connection: string): Promise<ApiResponse>;
    /**
     * Rename existing connections
     * @param ebgService
     * @param payload - old name, new name
     * @return API response
     */
    static renameConnection(ebgService: EBGRestService, payload: RenameConnectionPayload): Promise<ApiResponse>;
    /**
     * Updates personal mainframe credentials for a connection
     *
     * @param ebgService
     * @param payload request payload
     * @return API response
     */
    static updateCredentials(ebgService: EBGRestService, payload: UpdateEndevorCredentialsPayload): Promise<ApiResponse>;
}