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

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

@@ -1,41 +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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
-
-## Authenticator class
-
-Base Authenticator class for other Authenticators to extend. Not intended to be used as a stand-alone authenticator.
-
-<b>Signature:</b>
-
-```typescript
-export declare class Authenticator implements AuthenticatorInterface 
-```
-<b>Implements:</b> [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md)
-
-## Constructors
-
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)()](./ibm-cloud-sdk-core.authenticator._constructor_.md) |  | Create a new Authenticator instance. |
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [AUTHTYPE\_BASIC](./ibm-cloud-sdk-core.authenticator.authtype_basic.md) | <code>static</code> | string | Constants that define the various authenticator types. |
-|  [AUTHTYPE\_BEARERTOKEN](./ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md) | <code>static</code> | string |  |
-|  [AUTHTYPE\_CONTAINER](./ibm-cloud-sdk-core.authenticator.authtype_container.md) | <code>static</code> | string |  |
-|  [AUTHTYPE\_CP4D](./ibm-cloud-sdk-core.authenticator.authtype_cp4d.md) | <code>static</code> | string |  |
-|  [AUTHTYPE\_IAM](./ibm-cloud-sdk-core.authenticator.authtype_iam.md) | <code>static</code> | string |  |
-|  [AUTHTYPE\_NOAUTH](./ibm-cloud-sdk-core.authenticator.authtype_noauth.md) | <code>static</code> | string |  |
-|  [AUTHTYPE\_UNKNOWN](./ibm-cloud-sdk-core.authenticator.authtype_unknown.md) | <code>static</code> | string |  |
-|  [AUTHTYPE\_VPC](./ibm-cloud-sdk-core.authenticator.authtype_vpc.md) | <code>static</code> | string |  |
-
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.authenticator.authenticate.md) |  | Augment the request with authentication information. |
-|  [authenticationType()](./ibm-cloud-sdk-core.authenticator.authenticationtype.md) |  | Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the "<!-- -->&lt;<!-- -->service\_name<!-- -->&gt;<!-- -->\_AUTH\_TYPE" configuration property (e.g. "basic", "iam", etc.). This function should be overridden in each authenticator implementation class that extends this class. |
-

package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticate.md

@@ -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; [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) &gt; [authenticate](./ibm-cloud-sdk-core.authenticatorinterface.authenticate.md)
-
-## AuthenticatorInterface.authenticate() method
-
-Add authentication information to the specified request.
-
-<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;
-

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

@@ -1,17 +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; [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) &gt; [authenticationType](./ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md)
-
-## AuthenticatorInterface.authenticationType() method
-
-Returns a string that indicates the authentication type.
-
-<b>Signature:</b>
-
-```typescript
-authenticationType(): string;
-```
-<b>Returns:</b>
-
-string
-

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

@@ -1,21 +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; [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md)
-
-## AuthenticatorInterface interface
-
-This interface defines the common methods associated with an Authenticator implementation.
-
-<b>Signature:</b>
-
-```typescript
-export interface AuthenticatorInterface 
-```
-
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.authenticatorinterface.authenticate.md) | Add authentication information to the specified request. |
-|  [authenticationType()](./ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md) | Returns a string that indicates the authentication type. |
-

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

@@ -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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [(constructor)](./ibm-cloud-sdk-core.baseservice._constructor_.md)
-
-## BaseService.(constructor)
-
-Configuration values for a service.
-
-<b>Signature:</b>
-
-```typescript
-constructor(userOptions: UserOptions);
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  userOptions | [UserOptions](./ibm-cloud-sdk-core.useroptions.md) |  |
-

package/build/docs/ibm-cloud-sdk-core.baseservice.baseoptions.md

@@ -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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [baseOptions](./ibm-cloud-sdk-core.baseservice.baseoptions.md)
-
-## BaseService.baseOptions property
-
-<b>Signature:</b>
-
-```typescript
-protected baseOptions: BaseServiceOptions;
-```

package/build/docs/ibm-cloud-sdk-core.baseservice.configureservice.md

@@ -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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [configureService](./ibm-cloud-sdk-core.baseservice.configureservice.md)
-
-## BaseService.configureService() method
-
-Configure the service using external configuration
-
-<b>Signature:</b>
-
-```typescript
-protected configureService(serviceName: string): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  serviceName | string | The name of the service. Will be used to read from external configuration. |
-
-<b>Returns:</b>
-
-void
-

