ibm-cloud-sdk-core 4.0.0 → 4.0.2

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

@@ -4,7 +4,7 @@
 
 ## IamRequestBasedAuthenticator class
 
-The \[\[IamRequestBasedAuthenticator\]\] provides shared configuration and functionality for authenticators that interact with the IAM service to inherit. This authenticator is not meant for use on its own.
+The IamRequestBasedAuthenticator provides shared configuration and functionality for authenticators that interact with the IAM token service. This authenticator is not meant for use on its own.
 
 <b>Signature:</b>
 
@@ -17,22 +17,22 @@ export declare class IamRequestBasedAuthenticator extends TokenRequestBasedAuthe
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator._constructor_.md) |  | Create a new \[\[IamRequestBasedAuthenticator\]\] instance. |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator._constructor_.md) |  | Create a new IamRequestBasedAuthenticator instance. |
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [clientId](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientid.md) |  | string |  |
-|  [clientSecret](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientsecret.md) |  | string |  |
-|  [scope](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.scope.md) |  | string |  |
-|  [tokenManager](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.tokenmanager.md) |  | [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) |  |
+|  [clientId](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientid.md) | <code>protected</code> | string |  |
+|  [clientSecret](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientsecret.md) | <code>protected</code> | string |  |
+|  [scope](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.scope.md) | <code>protected</code> | string |  |
+|  [tokenManager](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.tokenmanager.md) | <code>protected</code> | [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) |  |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [getRefreshToken()](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.getrefreshtoken.md) |  | Return the most recently stored refresh token. |
-|  [setClientIdAndSecret(clientId, clientSecret)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md) |  | Setter for the mutually inclusive <code>clientId</code> and the <code>clientSecret</code>. |
+|  [setClientIdAndSecret(clientId, clientSecret)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md) |  | Setter for the mutually inclusive "clientId" and the "clientSecret" fields. |
 |  [setScope(scope)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.md) |  | Setter for the "scope" parameter to use when fetching the bearer token from the IAM token server. |
 

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md

@@ -4,7 +4,7 @@
 
 ## IamRequestBasedAuthenticator.setClientIdAndSecret() method
 
-Setter for the mutually inclusive `clientId` and the `clientSecret`<!-- -->.
+Setter for the mutually inclusive "clientId" and the "clientSecret" fields.
 
 <b>Signature:</b>
 
