ibm-cloud-sdk-core 4.0.0 → 4.0.2

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

@@ -8,7 +8,7 @@ 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>
+Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
 
 <b>Signature:</b>
 
@@ -27,13 +27,13 @@ export declare class BearerTokenAuthenticator extends Authenticator
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [requiredOptions](./ibm-cloud-sdk-core.bearertokenauthenticator.requiredoptions.md) |  | string\[\] |  |
+|  [requiredOptions](./ibm-cloud-sdk-core.bearertokenauthenticator.requiredoptions.md) | <code>protected</code> | string\[\] |  |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md) |  | Add a bearer token to the <code>request</code>. The bearer token information will be set in the Authorization property of<code>request.headers</code> in the form:<!-- -->Authorization: Bearer <bearer-token> |
+|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md) |  | <p>Add a bearer token to <code>requestOptions</code>. The bearer token information will be set in the Authorization property of "requestOptions.headers" in the form:</p><p>Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;</p> |
 |  [authenticationType()](./ibm-cloud-sdk-core.bearertokenauthenticator.authenticationtype.md) |  | Returns the authenticator's type ('bearertoken'). |
 |  [setBearerToken(bearerToken)](./ibm-cloud-sdk-core.bearertokenauthenticator.setbearertoken.md) |  | Set a new bearer token to be sent in subsequent requests. |
 

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

@@ -16,11 +16,11 @@ export declare function buildRequestFileObject(fileParam: FileWithMetadata): Pro
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  fileParam | [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) | The file parameter. |
+|  fileParam | [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) | The FileWithMetadata instance that contains the file information |
 
 <b>Returns:</b>
 
 Promise&lt;[FileObject](./ibm-cloud-sdk-core.fileobject.md)<!-- -->&gt;
 
-{<!-- -->FileObject<!-- -->}
+the FileObject instance
 

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

@@ -16,12 +16,12 @@ export declare function checkCredentials(obj: any, credsToCheck: string[]): Erro
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  obj | any | The options object holding credentials |
-|  credsToCheck | string\[\] | An array containing the keys of the credentials to check for problems |
+|  obj | any | the options object holding credentials |
+|  credsToCheck | string\[\] | an array containing the keys of the credentials to check for problems |
 
 <b>Returns:</b>
 
 Error \| null
 
-{<!-- -->string \| null<!-- -->} - Returns a string with the error message if there were problems, null if not
+a string with the error message if there were problems, null if not
 

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

@@ -4,7 +4,7 @@
 
 ## CloudPakForDataAuthenticator.(constructor)
 
-Create a new \[\[CloudPakForDataAuthenticator\]\] instance.
+Create a new CloudPakForDataAuthenticator instance.
 
 <b>Signature:</b>
 
@@ -16,9 +16,9 @@ constructor(options: Options);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | Options | Configuration options for CloudPakForData authentication. |
+|  options | Options | Configuration options for CloudPakForData authentication. This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service |
 
 ## Exceptions
 
-`Error` The username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.
+Error: the username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.
 

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

@@ -4,11 +4,11 @@
 
 ## CloudPakForDataAuthenticator class
 
-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 CloudPakForDataAuthenticator will either use a username/password pair or a username/apikey pair to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server.
 
 The bearer token will be sent as an Authorization header in the form:
 
-Authorization: Bearer <bearer-token>
+Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
 
 <b>Signature:</b>
 
@@ -21,14 +21,14 @@ export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthe
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md) |  | Create a new \[\[CloudPakForDataAuthenticator\]\] instance. |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md) |  | Create a new CloudPakForDataAuthenticator instance. |
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [requiredOptions](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md) |  | string\[\] |  |
-|  [tokenManager](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md) |  | [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) |  |
+|  [requiredOptions](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md) | <code>protected</code> | string\[\] |  |
+|  [tokenManager](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md) | <code>protected</code> | [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) |  |
 
 ## Methods
 

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

