@opentap/runner-client 1.0.0-alpha.37.12

package/lib/SessionClient.d.ts

@@ -0,0 +1,543 @@
+import { BreakPoints, CommonContext, CommonSettings, ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileParameter, FileResponse, Image, InstalledFile, Interaction, Links, ListItemType, LogList, Parameter, ProfileGroup, RepositoryPackageDefinition, RepositoryPackageReference, RepositorySettingsPackageDefinition, RunStatus, Setting, SettingsTapPackage, TestPlan, TestStep, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
+export declare class SessionClient {
+    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>;
+}