@@ -16,8 +16,8 @@ setClientIdAndSecret(clientId: string, clientSecret: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  clientId | string | The <code>clientId</code> and <code>clientSecret</code> fields are used to form a "basic" authorization header for IAM token requests. |
-|  clientSecret | string | The <code>clientId</code> and <code>clientSecret</code> fields are used to form a "basic" authorization header for IAM token requests. |
+|  clientId | string | the "clientId" value used to form a Basic Authorization header for IAM token requests |
+|  clientSecret | string | the "clientSecret" value used to form a Basic Authorization header for IAM token requests |
 
 <b>Returns:</b>
 

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.md

@@ -16,7 +16,7 @@ setScope(scope: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  scope | string | A space seperated string that makes up the scope parameter |
+|  scope | string | (optional) a space-separated string that specifies one or more scopes to be associated with IAM token requests |
 
 <b>Returns:</b>
 

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

@@ -4,7 +4,7 @@
 
 ## IamRequestBasedTokenManager.(constructor)
 
-Create a new \[\[IamRequestBasedTokenManager\]\] instance.
+Create a new IamRequestBasedTokenManager instance.
 
 <b>Signature:</b>
 
@@ -16,5 +16,9 @@ constructor(options: IamRequestOptions);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md) | Configuration options. |
+|  options | [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md) | 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 |
+
+## Exceptions
+
+Error: the configuration options are not valid.
 

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md

@@ -4,7 +4,7 @@
 
 ## IamRequestBasedTokenManager.getRefreshToken() method
 
-Return the most recently stored refresh token.
+Returns the most recently stored refresh token.
 
 <b>Signature:</b>
 
@@ -15,5 +15,5 @@ getRefreshToken(): string;
 
 string
 
-{<!-- -->string<!-- -->}
+the refresh token
 

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

@@ -17,22 +17,22 @@ export declare class IamRequestBasedTokenManager extends JwtTokenManager
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager._constructor_.md) |  | Create a new \[\[IamRequestBasedTokenManager\]\] instance. |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager._constructor_.md) |  | Create a new IamRequestBasedTokenManager instance. |
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [formData](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md) |  | any |  |
-|  [refreshToken](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.md) |  | string |  |
+|  [formData](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md) | <code>protected</code> | any |  |
+|  [refreshToken](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.md) | <code>protected</code> | string |  |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [getRefreshToken()](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md) |  | Return the most recently stored refresh token. |
-|  [requestToken()](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md) |  | Request an IAM token using an API key. |
-|  [saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md) |  | Extend this method from the parent class to extract the refresh token from the request and save it. |
-|  [setClientIdAndSecret(clientId, clientSecret)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setclientidandsecret.md) |  | Set the IAM <code>clientId</code> and <code>clientSecret</code> 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). |
-|  [setScope(scope)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setscope.md) |  | Set the IAM <code>scope</code> value. This value is the form parameter to use when fetching the bearer token from the IAM token server. |
+|  [getRefreshToken()](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md) |  | Returns the most recently stored refresh token. |
+|  [requestToken()](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md) | <code>protected</code> | Request an IAM access token using an API key. |
+|  [saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md) | <code>protected</code> | Extend this method from the parent class to extract the refresh token from the request and save it. |
+|  [setClientIdAndSecret(clientId, clientSecret)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setclientidandsecret.md) |  | 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). |
+|  [setScope(scope)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setscope.md) |  | Sets the IAM "scope" value. This value is sent as the "scope" form parameter within the request sent to the IAM token service. |
 

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md

@@ -4,7 +4,7 @@
 
 ## IamRequestBasedTokenManager.requestToken() method
 
-Request an IAM token using an API key.
+Request an IAM access token using an API key.
 
 <b>Signature:</b>
 
@@ -15,5 +15,5 @@ protected requestToken(): Promise<any>;
 
 Promise&lt;any&gt;
 
-{<!-- -->Promise<!-- -->}
+Promise
 

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md

@@ -16,11 +16,9 @@ protected saveTokenInfo(tokenResponse: any): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  tokenResponse | any | Response object from JWT service request  |
+|  tokenResponse | any | the response object from JWT service request |
 
 <b>Returns:</b>
 
 void
 
-{<!-- -->void<!-- -->}
-

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setclientidandsecret.md

@@ -4,7 +4,7 @@
 
 ## IamRequestBasedTokenManager.setClientIdAndSecret() method
 
-Set 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).
+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).
 
 <b>Signature:</b>
 
