@zowe/zos-files-for-zowe-sdk/lib/doc/IRestClientResponse.d.ts

Zowe SDK to interact with files and data sets on z/OS

import { Session, Logger } from "@zowe/imperative";
/**
 * Interface to map client's REST call response
 * @export
 * @deprecated - Use Imperative's IRestClientResponse instead
 * @interface IRestClientResponse
 */
export interface IRestClientResponse {
    /**
     * Status whether or not a REST request was successful by HTTP status code
     * @type {boolean}
     * @memberof IRestClientResponse
     */
    requestSuccess?: boolean;
    /**
     * Status whether or not a REST request was successful by HTTP status code
     * Reverse of requestSuccess
     * @type {boolean}
     * @memberof IRestClientResponse
     */
    requestFailure?: boolean;
    /**
     * Http(s) response body as a buffer
     * @type {Buffer}
     * @memberof IRestClientResponse
     */
    data?: Buffer;
    /**
     * Http(s) response body as a string
     * @type {string}
     * @memberof IRestClientResponse
     */
    dataString?: string;
    /**
     * Http(s) response object
     * @type {any}
     * @memberof IRestClientResponse
     */
    response?: any;
    /**
     * Session object
     * @type {Session}
     * @memberof IRestClientResponse
     */
    session?: Session;
    /**
     * Logger object
     * @type {Logger}
     * @memberof IRestClientResponse
     */
    log?: Logger;
}
//# sourceMappingURL=IRestClientResponse.d.ts.map