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

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

@@ -0,0 +1,27 @@
+<!-- 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; [onlyOne](./ibm-cloud-sdk-core.onlyone.md)
+
+## onlyOne() function
+
+Check for only one of two elements being defined. Returns true if a is defined and b is undefined, or vice versa. Returns false if both are defined or both are undefined.
+
+<b>Signature:</b>
+
+```typescript
+export declare function onlyOne(a: any, b: any): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  a | any | The first object |
+|  b | any | The second object |
+
+<b>Returns:</b>
+
+boolean
+
+{<!-- -->boolean<!-- -->}
+

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

@@ -0,0 +1,21 @@
+<!-- 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; [qs](./ibm-cloud-sdk-core.qs.md)
+
+## qs variable
+
+(C) Copyright IBM Corp. 2019, 2021.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+<b>Signature:</b>
+
+```typescript
+_default: {
+    stringify: (queryParams: Object) => string;
+}
+```

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

@@ -0,0 +1,17 @@
+<!-- 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; [readCredentialsFile](./ibm-cloud-sdk-core.readcredentialsfile.md)
+
+## readCredentialsFile() function
+
+Return a config object based on a credentials file. Credentials files can be specified filepath via the environment variable: `IBM_CREDENTIALS_FILE`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export declare function readCredentialsFile(): any;
+```
+<b>Returns:</b>
+
+any
+

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

@@ -0,0 +1,22 @@
+<!-- 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; [readCrTokenFile](./ibm-cloud-sdk-core.readcrtokenfile.md)
+
+## readCrTokenFile() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function readCrTokenFile(filepath: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  filepath | string |  |
+
+<b>Returns:</b>
+
+string
+

