ibm-cloud-sdk-core 4.0.0 → 4.0.2

package/lib/base-service.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2014, 2021.
+ * (C) Copyright IBM Corp. 2014, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -63,40 +63,39 @@ export declare class BaseService {
     private requestWrapperInstance;
     /**
      * Configuration values for a service.
-     * @param {Authenticator} userOptions.authenticator Object used to authenticate requests to the service.
-     * @param {string} [userOptions.serviceUrl] The base url to use when contacting the service.
+     *
+     * @param userOptions - the configuration options to set on the service instance.
+     * This should be an object with the following fields:
+     * - authenticator: (required) an Object used to authenticate requests to the service.
+     * - serviceUrl: (optional) the base url to use when contacting the service.
      *   The base url may differ between IBM Cloud regions.
-     * @param {object<string, string>} [userOptions.headers] Default headers that shall be
-     *   included with every request to the service.
-     * @param {string} [userOptions.version] The API version date to use with the service,
-     *   in "YYYY-MM-DD" format.
-     * @param {boolean} [userOptions.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
+     * - headers: (optional) a set of HTTP headers that should be included with every request sent to the service
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the server's SSL certificate should be
      *   disabled or not.
      */
     constructor(userOptions: UserOptions);
     /**
      * Get the instance of the authenticator set on the service.
      *
-     * @returns {Authenticator}
+     * @returns the Authenticator instance
      */
     getAuthenticator(): any;
     /**
      * Set the service URL to send requests to.
      *
-     * @param {string} url The base URL for the service.
+     * @param url - the base URL for the service.
      */
     setServiceUrl(url: string): void;
     /**
      * Set the HTTP headers to be sent in every request.
      *
-     * @param {OutgoingHttpHeaders} headers The map of headers to include in requests.
+     * @param headers - the map of headers to include in requests.
      */
     setDefaultHeaders(headers: OutgoingHttpHeaders): void;
     /**
      * Turn request body compression on or off.
      *
-     * @param {boolean} setting Will turn it on if 'true', off if 'false'.
+     * @param setting - Will turn it on if 'true', off if 'false'.
      */
     setEnableGzipCompression(setting: boolean): void;
     /**
@@ -107,7 +106,7 @@ export declare class BaseService {
     /**
      * Enable retries for unfulfilled requests.
      *
-     * @param {RetryOptions} retryOptions configuration for retries
+     * @param retryOptions - the configuration for retries
      */
     enableRetries(retryOptions?: RetryOptions): void;
     /**
@@ -117,30 +116,30 @@ export declare class BaseService {
     /**
      * Configure the service using external configuration
      *
-     * @param {string} serviceName The name of the service. Will be used to read from external
+     * @param serviceName - the name of the service. This will be used to read from external
      * configuration.
      */
     protected configureService(serviceName: string): void;
     /**
      * Wrapper around `sendRequest` that enforces the request will be authenticated.
      *
-     * @param {object} parameters Service request options passed in by user.
-     * @param {string} parameters.options.method The http method.
-     * @param {string} parameters.options.url The path portion of the URL to be appended to the serviceUrl.
-     * @param {object} [parameters.options.path] The path parameters to be inserted into the URL.
-     * @param {object} [parameters.options.qs] The querystring to be included in the URL.
-     * @param {object} [parameters.options.body] The data to be sent as the request body.
-     * @param {object} [parameters.options.form] An object containing the key/value pairs for a www-form-urlencoded request.
-     * @param {object} [parameters.options.formData] An object containing the contents for a multipart/form-data request
-     * The following processing is performed on formData values:
-     * - string: no special processing -- the value is sent as is
-     * - object: the value is converted to a JSON string before insertion into the form body
-     * - NodeJS.ReadableStream|Buffer|FileWithMetadata: sent as a file, with any associated metadata
-     * - array: each element of the array is sent as a separate form part using any special processing as described above
-     * @param {object} parameters.defaultOptions
-     * @param {string} parameters.defaultOptions.serviceUrl The base URL of the service.
-     * @param {OutgoingHttpHeaders} parameters.defaultOptions.headers Additional headers to be passed on the request.
-     * @returns {Promise<any>}
+     * @param parameters - Service request options passed in by user.
+     * This should be an object with the following fields:
+     * - options.method: the http method
+     * - options.url: the path portion of the URL to be appended to the serviceUrl
+     * - options.path: the path parameters to be inserted into the URL
+     * - options.qs: the querystring to be included in the URL
+     * - options.body: the data to be sent as the request body
+     * - options.form: an object containing the key/value pairs for a www-form-urlencoded request.
+     * - options.formData: an object containing the contents for a multipart/form-data request
+     *   The following processing is performed on formData values:
+     *     - string: no special processing -- the value is sent as is
+     *     - object: the value is converted to a JSON string before insertion into the form body
+     *     - NodeJS.ReadableStream|Buffer|FileWithMetadata: sent as a file, with any associated metadata
+     *     - array: each element of the array is sent as a separate form part using any special processing as described above
+     * - defaultOptions.serviceUrl: the base URL of the service
+     * - defaultOptions.headers: additional HTTP headers to be sent with the request
+     * @returns a Promise
      */
     protected createRequest(parameters: any): Promise<any>;
     private readOptionsFromExternalConfig;

package/lib/base-service.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2014, 2021.
+ * (C) Copyright IBM Corp. 2014, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -43,15 +43,14 @@ var request_wrapper_1 = require("./request-wrapper");
 var BaseService = /** @class */ (function () {
     /**
      * Configuration values for a service.
-     * @param {Authenticator} userOptions.authenticator Object used to authenticate requests to the service.
-     * @param {string} [userOptions.serviceUrl] The base url to use when contacting the service.
+     *
+     * @param userOptions - the configuration options to set on the service instance.
+     * This should be an object with the following fields:
+     * - authenticator: (required) an Object used to authenticate requests to the service.
+     * - serviceUrl: (optional) the base url to use when contacting the service.
      *   The base url may differ between IBM Cloud regions.
-     * @param {object<string, string>} [userOptions.headers] Default headers that shall be
-     *   included with every request to the service.
-     * @param {string} [userOptions.version] The API version date to use with the service,
-     *   in "YYYY-MM-DD" format.
-     * @param {boolean} [userOptions.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
+     * - headers: (optional) a set of HTTP headers that should be included with every request sent to the service
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the server's SSL certificate should be
      *   disabled or not.
      */
     function BaseService(userOptions) {
@@ -92,7 +91,7 @@ var BaseService = /** @class */ (function () {
     /**
      * Get the instance of the authenticator set on the service.
      *
-     * @returns {Authenticator}
+     * @returns the Authenticator instance
      */
     BaseService.prototype.getAuthenticator = function () {
         return this.authenticator;
@@ -100,7 +99,7 @@ var BaseService = /** @class */ (function () {
     /**
      * Set the service URL to send requests to.
      *
-     * @param {string} url The base URL for the service.
+     * @param url - the base URL for the service.
      */
     BaseService.prototype.setServiceUrl = function (url) {
         if (url) {
@@ -110,7 +109,7 @@ var BaseService = /** @class */ (function () {
     /**
      * Set the HTTP headers to be sent in every request.
      *
-     * @param {OutgoingHttpHeaders} headers The map of headers to include in requests.
+     * @param headers - the map of headers to include in requests.
      */
     BaseService.prototype.setDefaultHeaders = function (headers) {
         if (typeof headers !== 'object') {
@@ -122,7 +121,7 @@ var BaseService = /** @class */ (function () {
     /**
      * Turn request body compression on or off.
      *
-     * @param {boolean} setting Will turn it on if 'true', off if 'false'.
+     * @param setting - Will turn it on if 'true', off if 'false'.
      */
     BaseService.prototype.setEnableGzipCompression = function (setting) {
         this.requestWrapperInstance.setCompressRequestData(setting);
@@ -139,7 +138,7 @@ var BaseService = /** @class */ (function () {
     /**
      * Enable retries for unfulfilled requests.
      *
-     * @param {RetryOptions} retryOptions configuration for retries
+     * @param retryOptions - the configuration for retries
      */
     BaseService.prototype.enableRetries = function (retryOptions) {
         this.requestWrapperInstance.enableRetries(retryOptions);
@@ -153,7 +152,7 @@ var BaseService = /** @class */ (function () {
     /**
      * Configure the service using external configuration
      *
-     * @param {string} serviceName The name of the service. Will be used to read from external
+     * @param serviceName - the name of the service. This will be used to read from external
      * configuration.
      */
     BaseService.prototype.configureService = function (serviceName) {
@@ -169,23 +168,23 @@ var BaseService = /** @class */ (function () {
     /**
      * Wrapper around `sendRequest` that enforces the request will be authenticated.
      *
-     * @param {object} parameters Service request options passed in by user.
-     * @param {string} parameters.options.method The http method.
-     * @param {string} parameters.options.url The path portion of the URL to be appended to the serviceUrl.
-     * @param {object} [parameters.options.path] The path parameters to be inserted into the URL.
-     * @param {object} [parameters.options.qs] The querystring to be included in the URL.
-     * @param {object} [parameters.options.body] The data to be sent as the request body.
-     * @param {object} [parameters.options.form] An object containing the key/value pairs for a www-form-urlencoded request.
-     * @param {object} [parameters.options.formData] An object containing the contents for a multipart/form-data request
-     * The following processing is performed on formData values:
-     * - string: no special processing -- the value is sent as is
-     * - object: the value is converted to a JSON string before insertion into the form body
-     * - NodeJS.ReadableStream|Buffer|FileWithMetadata: sent as a file, with any associated metadata
-     * - array: each element of the array is sent as a separate form part using any special processing as described above
-     * @param {object} parameters.defaultOptions
-     * @param {string} parameters.defaultOptions.serviceUrl The base URL of the service.
-     * @param {OutgoingHttpHeaders} parameters.defaultOptions.headers Additional headers to be passed on the request.
-     * @returns {Promise<any>}
+     * @param parameters - Service request options passed in by user.
+     * This should be an object with the following fields:
+     * - options.method: the http method
+     * - options.url: the path portion of the URL to be appended to the serviceUrl
+     * - options.path: the path parameters to be inserted into the URL
+     * - options.qs: the querystring to be included in the URL
+     * - options.body: the data to be sent as the request body
+     * - options.form: an object containing the key/value pairs for a www-form-urlencoded request.
+     * - options.formData: an object containing the contents for a multipart/form-data request
+     *   The following processing is performed on formData values:
+     *     - string: no special processing -- the value is sent as is
+     *     - object: the value is converted to a JSON string before insertion into the form body
+     *     - NodeJS.ReadableStream|Buffer|FileWithMetadata: sent as a file, with any associated metadata
+     *     - array: each element of the array is sent as a separate form part using any special processing as described above
+     * - defaultOptions.serviceUrl: the base URL of the service
+     * - defaultOptions.headers: additional HTTP headers to be sent with the request
+     * @returns a Promise
      */
     BaseService.prototype.createRequest = function (parameters) {
         var _this = this;

package/lib/content-type.js

@@ -2,7 +2,7 @@
 /* eslint-disable prettier/prettier */
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -41,8 +41,8 @@ var filenameContentTypes = {
 /**
  * Takes the beginning of an audio file and returns the associated content-type / mime type
  *
- * @param {Buffer} buffer With at least the first 4 bytes of the file
- * @return {String|undefined} The contentType or undefined
+ * @param buffer - a Buffer containing at least the first 4 bytes of the file
+ * @return sthe contentType or undefined
  */
 var fromHeader = function (buffer) {
     var headerStr = buffer
@@ -58,8 +58,8 @@ var fromHeader = function (buffer) {
  * Note: Blob and File objects include a .type property, but we're ignoring it because it's frequently either
  * incorrect (e.g. video/ogg instead of audio/ogg) or else a different format than what's expected (e.g. audio/x-wav)
  *
- * @param {String|ReadableStream|FileObject|Buffer|File} file String filename or url, or binary File/Blob object.
- * @return {String|undefined}
+ * @param file - a String filename or url, or binary File/Blob object.
+ * @returns the content type
  */
 var fromFilename = function (file) {
     var ext = (0, path_1.extname)(

package/lib/get-new-logger.d.ts

@@ -31,9 +31,9 @@ export interface SDKLogger {
  * Additionally, the logger will be turned on automatically if the "NODE_DEBUG"
  * environment variable is set to "axios".
  *
- * @param {string} moduleName - the namespace for the logger. The name will appear in
+ * @param moduleName - the namespace for the logger. The name will appear in
  * the logs and it will be the name used for configuring the log level.
  *
- * @returns {SDKLogger} the new logger
+ * @returns the new logger
  */
 export declare function getNewLogger(moduleName: string): SDKLogger;

package/lib/get-new-logger.js

@@ -30,10 +30,10 @@ var debug_1 = __importDefault(require("debug"));
  * Additionally, the logger will be turned on automatically if the "NODE_DEBUG"
  * environment variable is set to "axios".
  *
- * @param {string} moduleName - the namespace for the logger. The name will appear in
+ * @param moduleName - the namespace for the logger. The name will appear in
  * the logs and it will be the name used for configuring the log level.
  *
- * @returns {SDKLogger} the new logger
+ * @returns the new logger
  */
 function getNewLogger(moduleName) {
     var debug = (0, debug_1.default)("".concat(moduleName, ":debug"));

package/lib/helper.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2014, 2021.
+ * (C) Copyright IBM Corp. 2014, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,31 +35,29 @@ export declare function isFileData(obj: any): obj is NodeJS.ReadableStream | Buf
 export declare function isEmptyObject(obj: any): boolean;
 /**
  * This function retrieves the content type of the input.
- * @param {NodeJS.ReadableStream|Buffer} inputData - The data to retrieve content type for.
- * @returns {string} the content type of the input.
+ * @param inputData - The data to retrieve content type for.
+ * @returns the content type of the input.
  */
 export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer): Promise<string>;
 /**
- *
- * @param {string} url - the url string.
- * @returns {string}
+ * Strips trailing slashes from "url", if present.
+ * @param  url - the url string
+ * @returns the url with any trailing slashes removed
  */
 export declare function stripTrailingSlash(url: string): string;
 /**
  * Return a query parameter value from a URL
  *
- * @param {string} urlStr - the url string.
- * @param {string} param - the name of the query parameter
- *                     whose value should be returned
- * @returns {string} the value of the `param` query parameter
- * @throws if urlStr is an invalid URL
+ * @param urlStr - the url string.
+ * @param param - the name of the query parameter whose value should be returned
+ * @returns the value of the "param" query parameter
  */
 export declare function getQueryParam(urlStr: string, param: string): string;
 /**
  * Validates that all required params are provided
  * @param params - the method parameters.
  * @param requires - the required parameter names.
- * @returns {Error|null}
+ * @returns null if no errors found, otherwise an Error instance
  */
 export declare function getMissingParams(params: {
     [key: string]: any;
@@ -75,52 +73,47 @@ export declare function getMissingParams(params: {
  * If null, then the "required params" check is bypassed.
  * @param allParams - the names of all valid parameters.
  * If null, then the "valid params" check is bypassed.
- * @returns {Error|null}
+ * @returns null if no errors found, otherwise an Error instance
  */
 export declare function validateParams(params: {
     [key: string]: any;
 }, requiredParams: string[], allParams: string[]): null | Error;
 /**
  * Return true if 'text' is html
- * @param  {string} text - The 'text' to analyze
- * @returns {boolean} true if 'text' has html tags
+ * @param  text - The 'text' to analyze
+ * @returns true if 'text' has html tags
  */
 export declare function isHTML(text: string): boolean;
 /**
  * Returns the first match from formats that is key the params map
  * otherwise null
- * @param  {Object} params - The parameters.
- * @param  {string[]} requires - The keys we want to check
- * @returns {string|null}
+ * @param  params - The parameters.
+ * @param  requires - The keys we want to check
  */
 export declare function getFormat(params: {
     [key: string]: any;
 }, formats: string[]): string;
 /**
  * This function builds a `form-data` object for each file parameter.
- * @param {FileWithMetadata} fileParam The file parameter.
- * @param {NodeJS.ReadableStream|Buffer} fileParam.data The data content of the file.
- * @param {string} fileParam.filename The filename of the file.
- * @param {string} fileParam.contentType The content type of the file.
- * @returns {FileObject}
+ * @param fileParam - The FileWithMetadata instance that contains the file information
+ * @returns the FileObject instance
  */
 export declare function buildRequestFileObject(fileParam: FileWithMetadata): Promise<FileObject>;
 /**
  * This function converts an object's keys to lower case.
  * note: does not convert nested keys
- * @param {Object} obj The object to convert the keys of.
- * @returns {Object}
+ * @param obj - The object to convert the keys of.
+ * @returns the object with keys folded to lowercase
  */
 export declare function toLowerKeys(obj: Object): Object;
 /**
  * Constructs a service URL by formatting a parameterized URL.
  *
- * @param {string} parameterizedUrl URL that contains variable placeholders, e.g. '{scheme}://ibm.com'.
- * @param {Map<string, string>} defaultUrlVariables Map from variable names to default values.
+ * @param parameterizedUrl - a URL that contains variable placeholders, e.g. '\{scheme\}://ibm.com'.
+ * @param defaultUrlVariables - a Map of variable names to default values.
  *  Each variable in the parameterized URL must have a default value specified in this map.
- * @param {Map<string, string>} providedUrlVariables Map from variable names to desired values.
- *  If a variable is not provided in this map,
- *  the default variable value will be used instead.
- * @returns {string} The formatted URL with all variable placeholders replaced by values.
+ * @param providedUrlVariables - a Map of variable names to desired values.
+ *  If a variable is not provided in this map, the default variable value will be used instead.
+ * @returns the formatted URL with all variable placeholders replaced by values.
  */
 export declare function constructServiceUrl(parameterizedUrl: string, defaultUrlVariables: Map<string, string>, providedUrlVariables: Map<string, string> | null): string;

package/lib/helper.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2014, 2021.
+ * (C) Copyright IBM Corp. 2014, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -90,8 +90,8 @@ function isEmptyObject(obj) {
 exports.isEmptyObject = isEmptyObject;
 /**
  * This function retrieves the content type of the input.
- * @param {NodeJS.ReadableStream|Buffer} inputData - The data to retrieve content type for.
- * @returns {string} the content type of the input.
+ * @param inputData - The data to retrieve content type for.
+ * @returns the content type of the input.
  */
 function getContentType(inputData) {
     return __awaiter(this, void 0, void 0, function () {
@@ -118,9 +118,9 @@ function getContentType(inputData) {
 }
 exports.getContentType = getContentType;
 /**
- *
- * @param {string} url - the url string.
- * @returns {string}
+ * Strips trailing slashes from "url", if present.
+ * @param  url - the url string
+ * @returns the url with any trailing slashes removed
  */
 function stripTrailingSlash(url) {
     // Match a forward slash / at the end of the string ($)
@@ -130,11 +130,9 @@ exports.stripTrailingSlash = stripTrailingSlash;
 /**
  * Return a query parameter value from a URL
  *
- * @param {string} urlStr - the url string.
- * @param {string} param - the name of the query parameter
- *                     whose value should be returned
- * @returns {string} the value of the `param` query parameter
- * @throws if urlStr is an invalid URL
+ * @param urlStr - the url string.
+ * @param param - the name of the query parameter whose value should be returned
+ * @returns the value of the "param" query parameter
  */
 function getQueryParam(urlStr, param) {
     // The base URL is a dummy value just so we can process relative URLs
@@ -146,7 +144,7 @@ exports.getQueryParam = getQueryParam;
  * Validates that all required params are provided
  * @param params - the method parameters.
  * @param requires - the required parameter names.
- * @returns {Error|null}
+ * @returns null if no errors found, otherwise an Error instance
  */
 function getMissingParams(params, requires) {
     var missing;
@@ -180,7 +178,7 @@ exports.getMissingParams = getMissingParams;
  * If null, then the "required params" check is bypassed.
  * @param allParams - the names of all valid parameters.
  * If null, then the "valid params" check is bypassed.
- * @returns {Error|null}
+ * @returns null if no errors found, otherwise an Error instance
  */
 function validateParams(params, requiredParams, allParams) {
     var missing = [];
@@ -226,15 +224,15 @@ exports.validateParams = validateParams;
  * as `undefined`, `null`, or the empty string.
  *
  * @param value - the parameter value
- * @returns boolean
+ * @returns true if "value" is either undefined, null or "" (empty string)
  */
 function isMissing(value) {
     return value === undefined || value === null || value === '';
 }
 /**
  * Return true if 'text' is html
- * @param  {string} text - The 'text' to analyze
- * @returns {boolean} true if 'text' has html tags
+ * @param  text - The 'text' to analyze
+ * @returns true if 'text' has html tags
  */
 function isHTML(text) {
     logger_1.default.debug("Determining if the text ".concat(text, " is HTML."));
@@ -244,9 +242,8 @@ exports.isHTML = isHTML;
 /**
  * Returns the first match from formats that is key the params map
  * otherwise null
- * @param  {Object} params - The parameters.
- * @param  {string[]} requires - The keys we want to check
- * @returns {string|null}
+ * @param  params - The parameters.
+ * @param  requires - The keys we want to check
  */
 function getFormat(params, formats) {
     if (!formats || !params) {
@@ -262,11 +259,8 @@ function getFormat(params, formats) {
 exports.getFormat = getFormat;
 /**
  * This function builds a `form-data` object for each file parameter.
- * @param {FileWithMetadata} fileParam The file parameter.
- * @param {NodeJS.ReadableStream|Buffer} fileParam.data The data content of the file.
- * @param {string} fileParam.filename The filename of the file.
- * @param {string} fileParam.contentType The content type of the file.
- * @returns {FileObject}
+ * @param fileParam - The FileWithMetadata instance that contains the file information
+ * @returns the FileObject instance
  */
 function buildRequestFileObject(fileParam) {
     return __awaiter(this, void 0, void 0, function () {
@@ -320,8 +314,8 @@ exports.buildRequestFileObject = buildRequestFileObject;
 /**
  * This function converts an object's keys to lower case.
  * note: does not convert nested keys
- * @param {Object} obj The object to convert the keys of.
- * @returns {Object}
+ * @param obj - The object to convert the keys of.
+ * @returns the object with keys folded to lowercase
  */
 function toLowerKeys(obj) {
     var lowerCaseObj = {};
@@ -339,13 +333,12 @@ exports.toLowerKeys = toLowerKeys;
 /**
  * Constructs a service URL by formatting a parameterized URL.
  *
- * @param {string} parameterizedUrl URL that contains variable placeholders, e.g. '{scheme}://ibm.com'.
- * @param {Map<string, string>} defaultUrlVariables Map from variable names to default values.
+ * @param parameterizedUrl - a URL that contains variable placeholders, e.g. '\{scheme\}://ibm.com'.
+ * @param defaultUrlVariables - a Map of variable names to default values.
  *  Each variable in the parameterized URL must have a default value specified in this map.
- * @param {Map<string, string>} providedUrlVariables Map from variable names to desired values.
- *  If a variable is not provided in this map,
- *  the default variable value will be used instead.
- * @returns {string} The formatted URL with all variable placeholders replaced by values.
+ * @param providedUrlVariables - a Map of variable names to desired values.
+ *  If a variable is not provided in this map, the default variable value will be used instead.
+ * @returns the formatted URL with all variable placeholders replaced by values.
  */
 function constructServiceUrl(parameterizedUrl, defaultUrlVariables, providedUrlVariables) {
     // If null was passed, we set the variables to an empty map.

package/lib/querystring.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/lib/querystring.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,8 +18,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * Lightweight implementation for stringify-ing query params
  *
- * @param {object<string, object>} queryParams
- * @return {String}
+ * @param queryParams - the query params
+ * @returns the query string
  */
 var stringify = function (queryParams) {
     return Object.keys(queryParams)

package/lib/request-wrapper.d.ts

@@ -40,16 +40,14 @@ export declare class RequestWrapper {
      * 2. Checks for missing parameters
      * 3. Encode path and query parameters
      * 4. Call the api
-     * @private
-     * @returns {ReadableStream|undefined}
-     * @throws {Error}
+     * @returns ReadableStream|undefined
+     * @throws Error
      */
     sendRequest(parameters: any): Promise<any>;
     /**
      * Format error returned by axios
-     * @param  {object} the object returned by axios via rejection
-     * @private
-     * @returns {Error}
+     * @param axiosError - the object returned by axios via rejection
+     * @returns the Error object
      */
     formatError(axiosError: any): Error;
     getHttpClient(): AxiosInstance;