ibm-cloud-sdk-core 4.0.0 → 4.0.2

package/es/lib/helper.js

@@ -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.
@@ -45,8 +45,8 @@ export function isEmptyObject(obj) {
 }
 /**
  * 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 function getContentType(inputData) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -64,9 +64,9 @@ export function getContentType(inputData) {
     });
 }
 /**
- *
- * @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 function stripTrailingSlash(url) {
     // Match a forward slash / at the end of the string ($)
@@ -75,11 +75,9 @@ export function stripTrailingSlash(url) {
 /**
  * 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 function getQueryParam(urlStr, param) {
     // The base URL is a dummy value just so we can process relative URLs
@@ -90,7 +88,7 @@ export function getQueryParam(urlStr, param) {
  * 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 function getMissingParams(params, requires) {
     let missing;
@@ -123,7 +121,7 @@ export function getMissingParams(params, requires) {
  * 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 function validateParams(params, requiredParams, allParams) {
     let missing = [];
@@ -168,15 +166,15 @@ export function validateParams(params, requiredParams, allParams) {
  * 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
  */
 export function isHTML(text) {
     logger.debug(`Determining if the text ${text} is HTML.`);
@@ -185,9 +183,8 @@ export function isHTML(text) {
 /**
  * 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 function getFormat(params, formats) {
     if (!formats || !params) {
@@ -202,11 +199,8 @@ export function getFormat(params, formats) {
 }
 /**
  * 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 function buildRequestFileObject(fileParam) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -254,8 +248,8 @@ export function buildRequestFileObject(fileParam) {
 /**
  * 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 function toLowerKeys(obj) {
     let lowerCaseObj = {};
@@ -269,13 +263,12 @@ export function toLowerKeys(obj) {
 /**
  * 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 function constructServiceUrl(parameterizedUrl, defaultUrlVariables, providedUrlVariables) {
     // If null was passed, we set the variables to an empty map.

package/es/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/es/lib/querystring.js

@@ -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.
@@ -16,8 +16,8 @@
 /**
  * Lightweight implementation for stringify-ing query params
  *
- * @param {object<string, object>} queryParams
- * @return {String}
+ * @param queryParams - the query params
+ * @returns the query string
  */
 const stringify = (queryParams) => Object.keys(queryParams)
     .map((key) => `${key}=${encodeURIComponent(queryParams[key])}`)

package/es/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;

package/es/lib/request-wrapper.js

@@ -120,9 +120,8 @@ export 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) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -220,9 +219,8 @@ export class RequestWrapper {
     }
     /**
      * 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) {
         // return an actual error object,
@@ -373,10 +371,10 @@ export class RequestWrapper {
     }
 }
 /**
- * @private
- * @param {string} path
- * @param {Object} params
- * @returns {string}
+ * Parses the path.
+ * @param path - the path
+ * @param params - the params
+ * @returns the parsed path
  */
 function parsePath(path, params) {
     if (!path || !params) {
@@ -389,9 +387,8 @@ function parsePath(path, params) {
 }
 /**
  * Determine if the error is due to bad credentials
- * @private
- * @param {Object} error - error object returned from axios
- * @returns {boolean} true if error is due to authentication
+ * @param error - error object returned from axios
+ * @returns true if error is due to authentication
  */
 function isAuthenticationError(error) {
     let isAuthErr = false;
@@ -406,9 +403,8 @@ function isAuthenticationError(error) {
 }
 /**
  * Determine if the error is due to a bad self signed certificate
- * @private
- * @param {Object} error - error object returned from axios
- * @returns {boolean} true if error is due to an SSL error
+ * @param error - error object returned from axios
+ * @returnstrue if error is due to an SSL error
  */
 function isSelfSignedCertificateError(error) {
     let result = false;
@@ -423,10 +419,9 @@ function isSelfSignedCertificateError(error) {
 }
 /**
  * Return true if object has a specified property that is a string
- * @private
- * @param {Object} obj - object to look for property in
- * @param {string} property - name of the property to look for
- * @returns {boolean} true if property exists and is string
+ * @param obj - object to look for property in
+ * @param property - name of the property to look for
+ * @returns true if property exists and is string
  */
 function hasStringProperty(obj, property) {
     return Boolean(obj[property] && typeof obj[property] === 'string');
@@ -435,9 +430,8 @@ function hasStringProperty(obj, property) {
  * Look for service error message in common places, by priority
  * first look in `errors[0].message`, then in `error`, then in
  * `message`, then in `errorMessage`
- * @private
- * @param {Object} response - error response body received from service
- * @returns {string | undefined} the error message if is was found, undefined otherwise
+ * @param response - error response body received from service
+ * @returns the error message if is was found, undefined otherwise
  */
 function parseServiceErrorMessage(response) {
     let message;

package/es/lib/sdk-test-helpers.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.
@@ -22,10 +22,9 @@
  * Takes the request options constructed by the SDK and checks that the `url` and `method` properties
  * were set to their correct values.
  *
- * @param {Object} options - the options object put together by the SDK, retrieved from the createRequest mock
- * @param {String} url - The URL path of the service endpoint, from the paths section of the API definition
- * @param {String} string - The HTTP method for the request, from the API definition
- * @returns {void}
+ * @param options - the options object put together by the SDK, retrieved from the createRequest mock
+ * @param url - The URL path of the service endpoint, from the paths section of the API definition
+ * @param method - The HTTP method for the request, from the API definition
  */
 export declare function checkUrlAndMethod(options: any, url: string, method: any): void;
 /**
@@ -33,10 +32,9 @@ export declare function checkUrlAndMethod(options: any, url: string, method: any
  * and checks for the expected values for `Accept` and `Content-Type`. This to verify that the SDK sets
  * the correct values in the code.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param {String} accept - the expected value for the `Accept` header
- * @param {String} contentType - the expected value for the `Content-Type` header
- * @returns {void}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
+ * @param accept - the expected value for the `Accept` header
+ * @param contentType - the expected value for the `Content-Type` header
  */
 export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
 /**
@@ -44,18 +42,16 @@ export declare function checkMediaHeaders(createRequestMock: any, accept: string
  * and checks for the expected value for a user-defined header. This is verify that the SDK accepts header
  * parameters and sends them as headers in the request.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param {String} userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`
- * @param {String} userHeaderValue - the expected value for the header passed by the user
- * @returns {void}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
+ * @param userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`
+ * @param userHeaderValue - the expected value for the header passed by the user
  */
 export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
 /**
  * This method simply ensures that the method executed without any issues by extracting
  * the argument from the mock object for the `createRequest` method and verifying that it is an object.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @returns {void}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
  */
 export declare function checkForSuccessfulExecution(createRequestMock: any): void;
 /**
@@ -63,15 +59,14 @@ export declare function checkForSuccessfulExecution(createRequestMock: any): voi
  * an object containing all of the SDK method-specific information (like `path` and `body`) used to build a request.
  * This method is just a convenience method for the unit tests to be able to make assertions on the items in the request.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @returns {Object}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
+ * @returns Object
  */
 export declare function getOptions(createRequestMock: any): any;
 /**
  * This method simply ensures that the SDK methods return Promises by checking for
  * the `then` function - common way to assess whether or not an object is a Promise.
  *
- * @param {Promise<any>} sdkPromise - the Promise returned by an SDK method
- * @returns {void}
+ * @param sdkPromise - the Promise returned by an SDK method
  */
 export declare function expectToBePromise(sdkPromise: any): void;

package/es/lib/sdk-test-helpers.js

@@ -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.
@@ -23,10 +23,9 @@ import expect from 'expect';
  * Takes the request options constructed by the SDK and checks that the `url` and `method` properties
  * were set to their correct values.
  *
- * @param {Object} options - the options object put together by the SDK, retrieved from the createRequest mock
- * @param {String} url - The URL path of the service endpoint, from the paths section of the API definition
- * @param {String} string - The HTTP method for the request, from the API definition
- * @returns {void}
+ * @param options - the options object put together by the SDK, retrieved from the createRequest mock
+ * @param url - The URL path of the service endpoint, from the paths section of the API definition
+ * @param method - The HTTP method for the request, from the API definition
  */
 export function checkUrlAndMethod(options, url, method) {
     expect(options.url).toEqual(url);
@@ -37,10 +36,9 @@ export function checkUrlAndMethod(options, url, method) {
  * and checks for the expected values for `Accept` and `Content-Type`. This to verify that the SDK sets
  * the correct values in the code.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param {String} accept - the expected value for the `Accept` header
- * @param {String} contentType - the expected value for the `Content-Type` header
- * @returns {void}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
+ * @param accept - the expected value for the `Accept` header
+ * @param contentType - the expected value for the `Content-Type` header
  */
 export function checkMediaHeaders(createRequestMock, accept, contentType) {
     const { headers } = createRequestMock.mock.calls[0][0].defaultOptions;
@@ -52,10 +50,9 @@ export function checkMediaHeaders(createRequestMock, accept, contentType) {
  * and checks for the expected value for a user-defined header. This is verify that the SDK accepts header
  * parameters and sends them as headers in the request.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param {String} userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`
- * @param {String} userHeaderValue - the expected value for the header passed by the user
- * @returns {void}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
+ * @param userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`
+ * @param userHeaderValue - the expected value for the header passed by the user
  */
 export function checkUserHeader(createRequestMock, userHeaderName, userHeaderValue) {
     const { headers } = createRequestMock.mock.calls[0][0].defaultOptions;
@@ -65,8 +62,7 @@ export function checkUserHeader(createRequestMock, userHeaderName, userHeaderVal
  * This method simply ensures that the method executed without any issues by extracting
  * the argument from the mock object for the `createRequest` method and verifying that it is an object.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @returns {void}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
  */
 export function checkForSuccessfulExecution(createRequestMock) {
     const sdkParams = createRequestMock.mock.calls[0][0];
@@ -77,8 +73,8 @@ export function checkForSuccessfulExecution(createRequestMock) {
  * an object containing all of the SDK method-specific information (like `path` and `body`) used to build a request.
  * This method is just a convenience method for the unit tests to be able to make assertions on the items in the request.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @returns {Object}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
+ * @returns Object
  */
 export function getOptions(createRequestMock) {
     return createRequestMock.mock.calls[0][0].options;
@@ -87,8 +83,7 @@ export function getOptions(createRequestMock) {
  * This method simply ensures that the SDK methods return Promises by checking for
  * the `then` function - common way to assess whether or not an object is a Promise.
  *
- * @param {Promise<any>} sdkPromise - the Promise returned by an SDK method
- * @returns {void}
+ * @param sdkPromise - the Promise returned by an SDK method
  */
 export function expectToBePromise(sdkPromise) {
     expect(typeof sdkPromise.then).toBe('function');

package/es/lib/stream-to-promise.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.
@@ -20,7 +20,7 @@ import { Stream } from 'stream';
  * or array of text chunks
  * Essentially a smaller version of concat-stream wrapped in a promise
  *
- * @param {Stream} stream Optional stream param for when not bound to an existing stream instance.
- * @return {Promise}
+ * @param stream - optional stream param for when not bound to an existing stream instance.
+ * @returns Promise
  */
 export declare function streamToPromise(stream: Stream): Promise<any>;

package/es/lib/stream-to-promise.js

@@ -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.
@@ -18,8 +18,8 @@
  * or array of text chunks
  * Essentially a smaller version of concat-stream wrapped in a promise
  *
- * @param {Stream} stream Optional stream param for when not bound to an existing stream instance.
- * @return {Promise}
+ * @param stream - optional stream param for when not bound to an existing stream instance.
+ * @returns Promise
  */
 export function streamToPromise(stream) {
     stream = stream || this;

package/es/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.20.0"
+      "packageVersion": "7.33.7"
     }
   ]
 }

package/etc/ibm-cloud-sdk-core.api.md

@@ -86,7 +86,7 @@ export class BasicAuthenticator extends Authenticator {
 
 // @public
 export class BearerTokenAuthenticator extends Authenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_2" needs to be exported by the entry point index.d.ts
     constructor(options: Options_2);
     authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     authenticationType(): string;
@@ -115,7 +115,7 @@ function checkUserHeader(createRequestMock: any, userHeaderName: string, userHea
 
 // @public
 export class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_4" needs to be exported by the entry point index.d.ts
     constructor(options: Options_4);
     authenticationType(): string;
     // (undocumented)
@@ -135,7 +135,7 @@ export function constructServiceUrl(parameterizedUrl: string, defaultUrlVariable
 
 // @public
 export class ContainerAuthenticator extends IamRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_8" needs to be exported by the entry point index.d.ts
     constructor(options: Options_8);
     authenticationType(): string;
     setCrTokenFilename(crTokenFilename: string): void;
@@ -147,7 +147,7 @@ export class ContainerAuthenticator extends IamRequestBasedAuthenticator {
 
 // @public
 export class ContainerTokenManager extends IamRequestBasedTokenManager {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_7" needs to be exported by the entry point index.d.ts
     constructor(options: Options_7);
     protected requestToken(): Promise<any>;
     setCrTokenFilename(crTokenFilename: string): void;
@@ -163,7 +163,7 @@ export const contentType: {
 
 // @public
 export class Cp4dTokenManager extends JwtTokenManager {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_3" needs to be exported by the entry point index.d.ts
     constructor(options: Options_3);
     // (undocumented)
     protected requestToken(): Promise<any>;
@@ -239,7 +239,7 @@ export function getQueryParam(urlStr: string, param: string): string;
 
 // @public
 export class IamAuthenticator extends IamRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_6" needs to be exported by the entry point index.d.ts
     constructor(options: Options_6);
     authenticationType(): string;
     // (undocumented)
@@ -250,7 +250,7 @@ export class IamAuthenticator extends IamRequestBasedAuthenticator {
 
 // @public
 export class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "IamRequestOptions" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "IamRequestOptions_2" needs to be exported by the entry point index.d.ts
     constructor(options: IamRequestOptions_2);
     // (undocumented)
     protected clientId: string;
@@ -291,7 +291,7 @@ export interface IamRequestOptions extends JwtTokenManagerOptions {
 
 // @public
 export class IamTokenManager extends IamRequestBasedTokenManager {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_5" needs to be exported by the entry point index.d.ts
     constructor(options: Options_5);
     // (undocumented)
     protected requiredOptions: string[];
@@ -367,7 +367,7 @@ export interface SDKLogger {
 // @public
 export function streamToPromise(stream: Stream): Promise<any>;
 
-// @public (undocumented)
+// @public
 export function stripTrailingSlash(url: string): string;
 
 // @public
@@ -449,7 +449,7 @@ export interface UserOptions {
     version?: string;
 }
 
-// @public (undocumented)
+// @public
 export function validateInput(options: any, requiredOptions: string[]): void;
 
 // @public
@@ -459,7 +459,7 @@ export function validateParams(params: {
 
 // @public
 export class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_10" needs to be exported by the entry point index.d.ts
     constructor(options: Options_10);
     authenticationType(): string;
     setIamProfileCrn(iamProfileCrn: string): void;
@@ -470,7 +470,7 @@ export class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator {
 
 // @public
 export class VpcInstanceTokenManager extends JwtTokenManager {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Options_9" needs to be exported by the entry point index.d.ts
     constructor(options: Options_9);
     // (undocumented)
     protected requestToken(): Promise<any>;