@@ -16,12 +16,10 @@ setClientIdAndSecret(clientId: string, clientSecret: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  clientId | string | The client id. |
-|  clientSecret | string | The client secret. |
+|  clientId | string | the client id. |
+|  clientSecret | string | the client secret. |
 
 <b>Returns:</b>
 
 void
 
-{<!-- -->void<!-- -->}
-

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setscope.md

@@ -4,7 +4,7 @@
 
 ## IamRequestBasedTokenManager.setScope() method
 
-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.
 
 <b>Signature:</b>
 
@@ -16,11 +16,9 @@ setScope(scope: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  scope | string | A space seperated string that makes up the scope parameter. |
+|  scope | string | a space-separated string that contains one or more scope names |
 
 <b>Returns:</b>
 
 void
 
-{<!-- -->void<!-- -->}
-

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

@@ -15,9 +15,9 @@ export interface IamRequestOptions extends JwtTokenManagerOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [clientId?](./ibm-cloud-sdk-core.iamrequestoptions.clientid.md) | string | <i>(Optional)</i> |
-|  [clientSecret?](./ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md) | string | <i>(Optional)</i> |
-|  [scope?](./ibm-cloud-sdk-core.iamrequestoptions.scope.md) | string | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [clientId?](./ibm-cloud-sdk-core.iamrequestoptions.clientid.md) |  | string | <i>(Optional)</i> |
+|  [clientSecret?](./ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md) |  | string | <i>(Optional)</i> |
+|  [scope?](./ibm-cloud-sdk-core.iamrequestoptions.scope.md) |  | string | <i>(Optional)</i> |
 

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

@@ -4,7 +4,7 @@
 
 ## IamTokenManager.(constructor)
 
-Create a new \[\[IamTokenManager\]\] instance.
+Create a new IamTokenManager instance.
 
 <b>Signature:</b>
 
@@ -16,5 +16,9 @@ constructor(options: Options);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | Options | Configuration options. |
+|  options | 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 |
+
+## Exceptions
+
+Error: the configuration options are not valid.
 

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

@@ -4,7 +4,7 @@
 
 ## IamTokenManager class
 
-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.
+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.
 
 <b>Signature:</b>
 
@@ -17,11 +17,11 @@ export declare class IamTokenManager extends IamRequestBasedTokenManager
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.iamtokenmanager._constructor_.md) |  | Create a new \[\[IamTokenManager\]\] instance. |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.iamtokenmanager._constructor_.md) |  | Create a new IamTokenManager instance. |
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [requiredOptions](./ibm-cloud-sdk-core.iamtokenmanager.requiredoptions.md) |  | string\[\] |  |
+|  [requiredOptions](./ibm-cloud-sdk-core.iamtokenmanager.requiredoptions.md) | <code>protected</code> | string\[\] |  |
 

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

@@ -22,5 +22,5 @@ export declare function isHTML(text: string): boolean;
 
 boolean
 
-{<!-- -->boolean<!-- -->} true if 'text' has html tags
+true if 'text' has html tags
 

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

@@ -4,7 +4,7 @@
 
 ## JwtTokenManager.(constructor)
 
-Create a new \[\[JwtTokenManager\]\] instance. 
+Create a new JwtTokenManager instance.
 
 <b>Signature:</b>
 
@@ -16,5 +16,5 @@ constructor(options: JwtTokenManagerOptions);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [JwtTokenManagerOptions](./ibm-cloud-sdk-core.jwttokenmanageroptions.md) | Configuration options. |
+|  options | [JwtTokenManagerOptions](./ibm-cloud-sdk-core.jwttokenmanageroptions.md) | 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 |
 

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

@@ -17,19 +17,19 @@ export declare class JwtTokenManager extends TokenManager
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.jwttokenmanager._constructor_.md) |  | Create a new \[\[JwtTokenManager\]\] instance.  |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.jwttokenmanager._constructor_.md) |  | Create a new JwtTokenManager instance. |
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [tokenInfo](./ibm-cloud-sdk-core.jwttokenmanager.tokeninfo.md) |  | any |  |
-|  [tokenName](./ibm-cloud-sdk-core.jwttokenmanager.tokenname.md) |  | string |  |
+|  [tokenInfo](./ibm-cloud-sdk-core.jwttokenmanager.tokeninfo.md) | <code>protected</code> | any |  |
+|  [tokenName](./ibm-cloud-sdk-core.jwttokenmanager.tokenname.md) | <code>protected</code> | string |  |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [requestToken()](./ibm-cloud-sdk-core.jwttokenmanager.requesttoken.md) |  | Request a JWT using an API key. |
-|  [saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md) |  | Save the JWT service response and the calculated expiration time to the object's state. |
+|  [requestToken()](./ibm-cloud-sdk-core.jwttokenmanager.requesttoken.md) | <code>protected</code> | Request a JWT using an API key. |
+|  [saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md) | <code>protected</code> | Save the JWT service response and the calculated expiration time to the object's state. |
 

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.requesttoken.md

