@nutanix-scratch/aiops-js-client 4.0.1-alpha.1 → 4.0.1

package/dist/es/ApiClient.d.ts

@@ -3,7 +3,7 @@
 * application to use this class directly - the *Api and model classes provide the public API for the service. The
 * contents of this file should be regarded as internal but are documented for completeness.
 * @module ApiClient
-* @version 4.0.1-alpha-1
+* @version 4.0.1
 */
 export class ApiClient {
     /**
@@ -12,9 +12,9 @@ export class ApiClient {
     * which can further be used in other HTTP operations.
     *
     * @param object Object from which ETag needs to be retrieved
-    * @returns returns ETag header in the object if it's an API response object, otherwise null
+    * @returns {(String|null)} returns ETag header in the object if it's an API response object, otherwise null
     */
-    static getEtag(object: any): any;
+    static getEtag(object: any): (string | null);
     static getValueForCaseInsensitiveKeyMatch(object: any, key: any): any;
     static addEtagReferenceToHeader(bodyParam: any, headerParams: any): void;
     static parseDate(str: any): Date;
@@ -35,7 +35,12 @@ export class ApiClient {
      * @param obj {Object|Array} The target object or array.
      */
     static constructFromObject(data: any | any[], obj: any | any[], itemType: any): void;
-    protocol: any;
+    /**
+    * URI scheme for connecting to the cluster (HTTP or HTTPS using SSL/TLS)
+    * @type {String}
+    * @default https
+    */
+    scheme: string;
     /**
      * The hostname of the URL against which to resolve every API call's (relative) path.
      * @type {String}
@@ -60,11 +65,17 @@ export class ApiClient {
      */
     defaultHeaders: Array<string>;
     /**
-     * The default HTTP timeout for all API calls.
+     * The default HTTP read timeout in milliseconds for all API calls.
      * @type {Number}
      * @default 30000
      */
-    timeout: number;
+    readTimeout: number;
+    /**
+    * The default HTTP connection timeout in milliseconds for all API calls.
+    * @type {Number}
+    * @default 30000
+    */
+    connectTimeout: number;
     /**
      * If set to false an additional timestamp parameter is added to all API GET calls to
      * prevent browser caching
@@ -73,10 +84,11 @@ export class ApiClient {
      */
     cache: boolean;
     /**
-     * Saved Cookies
-     * @default null
+     * The maximum number of redirects to be followed for all API calls.
+     * @type {Number}
+     * @default 1
      */
-    cookie: string;
+    maxRedirects: number;
     /**
      * The maximum number of retry attempts to be made by the client
      * in case of server error.
@@ -99,7 +111,6 @@ export class ApiClient {
      * Allow SDK to print debug logs
      */
     debug: boolean;
-    logger: any;
     /**
      * Username for basic auth
      */
@@ -108,51 +119,29 @@ export class ApiClient {
      * Password for basic auth
      */
     password: any;
-    /**
-     * Enable/Disable SSL Verification
-     * @param verifySsl (boolean)
-     */
-    set verifySsl(arg: any);
+    downloadDestination: string;
     /**
      * Configure log file to write activity logs
      * @param logfile The destination file (write stream / string)
      */
     set loggerFile(arg: any);
+    /**
+     * Enable/Disable SSL Verification
+     * @param verifySsl (boolean)
+     */
+    set verifySsl(arg: boolean);
+    get verifySsl(): boolean;
     /**
      * Adds key value pair to default headers map, (to be added to every API call request)
-     * @param key The key (string)
-     * @param value The corresponding value (string)
+     * @param {String} key The key
+     * @param {String} value The corresponding value
      */
-    addDefaultHeader(key: any, value: any): void;
+    addDefaultHeader(key: string, value: string): void;
     paramToString(param: any): any;
     buildUrl(path: any, pathParams: any): string;
-    isJsonMime(contentType: any): boolean;
-    jsonPreferredMime(contentTypes: any): any;
-    isFileParam(param: any): boolean;
-    normalizeParams(params: any): {};
     buildCollectionParam(param: any, collectionFormat: any): any;
-    applyAuthToRequest(request: any, authNames: any): void;
-    /**
-    * Deserializes an HTTP response body into a value of the specified type.
-    * @param {Object} response A SuperAgent response object.
-    * @param {(String|Array.<String>|Object.<String, Object>|Function)} returnType The type to return. Pass a string for simple types
-    * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To
-    * return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type:
-    * all properties on <code>data<code> will be converted to this type.
-    * @returns A value of the specified type.
-    */
-    deserialize(response: any, returnType: (string | Array<string> | any | Function)): any;
-    /**
-    * Set pagination data if response is a Paginable object
-    * @param {Object} data The response data already passed through deserialize
-    * @param {String} path The path given to callApi method
-    * @param {Object.<String, Object>} queryParams The queryParams given to callApi method
-    */
-    paginateIfNeeded(data: any, path: string, queryParams: any): void;
+    setApiKey(key: any): void;
     addEtagToReservedMap(response: any, data: any): any;
-    updateCookies(response: any): void;
-    attachCookies(request: any): void;
-    debugLog(...messages: any[]): void;
     /**
      * Invokes the REST service using the supplied settings and parameters.
      * @param {String} path The base URL to invoke.
@@ -170,6 +159,7 @@ export class ApiClient {
      * @returns {Promise} A {@link https://www.promisejs.org/|Promise} object.
      */
     callApi(path: string, httpMethod: string, pathParams: any, queryParams: any, headerParams: any, formParams: any, bodyParam: any, authNames: Array<string>, contentTypes: Array<string>, accepts: Array<string>, returnType: (string | any[] | any | Function)): Promise<any>;
+    #private;
 }
 export namespace ApiClient {
     const instance: ApiClient;