ibm-cloud-sdk-core 4.0.0 → 4.0.2

package/auth/token-managers/vpc-instance-token-manager.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.
@@ -81,17 +81,17 @@ var METADATA_SERVICE_VERSION = '2021-09-20';
 var VpcInstanceTokenManager = /** @class */ (function (_super) {
     __extends(VpcInstanceTokenManager, _super);
     /**
-     * Create a new [[VpcInstanceTokenManager]] instance.
+     * Create a new VpcInstanceTokenManager instance.
      *
-     * @param {object} [options] Configuration options.
-     * @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"
-     * @constructor
+     * @param options - Configuration options.
+     * 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 VpcInstanceTokenManager(options) {
         var _this = this;
@@ -111,15 +111,15 @@ var VpcInstanceTokenManager = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * Setter for the "trusted_profile" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} iamProfileCrn A string that makes up the iamProfileCrn parameter
+     * Sets the CRN of the IAM trusted profile to use when fetching the access token from the IAM token server.
+     * @param iamProfileCrn - the CRN of the IAM trusted profile
      */
     VpcInstanceTokenManager.prototype.setIamProfileCrn = function (iamProfileCrn) {
         this.iamProfileCrn = iamProfileCrn;
     };
     /**
-     * Setter for the "trusted_profile" 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 fetching the access token from the IAM token server.
+     * @param iamProfileId - the ID of the IAM trusted profile
      */
     VpcInstanceTokenManager.prototype.setIamProfileId = function (iamProfileId) {
         this.iamProfileId = iamProfileId;

package/auth/utils/get-authenticator-from-environment.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,7 +22,7 @@ import { Authenticator } from '../authenticators';
  * 2. Environment variables
  * 3. VCAP Services (Cloud Foundry)
  *
- * @param {string} serviceName The service name prefix.
+ * @param serviceName - the service name prefix.
  *
  */
 export declare function getAuthenticatorFromEnvironment(serviceName: string): Authenticator;

package/auth/utils/get-authenticator-from-environment.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.
@@ -26,7 +26,7 @@ var read_external_sources_1 = require("./read-external-sources");
  * 2. Environment variables
  * 3. VCAP Services (Cloud Foundry)
  *
- * @param {string} serviceName The service name prefix.
+ * @param serviceName - the service name prefix.
  *
  */
 function getAuthenticatorFromEnvironment(serviceName) {

package/auth/utils/helpers.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,66 +16,68 @@
 /**
  * Compute and return a Basic Authorization header from a username and password.
  *
- * @param {string} username - The username or client id
- * @param {string} password - The password or client secret
- * @returns {string} - A Basic Auth header with format "Basic <encoded-credentials>"
+ * @param username - The username or client id
+ * @param password - The password or client secret
+ * @returns a Basic Auth header with format "Basic <encoded-credentials>"
  */
 export declare function computeBasicAuthHeader(username: string, password: string): string;
 /**
- * Checks credentials for common user mistakes of copying {, }, or " characters from the documentation
+ * Checks credentials for common user mistakes of copying \{, \}, or \" characters from the documentation
  *
- * @param {object} obj - The options object holding credentials
- * @param {string[]} credsToCheck - An array containing the keys of the credentials to check for problems
- * @returns {string | null} - Returns a string with the error message if there were problems, null if not
+ * @param obj - the options object holding credentials
+ * @param credsToCheck - an array containing the keys of the credentials to check for problems
+ * @returns a string with the error message if there were problems, null if not
  */
 export declare function checkCredentials(obj: any, credsToCheck: string[]): Error | null;
 /**
- * @param {object} options - A configuration options object.
- * @param {string[]} requiredOptions - The list of properties that must be specified.
+ * Validates "options".
+ * @param options - a configuration options object
+ * @param requiredOptions - the list of properties that must be present in "options"
+ *
+ * @throws Error: "options" failed validation
  */
 export declare function validateInput(options: any, requiredOptions: string[]): void;
 /**
- * Get the current time
+ * Gets the current time.
  *
- * @returns {number} - Returns the current time in seconds.
+ * @returns the current time in seconds.
  */
 export declare function getCurrentTime(): number;
 /**
- * Check for only one of two elements being defined.
+ * Checks for only one of two elements being defined.
  * Returns true if a is defined and b is undefined,
  * or vice versa. Returns false if both are defined
  * or both are undefined.
  *
- * @param {any} a - The first object
- * @param {any} b - The second object
- * @returns {boolean}
+ * @param a - The first object
+ * @param b - The second object
+ * @returns true if and only if exactly one of a or b is defined
  */
 export declare function onlyOne(a: any, b: any): boolean;
 /**
- * Remove a given suffix if it exists.
+ * Removes a given suffix if it exists.
+ *
+ * @param str - the base string to operate on
+ * @param suffix - the suffix to remove, if present
  *
- * @param {string} str - The base string to operate on
- * @param {string} suffix - The suffix to remove, if present
- * @returns {string}
+ * @returns the substring of "str" that remains after the suffix is removed
  */
 export declare function removeSuffix(str: string, suffix: string): string;
 /**
- * Check for at least one of two elements being defined.
- * Returns true if a or b is defined. Returns false if
- * both are undefined.
+ * Checks for at least one of two elements being defined.
  *
- * @param {any} a - The first object
- * @param {any} b - The second object
- * @returns {boolean}
+ * @param a - the first object
+ * @param b - the second object
+ * @returns true if a or b is defined; false if both are undefined
  */
 export declare function atLeastOne(a: any, b: any): boolean;
 /**
- * Verify that both properties are not specified.
- * Returns true if only a, only b, or neither is defined.
- * Returns false if both are defined.
+ * Verifies that both properties are not specified.
+ *
+ * @param a - The first object
+ * @param b - The second object
  *
- * @param {any} a - The first object
- * @param {any} b - The second object
- * @returns {boolean}
+ * @returns  false if a and b are both defined, true otherwise
+
  */
 export declare function atMostOne(a: any, b: any): boolean;

package/auth/utils/helpers.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.
@@ -20,9 +20,9 @@ var helper_1 = require("../../lib/helper");
 /**
  * Compute and return a Basic Authorization header from a username and password.
  *
- * @param {string} username - The username or client id
- * @param {string} password - The password or client secret
- * @returns {string} - A Basic Auth header with format "Basic <encoded-credentials>"
+ * @param username - The username or client id
+ * @param password - The password or client secret
+ * @returns a Basic Auth header with format "Basic <encoded-credentials>"
  */
 function computeBasicAuthHeader(username, password) {
     var encodedCreds = Buffer.from("".concat(username, ":").concat(password)).toString('base64');
@@ -35,11 +35,11 @@ function badCharAtAnEnd(value) {
     return (value.startsWith('{') || value.startsWith('"') || value.endsWith('}') || value.endsWith('"'));
 }
 /**
- * Checks credentials for common user mistakes of copying {, }, or " characters from the documentation
+ * Checks credentials for common user mistakes of copying \{, \}, or \" characters from the documentation
  *
- * @param {object} obj - The options object holding credentials
- * @param {string[]} credsToCheck - An array containing the keys of the credentials to check for problems
- * @returns {string | null} - Returns a string with the error message if there were problems, null if not
+ * @param obj - the options object holding credentials
+ * @param credsToCheck - an array containing the keys of the credentials to check for problems
+ * @returns a string with the error message if there were problems, null if not
  */
 function checkCredentials(obj, credsToCheck) {
     var errorMessage = '';
@@ -57,8 +57,11 @@ function checkCredentials(obj, credsToCheck) {
 }
 exports.checkCredentials = checkCredentials;
 /**
- * @param {object} options - A configuration options object.
- * @param {string[]} requiredOptions - The list of properties that must be specified.
+ * Validates "options".
+ * @param options - a configuration options object
+ * @param requiredOptions - the list of properties that must be present in "options"
+ *
+ * @throws Error: "options" failed validation
  */
 function validateInput(options, requiredOptions) {
     // check for required params
@@ -76,34 +79,35 @@ function validateInput(options, requiredOptions) {
 }
 exports.validateInput = validateInput;
 /**
- * Get the current time
+ * Gets the current time.
  *
- * @returns {number} - Returns the current time in seconds.
+ * @returns the current time in seconds.
  */
 function getCurrentTime() {
     return Math.floor(Date.now() / 1000);
 }
 exports.getCurrentTime = getCurrentTime;
 /**
- * Check for only one of two elements being defined.
+ * Checks for only one of two elements being defined.
  * Returns true if a is defined and b is undefined,
  * or vice versa. Returns false if both are defined
  * or both are undefined.
  *
- * @param {any} a - The first object
- * @param {any} b - The second object
- * @returns {boolean}
+ * @param a - The first object
+ * @param b - The second object
+ * @returns true if and only if exactly one of a or b is defined
  */
 function onlyOne(a, b) {
     return Boolean((a && !b) || (b && !a));
 }
 exports.onlyOne = onlyOne;
 /**
- * Remove a given suffix if it exists.
+ * Removes a given suffix if it exists.
+ *
+ * @param str - the base string to operate on
+ * @param suffix - the suffix to remove, if present
  *
- * @param {string} str - The base string to operate on
- * @param {string} suffix - The suffix to remove, if present
- * @returns {string}
+ * @returns the substring of "str" that remains after the suffix is removed
  */
 function removeSuffix(str, suffix) {
     if (str.endsWith(suffix)) {
@@ -113,26 +117,24 @@ function removeSuffix(str, suffix) {
 }
 exports.removeSuffix = removeSuffix;
 /**
- * Check for at least one of two elements being defined.
- * Returns true if a or b is defined. Returns false if
- * both are undefined.
+ * Checks for at least one of two elements being defined.
  *
- * @param {any} a - The first object
- * @param {any} b - The second object
- * @returns {boolean}
+ * @param a - the first object
+ * @param b - the second object
+ * @returns true if a or b is defined; false if both are undefined
  */
 function atLeastOne(a, b) {
     return Boolean(a || b);
 }
 exports.atLeastOne = atLeastOne;
 /**
- * Verify that both properties are not specified.
- * Returns true if only a, only b, or neither is defined.
- * Returns false if both are defined.
+ * Verifies that both properties are not specified.
+ *
+ * @param a - The first object
+ * @param b - The second object
  *
- * @param {any} a - The first object
- * @param {any} b - The second object
- * @returns {boolean}
+ * @returns  false if a and b are both defined, true otherwise
+
  */
 function atMostOne(a, b) {
     return Boolean(!(a && b));

package/auth/utils/read-external-sources.d.ts

@@ -5,6 +5,7 @@
  * and will be converted to lower camel case.
  *
  * Only one source will be used at a time.
- * @param {string} serviceName The service name prefix.
+ *
+ * @param serviceName - the service name prefix
  */
 export declare function readExternalSources(serviceName: string): any;

package/auth/utils/read-external-sources.js

@@ -6,7 +6,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readExternalSources = void 0;
 /**
- * (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.
@@ -31,7 +31,8 @@ var file_reading_helpers_1 = require("./file-reading-helpers");
  * and will be converted to lower camel case.
  *
  * Only one source will be used at a time.
- * @param {string} serviceName The service name prefix.
+ *
+ * @param serviceName - the service name prefix
  */
 function readExternalSources(serviceName) {
     if (!serviceName) {
@@ -64,8 +65,8 @@ function getProperties(serviceName) {
  * For example, if service.name is speech_to_text,
  * env properties are SPEECH_TO_TEXT_USERNAME and SPEECH_TO_TEXT_PASSWORD
  *
- * @param {object} envObj - the object containing the credentials keyed by environment variables
- * @returns {Credentials}
+ * @param envObj - the object containing the credentials keyed by environment variables
+ * @returns the set of credentials
  */
 function filterPropertiesByServiceName(envObj, serviceName) {
     var credentials = {};

package/build/docs/ibm-cloud-sdk-core.atleastone.md

@@ -4,7 +4,7 @@
 
 ## atLeastOne() function
 
-Check for at least one of two elements being defined. Returns true if a or b is defined. Returns false if both are undefined.
+Checks for at least one of two elements being defined.
 
 <b>Signature:</b>
 
@@ -16,12 +16,12 @@ export declare function atLeastOne(a: any, b: any): boolean;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  a | any | The first object |
-|  b | any | The second object |
+|  a | any | the first object |
+|  b | any | the second object |
 
 <b>Returns:</b>
 
 boolean
 
-{<!-- -->boolean<!-- -->}
+true if a or b is defined; false if both are undefined
 

package/build/docs/ibm-cloud-sdk-core.atmostone.md

@@ -4,7 +4,7 @@
 
 ## atMostOne() function
 
-Verify that both properties are not specified. Returns true if only a, only b, or neither is defined. Returns false if both are defined.
+Verifies that both properties are not specified.
 
 <b>Signature:</b>
 
@@ -23,5 +23,5 @@ export declare function atMostOne(a: any, b: any): boolean;
 
 boolean
 
-{<!-- -->boolean<!-- -->}
+false if a and b are both defined, true otherwise
 

package/build/docs/ibm-cloud-sdk-core.authenticator._constructor_.md

@@ -14,5 +14,5 @@ constructor();
 
 ## Exceptions
 
-{<!-- -->Error<!-- -->} The `new` keyword was not used to create construct the authenticator.
+Error: the "new" keyword was not used to construct the authenticator.
 

package/build/docs/ibm-cloud-sdk-core.authenticator.authenticate.md

@@ -24,5 +24,5 @@ Promise<void>
 
 ## Exceptions
 
-{<!-- -->Error<!-- -->} - The authenticate method was not implemented by a subclass.
+Error: The authenticate method was not implemented by a subclass.
 

package/build/docs/ibm-cloud-sdk-core.authenticator.authenticationtype.md

@@ -4,7 +4,7 @@
 
 ## Authenticator.authenticationType() method
 
-Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the "<!-- -->&lt;<!-- -->service\_name<!-- -->&gt;<!-- -->\_AUTH\_TYPE" configuration property (e.g. "basic", "iam", etc.). This function should be overridden in each authenticator implementation class that extends this class.
+Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the &lt;<!-- -->service\_name<!-- -->&gt;<!-- -->\_AUTH\_TYPE configuration property (e.g. "basic", "iam", etc.). This function should be overridden in each authenticator implementation class that extends this class.
 
 <b>Signature:</b>
 

package/build/docs/ibm-cloud-sdk-core.authenticator.md

@@ -37,5 +37,5 @@ export declare class Authenticator implements AuthenticatorInterface
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [authenticate(requestOptions)](./ibm-cloud-sdk-core.authenticator.authenticate.md) |  | Augment the request with authentication information. |
-|  [authenticationType()](./ibm-cloud-sdk-core.authenticator.authenticationtype.md) |  | Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the "<!-- -->&lt;<!-- -->service\_name<!-- -->&gt;<!-- -->\_AUTH\_TYPE" configuration property (e.g. "basic", "iam", etc.). This function should be overridden in each authenticator implementation class that extends this class. |
+|  [authenticationType()](./ibm-cloud-sdk-core.authenticator.authenticationtype.md) |  | Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the &lt;<!-- -->service\_name<!-- -->&gt;<!-- -->\_AUTH\_TYPE configuration property (e.g. "basic", "iam", etc.). This function should be overridden in each authenticator implementation class that extends this class. |
 

package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticate.md

@@ -16,7 +16,7 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  requestOptions | AuthenticateOptions | The request to augment with authentication information. |
+|  requestOptions | AuthenticateOptions | The request to which authentication information is added (in the headers field). |
 
 <b>Returns:</b>
 

package/build/docs/ibm-cloud-sdk-core.baseservice._constructor_.md

@@ -16,5 +16,5 @@ constructor(userOptions: UserOptions);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  userOptions | [UserOptions](./ibm-cloud-sdk-core.useroptions.md) |  |
+|  userOptions | [UserOptions](./ibm-cloud-sdk-core.useroptions.md) | the configuration options to set on the service instance. This should be an object with the following fields: - authenticator: (required) an Object used to authenticate requests to the service. - serviceUrl: (optional) the base url to use when contacting the service. The base url may differ between IBM Cloud regions. - headers: (optional) a set of HTTP headers that should be included with every request sent to the service - disableSslVerification: (optional) a flag that indicates whether verification of the server's SSL certificate should be disabled or not. |
 

package/build/docs/ibm-cloud-sdk-core.baseservice.configureservice.md

@@ -16,7 +16,7 @@ protected configureService(serviceName: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  serviceName | string | The name of the service. Will be used to read from external configuration. |
+|  serviceName | string | the name of the service. This will be used to read from external configuration. |
 
 <b>Returns:</b>
 

package/build/docs/ibm-cloud-sdk-core.baseservice.createrequest.md

@@ -16,11 +16,11 @@ protected createRequest(parameters: any): Promise<any>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  parameters | any | Service request options passed in by user. |
+|  parameters | any | Service request options passed in by user. This should be an object with the following fields: - options.method: the http method - options.url: the path portion of the URL to be appended to the serviceUrl - options.path: the path parameters to be inserted into the URL - options.qs: the querystring to be included in the URL - options.body: the data to be sent as the request body - options.form: an object containing the key/value pairs for a www-form-urlencoded request. - options.formData: an object containing the contents for a multipart/form-data request The following processing is performed on formData values: - string: no special processing -- the value is sent as is - object: the value is converted to a JSON string before insertion into the form body - NodeJS.ReadableStream\|Buffer\|FileWithMetadata: sent as a file, with any associated metadata - array: each element of the array is sent as a separate form part using any special processing as described above - defaultOptions.serviceUrl: the base URL of the service - defaultOptions.headers: additional HTTP headers to be sent with the request |
 
 <b>Returns:</b>
 
 Promise&lt;any&gt;
 
-{<!-- -->Promise<any>}
+a Promise
 

package/build/docs/ibm-cloud-sdk-core.baseservice.enableretries.md

@@ -16,7 +16,7 @@ enableRetries(retryOptions?: RetryOptions): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  retryOptions | RetryOptions | <i>(Optional)</i> configuration for retries |
+|  retryOptions | RetryOptions | <i>(Optional)</i> the configuration for retries |
 
 <b>Returns:</b>
 

package/build/docs/ibm-cloud-sdk-core.baseservice.getauthenticator.md

@@ -15,5 +15,5 @@ getAuthenticator(): any;
 
 any
 
-{<!-- -->Authenticator<!-- -->}
+the Authenticator instance
 

package/build/docs/ibm-cloud-sdk-core.baseservice.md

@@ -24,7 +24,7 @@ export declare class BaseService
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [baseOptions](./ibm-cloud-sdk-core.baseservice.baseoptions.md) |  | BaseServiceOptions |  |
+|  [baseOptions](./ibm-cloud-sdk-core.baseservice.baseoptions.md) | <code>protected</code> | BaseServiceOptions |  |
 |  [DEFAULT\_SERVICE\_NAME](./ibm-cloud-sdk-core.baseservice.default_service_name.md) | <code>static</code> | string |  |
 |  [DEFAULT\_SERVICE\_URL](./ibm-cloud-sdk-core.baseservice.default_service_url.md) | <code>static</code> | string |  |
 
@@ -32,8 +32,8 @@ export declare class BaseService
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [configureService(serviceName)](./ibm-cloud-sdk-core.baseservice.configureservice.md) |  | Configure the service using external configuration |
-|  [createRequest(parameters)](./ibm-cloud-sdk-core.baseservice.createrequest.md) |  | Wrapper around <code>sendRequest</code> that enforces the request will be authenticated. |
+|  [configureService(serviceName)](./ibm-cloud-sdk-core.baseservice.configureservice.md) | <code>protected</code> | Configure the service using external configuration |
+|  [createRequest(parameters)](./ibm-cloud-sdk-core.baseservice.createrequest.md) | <code>protected</code> | Wrapper around <code>sendRequest</code> that enforces the request will be authenticated. |
 |  [disableRetries()](./ibm-cloud-sdk-core.baseservice.disableretries.md) |  | Disables retries. |
 |  [enableRetries(retryOptions)](./ibm-cloud-sdk-core.baseservice.enableretries.md) |  | Enable retries for unfulfilled requests. |
 |  [getAuthenticator()](./ibm-cloud-sdk-core.baseservice.getauthenticator.md) |  | Get the instance of the authenticator set on the service. |

package/build/docs/ibm-cloud-sdk-core.baseservice.setdefaultheaders.md

@@ -16,7 +16,7 @@ setDefaultHeaders(headers: OutgoingHttpHeaders): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  headers | OutgoingHttpHeaders | The map of headers to include in requests. |
+|  headers | OutgoingHttpHeaders | the map of headers to include in requests. |
 
 <b>Returns:</b>
 

package/build/docs/ibm-cloud-sdk-core.baseservice.setserviceurl.md

@@ -16,7 +16,7 @@ setServiceUrl(url: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  url | string | The base URL for the service. |
+|  url | string | the base URL for the service. |
 
 <b>Returns:</b>
 

package/build/docs/ibm-cloud-sdk-core.basicauthenticator._constructor_.md

@@ -16,9 +16,9 @@ constructor(options: Options);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | Options | Configuration options for basic authentication. |
+|  options | Options | Configuration options for basic authentication. This should be an object containing these fields: - username: the username portion of basic authentication - password: the password portion of basic authentication |
 
 ## Exceptions
 
-{<!-- -->Error<!-- -->} The configuration options are not valid.
+Error: the configuration options are not valid.
 

package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticate.md

@@ -4,7 +4,7 @@
 
 ## BasicAuthenticator.authenticate() method
 
-Add basic authentication information to `request`<!-- -->. The basic authentication information will be set in the Authorization property of`request.headers` in the form:
+Add basic authentication information to `requestOptions`<!-- -->. The basic authentication information will be set in the Authorization property of `requestOptions.headers` in the form:
 
 Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt;
 

package/build/docs/ibm-cloud-sdk-core.basicauthenticator.md

@@ -27,13 +27,13 @@ export declare class BasicAuthenticator extends Authenticator
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [authHeader](./ibm-cloud-sdk-core.basicauthenticator.authheader.md) |  | { Authorization: string; } |  |
-|  [requiredOptions](./ibm-cloud-sdk-core.basicauthenticator.requiredoptions.md) |  | string\[\] |  |
+|  [authHeader](./ibm-cloud-sdk-core.basicauthenticator.authheader.md) | <code>protected</code> | { Authorization: string; } |  |
+|  [requiredOptions](./ibm-cloud-sdk-core.basicauthenticator.requiredoptions.md) | <code>protected</code> | string\[\] |  |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.basicauthenticator.authenticate.md) |  | Add basic authentication information to <code>request</code>. The basic authentication information will be set in the Authorization property of<code>request.headers</code> in the form:<!-- -->Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt; |
+|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.basicauthenticator.authenticate.md) |  | <p>Add basic authentication information to <code>requestOptions</code>. The basic authentication information will be set in the Authorization property of <code>requestOptions.headers</code> in the form:</p><p>Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt;</p> |
 |  [authenticationType()](./ibm-cloud-sdk-core.basicauthenticator.authenticationtype.md) |  | Returns the authenticator's type ('basic'). |
 

package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator._constructor_.md

@@ -16,9 +16,9 @@ constructor(options: Options);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | Options | Configuration options for bearer authentication. |
+|  options | Options | Configuration options for bearer authentication. This should be an object containing the "bearerToken" field. |
 
 ## Exceptions
 
-{<!-- -->Error<!-- -->} The configuration bearerToken is not valid, or unspecified.
+Error: the options.bearerToken field is not valid, or unspecified
 

package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md

@@ -4,9 +4,9 @@
 
 ## BearerTokenAuthenticator.authenticate() method
 
-Add a bearer token to the `request`<!-- -->. The bearer token information will be set in the Authorization property of`request.headers` in the form:
+Add a bearer token 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 &lt;<!-- -->bearer-token<!-- -->&gt;
 
 <b>Signature:</b>