@@ -15,5 +15,5 @@ protected requestToken(): Promise<any>;
 
 Promise&lt;any&gt;
 
-{<!-- -->Promise<!-- -->}
+Promise
 

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md

@@ -16,11 +16,9 @@ protected saveTokenInfo(tokenResponse: any): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  tokenResponse | any | Response object from JWT service request  |
+|  tokenResponse | any | the response object from JWT service request |
 
 <b>Returns:</b>
 
 void
 
-{<!-- -->void<!-- -->}
-

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

@@ -9,56 +9,56 @@
 |  Class | Description |
 |  --- | --- |
 |  [Authenticator](./ibm-cloud-sdk-core.authenticator.md) | Base Authenticator class for other Authenticators to extend. Not intended to be used as a stand-alone authenticator. |
-|  [BaseService](./ibm-cloud-sdk-core.baseservice.md) | Common functionality shared by generated service classes.<!-- -->The base service authenticates requests via its authenticator, and sends them to the service endpoint. |
-|  [BasicAuthenticator](./ibm-cloud-sdk-core.basicauthenticator.md) | The BasicAuthenticator is used to add basic authentication information to requests.<!-- -->Basic Authorization will be sent as an Authorization header in the form:<!-- -->Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt; |
-|  [BearerTokenAuthenticator](./ibm-cloud-sdk-core.bearertokenauthenticator.md) | The BearerTokenAuthenticator will set a user-provided bearer token in requests.<!-- -->The bearer token will be sent as an Authorization header in the form:<!-- -->Authorization: Bearer <bearer-token> |
-|  [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md) | The \[\[CloudPakForDataAuthenticator\]\] will either use a username/password pair or a username/apikey pair to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server.<!-- -->The bearer token will be sent as an Authorization header in the form:<!-- -->Authorization: Bearer <bearer-token> |
-|  [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md) | The \[\[ContainerAuthenticator\]\] will read a compute resource token from the file system and use this value to obtain a bearer token from the IAM token server. When the bearer token expires, a new token is obtained from the token server.<!-- -->The bearer token will be sent as an Authorization header in the form:<!-- -->Authorization: Bearer <bearer-token> |
+|  [BaseService](./ibm-cloud-sdk-core.baseservice.md) | <p>Common functionality shared by generated service classes.</p><p>The base service authenticates requests via its authenticator, and sends them to the service endpoint.</p> |
+|  [BasicAuthenticator](./ibm-cloud-sdk-core.basicauthenticator.md) | <p>The BasicAuthenticator is used to add basic authentication information to requests.</p><p>Basic Authorization will be sent as an Authorization header in the form:</p><p>Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt;</p> |
+|  [BearerTokenAuthenticator](./ibm-cloud-sdk-core.bearertokenauthenticator.md) | <p>The BearerTokenAuthenticator will set a user-provided bearer token in requests.</p><p>The bearer token will be sent as an Authorization header in the form:</p><p>Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;</p> |
+|  [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md) | <p>The CloudPakForDataAuthenticator will either use a username/password pair or a username/apikey pair to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server.</p><p>The bearer token will be sent as an Authorization header in the form:</p><p>Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;</p> |
+|  [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md) | <p>The ContainerAuthenticator will read a compute resource token from the file system and use this value to obtain a bearer token from the IAM token server. When the bearer token expires, a new token is obtained from the token server.</p><p>The bearer token will be sent as an Authorization header in the form:</p><p>Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;</p> |
 |  [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) | The ContainerTokenManager retrieves a compute resource token from a file on the container. This token is used to perform the necessary interactions with the IAM token service to obtain and store a suitable bearer (access) token. |
