@nutanix-scratch/objects-js-client 4.0.1-beta.1 → 4.0.2

package/dist/lib/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-beta-1
+* @version 4.0.2
 */
 export class ApiClient {
     /**
@@ -41,12 +41,6 @@ export class ApiClient {
     * @default https
     */
     scheme: string;
-    /**
-     * The hostname of the URL against which to resolve every API call's (relative) path.
-     * @type {String}
-     * @default localhost
-    */
-    host: string;
     /**
      * The port of the base URL.
      * @type {String}
@@ -102,11 +96,21 @@ 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
      */
     requestAgent: any;
+    /**
+     * Allow SDK to fetch version info and negotiate version
+     */
+    allowVersionNegotiation: boolean;
     /**
      * Allow SDK to print debug logs
      */
@@ -131,6 +135,16 @@ export class ApiClient {
      */
     set verifySsl(arg: boolean);
     get verifySsl(): boolean;
+    /**
+     * Set the hostname for base URL
+     * @param {String} hostname the hostname
+     */
+    set host(arg: string);
+    /**
+     * Get the hostname for base URL
+     * @returns {String} the hostname
+     */
+    get host(): string;
     /**
      * Adds key value pair to default headers map, (to be added to every API call request)
      * @param {String} key The key
@@ -142,6 +156,19 @@ export class ApiClient {
     buildCollectionParam(param: any, collectionFormat: any): any;
     setApiKey(key: any): void;
     addEtagToReservedMap(response: any, data: any): any;
+    /**
+    * Get SDK's negotiated version.
+    * @returns {String} negotiated version.
+    */
+    getNegotiatedVersion(): string;
+    /**
+     * Call relevant options api and negotiate version
+     * Negotiated version available via getNegotiatedVersion()
+     * @param {ApiClient} selfInstance
+     * @param {Array.<String>} authNames An array of allowed authentication type names i.e. basicAuthScheme
+     * @returns {Promise<ApiClient>} a {@link https://www.promisejs.org/|Promise}
+     */
+    negotiateVersion(selfInstance: ApiClient, authNames: Array<string>): Promise<ApiClient>;
     /**
      * Invokes the REST service using the supplied settings and parameters.
      * @param {String} path The base URL to invoke.
@@ -159,6 +186,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>;
+    callApiInternal(path: any, httpMethod: any, pathParams: any, queryParams: any, headerParams: any, formParams: any, bodyParam: any, authNames: any, contentTypes: any, accepts: any, returnType: any): Promise<any>;
     #private;
 }
 export namespace ApiClient {