package/build/docs/ibm-cloud-sdk-core.baseservice.createrequest.md

@@ -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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [createRequest](./ibm-cloud-sdk-core.baseservice.createrequest.md)
-
-## BaseService.createRequest() method
-
-Wrapper around `sendRequest` that enforces the request will be authenticated.
-
-<b>Signature:</b>
-
-```typescript
-protected createRequest(parameters: any): Promise<any>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  parameters | any | Service request options passed in by user. |
-
-<b>Returns:</b>
-
-Promise&lt;any&gt;
-
-{<!-- -->Promise<any>}
-

package/build/docs/ibm-cloud-sdk-core.baseservice.default_service_name.md

@@ -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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [DEFAULT\_SERVICE\_NAME](./ibm-cloud-sdk-core.baseservice.default_service_name.md)
-
-## BaseService.DEFAULT\_SERVICE\_NAME property
-
-<b>Signature:</b>
-
-```typescript
-static DEFAULT_SERVICE_NAME: string;
-```

package/build/docs/ibm-cloud-sdk-core.baseservice.default_service_url.md

@@ -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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [DEFAULT\_SERVICE\_URL](./ibm-cloud-sdk-core.baseservice.default_service_url.md)
-
-## BaseService.DEFAULT\_SERVICE\_URL property
-
-<b>Signature:</b>
-
-```typescript
-static DEFAULT_SERVICE_URL: string;
-```

package/build/docs/ibm-cloud-sdk-core.baseservice.disableretries.md

@@ -1,17 +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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [disableRetries](./ibm-cloud-sdk-core.baseservice.disableretries.md)
-
-## BaseService.disableRetries() method
-
-Disables retries.
-
-<b>Signature:</b>
-
-```typescript
-disableRetries(): void;
-```
-<b>Returns:</b>
-
-void
-

package/build/docs/ibm-cloud-sdk-core.baseservice.enableretries.md

@@ -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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [enableRetries](./ibm-cloud-sdk-core.baseservice.enableretries.md)
-
-## BaseService.enableRetries() method
-
-Enable retries for unfulfilled requests.
-
-<b>Signature:</b>
-
-```typescript
-enableRetries(retryOptions?: RetryOptions): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  retryOptions | RetryOptions | <i>(Optional)</i> configuration for retries |
-
-<b>Returns:</b>
-
-void
-

package/build/docs/ibm-cloud-sdk-core.baseservice.getauthenticator.md

@@ -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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [getAuthenticator](./ibm-cloud-sdk-core.baseservice.getauthenticator.md)
-
-## BaseService.getAuthenticator() method
-
-Get the instance of the authenticator set on the service.
-
-<b>Signature:</b>
-
-```typescript
-getAuthenticator(): any;
-```
-<b>Returns:</b>
-
-any
-
-{<!-- -->Authenticator<!-- -->}
-

package/build/docs/ibm-cloud-sdk-core.baseservice.gethttpclient.md

@@ -1,17 +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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [getHttpClient](./ibm-cloud-sdk-core.baseservice.gethttpclient.md)
-
-## BaseService.getHttpClient() method
-
-Get the Axios instance set on the service. All requests will be made using this instance.
-
-<b>Signature:</b>
-
-```typescript
-getHttpClient(): import("axios").AxiosInstance;
-```
-<b>Returns:</b>
-
-import("axios").AxiosInstance
-

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

