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

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.2-alpha-1
+* @version 4.0.2
 */
 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;
@@ -83,6 +83,12 @@ export class ApiClient {
      * @default true
      */
     cache: boolean;
+    /**
+     * The maximum number of redirects to be followed for all API calls.
+     * @type {Number}
+     * @default 1
+     */
+    maxRedirects: number;
     /**
      * The maximum number of retry attempts to be made by the client
      * in case of server error.
@@ -96,6 +102,12 @@ export class ApiClient {
      * @default 3000
      */
     retryInterval: number;
+    /**
+     * A boolean value that indicates whether cross-site Access-Control requests should be made using auth credentials.
+     * @type {Boolean}
+     * @default false
+     */
+    withCredentials: boolean;
     agent: any;
     /**
      * Allow user to override superagent agent
@@ -113,6 +125,7 @@ export class ApiClient {
      * Password for basic auth
      */
     password: any;
+    downloadDestination: string;
     /**
      * Configure log file to write activity logs
      * @param logfile The destination file (write stream / string)
@@ -126,13 +139,14 @@ export class ApiClient {
     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;
     buildCollectionParam(param: any, collectionFormat: any): any;
+    setApiKey(key: any): void;
     addEtagToReservedMap(response: any, data: any): any;
     /**
      * Invokes the REST service using the supplied settings and parameters.