ibm-cloud-sdk-core 4.2.4 → 4.3.0

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

@@ -14,10 +14,39 @@ export declare function isHTML(text: string): boolean;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  text | string | The 'text' to analyze |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+text
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The 'text' to analyze
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 boolean

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

@@ -14,10 +14,39 @@ export declare function isJsonMimeType(mimeType: string): boolean;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  mimeType | string | the mimeType string |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+mimeType
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the mimeType string
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 boolean

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

@@ -14,7 +14,36 @@ constructor(options: JwtTokenManagerOptions);
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  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 |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[JwtTokenManagerOptions](./ibm-cloud-sdk-core.jwttokenmanageroptions.md)
+
+
+</td><td>
+
+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
+
+
+</td></tr>
+</tbody></table>

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

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

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

@@ -14,10 +14,39 @@ protected saveTokenInfo(tokenResponse: any): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  tokenResponse | any | the response object from JWT service request |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+tokenResponse
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the response object from JWT service request
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

package/build/docs/ibm-cloud-sdk-core.mcspauthenticator._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.mcspauthenticator.md

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

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

@@ -14,9 +14,39 @@ constructor(options: Options);
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  options | Options | Configuration options This should be an object containing these fields: - url: (required) the base endpoint URL for the MCSP token service - apikey: (required) the API key used to obtain the MCSP access token. - 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 This should be an object containing these fields: - url: (required) the base endpoint URL for the MCSP token service - apikey: (required) the API key used to obtain the MCSP access token. - 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.mcsptokenmanager.md

@@ -17,19 +17,112 @@ export declare class McspTokenManager extends JwtTokenManager
 
 ## Constructors
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.mcsptokenmanager._constructor_.md) |  | Create a new McspTokenManager instance. |
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./ibm-cloud-sdk-core.mcsptokenmanager._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new McspTokenManager instance.
+
+
+</td></tr>
+</tbody></table>
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [requiredOptions](./ibm-cloud-sdk-core.mcsptokenmanager.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.mcsptokenmanager.requiredoptions.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [requestToken()](./ibm-cloud-sdk-core.mcsptokenmanager.requesttoken.md) | <code>protected</code> |  |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[requestToken()](./ibm-cloud-sdk-core.mcsptokenmanager.requesttoken.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
 
+</td></tr>
+</tbody></table>