-|  [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) | Token Manager of CloudPak for data.<!-- -->The Token Manager performs basic auth with a username and password to acquire CP4D tokens. |
-|  [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) | The \[\[IamAuthenticator\]\] will use the user-supplied <code>apikey</code> values to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server. If specified, the optional, mutually inclusive <code>clientId</code> and<code>clientSecret</code> pair can be used to influence rate-limiting for requests to the IAM token server.<!-- -->The bearer token will be sent as an Authorization header in the form:<!-- -->Authorization: Bearer <bearer-token> |
-|  [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) | The \[\[IamRequestBasedAuthenticator\]\] provides shared configuration and functionality for authenticators that interact with the IAM service to inherit. This authenticator is not meant for use on its own. |
+|  [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) | <p>Token Manager of CloudPak for data.</p><p>The Token Manager performs basic auth with a username and password to acquire CP4D tokens.</p> |
+|  [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) | <p>The IamAuthenticator will use the user-supplied <code>apikey</code> value to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server. If specified, the optional, mutually inclusive "clientId" and "clientSecret" pair can be used to influence rate-limiting for requests to the IAM token server.</p><p>The bearer token will be sent as an Authorization header in the form:</p><p>Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;</p> |
+|  [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) | The IamRequestBasedAuthenticator provides shared configuration and functionality for authenticators that interact with the IAM token service. This authenticator is not meant for use on its own. |
 |  [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) | The IamRequestBasedTokenManager class contains code relevant to any token manager that interacts with the IAM service to manage a token. It stores information relevant to all IAM requests, such as the client ID and secret, and performs the token request with a set of request options common to any IAM token management scheme. It is intended that this class be extended with specific implementations. |
-|  [IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.md) | 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 <code>clientId</code> and <code>clientSecret</code> pair. |
+|  [IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.md) | 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. |
 |  [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) | A class for shared functionality for parsing, storing, and requesting JWT tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement <code>requestToken()</code> to retrieve the bearer token from intended sources. |
 |  [NoAuthAuthenticator](./ibm-cloud-sdk-core.noauthauthenticator.md) | NoAuthAuthenticator is a placeholder authenticator implementation which performs no authentication of outgoing REST API requests. It might be useful during development and testing. |
-|  [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) | A class for shared functionality for storing, and requesting tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement <code>requestToken()</code> to retrieve the token from intended sources and <code>saveTokenInfo(tokenResponse)</code> to parse and save token information from the response. |
-|  [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) | Class for common functionality shared by token-request authenticators. \[\[TokenRequestBasedAuthenticator\]\]s 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 implementations.<!-- -->The tokens will be added as an Authorization headers in the form:<!-- -->Authorization: Bearer <bearer-token> |
-|  [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) | 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> |
+|  [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) | A class for shared functionality for storing, and requesting tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement "requestToken()" to retrieve the token from intended sources and "saveTokenInfo(tokenResponse)" to parse and save token information from the response. |
+|  [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) | <p>Class for common functionality shared by token-request authenticators. TokenRequestBasedAuthenticators use token managers to retrieve, store, and refresh tokens. Not intended to be used as stand-alone authenticator, but as base class to authenticators that have their own token manager implementations.</p><p>The token will be added as an Authorization header in the form:</p><p>Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;</p> |
+|  [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) | <p>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).</p><p>The resulting IAM access token is then added to outbound requests in an Authorization header</p><p>Authorization: Bearer &lt;<!-- -->access-token<!-- -->&gt;</p> |
 |  [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) | Token Manager for VPC Instance Authentication. |
 
 ## Functions
 
 |  Function | Description |
 |  --- | --- |
