@nutanix-scratch/objects-js-client 4.0.1-alpha.2

package/dist/es/ApiClient.d.ts

@@ -0,0 +1,159 @@
+/**
+* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
+* 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-2
+*/
+export class ApiClient {
+    /**
+    * Get ETag from an object if exists.
+    * The ETag is usually provided in the response of the GET API calls,
+    * which can further be used in other HTTP operations.
+    *
+    * @param object Object from which ETag needs to be retrieved
+    * @returns {(String|null)} returns ETag header in the object if it's an API response object, otherwise null
+    */
+    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;
+    static parseQueryParam(path: any, queryParams: any, param: any, defaultValue: any): any;
+    /**
+     * Converts a value to the specified type.
+     * @param {(String|Object)} data The data to convert, as a string or object.
+     * @param {(String|Array.<String>|Object.<String, Object>|Function)} type 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 An instance of the specified type or null or undefined if data is null or undefined.
+     */
+    static convertToType(data: (string | any), type: (string | Array<string> | any | Function)): any;
+    /**
+     * Constructs a new map or array model from REST data.
+     * @param data {Object|Array} The REST data.
+     * @param obj {Object|Array} The target object or array.
+     */
+    static constructFromObject(data: any | any[], obj: any | any[], itemType: any): void;
+    /**
+    * 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}
+     * @default localhost
+    */
+    host: string;
+    /**
+     * The port of the base URL.
+     * @type {String}
+     * @default 9440
+    */
+    port: string;
+    /**
+     * The authentication methods to be included for all API calls.
+     * @type {Array.<String>}
+     */
+    authentications: Array<string>;
+    /**
+     * The default HTTP headers to be included for all API calls.
+     * @type {Array.<String>}
+     * @default {}
+     */
+    defaultHeaders: Array<string>;
+    /**
+     * The default HTTP read timeout in milliseconds for all API calls.
+     * @type {Number}
+     * @default 30000
+     */
+    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
+     * @type {Boolean}
+     * @default true
+     */
+    cache: boolean;
+    /**
+     * The maximum number of retry attempts to be made by the client
+     * in case of server error.
+     * @type {Number}
+     * @default 5
+     */
+    maxRetryAttempts: number;
+    /**
+     * The delay period (in milliseconds) between two consecutive retry attempts
+     * @type {Number}
+     * @default 3000
+     */
+    retryInterval: number;
+    agent: any;
+    /**
+     * Allow user to override superagent agent
+     */
+    requestAgent: any;
+    /**
+     * Allow SDK to print debug logs
+     */
+    debug: boolean;
+    /**
+     * Username for basic auth
+     */
+    username: any;
+    /**
+     * Password for basic auth
+     */
+    password: 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 {String} key The key
+     * @param {String} value The corresponding value
+     */
+    addDefaultHeader(key: string, value: string): void;
+    paramToString(param: any): any;
+    buildUrl(path: any, pathParams: any): string;
+    buildCollectionParam(param: any, collectionFormat: any): any;
+    addEtagToReservedMap(response: any, data: any): any;
+    /**
+     * Invokes the REST service using the supplied settings and parameters.
+     * @param {String} path The base URL to invoke.
+     * @param {String} httpMethod The HTTP method to use.
+     * @param {Object.<String, String>} pathParams A map of path parameters and their values.
+     * @param {Object.<String, Object>} queryParams A map of query parameters and their values.
+     * @param {Object.<String, Object>} headerParams A map of header parameters and their values.
+     * @param {Object.<String, Object>} formParams A map of form parameters and their values.
+     * @param {Object} bodyParam The value to pass as the request body.
+     * @param {Array.<String>} authNames An array of authentication type names.
+     * @param {Array.<String>} contentTypes An array of request MIME types.
+     * @param {Array.<String>} accepts An array of acceptable response MIME types.
+     * @param {(String|Array|Object|Function)} returnType The required type to return; can be a string for simple types or the
+     * constructor for a complex type.
+     * @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;
+}