ibm-cloud-sdk-core 4.0.0 → 4.0.2

package/es/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/es/auth/token-managers/container-token-manager.js

@@ -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.
@@ -34,23 +34,23 @@ const DEFAULT_CR_TOKEN_FILEPATH = '/var/run/secrets/tokens/vault-token';
 export class ContainerTokenManager extends IamRequestBasedTokenManager {
     /**
      *
-     * 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) {
         // all parameters are optional
@@ -70,30 +70,28 @@ export class ContainerTokenManager extends IamRequestBasedTokenManager {
         this.formData.grant_type = 'urn:ibm:params:oauth:grant-type:cr-token';
     }
     /**
-     * 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) {
         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
      */
     setIamProfileName(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
      */
     setIamProfileId(iamProfileId) {
         this.iamProfileId = iamProfileId;
     }
     /**
      * Request an IAM token using a compute resource token.
-     *
-     * @returns {Promise}
      */
     requestToken() {
         const _super = Object.create(null, {

package/es/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/es/auth/token-managers/cp4d-token-manager.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.
@@ -24,19 +24,19 @@ import { JwtTokenManager } from './jwt-token-manager';
  */
 export class Cp4dTokenManager extends JwtTokenManager {
     /**
-     * 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) {
         super(options);

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

package/es/auth/token-managers/iam-request-based-token-manager.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.
@@ -30,20 +30,21 @@ const OPERATION_PATH = '/identity/token';
 export class IamRequestBasedTokenManager extends JwtTokenManager {
     /**
      *
-     * 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) {
         // all parameters are optional
@@ -68,26 +69,23 @@ export class IamRequestBasedTokenManager extends JwtTokenManager {
         this.formData = {};
     }
     /**
-     * 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) {
         this.scope = scope;
     }
     /**
-     * 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, clientSecret) {
         this.clientId = clientId;
@@ -98,10 +96,9 @@ export class IamRequestBasedTokenManager extends JwtTokenManager {
         }
     }
     /**
-     * Return the most recently stored refresh token.
+     * Returns the most recently stored refresh token.
      *
-     * @public
-     * @returns {string}
+     * @returns the refresh token
      */
     getRefreshToken() {
         return this.refreshToken;
@@ -110,9 +107,7 @@ export class IamRequestBasedTokenManager extends JwtTokenManager {
      * 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
      */
     saveTokenInfo(tokenResponse) {
         super.saveTokenInfo(tokenResponse);
@@ -122,9 +117,9 @@ export class IamRequestBasedTokenManager extends JwtTokenManager {
         }
     }
     /**
-     * Request an IAM token using an API key.
+     * Request an IAM access token using an API key.
      *
-     * @returns {Promise}
+     * @returns Promise
      */
     requestToken() {
         // these cannot be overwritten

package/es/auth/token-managers/iam-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.
@@ -21,28 +21,29 @@ interface Options extends IamRequestOptions {
 /**
  * The IAMTokenManager takes an api key and performs the necessary interactions with
  * the IAM token service to obtain and store a suitable bearer token. Additionally, the IAMTokenManager
- * will retrieve bearer tokens via basic auth using a supplied `clientId` and `clientSecret` pair.
+ * will retrieve bearer tokens via basic auth using a supplied "clientId" and "clientSecret" pair.
  */
 export declare class IamTokenManager extends IamRequestBasedTokenManager {
     protected requiredOptions: string[];
     private apikey;
     /**
      *
-     * Create a new [[IamTokenManager]] instance.
+     * Create a new IamTokenManager instance.
      *
-     * @param {object} options Configuration options.
-     * @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} [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 IAM token service (default value: "https://iam.cloud.ibm.com")
+     * - 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/es/auth/token-managers/iam-token-manager.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,26 +18,27 @@ import { IamRequestBasedTokenManager } from './iam-request-based-token-manager';
 /**
  * The IAMTokenManager takes an api key and performs the necessary interactions with
  * the IAM token service to obtain and store a suitable bearer token. Additionally, the IAMTokenManager
- * will retrieve bearer tokens via basic auth using a supplied `clientId` and `clientSecret` pair.
+ * will retrieve bearer tokens via basic auth using a supplied "clientId" and "clientSecret" pair.
  */
 export class IamTokenManager extends IamRequestBasedTokenManager {
     /**
      *
-     * Create a new [[IamTokenManager]] instance.
+     * Create a new IamTokenManager instance.
      *
-     * @param {object} options Configuration options.
-     * @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} [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 IAM token service (default value: "https://iam.cloud.ibm.com")
+     * - 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) {
         super(options);

package/es/auth/token-managers/jwt-token-manager.d.ts

@@ -11,29 +11,26 @@ export declare class JwtTokenManager extends TokenManager {
     protected tokenName: string;
     protected tokenInfo: any;
     /**
-     * Create a new [[JwtTokenManager]] instance.
-     * @constructor
-     * @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] Headers to be sent with every
-     *   outbound HTTP requests to token services.
+     * Create a new JwtTokenManager instance.
+     *
+     * @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: JwtTokenManagerOptions);
     /**
      * Request a JWT using an API key.
      *
-     * @returns {Promise}
+     * @returns Promise
      */
     protected requestToken(): Promise<any>;
     /**
      * Save the JWT service response and the calculated expiration time to the object's state.
      *
-     * @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;
 }