-|  [atLeastOne(a, b)](./ibm-cloud-sdk-core.atleastone.md) | Check for at least one of two elements being defined. Returns true if a or b is defined. Returns false if both are undefined. |
-|  [atMostOne(a, b)](./ibm-cloud-sdk-core.atmostone.md) | Verify that both properties are not specified. Returns true if only a, only b, or neither is defined. Returns false if both are defined. |
+|  [atLeastOne(a, b)](./ibm-cloud-sdk-core.atleastone.md) | Checks for at least one of two elements being defined. |
+|  [atMostOne(a, b)](./ibm-cloud-sdk-core.atmostone.md) | Verifies that both properties are not specified. |
 |  [buildRequestFileObject(fileParam)](./ibm-cloud-sdk-core.buildrequestfileobject.md) | This function builds a <code>form-data</code> object for each file parameter. |
 |  [checkCredentials(obj, credsToCheck)](./ibm-cloud-sdk-core.checkcredentials.md) | Checks credentials for common user mistakes of copying {<!-- -->, }<!-- -->, or " characters from the documentation |
 |  [computeBasicAuthHeader(username, password)](./ibm-cloud-sdk-core.computebasicauthheader.md) | Compute and return a Basic Authorization header from a username and password. |
 |  [constructFilepath(filepath)](./ibm-cloud-sdk-core.constructfilepath.md) |  |
 |  [constructServiceUrl(parameterizedUrl, defaultUrlVariables, providedUrlVariables)](./ibm-cloud-sdk-core.constructserviceurl.md) | Constructs a service URL by formatting a parameterized URL. |
 |  [fileExistsAtPath(filepath)](./ibm-cloud-sdk-core.fileexistsatpath.md) |  |
-|  [getAuthenticatorFromEnvironment(serviceName)](./ibm-cloud-sdk-core.getauthenticatorfromenvironment.md) | Look for external configuration of authenticator.<!-- -->Try to get authenticator from external sources, with the following priority: 1. Credentials file (ibm-credentials.env) 2. Environment variables 3. VCAP Services (Cloud Foundry) |
+|  [getAuthenticatorFromEnvironment(serviceName)](./ibm-cloud-sdk-core.getauthenticatorfromenvironment.md) | <p>Look for external configuration of authenticator.</p><p>Try to get authenticator from external sources, with the following priority: 1. Credentials file (ibm-credentials.env) 2. Environment variables 3. VCAP Services (Cloud Foundry)</p> |
 |  [getContentType(inputData)](./ibm-cloud-sdk-core.getcontenttype.md) | This function retrieves the content type of the input. |
-|  [getCurrentTime()](./ibm-cloud-sdk-core.getcurrenttime.md) | Get the current time |
+|  [getCurrentTime()](./ibm-cloud-sdk-core.getcurrenttime.md) | Gets the current time. |
 |  [getFormat(params, formats)](./ibm-cloud-sdk-core.getformat.md) | Returns the first match from formats that is key the params map otherwise null |
 |  [getMissingParams(params, requires)](./ibm-cloud-sdk-core.getmissingparams.md) | Validates that all required params are provided |
-|  [getNewLogger(moduleName)](./ibm-cloud-sdk-core.getnewlogger.md) | Return a new logger, formatted with a particular name. The logging functions, in order of increasing verbosity, are: <code>error</code>, <code>warn</code>, <code>info</code>, <code>verbose</code>, and <code>debug</code>.<!-- -->The logger will be an instance of the <code>debug</code> package and utilizes its support for configuration with environment variables.<!-- -->Additionally, the logger will be turned on automatically if the "NODE\_DEBUG" environment variable is set to "axios". |
+|  [getNewLogger(moduleName)](./ibm-cloud-sdk-core.getnewlogger.md) | <p>Return a new logger, formatted with a particular name. The logging functions, in order of increasing verbosity, are: <code>error</code>, <code>warn</code>, <code>info</code>, <code>verbose</code>, and <code>debug</code>.</p><p>The logger will be an instance of the <code>debug</code> package and utilizes its support for configuration with environment variables.</p><p>Additionally, the logger will be turned on automatically if the "NODE\_DEBUG" environment variable is set to "axios".</p> |
 |  [getQueryParam(urlStr, param)](./ibm-cloud-sdk-core.getqueryparam.md) | Return a query parameter value from a URL |
 |  [isEmptyObject(obj)](./ibm-cloud-sdk-core.isemptyobject.md) |  |
 |  [isFileData(obj)](./ibm-cloud-sdk-core.isfiledata.md) |  |
 |  [isFileWithMetadata(obj)](./ibm-cloud-sdk-core.isfilewithmetadata.md) |  |
 |  [isHTML(text)](./ibm-cloud-sdk-core.ishtml.md) | Return true if 'text' is html |
