ibm-cloud-sdk-core 4.0.0 → 4.0.2

package/auth/authenticators/token-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.
@@ -39,27 +39,26 @@ var token_managers_1 = require("../token-managers");
 var authenticator_1 = require("./authenticator");
 /**
  * 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\>
  */
 var TokenRequestBasedAuthenticator = /** @class */ (function (_super) {
     __extends(TokenRequestBasedAuthenticator, _super);
     /**
-     * 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
      */
     function TokenRequestBasedAuthenticator(options) {
         var _this = _super.call(this) || this;
@@ -74,7 +73,7 @@ var TokenRequestBasedAuthenticator = /** @class */ (function (_super) {
      * 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.
      */
     TokenRequestBasedAuthenticator.prototype.setDisableSslVerification = function (value) {
@@ -86,8 +85,8 @@ var TokenRequestBasedAuthenticator = /** @class */ (function (_super) {
     /**
      * 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.
      */
     TokenRequestBasedAuthenticator.prototype.setHeaders = function (headers) {
         if (typeof headers !== 'object') {
@@ -98,16 +97,12 @@ var TokenRequestBasedAuthenticator = /** @class */ (function (_super) {
         this.tokenManager.setHeaders(this.headers);
     };
     /**
-     * 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.
      */
     TokenRequestBasedAuthenticator.prototype.authenticate = function (requestOptions) {
         return this.tokenManager.getToken().then(function (token) {

package/auth/authenticators/vpc-instance-authenticator.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2021.
+ * (C) Copyright IBM Corp. 2021, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,40 +23,41 @@ export interface Options extends BaseOptions {
     iamProfileId?: string;
 }
 /**
- * The [[VpcInstanceAuthenticator]] implements an authentication scheme in which it retrieves an "instance identity token"
+ * The VpcInstanceAuthenticator implements an authentication scheme in which it retrieves an "instance identity token"
  * and exchanges that for an IAM access token using the VPC Instance Metadata Service API which is available on the local
  * compute resource (VM). The instance identity token is similar to an IAM apikey, except that it is managed automatically
  * by the compute resource provider (VPC).
  *
  * The resulting IAM access token is then added to outbound requests in an Authorization header
  *
- *      Authorization: Bearer <access-token>
+ *      Authorization: Bearer \<access-token\>
  */
 export declare class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator {
     protected tokenManager: VpcInstanceTokenManager;
     private iamProfileCrn;
     private iamProfileId;
     /**
-     * Create a new [[VpcInstanceAuthenticator]] instance.
+     * Create a new VpcInstanceAuthenticator instance.
      *
-     * @param {object} [options] Configuration options for VpcInstance authentication.
-     * @param {string} [options.iamProfileCrn] The CRN of the linked trusted IAM profile to be used as the identity of the compute resource.
-     *    At most one of iamProfileCrn or iamProfileId may be specified.
-     *    If neither one is specified, then the default IAM profile defined for the compute resource will be used.
-     * @param {string} [options.iamProfileId] The ID of the linked trusted IAM profile to be used when obtaining the IAM access token.
-     *    At most one of iamProfileCrn or iamProfileId may be specified.
-     *    If neither one is specified, then the default IAM profile defined for the compute resource will be used.
-     * @param {string} [options.url] The VPC Instance Metadata Service's base endpoint URL. Default value: "http://169.254.169.254"
+     * @param options - Configuration options for VpcInstance authentication.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the VPC Instance Metadata Service (default value: "http://169.254.169.254")
+     * - iamProfileCrn: (optional) the CRN of the linked IAM trusted profile to be used to obtain the IAM access token
+     * - iamProfileId: (optional) the ID of the linked IAM trusted profile to be used to obtain the IAM access token
+     *
+     * @remarks
+     * At most one of "iamProfileCrn" or "iamProfileId" may be specified. If neither one is specified,
+     * then the default IAM profile defined for the compute resource will be used.
      */
     constructor(options: Options);
     /**
-     * Setter for the "profile_crn" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} A string that makes up the iamProfileCrn parameter
+     * Sets the "iamProfileCrn" value to be used when obtaining an IAM access token
+     * @param iamProfileCrn - the CRN of the linked IAM trusted profile to use when obtaining an IAM access token
      */
     setIamProfileCrn(iamProfileCrn: 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
+     * Sets the "iamProfileId" value to be used when obtaining an IAM access token
+     * @param iamProfileId - the ID of the linked IAM trusted profile to use when obtaining an IAM access token
      */
     setIamProfileId(iamProfileId: string): void;
     /**

package/auth/authenticators/vpc-instance-authenticator.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2021.
+ * (C) Copyright IBM Corp. 2021, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,28 +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 [[VpcInstanceAuthenticator]] implements an authentication scheme in which it retrieves an "instance identity token"
+ * The VpcInstanceAuthenticator implements an authentication scheme in which it retrieves an "instance identity token"
  * and exchanges that for an IAM access token using the VPC Instance Metadata Service API which is available on the local
  * compute resource (VM). The instance identity token is similar to an IAM apikey, except that it is managed automatically
  * by the compute resource provider (VPC).
  *
  * The resulting IAM access token is then added to outbound requests in an Authorization header
  *
- *      Authorization: Bearer <access-token>
+ *      Authorization: Bearer \<access-token\>
  */
 var VpcInstanceAuthenticator = /** @class */ (function (_super) {
     __extends(VpcInstanceAuthenticator, _super);
     /**
-     * Create a new [[VpcInstanceAuthenticator]] instance.
+     * Create a new VpcInstanceAuthenticator instance.
      *
-     * @param {object} [options] Configuration options for VpcInstance authentication.
-     * @param {string} [options.iamProfileCrn] The CRN of the linked trusted IAM profile to be used as the identity of the compute resource.
-     *    At most one of iamProfileCrn or iamProfileId may be specified.
-     *    If neither one is specified, then the default IAM profile defined for the compute resource will be used.
-     * @param {string} [options.iamProfileId] The ID of the linked trusted IAM profile to be used when obtaining the IAM access token.
-     *    At most one of iamProfileCrn or iamProfileId may be specified.
-     *    If neither one is specified, then the default IAM profile defined for the compute resource will be used.
-     * @param {string} [options.url] The VPC Instance Metadata Service's base endpoint URL. Default value: "http://169.254.169.254"
+     * @param options - Configuration options for VpcInstance authentication.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the VPC Instance Metadata Service (default value: "http://169.254.169.254")
+     * - iamProfileCrn: (optional) the CRN of the linked IAM trusted profile to be used to obtain the IAM access token
+     * - iamProfileId: (optional) the ID of the linked IAM trusted profile to be used to obtain the IAM access token
+     *
+     * @remarks
+     * At most one of "iamProfileCrn" or "iamProfileId" may be specified. If neither one is specified,
+     * then the default IAM profile defined for the compute resource will be used.
      */
     function VpcInstanceAuthenticator(options) {
         var _this = this;
@@ -76,8 +77,8 @@ var VpcInstanceAuthenticator = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * Setter for the "profile_crn" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} A string that makes up the iamProfileCrn parameter
+     * Sets the "iamProfileCrn" value to be used when obtaining an IAM access token
+     * @param iamProfileCrn - the CRN of the linked IAM trusted profile to use when obtaining an IAM access token
      */
     VpcInstanceAuthenticator.prototype.setIamProfileCrn = function (iamProfileCrn) {
         this.iamProfileCrn = iamProfileCrn;
@@ -85,8 +86,8 @@ var VpcInstanceAuthenticator = /** @class */ (function (_super) {
         this.tokenManager.setIamProfileCrn(iamProfileCrn);
     };
     /**
-     * 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
+     * Sets the "iamProfileId" value to be used when obtaining an IAM access token
+     * @param iamProfileId - the ID of the linked IAM trusted profile to use when obtaining an IAM access token
      */
     VpcInstanceAuthenticator.prototype.setIamProfileId = function (iamProfileId) {
         this.iamProfileId = iamProfileId;

package/auth/token-managers/container-token-manager.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.
@@ -31,44 +31,42 @@ export declare class ContainerTokenManager extends IamRequestBasedTokenManager {
     private iamProfileId;
     /**
      *
-     * Create a new [[ContainerTokenManager]] instance.
+     * Create a new ContainerTokenManager instance.
      *
-     * @param {object} options Configuration options.
-     * @param {string} [crTokenFilename='/var/run/secrets/tokens/vault-token'] The file containing the compute resource token.
-     * @param {string} [iamProfileName] The IAM profile name associated with the compute resource token.
-     * @param {string} [iamProfileId] The IAM profile ID associated with the compute resource token.
-     * @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} [url='https://iam.cloud.ibm.com'] The IAM endpoint for 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] Headers to be sent with every
-     *   outbound HTTP requests to token services.
-     * @constructor
+     * @param options - Configuration options.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service (default: "https://iam.cloud.ibm.com")
+     * - crTokenFilename: (optional) the file containing the compute resource token (default: "/var/run/secrets/tokens/vault-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)
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - 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
+     *
+     * @throws Error: the configuration options were invalid
      */
     constructor(options: Options);
     /**
-     * Setter for the filename of the compute resource token.
-     * @param {string} crTokenFilename A string containing a path to the CR token file
+     * Sets the "crTokenFilename" field
+     * @param crTokenFilename - the name of the file containing the CR token
      */
     setCrTokenFilename(crTokenFilename: string): void;
     /**
-     * Setter for the "profile_name" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} iamProfileName A string that makes up the iamProfileName parameter
+     * Sets the name of the IAM trusted profile to use when obtaining an access token from the IAM token server.
+     * @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} iamProfileId A string that makes up the iamProfileId parameter
+     * Sets the ID of the IAM trusted profile to use when obtaining an access token from the IAM token server.
+     * @param iamProfileId - the ID of the IAM trusted profile
      */
     setIamProfileId(iamProfileId: string): void;
     /**
      * Request an IAM token using a compute resource token.
-     *
-     * @returns {Promise}
      */
     protected requestToken(): Promise<any>;
 }

package/auth/token-managers/container-token-manager.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.
@@ -83,23 +83,23 @@ var ContainerTokenManager = /** @class */ (function (_super) {
     __extends(ContainerTokenManager, _super);
     /**
      *
-     * Create a new [[ContainerTokenManager]] instance.
+     * Create a new ContainerTokenManager instance.
      *
-     * @param {object} options Configuration options.
-     * @param {string} [crTokenFilename='/var/run/secrets/tokens/vault-token'] The file containing the compute resource token.
-     * @param {string} [iamProfileName] The IAM profile name associated with the compute resource token.
-     * @param {string} [iamProfileId] The IAM profile ID associated with the compute resource token.
-     * @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} [url='https://iam.cloud.ibm.com'] The IAM endpoint for 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] Headers to be sent with every
-     *   outbound HTTP requests to token services.
-     * @constructor
+     * @param options - Configuration options.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service (default: "https://iam.cloud.ibm.com")
+     * - crTokenFilename: (optional) the file containing the compute resource token (default: "/var/run/secrets/tokens/vault-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)
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - 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
+     *
+     * @throws Error: the configuration options were invalid
      */
     function ContainerTokenManager(options) {
         var _this = this;
@@ -121,30 +121,28 @@ var ContainerTokenManager = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * Setter for the filename of the compute resource token.
-     * @param {string} crTokenFilename A string containing a path to the CR token file
+     * Sets the "crTokenFilename" field
+     * @param crTokenFilename - the name of the file containing the CR token
      */
     ContainerTokenManager.prototype.setCrTokenFilename = function (crTokenFilename) {
         this.crTokenFilename = crTokenFilename;
     };
     /**
-     * Setter for the "profile_name" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} iamProfileName A string that makes up the iamProfileName parameter
+     * Sets the name of the IAM trusted profile to use when obtaining an access token from the IAM token server.
+     * @param iamProfileName - the name of the IAM trusted profile
      */
     ContainerTokenManager.prototype.setIamProfileName = function (iamProfileName) {
         this.iamProfileName = iamProfileName;
     };
     /**
-     * Setter for the "profile_id" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} iamProfileId A string that makes up the iamProfileId parameter
+     * Sets the ID of the IAM trusted profile to use when obtaining an access token from the IAM token server.
+     * @param iamProfileId - the ID of the IAM trusted profile
      */
     ContainerTokenManager.prototype.setIamProfileId = function (iamProfileId) {
         this.iamProfileId = iamProfileId;
     };
     /**
      * Request an IAM token using a compute resource token.
-     *
-     * @returns {Promise}
      */
     ContainerTokenManager.prototype.requestToken = function () {
         return __awaiter(this, void 0, void 0, function () {

package/auth/token-managers/cp4d-token-manager.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.
@@ -49,19 +49,19 @@ export declare class Cp4dTokenManager extends JwtTokenManager {
     private password;
     private apikey;
     /**
-     * Create a new [[Cp4dTokenManager]] instance.
+     * Create a new Cp4dTokenManager instance.
      *
-     * @param {object} options Configuration options.
-     * @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 {string} options.url The endpoint for CP4D 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] Headers to be sent with every
-     *   outbound HTTP requests to token services.
-     * @constructor
+     * @param options - Configuration options
+     * 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 configuration options were invalid.
      */
     constructor(options: Options);
     protected requestToken(): Promise<any>;

package/auth/token-managers/cp4d-token-manager.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.
@@ -46,19 +46,19 @@ var jwt_token_manager_1 = require("./jwt-token-manager");
 var Cp4dTokenManager = /** @class */ (function (_super) {
     __extends(Cp4dTokenManager, _super);
     /**
-     * Create a new [[Cp4dTokenManager]] instance.
+     * Create a new Cp4dTokenManager instance.
      *
-     * @param {object} options Configuration options.
-     * @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 {string} options.url The endpoint for CP4D 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] Headers to be sent with every
-     *   outbound HTTP requests to token services.
-     * @constructor
+     * @param options - Configuration options
+     * 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 configuration options were invalid.
      */
     function Cp4dTokenManager(options) {
         var _this = _super.call(this, options) || this;

package/auth/token-managers/iam-request-based-token-manager.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.
@@ -35,63 +35,58 @@ export declare class IamRequestBasedTokenManager extends JwtTokenManager {
     protected formData: any;
     /**
      *
-     * Create a new [[IamRequestBasedTokenManager]] instance.
+     * Create a new IamRequestBasedTokenManager instance.
      *
-     * @param {object} options Configuration options.
-     * @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} [url='https://iam.cloud.ibm.com'] The IAM endpoint for 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] Headers to be sent with every
-     *   outbound HTTP requests to token services.
-     * @constructor
+     * @param options - Configuration options.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service (default value: "https://iam.cloud.ibm.com")
+     * - 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);
     /**
-     * Set the IAM `scope` value.
-     * This value is the form parameter to use when fetching the bearer token
-     * from the IAM token server.
+     * Sets the IAM "scope" value.
+     * This value is sent as the "scope" form parameter within the request sent to the IAM token service.
      *
-     * @param {string} scope - A space seperated string that makes up the scope parameter.
-     * @returns {void}
+     * @param scope - a space-separated string that contains one or more scope names
      */
     setScope(scope: string): void;
     /**
-     * Set the IAM `clientId` and `clientSecret` values.
+     * Sets the IAM "clientId" and "clientSecret" values.
      * These values are used to compute the Authorization header used
      * when retrieving the IAM access token.
      * If these values are not set, no Authorization header will be
      * set on the request (it is not required).
      *
-     * @param {string} clientId - The client id.
-     * @param {string} clientSecret - The client secret.
-     * @returns {void}
+     * @param clientId - the client id.
+     * @param clientSecret - the client secret.
      */
     setClientIdAndSecret(clientId: string, clientSecret: string): void;
     /**
-     * Return the most recently stored refresh token.
+     * Returns the most recently stored refresh token.
      *
-     * @public
-     * @returns {string}
+     * @returns the refresh token
      */
     getRefreshToken(): string;
     /**
      * Extend this method from the parent class to extract the refresh token from
      * the request and save it.
      *
-     * @param tokenResponse - Response object from JWT service request
-     * @protected
-     * @returns {void}
+     * @param tokenResponse - the response object from JWT service request
      */
     protected saveTokenInfo(tokenResponse: any): void;
     /**
-     * Request an IAM token using an API key.
+     * Request an IAM access token using an API key.
      *
-     * @returns {Promise}
+     * @returns Promise
      */
     protected requestToken(): Promise<any>;
 }