ibm-cloud-sdk-core 4.2.5 → 4.3.0

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

@@ -15,25 +15,207 @@ export declare class IamRequestBasedTokenManager extends JwtTokenManager
 
 ## Constructors
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager._constructor_.md) |  | Create a new IamRequestBasedTokenManager instance. |
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new IamRequestBasedTokenManager instance.
+
+
+</td></tr>
+</tbody></table>
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [formData](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md) | <code>protected</code> | any |  |
-|  [refreshToken](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.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>
+
+[formData](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[refreshToken](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [getRefreshToken()](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md) |  | Returns the most recently stored refresh token. |
-|  [isTokenExpired()](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.istokenexpired.md) | <code>protected</code> | Returns true iff the currently-cached IAM access token is expired. We'll consider an access token as expired when we reach its IAM server-reported expiration time minus our expiration window (10 secs). We do this to avoid using an access token that might expire in the middle of a long-running transaction within an IBM Cloud service. |
-|  [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. |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getRefreshToken()](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Returns the most recently stored refresh token.
+
+
+</td></tr>
+<tr><td>
+
+[isTokenExpired()](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.istokenexpired.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Returns true iff the currently-cached IAM access token is expired. We'll consider an access token as expired when we reach its IAM server-reported expiration time minus our expiration window (10 secs). We do this to avoid using an access token that might expire in the middle of a long-running transaction within an IBM Cloud service.
+
+
+</td></tr>
+<tr><td>
+
+[requestToken()](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Request an IAM access token using an API key.
+
+
+</td></tr>
+<tr><td>
+
+[saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Extend this method from the parent class to extract the refresh token from the request and save it.
+
+
+</td></tr>
+<tr><td>
+
+[setClientIdAndSecret(clientId, clientSecret)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setclientidandsecret.md)
+
+
+</td><td>
+
+
+</td><td>
+
+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).
+
+
+</td></tr>
+<tr><td>
+
+[setScope(scope)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setscope.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the IAM "scope" value. This value is sent as the "scope" form parameter within the request sent to the IAM token service.
+
 
+</td></tr>
+</tbody></table>

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

@@ -14,11 +14,55 @@ setClientIdAndSecret(clientId: string, clientSecret: string): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  clientId | string | the client id. |
-|  clientSecret | string | the client secret. |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+clientId
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the client id.
+
+
+</td></tr>
+<tr><td>
+
+clientSecret
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the client secret.
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

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

@@ -14,10 +14,39 @@ setScope(scope: string): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  scope | string | a space-separated string that contains one or more scope names |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+scope
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+a space-separated string that contains one or more scope names
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

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

@@ -15,9 +15,82 @@ export interface IamRequestOptions extends JwtTokenManagerOptions
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [clientId?](./ibm-cloud-sdk-core.iamrequestoptions.clientid.md) |  | string | _(Optional)_ |
-|  [clientSecret?](./ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md) |  | string | _(Optional)_ |
-|  [scope?](./ibm-cloud-sdk-core.iamrequestoptions.scope.md) |  | string | _(Optional)_ |
+<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.iamrequestoptions.clientid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[clientSecret?](./ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[scope?](./ibm-cloud-sdk-core.iamrequestoptions.scope.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>

package/build/docs/ibm-cloud-sdk-core.iamtokenmanager._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: (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 |
+<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: (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
+
+
+</td></tr>
+</tbody></table>
 
 ## Exceptions
 

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

@@ -15,13 +15,78 @@ export declare class IamTokenManager extends IamRequestBasedTokenManager
 
 ## Constructors
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.iamtokenmanager._constructor_.md) |  | Create a new IamTokenManager instance. |
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./ibm-cloud-sdk-core.iamtokenmanager._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new IamTokenManager instance.
+
+
+</td></tr>
+</tbody></table>
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [requiredOptions](./ibm-cloud-sdk-core.iamtokenmanager.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.iamtokenmanager.requiredoptions.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
 
+</td></tr>
+</tbody></table>

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

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

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

@@ -12,10 +12,37 @@ export declare function isFileData(obj: any): obj is NodeJS.ReadableStream | Buf
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  obj | any |  |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+obj
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 obj is NodeJS.ReadableStream \| Buffer

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

@@ -12,10 +12,37 @@ export declare function isFileWithMetadata(obj: any): obj is FileWithMetadata;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  obj | any |  |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+obj
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 obj is [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md)