ibm-cloud-sdk-core 4.2.5 → 4.3.0

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

@@ -18,10 +18,39 @@ export declare function getNewLogger(moduleName: string): SDKLogger;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  moduleName | string | the namespace for the logger. The name will appear in the logs and it will be the name used for configuring the log level. |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+moduleName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the namespace for the logger. The name will appear in the logs and it will be the name used for configuring the log level.
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md)

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

@@ -14,11 +14,55 @@ export declare function getQueryParam(urlStr: string, param: string): string;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  urlStr | string | the url string. |
-|  param | string | the name of the query parameter whose value should be returned |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+urlStr
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the url string.
+
+
+</td></tr>
+<tr><td>
+
+param
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the name of the query parameter whose value should be returned
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 string

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

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

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

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

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

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

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

@@ -15,24 +15,197 @@ export declare class IamRequestBasedAuthenticator extends TokenRequestBasedAuthe
 
 ## Constructors
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator._constructor_.md) |  | Create a new IamRequestBasedAuthenticator instance. |
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new IamRequestBasedAuthenticator instance.
+
+
+</td></tr>
+</tbody></table>
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [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) |  |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[clientId](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientid.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[clientSecret](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientsecret.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[scope](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.scope.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[tokenManager](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.tokenmanager.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+[IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 ## 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 "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. |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getRefreshToken()](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.getrefreshtoken.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Return the most recently stored refresh token.
+
+
+</td></tr>
+<tr><td>
+
+[setClientIdAndSecret(clientId, clientSecret)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Setter for the mutually inclusive "clientId" and the "clientSecret" fields.
+
+
+</td></tr>
+<tr><td>
+
+[setScope(scope)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Setter for the "scope" parameter to use when fetching the bearer token from the IAM token server.
+
 
+</td></tr>
+</tbody></table>

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

@@ -14,11 +14,55 @@ setClientIdAndSecret(clientId: string, clientSecret: string): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  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 |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+clientId
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the "clientId" value used to form a Basic Authorization header for IAM token requests
+
+
+</td></tr>
+<tr><td>
+
+clientSecret
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the "clientSecret" value used to form a Basic Authorization header for IAM token requests
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

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

@@ -14,10 +14,39 @@ setScope(scope: string): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  scope | string | (optional) a space-separated string that specifies one or more scopes to be associated with IAM token requests |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+scope
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+(optional) a space-separated string that specifies one or more scopes to be associated with IAM token requests
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

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

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