@@ -23,5 +23,5 @@ export declare function computeBasicAuthHeader(username: string, password: strin
 
 string
 
-{<!-- -->string<!-- -->} - A Basic Auth header with format "Basic <encoded-credentials>"
+a Basic Auth header with format "Basic <encoded-credentials>"
 

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

@@ -16,13 +16,13 @@ export declare function constructServiceUrl(parameterizedUrl: string, defaultUrl
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  parameterizedUrl | string | URL that contains variable placeholders, e.g. '<!-- -->{<!-- -->scheme<!-- -->}<!-- -->://ibm.com'. |
-|  defaultUrlVariables | Map&lt;string, string&gt; | Map from variable names to default values. Each variable in the parameterized URL must have a default value specified in this map. |
-|  providedUrlVariables | Map&lt;string, string&gt; \| null | Map from variable names to desired values. If a variable is not provided in this map, the default variable value will be used instead. |
+|  parameterizedUrl | string | a URL that contains variable placeholders, e.g. '<!-- -->{<!-- -->scheme<!-- -->}<!-- -->://ibm.com'. |
+|  defaultUrlVariables | Map&lt;string, string&gt; | a Map of variable names to default values. Each variable in the parameterized URL must have a default value specified in this map. |
+|  providedUrlVariables | Map&lt;string, string&gt; \| null | a Map of variable names to desired values. If a variable is not provided in this map, the default variable value will be used instead. |
 
 <b>Returns:</b>
 
 string
 
-{<!-- -->string<!-- -->} The formatted URL with all variable placeholders replaced by values.
+the formatted URL with all variable placeholders replaced by values.
 

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

@@ -4,7 +4,7 @@
 
 ## ContainerAuthenticator.(constructor)
 
-Create a new \[\[ContainerAuthenticator\]\] instance.
+Create a new ContainerAuthenticator instance.
 
 <b>Signature:</b>
 
@@ -16,9 +16,9 @@ constructor(options: Options);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | Options | Configuration options for IAM authentication. |
+|  options | Options | Configuration options for IAM authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - crTokenFilename: (optional) the file containing the compute resource token - iamProfileName: (optional) the name of the IAM trusted profile associated with the compute resource token (required if iamProfileId is not specified) - iamProfileId\]: (optional) the ID of the IAM trusted profile associated with the compute resource token (required if iamProfileName is not specified) - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service |
 
 ## Exceptions
 
-{<!-- -->Error<!-- -->} When the configuration options are not valid.
+Error: the configuration options are not valid.
 

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

@@ -4,11 +4,11 @@
 
 ## ContainerAuthenticator class
 
-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 ContainerAuthenticator will read a compute resource token from the file system and use this value to obtain a bearer token from the IAM token server. When the bearer token expires, a new token is obtained from the token server.
 
 The bearer token will be sent as an Authorization header in the form:
 
-Authorization: Bearer <bearer-token>
+Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
 
 <b>Signature:</b>
 
@@ -21,13 +21,13 @@ export declare class ContainerAuthenticator extends IamRequestBasedAuthenticator
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.containerauthenticator._constructor_.md) |  | Create a new \[\[ContainerAuthenticator\]\] instance. |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.containerauthenticator._constructor_.md) |  | Create a new ContainerAuthenticator instance. |
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [tokenManager](./ibm-cloud-sdk-core.containerauthenticator.tokenmanager.md) |  | [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) |  |
+|  [tokenManager](./ibm-cloud-sdk-core.containerauthenticator.tokenmanager.md) | <code>protected</code> | [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) |  |
 
 ## Methods
 

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