@@ -1,44 +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; [BaseService](./ibm-cloud-sdk-core.baseservice.md)
-
-## BaseService class
-
-Common functionality shared by generated service classes.
-
-The base service authenticates requests via its authenticator, and sends them to the service endpoint.
-
-<b>Signature:</b>
-
-```typescript
-export declare class BaseService 
-```
-
-## Constructors
-
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(userOptions)](./ibm-cloud-sdk-core.baseservice._constructor_.md) |  | Configuration values for a service. |
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [baseOptions](./ibm-cloud-sdk-core.baseservice.baseoptions.md) |  | BaseServiceOptions |  |
-|  [DEFAULT\_SERVICE\_NAME](./ibm-cloud-sdk-core.baseservice.default_service_name.md) | <code>static</code> | string |  |
-|  [DEFAULT\_SERVICE\_URL](./ibm-cloud-sdk-core.baseservice.default_service_url.md) | <code>static</code> | string |  |
-
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [configureService(serviceName)](./ibm-cloud-sdk-core.baseservice.configureservice.md) |  | Configure the service using external configuration |
-|  [createRequest(parameters)](./ibm-cloud-sdk-core.baseservice.createrequest.md) |  | Wrapper around <code>sendRequest</code> that enforces the request will be authenticated. |
-|  [disableRetries()](./ibm-cloud-sdk-core.baseservice.disableretries.md) |  | Disables retries. |
-|  [enableRetries(retryOptions)](./ibm-cloud-sdk-core.baseservice.enableretries.md) |  | Enable retries for unfulfilled requests. |
-|  [getAuthenticator()](./ibm-cloud-sdk-core.baseservice.getauthenticator.md) |  | Get the instance of the authenticator set on the service. |
-|  [getHttpClient()](./ibm-cloud-sdk-core.baseservice.gethttpclient.md) |  | Get the Axios instance set on the service. All requests will be made using this instance. |
-|  [setDefaultHeaders(headers)](./ibm-cloud-sdk-core.baseservice.setdefaultheaders.md) |  | Set the HTTP headers to be sent in every request. |
-|  [setEnableGzipCompression(setting)](./ibm-cloud-sdk-core.baseservice.setenablegzipcompression.md) |  | Turn request body compression on or off. |
-|  [setServiceUrl(url)](./ibm-cloud-sdk-core.baseservice.setserviceurl.md) |  | Set the service URL to send requests to. |
-

package/build/docs/ibm-cloud-sdk-core.baseservice.setdefaultheaders.md

@@ -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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [setDefaultHeaders](./ibm-cloud-sdk-core.baseservice.setdefaultheaders.md)
-
-## BaseService.setDefaultHeaders() method
-
-Set the HTTP headers to be sent in every request.
-
-<b>Signature:</b>
-
-```typescript
-setDefaultHeaders(headers: OutgoingHttpHeaders): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  headers | OutgoingHttpHeaders | The map of headers to include in requests. |
-
-<b>Returns:</b>
-
-void
-

package/build/docs/ibm-cloud-sdk-core.baseservice.setenablegzipcompression.md

@@ -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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [setEnableGzipCompression](./ibm-cloud-sdk-core.baseservice.setenablegzipcompression.md)
-
-## BaseService.setEnableGzipCompression() method
-
-Turn request body compression on or off.
-
-<b>Signature:</b>
-
-```typescript
-setEnableGzipCompression(setting: boolean): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  setting | boolean | Will turn it on if 'true', off if 'false'. |
-
-<b>Returns:</b>
-
-void
-

package/build/docs/ibm-cloud-sdk-core.baseservice.setserviceurl.md

@@ -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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [setServiceUrl](./ibm-cloud-sdk-core.baseservice.setserviceurl.md)
-
-## BaseService.setServiceUrl() method
-
-Set the service URL to send requests to.
-
-<b>Signature:</b>
-
-```typescript
-setServiceUrl(url: string): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  url | string | The base URL for the service. |
-
-<b>Returns:</b>
-
-void
-

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

@@ -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; [BasicAuthenticator](./ibm-cloud-sdk-core.basicauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.basicauthenticator._constructor_.md)
-
-## BasicAuthenticator.(constructor)
-
-Create a new BasicAuthenticator instance.
-
-<b>Signature:</b>
-
-```typescript
-constructor(options: Options);
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  options | Options | Configuration options for basic authentication. |
-
-## Exceptions
-
-{<!-- -->Error<!-- -->} The configuration options are not valid.
-

