ibm-cloud-sdk-core 4.2.5 → 4.3.0

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

@@ -14,9 +14,39 @@ constructor(options: Options);
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  options | Options | Configuration options for bearer authentication. This should be an object containing the "bearerToken" field. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+Options
+
+
+</td><td>
+
+Configuration options for bearer authentication. This should be an object containing the "bearerToken" field.
+
+
+</td></tr>
+</tbody></table>
 
 ## Exceptions
 

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

@@ -16,10 +16,39 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  requestOptions | AuthenticateOptions | The request to augment with authentication information. |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+requestOptions
+
+
+</td><td>
+
+AuthenticateOptions
+
+
+</td><td>
+
+The request to augment with authentication information.
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 Promise&lt;void&gt;

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

@@ -19,21 +19,142 @@ export declare class BearerTokenAuthenticator extends Authenticator
 
 ## Constructors
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.bearertokenauthenticator._constructor_.md) |  | Create a new BearerTokenAuthenticator instance. |
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./ibm-cloud-sdk-core.bearertokenauthenticator._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new BearerTokenAuthenticator instance.
+
+
+</td></tr>
+</tbody></table>
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [requiredOptions](./ibm-cloud-sdk-core.bearertokenauthenticator.requiredoptions.md) | <code>protected</code> | string\[\] |  |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[requiredOptions](./ibm-cloud-sdk-core.bearertokenauthenticator.requiredoptions.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [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. |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticate(requestOptions)](./ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+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 &lt;<!-- -->bearer-token<!-- -->&gt;
+
+
+</td></tr>
+<tr><td>
+
+[authenticationType()](./ibm-cloud-sdk-core.bearertokenauthenticator.authenticationtype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Returns the authenticator's type ('bearertoken').
+
+
+</td></tr>
+<tr><td>
+
+[setBearerToken(bearerToken)](./ibm-cloud-sdk-core.bearertokenauthenticator.setbearertoken.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Set a new bearer token to be sent in subsequent requests.
+
 
+</td></tr>
+</tbody></table>

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

@@ -14,10 +14,39 @@ setBearerToken(bearerToken: string): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  bearerToken | string | The bearer token that will be sent in service requests. |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+bearerToken
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The bearer token that will be sent in service requests.
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

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

@@ -14,10 +14,39 @@ export declare function buildRequestFileObject(fileParam: FileWithMetadata): Pro
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  fileParam | [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) | The FileWithMetadata instance that contains the file information |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+fileParam
+
+
+</td><td>
+
+[FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md)
+
+
+</td><td>
+
+The FileWithMetadata instance that contains the file information
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 Promise&lt;[FileObject](./ibm-cloud-sdk-core.fileobject.md)<!-- -->&gt;

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

@@ -14,11 +14,55 @@ export declare function checkCredentials(obj: any, credsToCheck: string[]): Erro
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  obj | any | the options object holding credentials |
-|  credsToCheck | string\[\] | an array containing the keys of the credentials to check for problems |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+obj
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the options object holding credentials
+
+
+</td></tr>
+<tr><td>
+
+credsToCheck
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+an array containing the keys of the credentials to check for problems
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 Error \| null

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

@@ -14,9 +14,39 @@ constructor(options: Options);
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  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 |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+Options
+
+
+</td><td>
+
+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
+
+
+</td></tr>
+</tbody></table>
 
 ## Exceptions
 

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

@@ -19,20 +19,131 @@ export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthe
 
 ## Constructors
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md) |  | Create a new CloudPakForDataAuthenticator instance. |
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new CloudPakForDataAuthenticator instance.
+
+
+</td></tr>
+</tbody></table>
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [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) |  |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[requiredOptions](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[tokenManager](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+[Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [authenticationType()](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md) |  | Returns the authenticator's type ('cp4d'). |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticationType()](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Returns the authenticator's type ('cp4d').
+
 
+</td></tr>
+</tbody></table>

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

@@ -14,11 +14,55 @@ export declare function computeBasicAuthHeader(username: string, password: strin
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  username | string | The username or client id |
-|  password | string | The password or client secret |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+username
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The username or client id
+
+
+</td></tr>
+<tr><td>
+
+password
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The password or client secret
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 string

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

@@ -12,10 +12,37 @@ export declare function constructFilepath(filepath: string): string;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  filepath | string |  |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+filepath
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 string