@@ -16,7 +16,7 @@ setCrTokenFilename(crTokenFilename: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  crTokenFilename | string |  |
+|  crTokenFilename | string | A string containing a path to the CR token file |
 
 <b>Returns:</b>
 

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

@@ -16,7 +16,7 @@ setIamProfileId(iamProfileId: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  iamProfileId | string |  |
+|  iamProfileId | string | the ID of the IAM trusted profile |
 
 <b>Returns:</b>
 

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

@@ -16,7 +16,7 @@ setIamProfileName(iamProfileName: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  iamProfileName | string |  |
+|  iamProfileName | string | the name of the IAM trusted profile |
 
 <b>Returns:</b>
 

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

@@ -4,7 +4,7 @@
 
 ## ContainerTokenManager.(constructor)
 
-Create a new \[\[ContainerTokenManager\]\] instance.
+Create a new ContainerTokenManager 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 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 |
+
+## Exceptions
+
+Error: the configuration options were invalid
 

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

@@ -17,14 +17,14 @@ export declare class ContainerTokenManager extends IamRequestBasedTokenManager
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.containertokenmanager._constructor_.md) |  | Create a new \[\[ContainerTokenManager\]\] instance. |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.containertokenmanager._constructor_.md) |  | Create a new ContainerTokenManager instance. |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [requestToken()](./ibm-cloud-sdk-core.containertokenmanager.requesttoken.md) |  | Request an IAM token using a compute resource token. |
-|  [setCrTokenFilename(crTokenFilename)](./ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.md) |  | Setter for the filename of the compute resource token. |
-|  [setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.md) |  | Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server. |
-|  [setIamProfileName(iamProfileName)](./ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md) |  | Setter for the "profile\_name" parameter to use when fetching the bearer token from the IAM token server. |
+|  [requestToken()](./ibm-cloud-sdk-core.containertokenmanager.requesttoken.md) | <code>protected</code> | Request an IAM token using a compute resource token. |
+|  [setCrTokenFilename(crTokenFilename)](./ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.md) |  | Sets the "crTokenFilename" field |
+|  [setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.md) |  | Sets the ID of the IAM trusted profile to use when obtaining an access token from the IAM token server. |
+|  [setIamProfileName(iamProfileName)](./ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md) |  | Sets the name of the IAM trusted profile to use when obtaining an access token from the IAM token server. |
 

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

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

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

@@ -4,7 +4,7 @@
 
 ## ContainerTokenManager.setCrTokenFilename() method
 
-Setter for the filename of the compute resource token.
+Sets the "crTokenFilename" field
 
 <b>Signature:</b>
 
@@ -16,7 +16,7 @@ setCrTokenFilename(crTokenFilename: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  crTokenFilename | string | A string containing a path to the CR token file |
+|  crTokenFilename | string | the name of the file containing the CR token |
 
 <b>Returns:</b>
 

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

@@ -4,7 +4,7 @@
 
 ## ContainerTokenManager.setIamProfileId() method
 
-Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server.
+Sets the ID of the IAM trusted profile to use when obtaining an access token from the IAM token server.
 
 <b>Signature:</b>
 
@@ -16,7 +16,7 @@ setIamProfileId(iamProfileId: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  iamProfileId | string | A string that makes up the iamProfileId parameter |
+|  iamProfileId | string | the ID of the IAM trusted profile |
 
 <b>Returns:</b>
 

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

@@ -4,7 +4,7 @@
 
 ## ContainerTokenManager.setIamProfileName() method
 
-Setter for the "profile\_name" parameter to use when fetching the bearer token from the IAM token server.
+Sets the name of the IAM trusted profile to use when obtaining an access token from the IAM token server.
 
 <b>Signature:</b>
 
@@ -16,7 +16,7 @@ setIamProfileName(iamProfileName: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  iamProfileName | string | A string that makes up the iamProfileName parameter |
+|  iamProfileName | string | the name of the IAM trusted profile |
 
 <b>Returns:</b>
 

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

@@ -4,7 +4,7 @@
 
 ## Cp4dTokenManager.(constructor)
 
-Create a new \[\[Cp4dTokenManager\]\] instance.
+Create a new Cp4dTokenManager 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: (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 |
+
+## Exceptions
+
+Error: the configuration options were invalid.
 

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

@@ -19,17 +19,17 @@ export declare class Cp4dTokenManager extends JwtTokenManager
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md) |  | Create a new \[\[Cp4dTokenManager\]\] instance. |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md) |  | Create a new Cp4dTokenManager instance. |
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [requiredOptions](./ibm-cloud-sdk-core.cp4dtokenmanager.requiredoptions.md) |  | string\[\] |  |
+|  [requiredOptions](./ibm-cloud-sdk-core.cp4dtokenmanager.requiredoptions.md) | <code>protected</code> | string\[\] |  |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [requestToken()](./ibm-cloud-sdk-core.cp4dtokenmanager.requesttoken.md) |  |  |
+|  [requestToken()](./ibm-cloud-sdk-core.cp4dtokenmanager.requesttoken.md) | <code>protected</code> |  |
 

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

@@ -4,7 +4,7 @@
 
 ## FileObject interface
 
-(C) Copyright IBM Corp. 2014, 2021.
+(C) Copyright IBM Corp. 2014, 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
 
@@ -20,8 +20,8 @@ export interface FileObject
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [options?](./ibm-cloud-sdk-core.fileobject.options.md) | [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) | <i>(Optional)</i> |
-|  [value](./ibm-cloud-sdk-core.fileobject.value.md) | NodeJS.ReadableStream \| Buffer \| string |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [options?](./ibm-cloud-sdk-core.fileobject.options.md) |  | [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) | <i>(Optional)</i> |
+|  [value](./ibm-cloud-sdk-core.fileobject.value.md) |  | NodeJS.ReadableStream \| Buffer \| string |  |
 

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

@@ -12,8 +12,8 @@ export interface FileOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [contentType?](./ibm-cloud-sdk-core.fileoptions.contenttype.md) | string | <i>(Optional)</i> |
-|  [filename?](./ibm-cloud-sdk-core.fileoptions.filename.md) | string | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [contentType?](./ibm-cloud-sdk-core.fileoptions.contenttype.md) |  | string | <i>(Optional)</i> |
+|  [filename?](./ibm-cloud-sdk-core.fileoptions.filename.md) |  | string | <i>(Optional)</i> |
 

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

@@ -13,7 +13,7 @@ export interface FileStream extends NodeJS.ReadableStream
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [path](./ibm-cloud-sdk-core.filestream.path.md) | string \| Buffer |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [path](./ibm-cloud-sdk-core.filestream.path.md) |  | string \| Buffer |  |
 

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

@@ -12,9 +12,9 @@ export interface FileWithMetadata
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [contentType](./ibm-cloud-sdk-core.filewithmetadata.contenttype.md) | string |  |
-|  [data](./ibm-cloud-sdk-core.filewithmetadata.data.md) | NodeJS.ReadableStream \| Buffer |  |
-|  [filename](./ibm-cloud-sdk-core.filewithmetadata.filename.md) | string |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [contentType](./ibm-cloud-sdk-core.filewithmetadata.contenttype.md) |  | string |  |
+|  [data](./ibm-cloud-sdk-core.filewithmetadata.data.md) |  | NodeJS.ReadableStream \| Buffer |  |
+|  [filename](./ibm-cloud-sdk-core.filewithmetadata.filename.md) |  | string |  |
 

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

@@ -18,7 +18,7 @@ export declare function getAuthenticatorFromEnvironment(serviceName: string): Au
 
 |  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.getcontenttype.md

@@ -22,5 +22,5 @@ export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer
 
 Promise<string>
 
-{<!-- -->string<!-- -->} the content type of the input.
+the content type of the input.
 

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

@@ -4,7 +4,7 @@
 
 ## getCurrentTime() function
 
-Get the current time
+Gets the current time.
 
 <b>Signature:</b>
 
@@ -15,5 +15,5 @@ export declare function getCurrentTime(): number;
 
 number
 
-{<!-- -->number<!-- -->} - Returns the current time in seconds.
+the current time in seconds.
 

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

@@ -25,5 +25,3 @@ export declare function getFormat(params: {
 
 string
 
-{<!-- -->string\|null<!-- -->}
-

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

@@ -25,5 +25,5 @@ export declare function getMissingParams(params: {
 
 null \| Error
 
-{<!-- -->Error\|null<!-- -->}
+null if no errors found, otherwise an Error instance
 

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

@@ -26,5 +26,5 @@ export declare function getNewLogger(moduleName: string): SDKLogger;
 
 [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md)
 
-{<!-- -->SDKLogger<!-- -->} the new logger
+the new logger
 

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

@@ -23,9 +23,5 @@ export declare function getQueryParam(urlStr: string, param: string): string;
 
 string
 
-{<!-- -->string<!-- -->} the value of the `param` query parameter
-
-## Exceptions
-
-if urlStr is an invalid URL
+the value of the "param" query parameter
 

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

@@ -4,7 +4,7 @@
 
 ## IamAuthenticator.(constructor)
 
-Create a new \[\[IamAuthenticator\]\] instance.
+Create a new IamAuthenticator instance.
 
 <b>Signature:</b>
 
@@ -16,9 +16,9 @@ constructor(options: Options);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | Options | Configuration options for IAM authentication. |
+|  options | Options | Configuration options for IAM authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - apikey: (required) the IAM api key - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service |
 
 ## Exceptions
 
-{<!-- -->Error<!-- -->} When the configuration options are not valid.
+Error: the configuration options are not valid.
 

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

@@ -4,11 +4,11 @@
 
 ## IamAuthenticator class
 
-The \[\[IamAuthenticator\]\] will use the user-supplied `apikey` 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 `clientId` and`clientSecret` pair can be used to influence rate-limiting for requests to the IAM token server.
+The IamAuthenticator will use the user-supplied `apikey` value to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server. If specified, the optional, mutually inclusive "clientId" and "clientSecret" pair can be used to influence rate-limiting for requests to the IAM token server.
 
 The bearer token will be sent as an Authorization header in the form:
 
-Authorization: Bearer <bearer-token>
+Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
 
 <b>Signature:</b>
 
@@ -21,14 +21,14 @@ export declare class IamAuthenticator extends IamRequestBasedAuthenticator
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.iamauthenticator._constructor_.md) |  | Create a new \[\[IamAuthenticator\]\] instance. |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.iamauthenticator._constructor_.md) |  | Create a new IamAuthenticator instance. |
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [requiredOptions](./ibm-cloud-sdk-core.iamauthenticator.requiredoptions.md) |  | string\[\] |  |
-|  [tokenManager](./ibm-cloud-sdk-core.iamauthenticator.tokenmanager.md) |  | [IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.md) |  |
+|  [requiredOptions](./ibm-cloud-sdk-core.iamauthenticator.requiredoptions.md) | <code>protected</code> | string\[\] |  |
+|  [tokenManager](./ibm-cloud-sdk-core.iamauthenticator.tokenmanager.md) | <code>protected</code> | [IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.md) |  |
 
 ## Methods
 

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

@@ -4,7 +4,7 @@
 
 ## IamRequestBasedAuthenticator.(constructor)
 
-Create a new \[\[IamRequestBasedAuthenticator\]\] instance.
+Create a new IamRequestBasedAuthenticator instance.
 
 <b>Signature:</b>
 
@@ -16,9 +16,9 @@ constructor(options: IamRequestOptions);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md) | Configuration options for IAM authentication. |
+|  options | IamRequestOptions | Configuration options for IAM authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service |
 
 ## Exceptions
 
-{<!-- -->Error<!-- -->} When the configuration options are not valid.
+Error: the configuration options are not valid.
 

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

@@ -15,5 +15,5 @@ getRefreshToken(): string;
 
 string
 
-{<!-- -->string<!-- -->}
+the refresh token string