@zowe/cics-for-zowe-sdk
Version:
Zowe SDK for IBM CICS Transaction Server
36 lines (35 loc) • 2.02 kB
TypeScript
/**
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
import { type AbstractSession } from "@zowe/imperative";
import type { ICMCIApiResponse, IProgramParms, ITransactionParms, IURIMapParms } from "../../doc";
/**
* Discard a program installed in CICS through CMCI REST API
* @param {AbstractSession} session - the session to connect to CMCI with
* @param {IProgramParms} parms - parameters for discarding your program
* @returns {Promise<ICMCIApiResponse>} promise that resolves to the response (XML parsed into a javascript object)
* when the request is complete
* @throws {ImperativeError} CICS program name not defined or blank
* @throws {ImperativeError} CICS region name not defined or blank
* @throws {ImperativeError} CicsCmciRestClient request fails
*/
export declare function discardProgram(session: AbstractSession, parms: IProgramParms): Promise<ICMCIApiResponse>;
/**
* Discard a transaction installed in CICS through CMCI REST API
* @param {AbstractSession} session - the session to connect to CMCI with
* @param {ITransactionParms} parms - parameters for discarding your transaction
* @returns {Promise<ICMCIApiResponse>} promise that resolves to the response (XML parsed into a javascript object)
* when the request is complete
* @throws {ImperativeError} CICS transaction name not defined or blank
* @throws {ImperativeError} CICS region name not defined or blank
* @throws {ImperativeError} CicsCmciRestClient request fails
*/
export declare function discardTransaction(session: AbstractSession, parms: ITransactionParms): Promise<ICMCIApiResponse>;
export declare function discardUrimap(session: AbstractSession, parms: IURIMapParms): Promise<ICMCIApiResponse>;