UNPKG

@zowe/cics-for-zowe-sdk

Version:

Zowe SDK for IBM CICS Transaction Server

github.com/zowe/cics-for-zowe-client/blob/main/packages/sdk/README.md

zowe/cics-for-zowe-client

87 lines (86 loc) • 5.38 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/** * 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 { IBundleParms, ICMCIApiResponse, IProgramParms, ITransactionParms, IURIMapParms, IWebServiceParms } from "../../doc"; /** * Define a new program resource to CICS through CMCI REST API * @param {AbstractSession} session - the session to connect to CMCI with * @param {IProgramParms} parms - parameters for defining your program * @returns {Promise<any>} 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 CSD group not defined or blank * @throws {ImperativeError} CICS region name not defined or blank * @throws {ImperativeError} CicsCmciRestClient request fails */ export declare function defineProgram(session: AbstractSession, parms: IProgramParms): Promise<ICMCIApiResponse>; /** * Define a new transaction resource to CICS through CMCI REST API * @param {AbstractSession} session - the session to connect to CMCI with * @param {ITransactionParms} parms - parameters for defining your transaction * @returns {Promise<any>} 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 program name not defined or blank * @throws {ImperativeError} CICS CSD group not defined or blank * @throws {ImperativeError} CICS region name not defined or blank * @throws {ImperativeError} CicsCmciRestClient request fails */ export declare function defineTransaction(session: AbstractSession, parms: ITransactionParms): Promise<ICMCIApiResponse>; /** * Define a new server URIMap resource to CICS through CMCI REST API * @param {AbstractSession} session - the session to connect to CMCI with * @param {IURIMapParms} parms - parameters for defining your URIMap * @returns {Promise<any>} promise that resolves to the response (XML parsed into a javascript object) * when the request is complete * @throws {ImperativeError} CICS URIMap name not defined or blank * @throws {ImperativeError} CICS CSD group not defined or blank * @throws {ImperativeError} CICS URIMap path not defined or blank * @throws {ImperativeError} CICS URIMap host not defined or blank * @throws {ImperativeError} CICS URIMap scheme not defined or blank * @throws {ImperativeError} CICS region name not defined or blank * @throws {ImperativeError} CICS URIMap program name not defined or blank * @throws {ImperativeError} CicsCmciRestClient request fails */ export declare function defineUrimapServer(session: AbstractSession, parms: IURIMapParms): Promise<ICMCIApiResponse>; /** * Define a new client URIMap resource to CICS through CMCI REST API * @param {AbstractSession} session - the session to connect to CMCI with * @param {IURIMapParms} parms - parameters for defining your URIMap * @returns {Promise<any>} promise that resolves to the response (XML parsed into a javascript object) * when the request is complete * @throws {ImperativeError} CICS URIMap name not defined or blank * @throws {ImperativeError} CICS CSD group not defined or blank * @throws {ImperativeError} CICS URIMap path not defined or blank * @throws {ImperativeError} CICS URIMap host not defined or blank * @throws {ImperativeError} CICS URIMap scheme not defined or blank * @throws {ImperativeError} CICS region name not defined or blank * @throws {ImperativeError} CicsCmciRestClient request fails */ export declare function defineUrimapClient(session: AbstractSession, parms: IURIMapParms): Promise<ICMCIApiResponse>; /** * Define a new pipeline URIMap resource to CICS through CMCI REST API * @param {AbstractSession} session - the session to connect to CMCI with * @param {IURIMapParms} parms - parameters for defining your URIMap * @returns {Promise<any>} promise that resolves to the response (XML parsed into a javascript object) * when the request is complete * @throws {ImperativeError} CICS URIMap name not defined or blank * @throws {ImperativeError} CICS CSD group not defined or blank * @throws {ImperativeError} CICS URIMap path not defined or blank * @throws {ImperativeError} CICS URIMap host not defined or blank * @throws {ImperativeError} CICS URIMap scheme not defined or blank * @throws {ImperativeError} CICS region name not defined or blank * @throws {ImperativeError} CICS URIMap pipeline name not defined or blank * @throws {ImperativeError} CicsCmciRestClient request fails */ export declare function defineUrimapPipeline(session: AbstractSession, parms: IURIMapParms): Promise<ICMCIApiResponse>; export declare function defineWebservice(session: AbstractSession, parms: IWebServiceParms): Promise<ICMCIApiResponse>; export declare function defineBundle(session: AbstractSession, parms: IBundleParms): Promise<ICMCIApiResponse>;