ibm-cloud-sdk-core 4.0.0 → 4.0.2

package/auth/authenticators/cloud-pak-for-data-authenticator.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.
@@ -35,29 +35,29 @@ var authenticator_1 = require("./authenticator");
 var token_managers_1 = require("../token-managers");
 var token_request_based_authenticator_1 = require("./token-request-based-authenticator");
 /**
- * The [[CloudPakForDataAuthenticator]] will either use a username/password pair or a username/apikey pair to obtain
+ * The CloudPakForDataAuthenticator will either use a username/password pair or a username/apikey pair to obtain
  * a bearer token from a token server.  When the bearer token expires, a new token is obtained from the token server.
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 var CloudPakForDataAuthenticator = /** @class */ (function (_super) {
     __extends(CloudPakForDataAuthenticator, _super);
     /**
-     * Create a new [[CloudPakForDataAuthenticator]] instance.
+     * Create a new CloudPakForDataAuthenticator instance.
      *
-     * @param {object} options Configuration options for CloudPakForData authentication.
-     * @param {string} options.url For HTTP token requests.
-     * @param {string} options.username The username used to obtain a bearer token.
-     * @param {string} [options.password] The password used to obtain a bearer token [required if apikey not specified].
-     * @param {string} [options.apikey] The API key used to obtain a bearer token [required if password not specified].
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {object<string, string>} [options.headers] to be sent with every.
-     * @throws `Error` The username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token
-     *   requests.
+     * @param options - Configuration options for CloudPakForData authentication.
+     * This should be an object containing these fields:
+     * - url: (required) the endpoint URL for the CloudPakForData token service
+     * - username: (required) the username used to obtain a bearer token
+     * - password: (optional) the password used to obtain a bearer token (required if apikey is not specified)
+     * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified)
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     *
+     * @throws Error: the username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.
      */
     function CloudPakForDataAuthenticator(options) {
         var _this = _super.call(this, options) || this;

package/auth/authenticators/container-authenticator.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 IBM Corp. All Rights Reserved.
+ * Copyright 2021, 2022 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,13 +25,13 @@ export interface Options extends IamRequestOptions {
     iamProfileId?: string;
 }
 /**
- * The [[ContainerAuthenticator]] will read a compute resource token from the file system
+ * The ContainerAuthenticator will read a compute resource token from the file system
  * and use this value to obtain a bearer token from the IAM token server.  When the bearer
  * token expires, a new token is obtained from the token server.
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export declare class ContainerAuthenticator extends IamRequestBasedAuthenticator {
     protected tokenManager: ContainerTokenManager;
@@ -40,39 +40,39 @@ export declare class ContainerAuthenticator extends IamRequestBasedAuthenticator
     private iamProfileId;
     /**
      *
-     * Create a new [[ContainerAuthenticator]] instance.
+     * Create a new ContainerAuthenticator instance.
      *
-     * @param {object} options Configuration options for IAM authentication.
-     * @param {string} [options.crTokenFilename] The file containing the compute resource token.
-     * @param {string} [options.iamProfileName] The IAM profile name associated with the compute resource token.
-     * @param {string} [options.iamProfileId] The IAM profile ID associated with the compute resource token.
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {string} [options.url] for HTTP token requests.
-     * @param {object<string, string>} options.headers to be sent with every
-     * @param {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.scope] The "scope" parameter to use when fetching the bearer token from the
-     *   IAM token server.
-     * @throws {Error} When the configuration options are not valid.
+     * @param options - Configuration options for IAM authentication.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - crTokenFilename: (optional) the file containing the compute resource token
+     * - iamProfileName: (optional) the name of the IAM trusted profile associated with the compute resource token (required if iamProfileId is not specified)
+     * - iamProfileId]: (optional) the ID of the IAM trusted profile associated with the compute resource token (required if iamProfileName is not specified)
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     * - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service
+     *
+     * @throws Error: the configuration options are not valid.
      */
     constructor(options: Options);
     /**
      * Setter for the filename of the compute resource token.
-     * @param {string} A string containing a path to the CR token file
+     * @param crTokenFilename - A string containing a path to the CR token file
      */
     setCrTokenFilename(crTokenFilename: string): void;
     /**
      * Setter for the "profile_name" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} A string that makes up the iamProfileName parameter
+     * @param iamProfileName - the name of the IAM trusted profile
      */
     setIamProfileName(iamProfileName: string): void;
     /**
      * Setter for the "profile_id" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} A string that makes up the iamProfileId parameter
+     * @param iamProfileId - the ID of the IAM trusted profile
      */
     setIamProfileId(iamProfileId: string): void;
     /**

package/auth/authenticators/container-authenticator.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * Copyright 2021 IBM Corp. All Rights Reserved.
+ * Copyright 2021, 2022 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,36 +35,36 @@ var authenticator_1 = require("./authenticator");
 var token_managers_1 = require("../token-managers");
 var iam_request_based_authenticator_1 = require("./iam-request-based-authenticator");
 /**
- * The [[ContainerAuthenticator]] will read a compute resource token from the file system
+ * The ContainerAuthenticator will read a compute resource token from the file system
  * and use this value to obtain a bearer token from the IAM token server.  When the bearer
  * token expires, a new token is obtained from the token server.
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 var ContainerAuthenticator = /** @class */ (function (_super) {
     __extends(ContainerAuthenticator, _super);
     /**
      *
-     * Create a new [[ContainerAuthenticator]] instance.
+     * Create a new ContainerAuthenticator instance.
      *
-     * @param {object} options Configuration options for IAM authentication.
-     * @param {string} [options.crTokenFilename] The file containing the compute resource token.
-     * @param {string} [options.iamProfileName] The IAM profile name associated with the compute resource token.
-     * @param {string} [options.iamProfileId] The IAM profile ID associated with the compute resource token.
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {string} [options.url] for HTTP token requests.
-     * @param {object<string, string>} options.headers to be sent with every
-     * @param {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.scope] The "scope" parameter to use when fetching the bearer token from the
-     *   IAM token server.
-     * @throws {Error} When the configuration options are not valid.
+     * @param options - Configuration options for IAM authentication.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - crTokenFilename: (optional) the file containing the compute resource token
+     * - iamProfileName: (optional) the name of the IAM trusted profile associated with the compute resource token (required if iamProfileId is not specified)
+     * - iamProfileId]: (optional) the ID of the IAM trusted profile associated with the compute resource token (required if iamProfileName is not specified)
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     * - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service
+     *
+     * @throws Error: the configuration options are not valid.
      */
     function ContainerAuthenticator(options) {
         var _this = _super.call(this, options) || this;
@@ -79,7 +79,7 @@ var ContainerAuthenticator = /** @class */ (function (_super) {
     }
     /**
      * Setter for the filename of the compute resource token.
-     * @param {string} A string containing a path to the CR token file
+     * @param crTokenFilename - A string containing a path to the CR token file
      */
     ContainerAuthenticator.prototype.setCrTokenFilename = function (crTokenFilename) {
         this.crTokenFilename = crTokenFilename;
@@ -88,7 +88,7 @@ var ContainerAuthenticator = /** @class */ (function (_super) {
     };
     /**
      * Setter for the "profile_name" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} A string that makes up the iamProfileName parameter
+     * @param iamProfileName - the name of the IAM trusted profile
      */
     ContainerAuthenticator.prototype.setIamProfileName = function (iamProfileName) {
         this.iamProfileName = iamProfileName;
@@ -97,7 +97,7 @@ var ContainerAuthenticator = /** @class */ (function (_super) {
     };
     /**
      * Setter for the "profile_id" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} A string that makes up the iamProfileId parameter
+     * @param iamProfileId - the ID of the IAM trusted profile
      */
     ContainerAuthenticator.prototype.setIamProfileId = function (iamProfileId) {
         this.iamProfileId = iamProfileId;

package/auth/authenticators/iam-authenticator.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.
@@ -21,15 +21,15 @@ export interface Options extends IamRequestOptions {
     apikey: string;
 }
 /**
- * The [[IamAuthenticator]] will use the user-supplied `apikey`
- * values to obtain a bearer token from a token server.  When the bearer token
+ * The IamAuthenticator will use the user-supplied `apikey`
+ * value to obtain a bearer token from a token server.  When the bearer token
  * expires, a new token is obtained from the token server. If specified, the
- * optional, mutually inclusive `clientId` and`clientSecret` pair can be used to
+ * optional, mutually inclusive "clientId" and "clientSecret" pair can be used to
  * influence rate-limiting for requests to the IAM token server.
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export declare class IamAuthenticator extends IamRequestBasedAuthenticator {
     protected requiredOptions: string[];
@@ -37,22 +37,22 @@ export declare class IamAuthenticator extends IamRequestBasedAuthenticator {
     private apikey;
     /**
      *
-     * Create a new [[IamAuthenticator]] instance.
+     * Create a new IamAuthenticator instance.
      *
-     * @param {object} options Configuration options for IAM authentication.
-     * @param {boolean} options.disableSslVerification A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {string} options.url for HTTP token requests.
-     * @param {object<string, string>} options.headers to be sent with every
-     * @param {string} options.apikey The IAM api key.
-     * @param {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.scope] The "scope" parameter to use when fetching the bearer token from the
-     *   IAM token server.
-     * @throws {Error} When the configuration options are not valid.
+     * @param options - Configuration options for IAM authentication.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - apikey: (required) the IAM api key
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     * - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service
+     *
+     * @throws Error: the configuration options are not valid.
      */
     constructor(options: Options);
     /**

package/auth/authenticators/iam-authenticator.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.
@@ -36,36 +36,36 @@ var token_managers_1 = require("../token-managers");
 var utils_1 = require("../utils");
 var iam_request_based_authenticator_1 = require("./iam-request-based-authenticator");
 /**
- * The [[IamAuthenticator]] will use the user-supplied `apikey`
- * values to obtain a bearer token from a token server.  When the bearer token
+ * The IamAuthenticator will use the user-supplied `apikey`
+ * value to obtain a bearer token from a token server.  When the bearer token
  * expires, a new token is obtained from the token server. If specified, the
- * optional, mutually inclusive `clientId` and`clientSecret` pair can be used to
+ * optional, mutually inclusive "clientId" and "clientSecret" pair can be used to
  * influence rate-limiting for requests to the IAM token server.
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 var IamAuthenticator = /** @class */ (function (_super) {
     __extends(IamAuthenticator, _super);
     /**
      *
-     * Create a new [[IamAuthenticator]] instance.
+     * Create a new IamAuthenticator instance.
      *
-     * @param {object} options Configuration options for IAM authentication.
-     * @param {boolean} options.disableSslVerification A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {string} options.url for HTTP token requests.
-     * @param {object<string, string>} options.headers to be sent with every
-     * @param {string} options.apikey The IAM api key.
-     * @param {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.scope] The "scope" parameter to use when fetching the bearer token from the
-     *   IAM token server.
-     * @throws {Error} When the configuration options are not valid.
+     * @param options - Configuration options for IAM authentication.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - apikey: (required) the IAM api key
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     * - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service
+     *
+     * @throws Error: the configuration options are not valid.
      */
     function IamAuthenticator(options) {
         var _this = _super.call(this, options) || this;

package/auth/authenticators/iam-request-based-authenticator.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.
@@ -33,8 +33,8 @@ export interface IamRequestOptions extends BaseOptions {
     scope?: string;
 }
 /**
- * The [[IamRequestBasedAuthenticator]] provides shared configuration and functionality
- * for authenticators that interact with the IAM service to inherit. This authenticator
+ * The IamRequestBasedAuthenticator provides shared configuration and functionality
+ * for authenticators that interact with the IAM token service. This authenticator
  * is not meant for use on its own.
  */
 export declare class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator {
@@ -44,41 +44,39 @@ export declare class IamRequestBasedAuthenticator extends TokenRequestBasedAuthe
     protected scope: string;
     /**
      *
-     * Create a new [[IamRequestBasedAuthenticator]] instance.
+     * Create a new IamRequestBasedAuthenticator instance.
      *
-     * @param {object} options Configuration options for IAM authentication.
-     * @param {boolean} options.disableSslVerification A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {string} options.url for HTTP token requests.
-     * @param {object<string, string>} options.headers to be sent with every IAM token request
-     * @param {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.scope] The "scope" parameter to use when fetching the bearer token from the
-     *   IAM token server.
-     * @throws {Error} When the configuration options are not valid.
+     * @param options - Configuration options for IAM authentication.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     * - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service
+     *
+     * @throws Error: the configuration options are not valid.
      */
     constructor(options: IamRequestOptions);
     /**
-     * Setter for the mutually inclusive `clientId` and the `clientSecret`.
-     * @param {string} clientId The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} clientSecret The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
+     * Setter for the mutually inclusive "clientId" and the "clientSecret" fields.
+     * @param clientId - the "clientId" value used to form a Basic Authorization header for IAM token requests
+     * @param clientSecret - the "clientSecret" value used to form a Basic Authorization header for IAM token requests
      */
     setClientIdAndSecret(clientId: string, clientSecret: string): void;
     /**
      * Setter for the "scope" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} scope A space seperated string that makes up the scope parameter
+     * @param scope - (optional) a space-separated string that specifies one or more scopes to be
+     * associated with IAM token requests
      */
     setScope(scope: string): void;
     /**
      * Return the most recently stored refresh token.
      *
-     * @public
-     * @returns {string}
+     * @returns the refresh token string
      */
     getRefreshToken(): string;
 }

package/auth/authenticators/iam-request-based-authenticator.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.
@@ -34,29 +34,29 @@ exports.IamRequestBasedAuthenticator = void 0;
 var token_managers_1 = require("../token-managers");
 var token_request_based_authenticator_1 = require("./token-request-based-authenticator");
 /**
- * The [[IamRequestBasedAuthenticator]] provides shared configuration and functionality
- * for authenticators that interact with the IAM service to inherit. This authenticator
+ * The IamRequestBasedAuthenticator provides shared configuration and functionality
+ * for authenticators that interact with the IAM token service. This authenticator
  * is not meant for use on its own.
  */
 var IamRequestBasedAuthenticator = /** @class */ (function (_super) {
     __extends(IamRequestBasedAuthenticator, _super);
     /**
      *
-     * Create a new [[IamRequestBasedAuthenticator]] instance.
+     * Create a new IamRequestBasedAuthenticator instance.
      *
-     * @param {object} options Configuration options for IAM authentication.
-     * @param {boolean} options.disableSslVerification A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {string} options.url for HTTP token requests.
-     * @param {object<string, string>} options.headers to be sent with every IAM token request
-     * @param {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.scope] The "scope" parameter to use when fetching the bearer token from the
-     *   IAM token server.
-     * @throws {Error} When the configuration options are not valid.
+     * @param options - Configuration options for IAM authentication.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     * - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service
+     *
+     * @throws Error: the configuration options are not valid.
      */
     function IamRequestBasedAuthenticator(options) {
         var _this = this;
@@ -70,11 +70,9 @@ var IamRequestBasedAuthenticator = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * Setter for the mutually inclusive `clientId` and the `clientSecret`.
-     * @param {string} clientId The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} clientSecret The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
+     * Setter for the mutually inclusive "clientId" and the "clientSecret" fields.
+     * @param clientId - the "clientId" value used to form a Basic Authorization header for IAM token requests
+     * @param clientSecret - the "clientSecret" value used to form a Basic Authorization header for IAM token requests
      */
     IamRequestBasedAuthenticator.prototype.setClientIdAndSecret = function (clientId, clientSecret) {
         this.clientId = clientId;
@@ -84,7 +82,8 @@ var IamRequestBasedAuthenticator = /** @class */ (function (_super) {
     };
     /**
      * Setter for the "scope" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} scope A space seperated string that makes up the scope parameter
+     * @param scope - (optional) a space-separated string that specifies one or more scopes to be
+     * associated with IAM token requests
      */
     IamRequestBasedAuthenticator.prototype.setScope = function (scope) {
         this.scope = scope;
@@ -94,8 +93,7 @@ var IamRequestBasedAuthenticator = /** @class */ (function (_super) {
     /**
      * Return the most recently stored refresh token.
      *
-     * @public
-     * @returns {string}
+     * @returns the refresh token string
      */
     IamRequestBasedAuthenticator.prototype.getRefreshToken = function () {
         return this.tokenManager.getRefreshToken();

package/auth/authenticators/token-request-based-authenticator.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.
@@ -34,14 +34,14 @@ export type BaseOptions = {
 };
 /**
  * Class for common functionality shared by token-request authenticators.
- * [[TokenRequestBasedAuthenticator]]s use token managers to retrieve, store,
+ * TokenRequestBasedAuthenticators use token managers to retrieve, store,
  * and refresh tokens. Not intended to be used as stand-alone authenticator,
- * but as parent class to authenticators that have their own token manager
+ * but as base class to authenticators that have their own token manager
  * implementations.
  *
- * The tokens will be added as an Authorization headers in the form:
+ * The token will be added as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export declare class TokenRequestBasedAuthenticator extends Authenticator {
     protected tokenManager: JwtTokenManager;
@@ -49,43 +49,38 @@ export declare class TokenRequestBasedAuthenticator extends Authenticator {
     protected headers: OutgoingHttpHeaders;
     protected disableSslVerification: boolean;
     /**
-     * Create a new [[TokenRequestBasedAuthenticator]] instance with an internal [[JwtTokenManager]].
+     * Create a new TokenRequestBasedAuthenticator instance with an internal JwtTokenManager.
      *
-     * @param {object} options Configuration options.
-     * @param {string} options.url for HTTP token requests.
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not.
-     * @param {object<string, string>} [options.headers] to be sent with every
-     *   outbound HTTP requests to token services.
+     * @param options - Configuration options.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
      */
     constructor(options: BaseOptions);
     /**
      * Set the flag that indicates whether verification of the server's SSL
      * certificate should be disabled or not.
      *
-     * @param {boolean} value A flag that indicates whether verification of the
+     * @param value - a flag that indicates whether verification of the
      *   token server's SSL certificate should be disabled or not.
      */
     setDisableSslVerification(value: boolean): void;
     /**
      * Set headers.
      *
-     * @param {object<string, string>} headers Default headers to be sent with
-     *   every Cloud Pak For Data token request. Overwrites previous default headers.
+     * @param headers - a set of HTTP headers to be sent with each outbound token server request.
+     * Overwrites previous default headers.
      */
     setHeaders(headers: OutgoingHttpHeaders): void;
     /**
-     * Adds bearer token information to `request`. The bearer token information
-     * will be set in the Authorization property of`request.headers` in the form:
+     * Adds bearer token information to "requestOptions". The bearer token information
+     * will be set in the Authorization property of "requestOptions.headers" in the form:
      *
-     *     Authorization: Bearer <bearer-token>
+     *     Authorization: Bearer \<bearer-token\>
      *
-     * @param {object} requestOptions - The request to augment with authentication
-     *   information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added too. Overrides default headers
-     *   where there's conflict.
+     * @param requestOptions - The request to augment with authentication information.
      */
     authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 }