opentap-restapi-clients/dist/SessionClient.d.ts

This is the TypeScript Clients for the OpenTAP REST-API Plugin.

export declare module SessionClient {
    class Client {
        private http;
        private baseUrl;
        protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
        constructor(baseUrl?: string, http?: {
            fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
        });
        /**
         * Retrieve session logs
         * @param id (optional)
         * @param level (optional)
         * @param excludedSource (optional)
         * @param filterText (optional)
         * @param offset (optional)
         * @param limit (optional)
         * @return Successfully retrieved OpenTAP log messages.
         */
        getSessionLogs(id: string | undefined, level: number[] | null | undefined, excludedSource: string[] | null | undefined, filterText: string | null | undefined, offset: number | undefined, limit: number | undefined): Promise<LogList>;
        protected processGetSessionLogs(response: Response): Promise<LogList>;
        /**
         * Retrieve session log indexes
         * @param id (optional)
         * @param level (optional)
         * @param excludedSource (optional)
         * @param filterText (optional)
         * @param searchText (optional)
         * @return Logs indexes retrieved
         */
        sessionLogSearch(id: string | undefined, level: number[] | null | undefined, excludedSource: string[] | null | undefined, filterText: string | null | undefined, searchText: string | null | undefined): Promise<number[]>;
        protected processSessionLogSearch(response: Response): Promise<number[]>;
        /**
         * Retrieve log sources
         * @param id (optional)
         * @return Logs indexes retrieved
         */
        sessionLogSources(id: string | undefined): Promise<string[]>;
        protected processSessionLogSources(response: Response): Promise<string[]>;
        /**
         * Retrieve session log counts
         * @param id (optional)
         * @return Logs indexes retrieved
         */
        sessionLogCounts(id: string | undefined): Promise<{
            [key: string]: number;
        }>;
        protected processSessionLogCounts(response: Response): Promise<{
            [key: string]: number;
        }>;
        /**
         * Retrieve log severities
         * @return Log levels retrieved
         */
        logLevels(): Promise<{
            [key: string]: string;
        }>;
        protected processLogLevels(response: Response): Promise<{
            [key: string]: string;
        }>;
        /**
         * Retrieve testplan run logs
         * @param id (optional)
         * @param level (optional)
         * @param excludedSource (optional)
         * @param filterText (optional)
         * @param offset (optional)
         * @param limit (optional)
         * @return Logs retrieved
         */
        testPlanRunLogs(id: string | undefined, level: number[] | null | undefined, excludedSource: string[] | null | undefined, filterText: string | null | undefined, offset: number | undefined, limit: number | undefined): Promise<LogList>;
        protected processTestPlanRunLogs(response: Response): Promise<LogList>;
        /**
         * Search testplan run logs
         * @param id (optional)
         * @param level (optional)
         * @param excludedSource (optional)
         * @param filterText (optional)
         * @param searchText (optional)
         * @return Logs indexes retrieved
         */
        testPlanRunLogSearch(id: string | undefined, level: number[] | null | undefined, excludedSource: string[] | null | undefined, filterText: string | null | undefined, searchText: string | null | undefined): Promise<number[]>;
        protected processTestPlanRunLogSearch(response: Response): Promise<number[]>;
        /**
         * Retrieve testplan run log sources
         * @param id (optional)
         * @return Logs indexes retrieved
         */
        testPlanRunLogSources(id: string | undefined): Promise<string[]>;
        protected processTestPlanRunLogSources(response: Response): Promise<string[]>;
        /**
         * Retrieve testplan run log count
         * @param id (optional)
         * @return Logs indexes retrieved
         */
        testPlanRunLogCounts(id: string | undefined): Promise<{
            [key: string]: number;
        }>;
        protected processTestPlanRunLogCounts(response: Response): Promise<{
            [key: string]: number;
        }>;
        /**
         * Get status, with an optional testplan execution completion timeout
         * @param timeout (optional)
         */
        getStatus(timeout: number | null | undefined): Promise<RunStatus>;
        protected processGetStatus(response: Response): Promise<RunStatus>;
        /**
         * Load a .TapPlan from the OpenTAP installation.
         * @return Test plan loaded. List of load errors is returned.
         */
        loadTestPlanFile(testPlanPath: string): Promise<string[]>;
        protected processLoadTestPlanFile(response: Response): Promise<string[]>;
        /**
         * Upload .TapPlan XML
         * @param testPlanName (optional)
         * @return Test plan loaded
         */
        setTestPlanXML(testPlanName: string | null | undefined, planXML: string): Promise<void>;
        protected processSetTestPlanXML(response: Response): Promise<void>;
        /**
         * Retrieve loaded test plan XML
         * @return Test plan retrieved
         */
        getTestPlanXML(): Promise<string>;
        protected processGetTestPlanXML(response: Response): Promise<string>;
        /**
         * Upload test plan XML
         * @param testPlanName (optional)
         * @return Test plan loaded. List of load errors is returned.
         */
        setTestPlanXMLNonInteractive(testPlanName: string | null | undefined, planXML: string): Promise<string[]>;
        protected processSetTestPlanXMLNonInteractive(response: Response): Promise<string[]>;
        /**
         * Load test plan using a test plan TapPackage from a repository
         * @return Test plan loaded. List of load errors is returned.
         */
        loadTestPlanFromRepository(packageReference: RepositoryPackageReference): Promise<string[]>;
        protected processLoadTestPlanFromRepository(response: Response): Promise<string[]>;
        /**
         * Save currently loaded test plan to a repository
         * @return Test plan uploaded.
         */
        saveTestPlanToRepository(packageReference: RepositoryPackageDefinition): Promise<void>;
        protected processSaveTestPlanToRepository(response: Response): Promise<void>;
        /**
         * Test plan resources opened
         * @return Test plan resources opened.
         */
        resourcesOpen(): Promise<TestPlan>;
        protected processResourcesOpen(response: Response): Promise<TestPlan>;
        /**
         * Test plan resources closed
         * @return Test plan resources closed.
         */
        resourcesClose(): Promise<TestPlan>;
        protected processResourcesClose(response: Response): Promise<TestPlan>;
        /**
         * Retrieve test plan or test step settings
         * @return Test step retrieved
         */
        getSettings(contextId: string): Promise<Setting[]>;
        protected processGetSettings(response: Response): Promise<Setting[]>;
        /**
         * Change test plan or test step settings
         * @return Settings changed
         */
        setSettings(contextId: string, settings: Setting[]): Promise<Setting[]>;
        protected processSetSettings(response: Response): Promise<Setting[]>;
        /**
         * Retrieve test plan structure
         * @param properties (optional)
         * @return Test plan retrieved
         */
        getTestPlan(properties: string[] | null | undefined): Promise<TestPlan>;
        protected processGetTestPlan(response: Response): Promise<TestPlan>;
        /**
         * Change test plan structure
         * @return Test plan changed
         */
        setTestPlan(plan: TestPlan): Promise<TestPlan>;
        protected processSetTestPlan(response: Response): Promise<TestPlan>;
        /**
         * Retrieve all validation errors present in the test plan
         * @return Retrieved validation errors for loaded TestPlan
         */
        getValidationErrors(): Promise<TestStepValidationError[]>;
        protected processGetValidationErrors(response: Response): Promise<TestStepValidationError[]>;
        /**
         * Retrieve or change common test step settings
         * @return Common test step settings retrieved or changed
         */
        commonStepSettings(commonSettings: CommonSettings): Promise<CommonSettings>;
        protected processCommonStepSettings(response: Response): Promise<CommonSettings>;
        /**
         * Retrieve or invoke common test step settings context menu items
         * @return Get context menu (right-click menu) for a property in the testplan or teststep
         */
        commonStepSettingsContextMenu(propertyName: string | null, commonContext: CommonContext): Promise<CommonContext>;
        protected processCommonStepSettingsContextMenu(response: Response): Promise<CommonContext>;
        /**
         * Retrieve all pending user input IDs
         * @return Retrieved pending user inputs
         */
        getUserInputs(): Promise<string[]>;
        protected processGetUserInputs(response: Response): Promise<string[]>;
        /**
         * Retrieve pending user input based on ID
         * @return Retrieved pending user input
         */
        getUserInput(id: string): Promise<Interaction>;
        protected processGetUserInput(response: Response): Promise<Interaction>;
        /**
         * Modify or answer pending user input based on ID
         */
        setUserInput(id: string, interaction: Interaction): Promise<Interaction>;
        protected processSetUserInput(response: Response): Promise<Interaction>;
        /**
         * Property context menu
         * @return Get context menu (right-click menu) for a property in the testplan or teststep
         */
        getContextMenu(contextId: string, propertyName: string | null): Promise<Setting[]>;
        protected processGetContextMenu(response: Response): Promise<Setting[]>;
        /**
         * Property context menu
         * @return Set context menu (right-click menu) for a property in the testplan or teststep
         */
        setContextMenu(contextId: string, propertyName: string | null, contextMenu: Setting[]): Promise<Setting[]>;
        protected processSetContextMenu(response: Response): Promise<Setting[]>;
        /**
         * Get data grid
         * @return Get data grid
         */
        getDataGrid(contextId: string, propertyName: string | null): Promise<DataGridControl>;
        protected processGetDataGrid(response: Response): Promise<DataGridControl>;
        /**
         * Set data grid
         * @return Set data grid
         */
        setDataGrid(contextId: string, propertyName: string | null, dataGridControl: DataGridControl): Promise<DataGridControl>;
        protected processSetDataGrid(response: Response): Promise<DataGridControl>;
        /**
         * Add item to data grid
         * @return Add data grid item
         */
        addDataGridItemType(contextId: string, propertyName: string | null, typeName: string | null): Promise<DataGridControl>;
        protected processAddDataGridItemType(response: Response): Promise<DataGridControl>;
        /**
         * Add item to data grid
         * @return Add data grid item
         */
        addDataGridItem(contextId: string, propertyName: string | null): Promise<DataGridControl>;
        protected processAddDataGridItem(response: Response): Promise<DataGridControl>;
        /**
         * Get item types available in the data grid
         * @return Add data grid item
         */
        getDataGridTypes(contextId: string, propertyName: string | null): Promise<ListItemType[]>;
        protected processGetDataGridTypes(response: Response): Promise<ListItemType[]>;
        /**
         * Get installed files to be used in FilePaths
         * @param extension (optional)
         * @return Get installed files
         */
        getInstalledFiles(extension: string | null | undefined): Promise<InstalledFile[]>;
        protected processGetInstalledFiles(response: Response): Promise<InstalledFile[]>;
        /**
         * Retrieve static available step type information.
         * @return StepTypes retrieved
         */
        getTestStepTypes(): Promise<TestStepType[]>;
        protected processGetTestStepTypes(response: Response): Promise<TestStepType[]>;
        /**
         * DEPRECATED. Use /edit/plan/repository/load (LoadTestPlanFromRepository) instead
         * @return Test plan loaded. List of load errors is returned.
         * @deprecated
         */
        loadTestPlanFromRepositoryReference(packageReference: RepositoryPackageReference): Promise<string[]>;
        protected processLoadTestPlanFromRepositoryReference(response: Response): Promise<string[]>;
        /**
         * DEPRECATED. Use /edit/settings/{contextId} (GetSettings) instead
         * @return Test step retrieved
         * @deprecated
         */
        getTestStep(stepId: string): Promise<TestStep>;
        protected processGetTestStep(response: Response): Promise<TestStep>;
        /**
         * DEPRECATED. Use /edit/settings/{contextId} (SetSettings) instead
         * @return Test step changed
         * @deprecated
         */
        setTestStep(stepId: string, step: TestStep): Promise<TestStep>;
        protected processSetTestStep(response: Response): Promise<TestStep>;
        /**
         * DEPRECATED. Use /edit/settings/{contextId} (GetSettings) instead
         * @return Get testplan properties
         * @deprecated
         */
        getTestPlanSettings(): Promise<TestPlan>;
        protected processGetTestPlanSettings(response: Response): Promise<TestPlan>;
        /**
         * DEPRECATED. Use /edit/settings/{contextId} (SetSettings) instead
         * @return Set testplan properties
         * @deprecated
         */
        setTestPlanSettings(testPlan: TestPlan): Promise<TestPlan>;
        protected processSetTestPlanSettings(response: Response): Promise<TestPlan>;
        /**
         * DEPRECATED. Use /edit/settings/{contextId}/{propertyName}/contextmenu (GetContextMenu) instead
         * @return Get context menu (right-click menu) for a property in a step
         * @deprecated
         */
        getTestStepContextMenu(stepId: string, propertyName: string | null): Promise<Setting[]>;
        protected processGetTestStepContextMenu(response: Response): Promise<Setting[]>;
        /**
         * DEPRECATED. Use /edit/settings/{contextId}/{propertyName}/contextmenu (SetContextMenu) instead
         * @return Set context menu (right-click menu) for a property in a step
         * @deprecated
         */
        setTestStepContextMenu(stepId: string, propertyName: string | null, contextMenu: Setting[]): Promise<Setting[]>;
        protected processSetTestStepContextMenu(response: Response): Promise<Setting[]>;
        /**
         * DEPRECATED. Use /edit/settings/{contextId}/{propertyName}/contextmenu (GetContextMenu) instead
         * @return Get context menu (right-click menu) for a property in the testplan
         * @deprecated
         */
        getTestPlanContextMenu(propertyName: string | null): Promise<Setting[]>;
        protected processGetTestPlanContextMenu(response: Response): Promise<Setting[]>;
        /**
         * DEPRECATED. Use /edit/settings/{contextId}/{propertyName}/contextmenu (SetContextMenu) instead
         * @return Set context menu (right-click menu) for a property in the testplan
         * @deprecated
         */
        setTestPlanContextMenu(propertyName: string | null, contextMenu: Setting[]): Promise<Setting[]>;
        protected processSetTestPlanContextMenu(response: Response): Promise<Setting[]>;
        /**
         * DEPRECATED. Use /edit/datagrid/{contextId}/{propertyName} (GetDataGrid) instead
         * @return Get data grid
         * @deprecated
         */
        getDataGridDeprecated(stepId: string, propertyName: string | null): Promise<DataGridControl>;
        protected processGetDataGridDeprecated(response: Response): Promise<DataGridControl>;
        /**
         * DEPRECATED. Use /edit/datagrid/{contextId}/{propertyName} (SetDataGrid) instead
         * @return Set data grid
         * @deprecated
         */
        setDataGridDeprecated(stepId: string, propertyName: string | null, dataGridControl: DataGridControl): Promise<DataGridControl>;
        protected processSetDataGridDeprecated(response: Response): Promise<DataGridControl>;
        /**
         * DEPRECATED. Use //edit/datagrid/{contextId}/{propertyName}/new/{typeName} (AddDataGridItemType) instead
         * @return Add data grid item
         * @deprecated
         */
        addDataGridItemTypeDeprecated(stepId: string, propertyName: string | null, typeName: string | null): Promise<DataGridControl>;
        protected processAddDataGridItemTypeDeprecated(response: Response): Promise<DataGridControl>;
        /**
         * DEPRECATED. Use /edit/datagrid/{contextId}/{propertyName}/new (AddDataGridItem) instead
         * @return Add data grid item
         * @deprecated
         */
        addDataGridItemDeprecated(stepId: string, propertyName: string | null): Promise<DataGridControl>;
        protected processAddDataGridItemDeprecated(response: Response): Promise<DataGridControl>;
        /**
         * DEPRECATED. Use /edit/datagrid/{contextId}/{propertyName}/availabletypes (GetDataGridTypes) instead
         * @return Add data grid item
         * @deprecated
         */
        getDataGridTypesDeprecated(stepId: string, propertyName: string | null): Promise<ListItemType[]>;
        protected processGetDataGridTypesDeprecated(response: Response): Promise<ListItemType[]>;
        /**
         * Pause test plan execution at next possible test step
         */
        setPauseNext(): Promise<void>;
        protected processSetPauseNext(response: Response): Promise<void>;
        /**
         * Retrieve breakpoints set in test plan
         */
        getBreakpoints(): Promise<BreakPoints>;
        protected processGetBreakpoints(response: Response): Promise<BreakPoints>;
        /**
         * Set breakpoints in test plan
         */
        setBreakpoints(breakPointsDto: BreakPoints): Promise<BreakPoints>;
        protected processSetBreakpoints(response: Response): Promise<BreakPoints>;
        /**
         * Jump test plan execution to step. Execution state must be 'breaking'.
         */
        setJumpToStep(stepId: string): Promise<void>;
        protected processSetJumpToStep(response: Response): Promise<void>;
        /**
         * Execute test plan
         */
        runTestPlan(): Promise<RunStatus>;
        protected processRunTestPlan(response: Response): Promise<RunStatus>;
        /**
         * Execute test plan with attaching metadata
         */
        runTestPlanMetadata(parameters: Parameter[]): Promise<RunStatus>;
        protected processRunTestPlanMetadata(response: Response): Promise<RunStatus>;
        /**
         * Abort test plan execution
         */
        abortTestPlan(): Promise<void>;
        protected processAbortTestPlan(response: Response): Promise<void>;
        /**
         * Shuts down session
         */
        shutdown(): Promise<void>;
        protected processShutdown(response: Response): Promise<void>;
        /**
         * Retrieves installed packages in this session
         */
        getImage(): Promise<Image>;
        protected processGetImage(response: Response): Promise<Image>;
        /**
         * Retrieves session readiness
         */
        getReadiness(): Promise<void>;
        protected processGetReadiness(response: Response): Promise<void>;
        /**
         * Retrieves watchdog
         */
        getWatchDog(): Promise<WatchDog>;
        protected processGetWatchDog(response: Response): Promise<WatchDog>;
        /**
         * Sets a new watchdog
         */
        setWatchDog(watchDog: WatchDog): Promise<WatchDog>;
        protected processSetWatchDog(response: Response): Promise<WatchDog>;
        /**
         * Links to other applications or services
         */
        getLinks(): Promise<Links>;
        protected processGetLinks(response: Response): Promise<Links>;
        /**
         * Retrieve component settings overview
         */
        getComponentSettingsOverview(): Promise<ComponentSettingsIdentifier[]>;
        protected processGetComponentSettingsOverview(response: Response): Promise<ComponentSettingsIdentifier[]>;
        /**
         * Change componentsettings
         */
        setComponentSettings(groupName: string | null, name: string | null, returnedSettings: ComponentSettingsBase): Promise<ComponentSettingsBase>;
        protected processSetComponentSettings(response: Response): Promise<ComponentSettingsBase>;
        /**
         * Retrieve componentsettings
         */
        getComponentSettings(groupName: string | null, name: string | null): Promise<ComponentSettingsBase>;
        protected processGetComponentSettings(response: Response): Promise<ComponentSettingsBase>;
        /**
         * Retrieve componentsettings list item
         */
        getComponentSettingsListItem(groupName: string | null, name: string | null, index: number): Promise<ComponentSettingsListItem>;
        protected processGetComponentSettingsListItem(response: Response): Promise<ComponentSettingsListItem>;
        /**
         * Set componentsettings list item settings
         */
        setComponentSettingsListItem(groupName: string | null, name: string | null, index: number, item: ComponentSettingsListItem): Promise<ComponentSettingsListItem>;
        protected processSetComponentSettingsListItem(response: Response): Promise<ComponentSettingsListItem>;
        /**
         * Get component setting data grid
         * @return Get component setting data grid
         */
        getComponentSettingDataGrid(groupName: string | null, name: string | null, index: number, propertyName: string | null): Promise<DataGridControl>;
        protected processGetComponentSettingDataGrid(response: Response): Promise<DataGridControl>;
        /**
         * Set component setting data grid
         * @return Set data grid
         */
        setComponentSettingDataGrid(groupName: string | null, name: string | null, index: number, propertyName: string | null, dataGridControl: DataGridControl): Promise<DataGridControl>;
        protected processSetComponentSettingDataGrid(response: Response): Promise<DataGridControl>;
        /**
         * Add component setting item to data grid
         * @return Add component setting data grid item
         */
        addComponentSettingDataGridItemType(groupName: string | null, name: string | null, index: number, propertyName: string | null, typeName: string | null): Promise<DataGridControl>;
        protected processAddComponentSettingDataGridItemType(response: Response): Promise<DataGridControl>;
        /**
         * Add component setting item to data grid
         * @return Add component setting data grid item
         */
        addComponentSettingDataGridItem(groupName: string | null, name: string | null, index: number, propertyName: string | null): Promise<DataGridControl>;
        protected processAddComponentSettingDataGridItem(response: Response): Promise<DataGridControl>;
        /**
         * Get item types available in the component setting data grid
         * @return Get component setting data grid types
         */
        getComponentSettingDataGridTypes(groupName: string | null, name: string | null, index: number, propertyName: string | null): Promise<ListItemType[]>;
        protected processGetComponentSettingDataGridTypes(response: Response): Promise<ListItemType[]>;
        /**
         * Change componentsettings profiles
         */
        setComponentSettingsProfiles(returnedSettings: ProfileGroup[]): Promise<ProfileGroup[]>;
        protected processSetComponentSettingsProfiles(response: Response): Promise<ProfileGroup[]>;
        /**
         * Get componentsettings profiles
         */
        getComponentSettingsProfiles(): Promise<ProfileGroup[]>;
        protected processGetComponentSettingsProfiles(response: Response): Promise<ProfileGroup[]>;
        /**
         * Upload exported OpenTAP Settings files
         * @param file (optional)
         */
        uploadComponentSettings(file: FileParameter | null | undefined): Promise<void>;
        protected processUploadComponentSettings(response: Response): Promise<void>;
        /**
         * DEPRECATED: Use /componentsettings/load (LoadComponentSettingsFromRepository) instead
         * @deprecated
         */
        loadComponentSettingsFromPackageReference(packageReference: RepositoryPackageReference): Promise<ErrorResponse[]>;
        protected processLoadComponentSettingsFromPackageReference(response: Response): Promise<ErrorResponse[]>;
        /**
         * Load a component settings TapPackage by referencing a package in a package repository
         */
        loadComponentSettingsFromRepository(packageReference: RepositoryPackageReference): Promise<ErrorResponse[]>;
        protected processLoadComponentSettingsFromRepository(response: Response): Promise<ErrorResponse[]>;
        /**
         * Save a TapPackage containing component settings in a package repository
         * @return Settings TapPackage uploaded.
         */
        saveComponentSettingsToRepository(repositoryPackageDefinition: RepositorySettingsPackageDefinition): Promise<void>;
        protected processSaveComponentSettingsToRepository(response: Response): Promise<void>;
        /**
         * Retrieve types available to be added to specified component settings list
         */
        getComponentSettingsListAvailableTypes(groupName: string | null, name: string | null): Promise<ListItemType[]>;
        protected processGetComponentSettingsListAvailableTypes(response: Response): Promise<ListItemType[]>;
        /**
         * Adds a new item to a component settings list
         */
        addComponentSettingsListItem(groupName: string | null, name: string | null, typeName: string | null): Promise<ComponentSettingsBase>;
        protected processAddComponentSettingsListItem(response: Response): Promise<ComponentSettingsBase>;
        /**
         * Retrieve settings types used in creating a Settings TapPackage
         */
        getSettingsTypes(): Promise<string[]>;
        protected processGetSettingsTypes(response: Response): Promise<string[]>;
        /**
         * Download a TapPackage containing settings files
         */
        downloadSettingsPackage(settingsTapPackage: SettingsTapPackage): Promise<FileResponse>;
        protected processDownloadSettingsPackage(response: Response): Promise<FileResponse>;
    }
    class LogList implements ILogList {
        logs?: LogEntry[] | undefined;
        offset?: number;
        filteredCount?: number;
        totalCount?: {
            [key: string]: number;
        } | undefined;
        constructor(data?: ILogList);
        init(_data?: any): void;
        static fromJS(data: any): LogList;
        toJSON(data?: any): any;
    }
    interface ILogList {
        logs?: LogEntry[] | undefined;
        offset?: number;
        filteredCount?: number;
        totalCount?: {
            [key: string]: number;
        } | undefined;
    }
    class LogEntry implements ILogEntry {
        source?: string | undefined;
        timestamp?: number;
        message?: string | undefined;
        level?: number;
        durationNS?: number;
        constructor(data?: ILogEntry);
        init(_data?: any): void;
        static fromJS(data: any): LogEntry;
        toJSON(data?: any): any;
    }
    interface ILogEntry {
        source?: string | undefined;
        timestamp?: number;
        message?: string | undefined;
        level?: number;
        durationNS?: number;
    }
    class MissingLicenseResponse implements IMissingLicenseResponse {
        message?: string | undefined;
        constructor(data?: IMissingLicenseResponse);
        init(_data?: any): void;
        static fromJS(data: any): MissingLicenseResponse;
        toJSON(data?: any): any;
    }
    interface IMissingLicenseResponse {
        message?: string | undefined;
    }
    class RunStatus implements IRunStatus {
        sessionId?: string;
        verdict?: Verdict;
        testPlanRunId?: string | undefined;
        failedToStart?: boolean;
        executionState?: ExecutionState;
        executingSteps?: string[] | undefined;
        constructor(data?: IRunStatus);
        init(_data?: any): void;
        static fromJS(data: any): RunStatus;
        toJSON(data?: any): any;
    }
    interface IRunStatus {
        sessionId?: string;
        verdict?: Verdict;
        testPlanRunId?: string | undefined;
        failedToStart?: boolean;
        executionState?: ExecutionState;
        executingSteps?: string[] | undefined;
    }
    /** Enumeration containing the verdict types used for Verdict and Verdict properties. */
    enum Verdict {
        NotSet = "NotSet",
        Pass = "Pass",
        Inconclusive = "Inconclusive",
        Fail = "Fail",
        Aborted = "Aborted",
        Error = "Error"
    }
    enum ExecutionState {
        Idle = "Idle",
        Executing = "Executing",
        Breaking = "Breaking",
        Aborting = "Aborting"
    }
    class ErrorResponse implements IErrorResponse {
        type?: string | undefined;
        message?: string | undefined;
        parameter?: string | undefined;
        source?: string | undefined;
        stackTrace?: string | undefined;
        inner?: ErrorResponse | undefined;
        constructor(data?: IErrorResponse);
        init(_data?: any): void;
        static fromJS(data: any): ErrorResponse;
        toJSON(data?: any): any;
    }
    interface IErrorResponse {
        type?: string | undefined;
        message?: string | undefined;
        parameter?: string | undefined;
        source?: string | undefined;
        stackTrace?: string | undefined;
        inner?: ErrorResponse | undefined;
    }
    class RepositoryPackageReference implements IRepositoryPackageReference {
        name?: string | undefined;
        version?: string | undefined;
        repository?: string | undefined;
        path?: string | undefined;
        constructor(data?: IRepositoryPackageReference);
        init(_data?: any): void;
        static fromJS(data: any): RepositoryPackageReference;
        toJSON(data?: any): any;
    }
    interface IRepositoryPackageReference {
        name?: string | undefined;
        version?: string | undefined;
        repository?: string | undefined;
        path?: string | undefined;
    }
    class RepositoryPackageDefinition extends RepositoryPackageReference implements IRepositoryPackageDefinition {
        tags?: string[] | undefined;
        constructor(data?: IRepositoryPackageDefinition);
        init(_data?: any): void;
        static fromJS(data: any): RepositoryPackageDefinition;
        toJSON(data?: any): any;
    }
    interface IRepositoryPackageDefinition extends IRepositoryPackageReference {
        tags?: string[] | undefined;
    }
    class TestPlan implements ITestPlan {
        childTestSteps?: TestStep[] | undefined;
        settings?: Setting[] | undefined;
        isOpen?: boolean;
        propertiesToInclude?: string[] | undefined;
        id?: string;
        constructor(data?: ITestPlan);
        init(_data?: any): void;
        static fromJS(data: any): TestPlan;
        toJSON(data?: any): any;
    }
    interface ITestPlan {
        childTestSteps?: TestStep[] | undefined;
        settings?: Setting[] | undefined;
        isOpen?: boolean;
        propertiesToInclude?: string[] | undefined;
        id?: string;
    }
    class TestStep implements ITestStep {
        id?: string;
        childTestSteps?: TestStep[] | undefined;
        isChildTestStepsReadOnly?: boolean;
        isReadOnly?: boolean;
        settings?: Setting[] | undefined;
        typeName?: string | undefined;
        typeDisplay?: DisplayAttribute | undefined;
        name?: string | undefined;
        protected _discriminator: string;
        constructor(data?: ITestStep);
        init(_data?: any): void;
        static fromJS(data: any): TestStep;
        toJSON(data?: any): any;
    }
    interface ITestStep {
        id?: string;
        childTestSteps?: TestStep[] | undefined;
        isChildTestStepsReadOnly?: boolean;
        isReadOnly?: boolean;
        settings?: Setting[] | undefined;
        typeName?: string | undefined;
        typeDisplay?: DisplayAttribute | undefined;
        name?: string | undefined;
    }
    abstract class AnnotatedObject implements IAnnotatedObject {
        visualStatus?: VisualStatus | undefined;
        valueType?: string | undefined;
        display?: DisplayAttribute | undefined;
        metaData?: MetaData | undefined;
        externalParameter?: ExternalParameter | undefined;
        constructor(data?: IAnnotatedObject);
        init(_data?: any): void;
        static fromJS(data: any): AnnotatedObject;
        toJSON(data?: any): any;
    }
    interface IAnnotatedObject {
        visualStatus?: VisualStatus | undefined;
        valueType?: string | undefined;
        display?: DisplayAttribute | undefined;
        metaData?: MetaData | undefined;
        externalParameter?: ExternalParameter | undefined;
    }
    class Setting extends AnnotatedObject implements ISetting {
        errors?: string[] | undefined;
        layout?: Layout | undefined;
        columnDisplayName?: ColumnDisplayName | undefined;
        valueDescription?: string | undefined;
        propertyName?: string | undefined;
        icons?: Icon[] | undefined;
        protected _discriminator: string;
        constructor(data?: ISetting);
        init(_data?: any): void;
        static fromJS(data: any): Setting;
        toJSON(data?: any): any;
    }
    interface ISetting extends IAnnotatedObject {
        errors?: string[] | undefined;
        layout?: Layout | undefined;
        columnDisplayName?: ColumnDisplayName | undefined;
        valueDescription?: string | undefined;
        propertyName?: string | undefined;
        icons?: Icon[] | undefined;
    }
    class Layout implements ILayout {
        mode?: LayoutMode;
        rowHeight?: number;
        maxRowHeight?: number;
        constructor(data?: ILayout);
        init(_data?: any): void;
        static fromJS(data: any): Layout;
        toJSON(data?: any): any;
    }
    interface ILayout {
        mode?: LayoutMode;
        rowHeight?: number;
        maxRowHeight?: number;
    }
    /** The supported layout modes. */
    enum LayoutMode {
        Normal = "Normal",
        FullRow = "FullRow",
        FloatBottom = "FloatBottom"
    }
    class ColumnDisplayName implements IColumnDisplayName {
        columnName?: string | undefined;
        order?: number;
        isReadOnly?: boolean;
        constructor(data?: IColumnDisplayName);
        init(_data?: any): void;
        static fromJS(data: any): ColumnDisplayName;
        toJSON(data?: any): any;
    }
    interface IColumnDisplayName {
        columnName?: string | undefined;
        order?: number;
        isReadOnly?: boolean;
    }
    class Icon implements IIcon {
        iconName?: string | undefined;
        invoke?: boolean | undefined;
        stepReference?: string | undefined;
        propertyReference?: string | undefined;
        constructor(data?: IIcon);
        init(_data?: any): void;
        static fromJS(data: any): Icon;
        toJSON(data?: any): any;
    }
    interface IIcon {
        iconName?: string | undefined;
        invoke?: boolean | undefined;
        stepReference?: string | undefined;
        propertyReference?: string | undefined;
    }
    class VisualStatus implements IVisualStatus {
        isReadOnly?: boolean;
        isVisible?: boolean;
        isEnabled?: boolean;
        constructor(data?: IVisualStatus);
        init(_data?: any): void;
        static fromJS(data: any): VisualStatus;
        toJSON(data?: any): any;
    }
    interface IVisualStatus {
        isReadOnly?: boolean;
        isVisible?: boolean;
        isEnabled?: boolean;
    }
    class DisplayAttribute implements IDisplayAttribute {
        description?: string | undefined;
        group?: string[] | undefined;
        name?: string | undefined;
        order?: number;
        collapsed?: boolean;
        constructor(data?: IDisplayAttribute);
        init(_data?: any): void;
        static fromJS(data: any): DisplayAttribute;
        toJSON(data?: any): any;
    }
    interface IDisplayAttribute {
        description?: string | undefined;
        group?: string[] | undefined;
        name?: string | undefined;
        order?: number;
        collapsed?: boolean;
    }
    class MetaData implements IMetaData {
        name?: string | undefined;
        macroName?: string | undefined;
        group?: string | undefined;
        frozen?: boolean;
        constructor(data?: IMetaData);
        init(_data?: any): void;
        static fromJS(data: any): MetaData;
        toJSON(data?: any): any;
    }
    interface IMetaData {
        name?: string | undefined;
        macroName?: string | undefined;
        group?: string | undefined;
        frozen?: boolean;
    }
    class ExternalParameter implements IExternalParameter {
        name?: string | undefined;
        constructor(data?: IExternalParameter);
        init(_data?: any): void;
        static fromJS(data: any): ExternalParameter;
        toJSON(data?: any): any;
    }
    interface IExternalParameter {
        name?: string | undefined;
    }
    class ButtonControl extends Setting implements IButtonControl {
        invokeMethod?: boolean;
        constructor(data?: IButtonControl);
        init(_data?: any): void;
        static fromJS(data: any): ButtonControl;
        toJSON(data?: any): any;
    }
    interface IButtonControl extends ISetting {
        invokeMethod?: boolean;
    }
    class ButtonsControl extends Setting implements IButtonsControl {
        availableValues?: AvailableValue[] | undefined;
        selectedIndex?: number;
        invokeMethod?: boolean;
        constructor(data?: IButtonsControl);
        init(_data?: any): void;
        static fromJS(data: any): ButtonsControl;
        toJSON(data?: any): any;
    }
    interface IButtonsControl extends ISetting {
        availableValues?: AvailableValue[] | undefined;
        selectedIndex?: number;
        invokeMethod?: boolean;
    }
    class AvailableValue implements IAvailableValue {
        name?: string | undefined;
        description?: string | undefined;
        constructor(data?: IAvailableValue);
        init(_data?: any): void;
        static fromJS(data: any): AvailableValue;
        toJSON(data?: any): any;
    }
    interface IAvailableValue {
        name?: string | undefined;
        description?: string | undefined;
    }
    class CheckBoxControl extends Setting implements ICheckBoxControl {
        boolValue?: boolean | undefined;
        constructor(data?: ICheckBoxControl);
        init(_data?: any): void;
        static fromJS(data: any): CheckBoxControl;
        toJSON(data?: any): any;
    }
    interface ICheckBoxControl extends ISetting {
        boolValue?: boolean | undefined;
    }
    class DataGridReferenceControl extends Setting implements IDataGridReferenceControl {
        constructor(data?: IDataGridReferenceControl);
        init(_data?: any): void;
        static fromJS(data: any): DataGridReferenceControl;
        toJSON(data?: any): any;
    }
    interface IDataGridReferenceControl extends ISetting {
    }
    class DataGridControl extends Setting implements IDataGridControl {
        items?: Setting[][] | undefined;
        fixedSize?: boolean;
        constructor(data?: IDataGridControl);
        init(_data?: any): void;
        static fromJS(data: any): DataGridControl;
        toJSON(data?: any): any;
    }
    interface IDataGridControl extends ISetting {
        items?: Setting[][] | undefined;
        fixedSize?: boolean;
    }
    class TextBoxControl extends Setting implements ITextBoxControl {
        stringValue?: string | undefined;
        constructor(data?: ITextBoxControl);
        init(_data?: any): void;
        static fromJS(data: any): TextBoxControl;
        toJSON(data?: any): any;
    }
    interface ITextBoxControl extends ISetting {
        stringValue?: string | undefined;
    }
    class ComboBoxControl extends TextBoxControl implements IComboBoxControl {
        suggestedValues?: string[] | undefined;
        constructor(data?: IComboBoxControl);
        init(_data?: any): void;
        static fromJS(data: any): ComboBoxControl;
        toJSON(data?: any): any;
    }
    interface IComboBoxControl extends ITextBoxControl {
        suggestedValues?: string[] | undefined;
    }
    class FilePathControl extends Setting implements IFilePathControl {
        stringValue?: string | undefined;
        fileExtension?: string | undefined;
        constructor(data?: IFilePathControl);
        init(_data?: any): void;
        static fromJS(data: any): FilePathControl;
        toJSON(data?: any): any;
    }
    interface IFilePathControl extends ISetting {
        stringValue?: string | undefined;
        fileExtension?: string | undefined;
    }
    class EnabledControl extends Setting implements IEnabledControl {
        isEnabled?: boolean | undefined;
        value?: Setting | undefined;
        constructor(data?: IEnabledControl);
        init(_data?: any): void;
        static fromJS(data: any): EnabledControl;
        toJSON(data?: any): any;
    }
    interface IEnabledControl extends ISetting {
        isEnabled?: boolean | undefined;
        value?: Setting | undefined;
    }
    class DropdownControl extends Setting implements IDropdownControl {
        availableValues?: AvailableValue[] | undefined;
        selectedIndex?: number;
        constructor(data?: IDropdownControl);
        init(_data?: any): void;
        static fromJS(data: any): DropdownControl;
        toJSON(data?: any): any;
    }
    interface IDropdownControl extends ISetting {
        availableValues?: AvailableValue[] | undefined;
        selectedIndex?: number;
    }
    class MultiSelectControl extends Setting implements IMultiSelectControl {
        availableValues?: AvailableValue[] | undefined;
        selectedIndex?: number[] | undefined;
        constructor(data?: IMultiSelectControl);
        init(_data?: any): void;
        static fromJS(data: any): MultiSelectControl;
        toJSON(data?: any): any;
    }
    interface IMultiSelectControl extends ISetting {
        availableValues?: AvailableValue[] | undefined;
        selectedIndex?: number[] | undefined;
    }
    class PasswordControl extends Setting implements IPasswordControl {
        password?: string | undefined;
        constructor(data?: IPasswordControl);
        init(_data?: any): void;
        static fromJS(data: any): PasswordControl;
        toJSON(data?: any): any;
    }
    interface IPasswordControl extends ISetting {
        password?: string | undefined;
    }
    class TestStepType extends TestStep implements ITestStepType {
        availableChildrenTypes?: string[] | undefined;
        constructor(data?: ITestStepType);
        init(_data?: any): void;
        static fromJS(data: any): TestStepType;
        toJSON(data?: any): any;
    }
    interface ITestStepType extends ITestStep {
        availableChildrenTypes?: string[] | undefined;
    }
    class TestStepValidationError implements ITestStepValidationError {
        stepId?: string | undefined;
        validationErrors?: ValidationError[] | undefined;
        constructor(data?: ITestStepValidationError);
        init(_data?: any): void;
        static fromJS(data: any): TestStepValidationError;
        toJSON(data?: any): any;
    }
    interface ITestStepValidationError {
        stepId?: string | undefined;
        validationErrors?: ValidationError[] | undefined;
    }
    class ValidationError implements IValidationError {
        propertyName?: string | undefined;
        error?: string | undefined;
        constructor(data?: IValidationError);
        init(_data?: any): void;
        static fromJS(data: any): ValidationError;
        toJSON(data?: any): any;
    }
    interface IValidationError {
        propertyName?: string | undefined;
        error?: string | undefined;
    }
    class CommonSettings implements ICommonSettings {
        step?: TestStep | undefined;
        stepIds?: string[] | undefined;
        constructor(data?: ICommonSettings);
        init(_data?: any): void;
        static fromJS(data: any): CommonSettings;
        toJSON(data?: any): any;
    }
    interface ICommonSettings {
        step?: TestStep | undefined;
        stepIds?: string[] | undefined;
    }
    class CommonContext implements ICommonContext {
        contextItems?: Setting[] | undefined;
        stepIds?: string[] | undefined;
        constructor(data?: ICommonContext);
        init(_data?: any): void;
        static fromJS(data: any): CommonContext;
        toJSON(data?: any): any;
    }
    interface ICommonContext {
        contextItems?: Setting[] | undefined;
        stepIds?: string[] | undefined;
    }
    class Interaction implements IInteraction {
        timeout?: string | undefined;
        title?: string | undefined;
        settings?: Setting[] | undefined;
        id?: string;
        constructor(data?: IInteraction);
        init(_data?: any): void;
        static fromJS(data: any): Interaction;
        toJSON(data?: any): any;
    }
    interface IInteraction {
        timeout?: string | undefined;
        title?: string | undefined;
        settings?: Setting[] | undefined;
        id?: string;
    }
    class ListItemType implements IListItemType {
        typeName?: string | undefined;
        typeDisplay?: DisplayAttribute | undefined;
        constructor(data?: IListItemType);
        init(_data?: any): void;
        static fromJS(data: any): ListItemType;
        toJSON(data?: any): any;
    }
    interface IListItemType {
        typeName?: string | undefined;
        typeDisplay?: DisplayAttribute | undefined;
    }
    class InstalledFile implements IInstalledFile {
        relativePath?: string | undefined;
        tapPackage?: string | undefined;
        constructor(data?: IInstalledFile);
        init(_data?: any): void;
        static fromJS(data: any): InstalledFile;
        toJSON(data?: any): any;
    }
    interface IInstalledFile {
        relativePath?: string | undefined;
        tapPackage?: string | undefined;
    }
    class BreakPoints implements IBreakPoints {
        testSteps?: string[] | undefined;
        constructor(data?: IBreakPoints);
        init(_data?: any): void;
        static fromJS(data: any): BreakPoints;
        toJSON(data?: any): any;
    }
    interface IBreakPoints {
        testSteps?: string[] | undefined;
    }
    class Parameter implements IParameter {
        group?: string | undefined;
        name?: string | undefined;
        macroName?: string | undefined;
        parentLevel?: string | undefined;
        value?: string | undefined;
        constructor(data?: IParameter);
        init(_data?: any): void;
        static fromJS(data: any): Parameter;
        toJSON(data?: any): any;
    }
    interface IParameter {
        group?: string | undefined;
        name?: string | undefined;
        macroName?: string | undefined;
        parentLevel?: string | undefined;
        value?: string | undefined;
    }
    class Image implements IImage {
        name?: string | undefined;
        packages?: PackageSpecifier[] | undefined;
        repositories?: string[] | undefined;
        id?: string | undefined;
        constructor(data?: IImage);
        init(_data?: any): void;
        static fromJS(data: any): Image;
        toJSON(data?: any): any;
    }
    interface IImage {
        name?: string | undefined;
        packages?: PackageSpecifier[] | undefined;
        repositories?: string[] | undefined;
        id?: string | undefined;
    }
    class PackageSpecifier implements IPackageSpecifier {
        name?: string | undefined;
        version?: string | undefined;
        architecture?: string | undefined;
        oS?: string | undefined;
        constructor(data?: IPackageSpecifier);
        init(_data?: any): void;
        static fromJS(data: any): PackageSpecifier;
        toJSON(data?: any): any;
    }
    interface IPackageSpecifier {
        name?: string | undefined;
        version?: string | undefined;
        architecture?: string | undefined;
        oS?: string | undefined;
    }
    class WatchDog implements IWatchDog {
        inactiveSeconds?: number;
        terminationTimeout?: number;
        constructor(data?: IWatchDog);
        init(_data?: any): void;
        static fromJS(data: any): WatchDog;
        toJSON(data?: any): any;
    }
    interface IWatchDog {
        inactiveSeconds?: number;
        terminationTimeout?: number;
    }
    class Links implements ILinks {
        editor?: string | undefined;
        constructor(data?: ILinks);
        init(_data?: any): void;
        static fromJS(data: any): Links;
        toJSON(data?: any): any;
    }
    interface ILinks {
        editor?: string | undefined;
    }
    abstract class ComponentSettingsBase implements IComponentSettingsBase {
        name?: string | undefined;
        groupName?: string | undefined;
        protected _discriminator: string;