npm - ibm-cloud-sdk-core - Versions diffs - 3.2.2-beta → 3.2.2-beta-1 - Mend

ibm-cloud-sdk-core 3.2.2-beta → 3.2.2-beta-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (375) hide show

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) &gt; [clientSecret](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientsecret.md)
-## IamRequestBasedAuthenticator.clientSecret property
-<b>Signature:</b>
-```typescript
-protected clientSecret: string;
-```

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

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) &gt; [getRefreshToken](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.getrefreshtoken.md)
-## IamRequestBasedAuthenticator.getRefreshToken() method
-Return the most recently stored refresh token.
-<b>Signature:</b>
-```typescript
-getRefreshToken(): string;
-```
-<b>Returns:</b>
-string
-{<!-- -->string<!-- -->}

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

@@ -1,38 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md)
-## IamRequestBasedAuthenticator class
-The \[\[IamRequestBasedAuthenticator\]\] provides shared configuration and functionality for authenticators that interact with the IAM service to inherit. This authenticator is not meant for use on its own.
-<b>Signature:</b>
-```typescript
-export declare class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator
-```
-<b>Extends:</b> [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
-## Constructors
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator._constructor_.md) |  | Create a new \[\[IamRequestBasedAuthenticator\]\] instance. |
-## Properties
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [clientId](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientid.md) |  | string |  |
-|  [clientSecret](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientsecret.md) |  | string |  |
-|  [scope](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.scope.md) |  | string |  |
-|  [tokenManager](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.tokenmanager.md) |  | [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) |  |
-## 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 <code>clientId</code> and the <code>clientSecret</code>. |
-|  [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. |

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) &gt; [scope](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.scope.md)
-## IamRequestBasedAuthenticator.scope property
-<b>Signature:</b>
-```typescript
-protected scope: string;
-```

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

@@ -1,25 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) &gt; [setClientIdAndSecret](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md)
-## IamRequestBasedAuthenticator.setClientIdAndSecret() method
-Setter for the mutually inclusive `clientId` and the `clientSecret`<!-- -->.
-<b>Signature:</b>
-```typescript
-setClientIdAndSecret(clientId: string, clientSecret: string): void;
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  clientId | string | The <code>clientId</code> and <code>clientSecret</code> fields are used to form a "basic" authorization header for IAM token requests. |
-|  clientSecret | string | The <code>clientId</code> and <code>clientSecret</code> fields are used to form a "basic" authorization header for IAM token requests. |
-<b>Returns:</b>
-void

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

@@ -1,24 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) &gt; [setScope](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.md)
-## IamRequestBasedAuthenticator.setScope() method
-Setter for the "scope" parameter to use when fetching the bearer token from the IAM token server.
-<b>Signature:</b>
-```typescript
-setScope(scope: string): void;
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  scope | string | A space seperated string that makes up the scope parameter |
-<b>Returns:</b>
-void

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.tokenmanager.md)
-## IamRequestBasedAuthenticator.tokenManager property
-<b>Signature:</b>
-```typescript
-protected tokenManager: IamRequestBasedTokenManager;
-```

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

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager._constructor_.md)
-## IamRequestBasedTokenManager.(constructor)
-Create a new \[\[IamRequestBasedTokenManager\]\] instance.
-<b>Signature:</b>
-```typescript
-constructor(options: IamRequestOptions);
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  options | [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md) | Configuration options. |

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [formData](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md)
-## IamRequestBasedTokenManager.formData property
-<b>Signature:</b>
-```typescript
-protected formData: any;
-```

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

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [getRefreshToken](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md)
-## IamRequestBasedTokenManager.getRefreshToken() method
-Return the most recently stored refresh token.
-<b>Signature:</b>
-```typescript
-getRefreshToken(): string;
-```
-<b>Returns:</b>
-string
-{<!-- -->string<!-- -->}

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

@@ -1,38 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md)
-## IamRequestBasedTokenManager class
-The IamRequestBasedTokenManager class contains code relevant to any token manager that interacts with the IAM service to manage a token. It stores information relevant to all IAM requests, such as the client ID and secret, and performs the token request with a set of request options common to any IAM token management scheme. It is intended that this class be extended with specific implementations.
-<b>Signature:</b>
-```typescript
-export declare class IamRequestBasedTokenManager extends JwtTokenManager
-```
-<b>Extends:</b> [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
-## Constructors
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager._constructor_.md) |  | Create a new \[\[IamRequestBasedTokenManager\]\] instance. |
-## Properties
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [formData](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md) |  | any |  |
-|  [refreshToken](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.md) |  | string |  |
-## Methods
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [getRefreshToken()](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md) |  | Return the most recently stored refresh token. |
-|  [requestToken()](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md) |  | Request an IAM token using an API key. |
-|  [saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md) |  | 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) |  | Set the IAM <code>clientId</code> and <code>clientSecret</code> 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) |  | Set the IAM <code>scope</code> value. This value is the form parameter to use when fetching the bearer token from the IAM token server. |

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [refreshToken](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.md)
-## IamRequestBasedTokenManager.refreshToken property
-<b>Signature:</b>
-```typescript
-protected refreshToken: string;
-```

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

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [requestToken](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md)
-## IamRequestBasedTokenManager.requestToken() method
-Request an IAM token using an API key.
-<b>Signature:</b>
-```typescript
-protected requestToken(): Promise<any>;
-```
-<b>Returns:</b>
-Promise&lt;any&gt;
-{<!-- -->Promise<!-- -->}

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

@@ -1,26 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [saveTokenInfo](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md)
-## IamRequestBasedTokenManager.saveTokenInfo() method
-Extend this method from the parent class to extract the refresh token from the request and save it.
-<b>Signature:</b>
-```typescript
-protected saveTokenInfo(tokenResponse: any): void;
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  tokenResponse | any | Response object from JWT service request  |
-<b>Returns:</b>
-void
-{<!-- -->void<!-- -->}

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