package/build/docs/ibm-cloud-sdk-core.readexternalsources.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; [readExternalSources](./ibm-cloud-sdk-core.readexternalsources.md)
+
+## readExternalSources() function
+
+Read properties stored in external sources like Environment Variables, the credentials file, VCAP services, etc. and return them as an object. The keys of this object will have the service name prefix removed and will be converted to lower camel case.
+
+Only one source will be used at a time.
+
+<b>Signature:</b>
+
+```typescript
+export declare function readExternalSources(serviceName: string): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  serviceName | string | The service name prefix. |
+
+<b>Returns:</b>
+
+any
+

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

@@ -0,0 +1,27 @@
+<!-- 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; [removeSuffix](./ibm-cloud-sdk-core.removesuffix.md)
+
+## removeSuffix() function
+
+Remove a given suffix if it exists.
+
+<b>Signature:</b>
+
+```typescript
+export declare function removeSuffix(str: string, suffix: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  str | string | The base string to operate on |
+|  suffix | string | The suffix to remove, if present |
+
+<b>Returns:</b>
+
+string
+
+{<!-- -->string<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.sdklogger.debug.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; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [debug](./ibm-cloud-sdk-core.sdklogger.debug.md)
+
+## SDKLogger.debug property
+
+<b>Signature:</b>
+
+```typescript
+debug: Debugger;
+```

package/build/docs/ibm-cloud-sdk-core.sdklogger.error.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; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [error](./ibm-cloud-sdk-core.sdklogger.error.md)
+
+## SDKLogger.error property
+
+<b>Signature:</b>
+
+```typescript
+error: Debugger;
+```

package/build/docs/ibm-cloud-sdk-core.sdklogger.info.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; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [info](./ibm-cloud-sdk-core.sdklogger.info.md)
+
+## SDKLogger.info property
+
+<b>Signature:</b>
+
+```typescript
+info: Debugger;
+```

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

@@ -0,0 +1,22 @@
+<!-- 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; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md)
+
+## SDKLogger interface
+
+<b>Signature:</b>
+
+```typescript
+export interface SDKLogger 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [debug](./ibm-cloud-sdk-core.sdklogger.debug.md) | Debugger |  |
+|  [error](./ibm-cloud-sdk-core.sdklogger.error.md) | Debugger |  |
+|  [info](./ibm-cloud-sdk-core.sdklogger.info.md) | Debugger |  |
+|  [verbose](./ibm-cloud-sdk-core.sdklogger.verbose.md) | Debugger |  |
+|  [warn](./ibm-cloud-sdk-core.sdklogger.warn.md) | Debugger |  |
+

package/build/docs/ibm-cloud-sdk-core.sdklogger.verbose.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; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [verbose](./ibm-cloud-sdk-core.sdklogger.verbose.md)
+
+## SDKLogger.verbose property
+
+<b>Signature:</b>
+
+```typescript
+verbose: Debugger;
+```

package/build/docs/ibm-cloud-sdk-core.sdklogger.warn.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; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [warn](./ibm-cloud-sdk-core.sdklogger.warn.md)
+
+## SDKLogger.warn property
+
+<b>Signature:</b>
+
+```typescript
+warn: Debugger;
+```

package/build/docs/ibm-cloud-sdk-core.streamtopromise.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; [streamToPromise](./ibm-cloud-sdk-core.streamtopromise.md)
+
+## streamToPromise() function
+
+Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer or array of text chunks Essentially a smaller version of concat-stream wrapped in a promise
+
+<b>Signature:</b>
+
+```typescript
+export declare function streamToPromise(stream: Stream): Promise<any>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  stream | Stream | Optional stream param for when not bound to an existing stream instance.  {<!-- -->Promise<!-- -->} |
+
+<b>Returns:</b>
+
+Promise&lt;any&gt;
+

package/build/docs/ibm-cloud-sdk-core.striptrailingslash.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; [stripTrailingSlash](./ibm-cloud-sdk-core.striptrailingslash.md)
+
+## stripTrailingSlash() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function stripTrailingSlash(url: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  url | string | the url string. |
+
+<b>Returns:</b>
+
+string
+
+{<!-- -->string<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.tokenmanager._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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.tokenmanager._constructor_.md)
+
+## TokenManager.(constructor)
+
+Create a new \[\[TokenManager\]\] instance. 
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: TokenManagerOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | [TokenManagerOptions](./ibm-cloud-sdk-core.tokenmanageroptions.md) | Configuration options. |
+

package/build/docs/ibm-cloud-sdk-core.tokenmanager.accesstoken.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [accessToken](./ibm-cloud-sdk-core.tokenmanager.accesstoken.md)
+
+## TokenManager.accessToken property
+
+<b>Signature:</b>
+
+```typescript
+protected accessToken: string;
+```

package/build/docs/ibm-cloud-sdk-core.tokenmanager.disablesslverification.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [disableSslVerification](./ibm-cloud-sdk-core.tokenmanager.disablesslverification.md)
+
+## TokenManager.disableSslVerification property
+
+<b>Signature:</b>
+
+```typescript
+protected disableSslVerification: boolean;
+```

package/build/docs/ibm-cloud-sdk-core.tokenmanager.expiretime.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [expireTime](./ibm-cloud-sdk-core.tokenmanager.expiretime.md)
+
+## TokenManager.expireTime property
+
+<b>Signature:</b>
+
+```typescript
+protected expireTime: number;
+```

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

@@ -0,0 +1,17 @@
+<!-- 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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [getToken](./ibm-cloud-sdk-core.tokenmanager.gettoken.md)
+
+## TokenManager.getToken() method
+
+Retrieve a new token using `requestToken()` in the case there is not a currently stored token from a previous call, or the previous token has expired.
+
+<b>Signature:</b>
+
+```typescript
+getToken(): Promise<any>;
+```
+<b>Returns:</b>
+
+Promise&lt;any&gt;
+

package/build/docs/ibm-cloud-sdk-core.tokenmanager.headers.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [headers](./ibm-cloud-sdk-core.tokenmanager.headers.md)
+
+## TokenManager.headers property
+
+<b>Signature:</b>
+
+```typescript
+protected headers: OutgoingHttpHeaders;
+```

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

@@ -0,0 +1,43 @@
+<!-- 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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md)
+
+## TokenManager class
+
+A class for shared functionality for storing, and requesting tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement `requestToken()` to retrieve the token from intended sources and `saveTokenInfo(tokenResponse)` to parse and save token information from the response.
+
+<b>Signature:</b>
+
+```typescript
+export declare class TokenManager 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.tokenmanager._constructor_.md) |  | Create a new \[\[TokenManager\]\] instance.  |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [accessToken](./ibm-cloud-sdk-core.tokenmanager.accesstoken.md) |  | string |  |
+|  [disableSslVerification](./ibm-cloud-sdk-core.tokenmanager.disablesslverification.md) |  | boolean |  |
+|  [expireTime](./ibm-cloud-sdk-core.tokenmanager.expiretime.md) |  | number |  |
+|  [headers](./ibm-cloud-sdk-core.tokenmanager.headers.md) |  | OutgoingHttpHeaders |  |
+|  [refreshTime](./ibm-cloud-sdk-core.tokenmanager.refreshtime.md) |  | number |  |
+|  [requestWrapperInstance](./ibm-cloud-sdk-core.tokenmanager.requestwrapperinstance.md) |  | RequestWrapper |  |
+|  [url](./ibm-cloud-sdk-core.tokenmanager.url.md) |  | string |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [getToken()](./ibm-cloud-sdk-core.tokenmanager.gettoken.md) |  | Retrieve a new token using <code>requestToken()</code> in the case there is not a currently stored token from a previous call, or the previous token has expired. |
+|  [pacedRequestToken()](./ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md) |  | Paces requests to request\_token.<!-- -->This method pseudo-serializes requests for an access\_token when the current token is undefined or expired. The first caller to this method records its <code>requestTime</code> and then issues the token request. Subsequent callers will check the <code>requestTime</code> to see if a request is active (has been issued within the past 60 seconds), and if so will queue their promise for the active requestor to resolve when that request completes. |
+|  [requestToken()](./ibm-cloud-sdk-core.tokenmanager.requesttoken.md) |  | Request a token using an API endpoint. |
+|  [saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md) |  | Parse and save token information from the response. Save the requested token into field <code>accessToken</code>. Calculate expiration and refresh time from the received info and store them in fields <code>expireTime</code> and <code>refreshTime</code>. |
+|  [setDisableSslVerification(value)](./ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md) |  | Setter for the disableSslVerification property. |
+|  [setHeaders(headers)](./ibm-cloud-sdk-core.tokenmanager.setheaders.md) |  | Set a completely new set of headers. |
+

package/build/docs/ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [pacedRequestToken](./ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md)
+
+## TokenManager.pacedRequestToken() method
+
+Paces requests to request\_token.
+
+This method pseudo-serializes requests for an access\_token when the current token is undefined or expired. The first caller to this method records its `requestTime` and then issues the token request. Subsequent callers will check the `requestTime` to see if a request is active (has been issued within the past 60 seconds), and if so will queue their promise for the active requestor to resolve when that request completes.
+
+<b>Signature:</b>
+
+```typescript
+protected pacedRequestToken(): Promise<any>;
+```
+<b>Returns:</b>
+
+Promise&lt;any&gt;
+

package/build/docs/ibm-cloud-sdk-core.tokenmanager.refreshtime.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [refreshTime](./ibm-cloud-sdk-core.tokenmanager.refreshtime.md)
+
+## TokenManager.refreshTime property
+
+<b>Signature:</b>
+
+```typescript
+protected refreshTime: number;
+```

package/build/docs/ibm-cloud-sdk-core.tokenmanager.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [requestToken](./ibm-cloud-sdk-core.tokenmanager.requesttoken.md)
+
+## TokenManager.requestToken() method
+
+Request a token using an API endpoint.
+
+<b>Signature:</b>
+
+```typescript
+protected requestToken(): Promise<any>;
+```
+<b>Returns:</b>
+
+Promise&lt;any&gt;
+
+{<!-- -->Promise<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.tokenmanager.requestwrapperinstance.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [requestWrapperInstance](./ibm-cloud-sdk-core.tokenmanager.requestwrapperinstance.md)
+
+## TokenManager.requestWrapperInstance property
+
+<b>Signature:</b>
+
+```typescript
+protected requestWrapperInstance: RequestWrapper;
+```

package/build/docs/ibm-cloud-sdk-core.tokenmanager.savetokeninfo.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [saveTokenInfo](./ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md)
+
+## TokenManager.saveTokenInfo() method
+
+Parse and save token information from the response. Save the requested token into field `accessToken`<!-- -->. Calculate expiration and refresh time from the received info and store them in fields `expireTime` and `refreshTime`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+protected saveTokenInfo(tokenResponse: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  tokenResponse | any | Response object from a token service request  |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [setDisableSslVerification](./ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md)
+
+## TokenManager.setDisableSslVerification() method
+
+Setter for the disableSslVerification property.
+
+<b>Signature:</b>
+
+```typescript
+setDisableSslVerification(value: boolean): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  value | boolean | the new value for the disableSslVerification property |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.tokenmanager.setheaders.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [setHeaders](./ibm-cloud-sdk-core.tokenmanager.setheaders.md)
+
+## TokenManager.setHeaders() method
+
+Set a completely new set of headers.
+
+<b>Signature:</b>
+
+```typescript
+setHeaders(headers: OutgoingHttpHeaders): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  headers | OutgoingHttpHeaders | the new set of headers as an object |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.tokenmanager.url.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [url](./ibm-cloud-sdk-core.tokenmanager.url.md)
+
+## TokenManager.url property
+
+<b>Signature:</b>
+
+```typescript
+protected url: string;
+```

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

@@ -0,0 +1,18 @@
+<!-- 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; [TokenManagerOptions](./ibm-cloud-sdk-core.tokenmanageroptions.md)
+
+## TokenManagerOptions type
+
+Configuration options for token retrieval.
+
+<b>Signature:</b>
+
+```typescript
+export declare type TokenManagerOptions = {
+    url?: string;
+    headers?: OutgoingHttpHeaders;
+    disableSslVerification?: boolean;
+    [propName: string]: any;
+};
+```

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator._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; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator._constructor_.md)
+
+## TokenRequestBasedAuthenticator.(constructor)
+
+Create a new \[\[TokenRequestBasedAuthenticator\]\] instance with an internal \[\[JwtTokenManager\]\].
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: BaseOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | BaseOptions | Configuration options. |
+

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.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; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [authenticate](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md)
+
+## TokenRequestBasedAuthenticator.authenticate() method
+
+Adds bearer token information to `request`<!-- -->. The bearer token information will be set in the Authorization property of`request.headers` in the form:
+
+Authorization: Bearer <bearer-token>
+
+<b>Signature:</b>
+
+```typescript
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  requestOptions | AuthenticateOptions | The request to augment with authentication information. |
+
+<b>Returns:</b>
+
+Promise&lt;void&gt;
+