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

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

@@ -0,0 +1,20 @@
+<!-- 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; [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md)
+
+## FileWithMetadata interface
+
+<b>Signature:</b>
+
+```typescript
+export interface FileWithMetadata 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [contentType](./ibm-cloud-sdk-core.filewithmetadata.contenttype.md) | string |  |
+|  [data](./ibm-cloud-sdk-core.filewithmetadata.data.md) | NodeJS.ReadableStream \| Buffer |  |
+|  [filename](./ibm-cloud-sdk-core.filewithmetadata.filename.md) | string |  |
+

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

@@ -0,0 +1,26 @@
+<!-- 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; [getAuthenticatorFromEnvironment](./ibm-cloud-sdk-core.getauthenticatorfromenvironment.md)
+
+## getAuthenticatorFromEnvironment() function
+
+Look for external configuration of authenticator.
+
+Try to get authenticator from external sources, with the following priority: 1. Credentials file (ibm-credentials.env) 2. Environment variables 3. VCAP Services (Cloud Foundry)
+
+<b>Signature:</b>
+
+```typescript
+export declare function getAuthenticatorFromEnvironment(serviceName: string): Authenticator;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  serviceName | string | The service name prefix. |
+
+<b>Returns:</b>
+
+[Authenticator](./ibm-cloud-sdk-core.authenticator.md)
+

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

@@ -0,0 +1,26 @@
+<!-- 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; [getContentType](./ibm-cloud-sdk-core.getcontenttype.md)
+
+## getContentType() function
+
+This function retrieves the content type of the input.
+
+<b>Signature:</b>
+
+```typescript
+export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer): Promise<string>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  inputData | NodeJS.ReadableStream \| Buffer | The data to retrieve content type for. |
+
+<b>Returns:</b>
+
+Promise&lt;string&gt;
+
+{<!-- -->string<!-- -->} the content type of the input.
+

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

@@ -0,0 +1,19 @@
+<!-- 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; [getCurrentTime](./ibm-cloud-sdk-core.getcurrenttime.md)
+
+## getCurrentTime() function
+
+Get the current time
+
+<b>Signature:</b>
+
+```typescript
+export declare function getCurrentTime(): number;
+```
+<b>Returns:</b>
+
+number
+
+{<!-- -->number<!-- -->} - Returns the current time in seconds.
+

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

@@ -0,0 +1,29 @@
+<!-- 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; [getFormat](./ibm-cloud-sdk-core.getformat.md)
+
+## getFormat() function
+
+Returns the first match from formats that is key the params map otherwise null
+
+<b>Signature:</b>
+
+```typescript
+export declare function getFormat(params: {
+    [key: string]: any;
+}, formats: string[]): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  params | { \[key: string\]: any; } | The parameters. |
+|  formats | string\[\] |  |
+
+<b>Returns:</b>
+
+string
+
+{<!-- -->string\|null<!-- -->}
+

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

@@ -0,0 +1,29 @@
+<!-- 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; [getMissingParams](./ibm-cloud-sdk-core.getmissingparams.md)
+
+## getMissingParams() function
+
+Validates that all required params are provided
+
+<b>Signature:</b>
+
+```typescript
+export declare function getMissingParams(params: {
+    [key: string]: any;
+}, requires: string[]): null | Error;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  params | { \[key: string\]: any; } | the method parameters. |
+|  requires | string\[\] | the required parameter names. |
+
+<b>Returns:</b>
+
+null \| Error
+
+{<!-- -->Error\|null<!-- -->}
+

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

@@ -0,0 +1,30 @@
+<!-- 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; [getNewLogger](./ibm-cloud-sdk-core.getnewlogger.md)
+
+## getNewLogger() function
+
+Return a new logger, formatted with a particular name. The logging functions, in order of increasing verbosity, are: `error`<!-- -->, `warn`<!-- -->, `info`<!-- -->, `verbose`<!-- -->, and `debug`<!-- -->.
+
+The logger will be an instance of the `debug` package and utilizes its support for configuration with environment variables.
+
+Additionally, the logger will be turned on automatically if the "NODE\_DEBUG" environment variable is set to "axios".
+
+<b>Signature:</b>
+
+```typescript
+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. |
+
+<b>Returns:</b>
+
+[SDKLogger](./ibm-cloud-sdk-core.sdklogger.md)
+
+{<!-- -->SDKLogger<!-- -->} the new logger
+

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