-|  [onlyOne(a, b)](./ibm-cloud-sdk-core.onlyone.md) | Check 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. |
+|  [onlyOne(a, b)](./ibm-cloud-sdk-core.onlyone.md) | 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. |
 |  [readCredentialsFile()](./ibm-cloud-sdk-core.readcredentialsfile.md) | Return a config object based on a credentials file. Credentials files can be specified filepath via the environment variable: <code>IBM_CREDENTIALS_FILE</code>. |
 |  [readCrTokenFile(filepath)](./ibm-cloud-sdk-core.readcrtokenfile.md) |  |
-|  [readExternalSources(serviceName)](./ibm-cloud-sdk-core.readexternalsources.md) | Read properties stored in external sources like Environment Variables, the credentials file, VCAP services, etc. and return them as an object. The keys of this object will have the service name prefix removed and will be converted to lower camel case.<!-- -->Only one source will be used at a time. |
-|  [removeSuffix(str, suffix)](./ibm-cloud-sdk-core.removesuffix.md) | Remove a given suffix if it exists. |
+|  [readExternalSources(serviceName)](./ibm-cloud-sdk-core.readexternalsources.md) | <p>Read properties stored in external sources like Environment Variables, the credentials file, VCAP services, etc. and return them as an object. The keys of this object will have the service name prefix removed and will be converted to lower camel case.</p><p>Only one source will be used at a time.</p> |
+|  [removeSuffix(str, suffix)](./ibm-cloud-sdk-core.removesuffix.md) | Removes a given suffix if it exists. |
 |  [streamToPromise(stream)](./ibm-cloud-sdk-core.streamtopromise.md) | Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer or array of text chunks Essentially a smaller version of concat-stream wrapped in a promise |
-|  [stripTrailingSlash(url)](./ibm-cloud-sdk-core.striptrailingslash.md) |  |
+|  [stripTrailingSlash(url)](./ibm-cloud-sdk-core.striptrailingslash.md) | Strips trailing slashes from "url", if present. |
 |  [toLowerKeys(obj)](./ibm-cloud-sdk-core.tolowerkeys.md) | This function converts an object's keys to lower case. note: does not convert nested keys |
-|  [validateInput(options, requiredOptions)](./ibm-cloud-sdk-core.validateinput.md) |  |
+|  [validateInput(options, requiredOptions)](./ibm-cloud-sdk-core.validateinput.md) | Validates "options". |
 |  [validateParams(params, requiredParams, allParams)](./ibm-cloud-sdk-core.validateparams.md) | Validates that "params" contains a value for each key listed in "requiredParams", and that each key contained in "params" is a valid key listed in "allParams". In essence, we want params to contain only valid keys and we want params to contain at least the required keys. |
 
 ## Interfaces
@@ -66,7 +66,7 @@
 |  Interface | Description |
 |  --- | --- |
 |  [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) | This interface defines the common methods associated with an Authenticator implementation. |
-|  [FileObject](./ibm-cloud-sdk-core.fileobject.md) | (C) Copyright IBM Corp. 2014, 2021.<!-- -->Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at<!-- -->http://www.apache.org/licenses/LICENSE-2.0<!-- -->Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. |
+|  [FileObject](./ibm-cloud-sdk-core.fileobject.md) | <p>(C) Copyright IBM Corp. 2014, 2022.</p><p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at</p><p>http://www.apache.org/licenses/LICENSE-2.0</p><p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</p> |
 |  [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) |  |
 |  [FileStream](./ibm-cloud-sdk-core.filestream.md) |  |
 |  [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) |  |
@@ -85,7 +85,7 @@
 |  Variable | Description |
 |  --- | --- |
 |  [contentType](./ibm-cloud-sdk-core.contenttype.md) |  |