@@ -1,27 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [setClientIdAndSecret](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setclientidandsecret.md)
-## IamRequestBasedTokenManager.setClientIdAndSecret() method
-Set 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).
-<b>Signature:</b>
-```typescript
-setClientIdAndSecret(clientId: string, clientSecret: string): void;
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  clientId | string | The client id. |
-|  clientSecret | string | The client secret. |
-<b>Returns:</b>
-void
-{<!-- -->void<!-- -->}

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

@@ -1,26 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [setScope](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setscope.md)
-## IamRequestBasedTokenManager.setScope() method
-Set the IAM `scope` value. This value is the form parameter to use when fetching the bearer token from the IAM token server.
-<b>Signature:</b>
-```typescript
-setScope(scope: string): void;
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  scope | string | A space seperated string that makes up the scope parameter. |
-<b>Returns:</b>
-void
-{<!-- -->void<!-- -->}

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md) &gt; [clientId](./ibm-cloud-sdk-core.iamrequestoptions.clientid.md)
-## IamRequestOptions.clientId property
-<b>Signature:</b>
-```typescript
-clientId?: string;
-```

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md) &gt; [clientSecret](./ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md)
-## IamRequestOptions.clientSecret property
-<b>Signature:</b>
-```typescript
-clientSecret?: string;
-```

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