@@ -0,0 +1,31 @@
+<!-- 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; [getQueryParam](./ibm-cloud-sdk-core.getqueryparam.md)
+
+## getQueryParam() function
+
+Return a query parameter value from a URL
+
+<b>Signature:</b>
+
+```typescript
+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 |
+
+<b>Returns:</b>
+
+string
+
+{<!-- -->string<!-- -->} the value of the `param` query parameter
+
+## Exceptions
+
+if urlStr is an invalid URL
+

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

@@ -0,0 +1,24 @@
+<!-- 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; [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.iamauthenticator._constructor_.md)
+
+## IamAuthenticator.(constructor)
+
+Create a new \[\[IamAuthenticator\]\] instance.
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: Options);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | Options | Configuration options for IAM authentication. |
+
+## Exceptions
+
+{<!-- -->Error<!-- -->} When the configuration options are not valid.
+

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

@@ -0,0 +1,19 @@
+<!-- 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; [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.iamauthenticator.authenticationtype.md)
+
+## IamAuthenticator.authenticationType() method
+
+Returns the authenticator's type ('iam').
+
+<b>Signature:</b>
+
+```typescript
+authenticationType(): string;
+```
+<b>Returns:</b>
+
+string
+
+a string that indicates the authenticator's type
+

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

@@ -0,0 +1,38 @@
+<!-- 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; [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md)
+
+## IamAuthenticator class
+
+The \[\[IamAuthenticator\]\] will use the user-supplied `apikey` values to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server. If specified, the optional, mutually inclusive `clientId` and`clientSecret` pair can be used to influence rate-limiting for requests to the IAM token server.
+
+The bearer token will be sent as an Authorization header in the form:
+
+Authorization: Bearer <bearer-token>
+
+<b>Signature:</b>
+
+```typescript
+export declare class IamAuthenticator extends IamRequestBasedAuthenticator 
+```
+<b>Extends:</b> [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.iamauthenticator._constructor_.md) |  | Create a new \[\[IamAuthenticator\]\] instance. |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [requiredOptions](./ibm-cloud-sdk-core.iamauthenticator.requiredoptions.md) |  | string\[\] |  |
+|  [tokenManager](./ibm-cloud-sdk-core.iamauthenticator.tokenmanager.md) |  | [IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.md) |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [authenticationType()](./ibm-cloud-sdk-core.iamauthenticator.authenticationtype.md) |  | Returns the authenticator's type ('iam'). |
+

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

@@ -0,0 +1,11 @@
+<!-- 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; [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) &gt; [requiredOptions](./ibm-cloud-sdk-core.iamauthenticator.requiredoptions.md)
+
+## IamAuthenticator.requiredOptions property
+
+<b>Signature:</b>
+
+```typescript
+protected requiredOptions: string[];
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.iamauthenticator.tokenmanager.md)
+
+## IamAuthenticator.tokenManager property
+
+<b>Signature:</b>
+
+```typescript
+protected tokenManager: IamTokenManager;
+```

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

@@ -0,0 +1,24 @@
+<!-- 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; [(constructor)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator._constructor_.md)
+
+## IamRequestBasedAuthenticator.(constructor)
+
+Create a new \[\[IamRequestBasedAuthenticator\]\] instance.
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: IamRequestOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md) | Configuration options for IAM authentication. |
+
+## Exceptions
+
+{<!-- -->Error<!-- -->} When the configuration options are not valid.
+

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

@@ -0,0 +1,11 @@
+<!-- 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; [clientId](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientid.md)
+
+## IamRequestBasedAuthenticator.clientId property
+
+<b>Signature:</b>
+
+```typescript
+protected clientId: string;
+```

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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,19 @@
+<!-- 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

@@ -0,0 +1,38 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,25 @@
+<!-- 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

@@ -0,0 +1,24 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,20 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,19 @@
+<!-- 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

@@ -0,0 +1,38 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,19 @@
+<!-- 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<!-- -->}
+