@broadcom/endevor-for-zowe-cli/lib/api/EndevorClient.d.ts

Endevor Plug-in for Zowe CLI

import { IHandlerProgressApi, IHeaderContent, Session } from "@zowe/imperative";
import { IEndevorConfigTable } from "./configs/doc/IEndevorConfigTable";
import { IEndevorRestResponse, ElmSpecDictionary, AddUpdElmDictionary, DeleteElmDictionary, GenerateElmDictionary, MoveElmDictionary, PrintElmCompDictionary, PrintMemberDictionary, RetrieveElmDictionary, SigninElmDictionary, TransferElmDictionary, ListElmDictionary, ListInventories, ListInventoryDictionary, ListPkgDictionary, PkgSpecDictionary, PkgNotesDictionary, BackinBackoutPkgDictionary, CastPkgDictionary, DefinePkgDictionary, DeletePkgDictionary, ExecutePkgDictionary, SubmitPkgDictionary, QueryAcmDictionary, SubmitSCLDictionary, CommitPkgDictionary, EndevorWorkspaceResponse, IEndevorElement, IEndevorType, IEndevorTypeSequence, IEndevorAsyncTask, IEndevorAuthToken, IEndevorHealthCheckResponse, IEndevorProcessorGroup, IEndevorProcessorSymbol } from "./index";
import { IEndevorAcmComponents } from "./metadata/doc/IEndevorAcmComponents";
import { IEndevorEnvironment } from "./metadata/doc/IEndevorEnvironment";
import { IEndevorPackage } from "./metadata/doc/IEndevorPackage";
import { IEndevorStage } from "./metadata/doc/IEndevorStage";
import { IEndevorSubsystem } from "./metadata/doc/IEndevorSubsystem";
import { IEndevorSystem } from "./metadata/doc/IEndevorSystem";
import { EncodingDictionary, TaskDictionary, WorkspaceDictionary } from "./utils/doc/ActionArguments";
import { IEndevorCodepageConfig } from "./configs/doc/IEndevorCodepageConfig";
import { Stream } from "form-data";
export declare const listInstances: typeof ListInventories.listInstances;
export declare function setUserAgent(userAgent: string): void;
export declare function getUserAgentHeader(): IHeaderContent;
export declare const addElement: (session: Session) => (instance: string) => (args: ElmSpecDictionary & AddUpdElmDictionary & EncodingDictionary, fileInputStream?: Stream) => Promise<IEndevorRestResponse<void>>;
export declare const updateElement: (session: Session) => (instance: string) => (args: ElmSpecDictionary & AddUpdElmDictionary & EncodingDictionary, fileInputStream?: Stream) => Promise<IEndevorRestResponse<void>>;
export declare const deleteElement: (session: Session) => (instance: string) => (args: ElmSpecDictionary & DeleteElmDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const deleteElementAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & DeleteElmDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const generateElement: (session: Session) => (instance: string) => (args: ElmSpecDictionary & GenerateElmDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const generateElementAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & GenerateElmDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const moveElement: (session: Session) => (instance: string) => (args: ElmSpecDictionary & MoveElmDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const moveElementAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & MoveElmDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const printElement: (session: Session) => (instance: string) => (args: ElmSpecDictionary & PrintElmCompDictionary & EncodingDictionary) => Promise<IEndevorRestResponse<string>>;
export declare const printElementAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & PrintElmCompDictionary & EncodingDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const printComponent: (session: Session) => (instance: string) => (args: ElmSpecDictionary & PrintElmCompDictionary & EncodingDictionary) => Promise<IEndevorRestResponse<string>>;
export declare const printComponentAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & PrintElmCompDictionary & EncodingDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const printMember: (session: Session) => (instance: string) => (args: PrintMemberDictionary & EncodingDictionary) => Promise<IEndevorRestResponse<string>>;
export declare const printMemberAsync: (session: Session) => (instance: string) => (args: PrintMemberDictionary & EncodingDictionary) => Promise<IEndevorRestResponse<string>>;
export declare const retrieveElement: (session: Session) => (instance: string) => (args: ElmSpecDictionary & RetrieveElmDictionary & EncodingDictionary) => Promise<IEndevorRestResponse<Buffer>>;
export declare const viewElement: (session: Session) => (instance: string) => (args: ElmSpecDictionary & RetrieveElmDictionary & EncodingDictionary) => Promise<IEndevorRestResponse<Buffer>>;
export declare const signinElement: (session: Session) => (instance: string) => (args: ElmSpecDictionary & SigninElmDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const signinElementAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & SigninElmDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const transferElement: (session: Session) => (instance: string) => (args: ElmSpecDictionary & TransferElmDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const transferElementAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & TransferElmDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const confirmResolution: (args: WorkspaceDictionary) => Promise<EndevorWorkspaceResponse>;
export declare const listElement: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListElmDictionary) => Promise<IEndevorRestResponse<IEndevorElement>>;
export declare const listElementAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListElmDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const queryAcmComponent: (session: Session) => (instance: string) => (args: ElmSpecDictionary & QueryAcmDictionary) => Promise<IEndevorRestResponse<IEndevorAcmComponents>>;
export declare const queryAcmComponentAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & QueryAcmDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const listEnvironment: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListInventoryDictionary) => Promise<IEndevorRestResponse<IEndevorEnvironment>>;
export declare const listEnvironmentAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListInventoryDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const listStage: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListInventoryDictionary) => Promise<IEndevorRestResponse<IEndevorStage>>;
export declare const listStageAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListInventoryDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const listSystem: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListInventoryDictionary) => Promise<IEndevorRestResponse<IEndevorSystem>>;
export declare const listSystemAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListInventoryDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const listSubsystem: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListInventoryDictionary) => Promise<IEndevorRestResponse<IEndevorSubsystem>>;
export declare const listSubsystemAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListInventoryDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const listType: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListInventoryDictionary) => Promise<IEndevorRestResponse<IEndevorType>>;
export declare const listTypeAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListInventoryDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const listProcessorGroup: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListInventoryDictionary) => Promise<IEndevorRestResponse<IEndevorProcessorGroup>>;
export declare const listProcessorGroupAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListInventoryDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const listProcessorSymbol: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListInventoryDictionary) => Promise<IEndevorRestResponse<IEndevorProcessorSymbol>>;
export declare const listProcessorSymbolAsync: (session: Session) => (instance: string) => (args: ElmSpecDictionary & ListInventoryDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const listPackage: (session: Session) => (instance: string) => (args: PkgSpecDictionary & ListPkgDictionary) => Promise<IEndevorRestResponse<IEndevorPackage>>;
export declare const listPackageAsync: (session: Session) => (instance: string) => (args: PkgSpecDictionary & ListPkgDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const approvePackage: (session: Session) => (instance: string) => (args: PkgSpecDictionary & PkgNotesDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const approvePackageAsync: (session: Session) => (instance: string) => (args: PkgSpecDictionary & PkgNotesDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const denyPackage: (session: Session) => (instance: string) => (args: PkgSpecDictionary & PkgNotesDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const denyPackageAsync: (session: Session) => (instance: string) => (args: PkgSpecDictionary & PkgNotesDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const backinPackage: (session: Session) => (instance: string) => (args: PkgSpecDictionary & BackinBackoutPkgDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const backinPackageAsync: (session: Session) => (instance: string) => (args: PkgSpecDictionary & BackinBackoutPkgDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const backoutPackage: (session: Session) => (instance: string) => (args: PkgSpecDictionary & BackinBackoutPkgDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const backoutPackageAsync: (session: Session) => (instance: string) => (args: PkgSpecDictionary & BackinBackoutPkgDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const castPackage: (session: Session) => (instance: string) => (args: PkgSpecDictionary & CastPkgDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const castPackageAsync: (session: Session) => (instance: string) => (args: PkgSpecDictionary & CastPkgDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const createPackage: (session: Session) => (instance: string) => (args: PkgSpecDictionary & DefinePkgDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const updatePackage: (session: Session) => (instance: string) => (args: PkgSpecDictionary & DefinePkgDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const deletePackage: (session: Session) => (instance: string) => (args: PkgSpecDictionary & DeletePkgDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const deletePackageAsync: (session: Session) => (instance: string) => (args: PkgSpecDictionary & DeletePkgDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const executePackage: (session: Session) => (instance: string) => (args: PkgSpecDictionary & ExecutePkgDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const executePackageAsync: (session: Session) => (instance: string) => (args: PkgSpecDictionary & ExecutePkgDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const exportPackageSCL: (session: Session) => (instance: string) => (args: PkgSpecDictionary) => Promise<IEndevorRestResponse<string>>;
export declare const submitPackage: (session: Session) => (instance: string) => (args: PkgSpecDictionary & SubmitPkgDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const submitPackageAsync: (session: Session) => (instance: string) => (args: PkgSpecDictionary & SubmitPkgDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const resetPackage: (session: Session) => (instance: string) => (args: PkgSpecDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const resetPackageAsync: (session: Session) => (instance: string) => (args: PkgSpecDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const commitPackage: (session: Session) => (instance: string) => (args: PkgSpecDictionary & CommitPkgDictionary) => Promise<IEndevorRestResponse<void>>;
export declare const commitPackageAsync: (session: Session) => (instance: string) => (args: PkgSpecDictionary & CommitPkgDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const submitSCL: (session: Session) => (instance: string) => (args: SubmitSCLDictionary) => Promise<IEndevorRestResponse<string>>;
export declare const submitSCLAsync: (session: Session) => (instance: string) => (args: SubmitSCLDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const initWorkspace: (args: WorkspaceDictionary) => Promise<EndevorWorkspaceResponse>;
export declare const syncWorkspace: (session: Session) => (instance: string) => (args: ElmSpecDictionary & WorkspaceDictionary, progressApi?: IHandlerProgressApi) => Promise<EndevorWorkspaceResponse>;
export declare const unsyncWorkspace: (session: Session) => (instance: string) => (args: ElmSpecDictionary & WorkspaceDictionary, progressApi?: IHandlerProgressApi) => Promise<EndevorWorkspaceResponse>;
export declare const mergeElement: (session: Session) => (instance: string) => (args: ElmSpecDictionary & WorkspaceDictionary, progressApi?: IHandlerProgressApi) => Promise<EndevorWorkspaceResponse>;
export declare const downloadReport: (session: Session) => (instance: string) => (url: string) => Promise<string>;
export declare const downloadReportById: (session: Session) => (instance: string) => (reportId: string) => Promise<string>;
export declare const listC1Defaults: (session: Session) => (instance: string) => Promise<IEndevorRestResponse<IEndevorConfigTable>>;
export declare const listDialogDefaults: (session: Session) => (instance: string) => Promise<IEndevorRestResponse<IEndevorConfigTable>>;
export declare const listOptionalFeatures: (session: Session) => (instance: string) => Promise<IEndevorRestResponse<IEndevorConfigTable>>;
export declare const listSiteSymbols: (session: Session) => (instance: string) => Promise<IEndevorRestResponse<IEndevorConfigTable>>;
export declare const listTypeSequence: (session: Session) => (instance: string) => Promise<IEndevorRestResponse<IEndevorTypeSequence>>;
export declare const listTasks: (session: Session) => (instance: string) => (args: TaskDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const retrieveTaskResult: (session: Session) => (instance: string) => (args: TaskDictionary) => Promise<IEndevorRestResponse<IEndevorAsyncTask>>;
export declare const checkInstance: (session: Session) => (instance: string) => Promise<IEndevorHealthCheckResponse>;
export declare const listCodePageConfig: (session: Session) => (instance: string) => Promise<IEndevorCodepageConfig>;
export declare const getAuthToken: (session: Session) => (instance: string) => Promise<IEndevorRestResponse<IEndevorAuthToken>>;