@@ -1,23 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md)
-## IamRequestOptions interface
-Configuration options for IAM token retrieval.
-<b>Signature:</b>
-```typescript
-export interface IamRequestOptions extends JwtTokenManagerOptions
-```
-<b>Extends:</b> [JwtTokenManagerOptions](./ibm-cloud-sdk-core.jwttokenmanageroptions.md)
-## Properties
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [clientId?](./ibm-cloud-sdk-core.iamrequestoptions.clientid.md) | string | <i>(Optional)</i> |
-|  [clientSecret?](./ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md) | string | <i>(Optional)</i> |
-|  [scope?](./ibm-cloud-sdk-core.iamrequestoptions.scope.md) | string | <i>(Optional)</i> |

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md) &gt; [scope](./ibm-cloud-sdk-core.iamrequestoptions.scope.md)
-## IamRequestOptions.scope property
-<b>Signature:</b>
-```typescript
-scope?: string;
-```

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

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.iamtokenmanager._constructor_.md)
-## IamTokenManager.(constructor)
-Create a new \[\[IamTokenManager\]\] instance.
-<b>Signature:</b>
-```typescript
-constructor(options: Options);
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  options | Options | Configuration options. |

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

@@ -1,27 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.md)
-## IamTokenManager class
-The IAMTokenManager takes an api key and performs the necessary interactions with the IAM token service to obtain and store a suitable bearer token. Additionally, the IAMTokenManager will retrieve bearer tokens via basic auth using a supplied `clientId` and `clientSecret` pair.
-<b>Signature:</b>
-```typescript
-export declare class IamTokenManager extends IamRequestBasedTokenManager
-```
-<b>Extends:</b> [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md)
-## Constructors
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.iamtokenmanager._constructor_.md) |  | Create a new \[\[IamTokenManager\]\] instance. |
-## Properties
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [requiredOptions](./ibm-cloud-sdk-core.iamtokenmanager.requiredoptions.md) |  | string\[\] |  |

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.md) &gt; [requiredOptions](./ibm-cloud-sdk-core.iamtokenmanager.requiredoptions.md)
-## IamTokenManager.requiredOptions property
-<b>Signature:</b>
-```typescript
-protected requiredOptions: string[];
-```

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

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [isEmptyObject](./ibm-cloud-sdk-core.isemptyobject.md)
-## isEmptyObject() function
-<b>Signature:</b>
-```typescript
-export declare function isEmptyObject(obj: any): boolean;
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  obj | any |  |
-<b>Returns:</b>
-boolean

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

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [isFileData](./ibm-cloud-sdk-core.isfiledata.md)
-## isFileData() function
-<b>Signature:</b>
-```typescript
-export declare function isFileData(obj: any): obj is NodeJS.ReadableStream | Buffer;
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  obj | any |  |
-<b>Returns:</b>
-obj is NodeJS.ReadableStream \| Buffer

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

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [isFileWithMetadata](./ibm-cloud-sdk-core.isfilewithmetadata.md)
-## isFileWithMetadata() function
-<b>Signature:</b>
-```typescript
-export declare function isFileWithMetadata(obj: any): obj is FileWithMetadata;
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  obj | any |  |
-<b>Returns:</b>
-obj is [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md)

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

@@ -1,26 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [isHTML](./ibm-cloud-sdk-core.ishtml.md)
-## isHTML() function
-Return true if 'text' is html
-<b>Signature:</b>
-```typescript
-export declare function isHTML(text: string): boolean;
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  text | string | The 'text' to analyze |
-<b>Returns:</b>
-boolean
-{<!-- -->boolean<!-- -->} true if 'text' has html tags

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

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.jwttokenmanager._constructor_.md)
-## JwtTokenManager.(constructor)
-Create a new \[\[JwtTokenManager\]\] instance.
-<b>Signature:</b>
-```typescript
-constructor(options: JwtTokenManagerOptions);
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  options | [JwtTokenManagerOptions](./ibm-cloud-sdk-core.jwttokenmanageroptions.md) | Configuration options. |

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

@@ -1,35 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
-## JwtTokenManager class
-A class for shared functionality for parsing, storing, and requesting JWT tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement `requestToken()` to retrieve the bearer token from intended sources.
-<b>Signature:</b>
-```typescript
-export declare class JwtTokenManager extends TokenManager
-```
-<b>Extends:</b> [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md)
-## Constructors
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.jwttokenmanager._constructor_.md) |  | Create a new \[\[JwtTokenManager\]\] instance.  |
-## Properties
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [tokenInfo](./ibm-cloud-sdk-core.jwttokenmanager.tokeninfo.md) |  | any |  |
-|  [tokenName](./ibm-cloud-sdk-core.jwttokenmanager.tokenname.md) |  | string |  |
-## Methods
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [requestToken()](./ibm-cloud-sdk-core.jwttokenmanager.requesttoken.md) |  | Request a JWT using an API key. |
-|  [saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md) |  | Save the JWT service response and the calculated expiration time to the object's state. |