package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticate.md

@@ -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; [BasicAuthenticator](./ibm-cloud-sdk-core.basicauthenticator.md) &gt; [authenticate](./ibm-cloud-sdk-core.basicauthenticator.authenticate.md)
-
-## BasicAuthenticator.authenticate() method
-
-Add basic authentication information to `request`<!-- -->. The basic authentication information will be set in the Authorization property of`request.headers` in the form:
-
-Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt;
-
-<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;
-

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

@@ -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; [BasicAuthenticator](./ibm-cloud-sdk-core.basicauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.basicauthenticator.authenticationtype.md)
-
-## BasicAuthenticator.authenticationType() method
-
-Returns the authenticator's type ('basic').
-
-<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.basicauthenticator.authheader.md

@@ -1,13 +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; [BasicAuthenticator](./ibm-cloud-sdk-core.basicauthenticator.md) &gt; [authHeader](./ibm-cloud-sdk-core.basicauthenticator.authheader.md)
-
-## BasicAuthenticator.authHeader property
-
-<b>Signature:</b>
-
-```typescript
-protected authHeader: {
-        Authorization: string;
-    };
-```

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

@@ -1,39 +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; [BasicAuthenticator](./ibm-cloud-sdk-core.basicauthenticator.md)
-
-## BasicAuthenticator class
-
-The BasicAuthenticator is used to add basic authentication information to requests.
-
-Basic Authorization will be sent as an Authorization header in the form:
-
-Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt;
-
-<b>Signature:</b>
-
-```typescript
-export declare class BasicAuthenticator extends Authenticator 
-```
-<b>Extends:</b> [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
-
-## Constructors
-
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.basicauthenticator._constructor_.md) |  | Create a new BasicAuthenticator instance. |
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [authHeader](./ibm-cloud-sdk-core.basicauthenticator.authheader.md) |  | { Authorization: string; } |  |
-|  [requiredOptions](./ibm-cloud-sdk-core.basicauthenticator.requiredoptions.md) |  | string\[\] |  |
-
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.basicauthenticator.authenticate.md) |  | Add basic authentication information to <code>request</code>. The basic authentication information will be set in the Authorization property of<code>request.headers</code> in the form:<!-- -->Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt; |
-|  [authenticationType()](./ibm-cloud-sdk-core.basicauthenticator.authenticationtype.md) |  | Returns the authenticator's type ('basic'). |
-

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

@@ -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; [BasicAuthenticator](./ibm-cloud-sdk-core.basicauthenticator.md) &gt; [requiredOptions](./ibm-cloud-sdk-core.basicauthenticator.requiredoptions.md)
-
-## BasicAuthenticator.requiredOptions property
-
-<b>Signature:</b>
-
-```typescript
-protected requiredOptions: string[];
-```

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

@@ -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; [BearerTokenAuthenticator](./ibm-cloud-sdk-core.bearertokenauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.bearertokenauthenticator._constructor_.md)
-
-## BearerTokenAuthenticator.(constructor)
-
-Create a new BearerTokenAuthenticator instance.
-
-<b>Signature:</b>
-
-```typescript
-constructor(options: Options);
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  options | Options | Configuration options for bearer authentication. |
-
-## Exceptions
-
-{<!-- -->Error<!-- -->} The configuration bearerToken is not valid, or unspecified.
-

package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md

@@ -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; [BearerTokenAuthenticator](./ibm-cloud-sdk-core.bearertokenauthenticator.md) &gt; [authenticate](./ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md)
-
-## BearerTokenAuthenticator.authenticate() method
-
-Add a bearer token to the `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;
-

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

@@ -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; [BearerTokenAuthenticator](./ibm-cloud-sdk-core.bearertokenauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.bearertokenauthenticator.authenticationtype.md)
-
-## BearerTokenAuthenticator.authenticationType() method
-
-Returns the authenticator's type ('bearertoken').
-
-<b>Signature:</b>
-
-```typescript
-authenticationType(): string;
-```
-<b>Returns:</b>
-
-string
-
-a string that indicates the authenticator's type
-