-|  [qs](./ibm-cloud-sdk-core.qs.md) | (C) Copyright IBM Corp. 2019, 2021.<!-- -->Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at<!-- -->http://www.apache.org/licenses/LICENSE-2.0<!-- -->Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. |
+|  [qs](./ibm-cloud-sdk-core.qs.md) | <p>(C) Copyright IBM Corp. 2019, 2022.</p><p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at</p><p>http://www.apache.org/licenses/LICENSE-2.0</p><p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</p> |
 
 ## Type Aliases
 

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

@@ -4,7 +4,7 @@
 
 ## onlyOne() function
 
-Check 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.
+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.
 
 <b>Signature:</b>
 
@@ -23,5 +23,5 @@ export declare function onlyOne(a: any, b: any): boolean;
 
 boolean
 
-{<!-- -->boolean<!-- -->}
+true if and only if exactly one of a or b is defined
 

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

@@ -4,7 +4,7 @@
 
 ## qs variable
 
-(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. You may obtain a copy of the License at
 

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

@@ -18,7 +18,7 @@ export declare function readExternalSources(serviceName: string): any;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  serviceName | string | The service name prefix. |
+|  serviceName | string | the service name prefix |
 
 <b>Returns:</b>
 

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

@@ -4,7 +4,7 @@
 
 ## removeSuffix() function
 
-Remove a given suffix if it exists.
+Removes a given suffix if it exists.
 
 <b>Signature:</b>
 
@@ -16,12 +16,12 @@ export declare function removeSuffix(str: string, suffix: string): string;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  str | string | The base string to operate on |
-|  suffix | string | The suffix to remove, if present |
+|  str | string | the base string to operate on |
+|  suffix | string | the suffix to remove, if present |
 
 <b>Returns:</b>
 
 string
 
-{<!-- -->string<!-- -->}
+the substring of "str" that remains after the suffix is removed
 

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

@@ -12,11 +12,11 @@ export interface SDKLogger
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [debug](./ibm-cloud-sdk-core.sdklogger.debug.md) | Debugger |  |
-|  [error](./ibm-cloud-sdk-core.sdklogger.error.md) | Debugger |  |
-|  [info](./ibm-cloud-sdk-core.sdklogger.info.md) | Debugger |  |
-|  [verbose](./ibm-cloud-sdk-core.sdklogger.verbose.md) | Debugger |  |
-|  [warn](./ibm-cloud-sdk-core.sdklogger.warn.md) | Debugger |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [debug](./ibm-cloud-sdk-core.sdklogger.debug.md) |  | Debugger |  |
+|  [error](./ibm-cloud-sdk-core.sdklogger.error.md) |  | Debugger |  |
+|  [info](./ibm-cloud-sdk-core.sdklogger.info.md) |  | Debugger |  |
+|  [verbose](./ibm-cloud-sdk-core.sdklogger.verbose.md) |  | Debugger |  |
+|  [warn](./ibm-cloud-sdk-core.sdklogger.warn.md) |  | Debugger |  |
 

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

@@ -16,9 +16,11 @@ export declare function streamToPromise(stream: Stream): Promise<any>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  stream | Stream | Optional stream param for when not bound to an existing stream instance.  {<!-- -->Promise<!-- -->} |
+|  stream | Stream | optional stream param for when not bound to an existing stream instance. |
 
 <b>Returns:</b>
 
 Promise&lt;any&gt;
 
+Promise
+

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

@@ -4,6 +4,8 @@
 
 ## stripTrailingSlash() function
 
+Strips trailing slashes from "url", if present.
+
 <b>Signature:</b>
 
 ```typescript
@@ -14,11 +16,11 @@ export declare function stripTrailingSlash(url: string): string;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  url | string | the url string. |
+|  url | string | the url string |
 
 <b>Returns:</b>
 
 string
 
-{<!-- -->string<!-- -->}
+the url with any trailing slashes removed