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

package/build/docs/ibm-cloud-sdk-core.baseservice.gethttpclient.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; [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

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

@@ -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; [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

@@ -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; [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

@@ -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; [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

@@ -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; [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

@@ -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; [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

@@ -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; [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

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

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

@@ -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; [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

@@ -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; [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

@@ -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; [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

@@ -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; [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
+

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

@@ -0,0 +1,39 @@
+<!-- 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)
+
+## BearerTokenAuthenticator class
+
+The BearerTokenAuthenticator will set a user-provided bearer token in requests.
+
+The bearer token will be sent as an Authorization header in the form:
+
+Authorization: Bearer <bearer-token>
+
+<b>Signature:</b>
+
+```typescript
+export declare class BearerTokenAuthenticator extends Authenticator 
+```
+<b>Extends:</b> [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.bearertokenauthenticator._constructor_.md) |  | Create a new BearerTokenAuthenticator instance. |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [requiredOptions](./ibm-cloud-sdk-core.bearertokenauthenticator.requiredoptions.md) |  | string\[\] |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md) |  | Add a bearer token to the <code>request</code>. The bearer token information will be set in the Authorization property of<code>request.headers</code> in the form:<!-- -->Authorization: Bearer <bearer-token> |
+|  [authenticationType()](./ibm-cloud-sdk-core.bearertokenauthenticator.authenticationtype.md) |  | Returns the authenticator's type ('bearertoken'). |
+|  [setBearerToken(bearerToken)](./ibm-cloud-sdk-core.bearertokenauthenticator.setbearertoken.md) |  | Set a new bearer token to be sent in subsequent requests. |
+

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

package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.setbearertoken.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; [BearerTokenAuthenticator](./ibm-cloud-sdk-core.bearertokenauthenticator.md) &gt; [setBearerToken](./ibm-cloud-sdk-core.bearertokenauthenticator.setbearertoken.md)
+
+## BearerTokenAuthenticator.setBearerToken() method
+
+Set a new bearer token to be sent in subsequent requests.
+
+<b>Signature:</b>
+
+```typescript
+setBearerToken(bearerToken: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  bearerToken | string | The bearer token that will be sent in service requests. |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.buildrequestfileobject.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; [buildRequestFileObject](./ibm-cloud-sdk-core.buildrequestfileobject.md)
+
+## buildRequestFileObject() function
+
+This function builds a `form-data` object for each file parameter.
+
+<b>Signature:</b>
+
+```typescript
+export declare function buildRequestFileObject(fileParam: FileWithMetadata): Promise<FileObject>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fileParam | [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) | The file parameter. |
+
+<b>Returns:</b>
+
+Promise&lt;[FileObject](./ibm-cloud-sdk-core.fileobject.md)<!-- -->&gt;
+
+{<!-- -->FileObject<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.checkcredentials.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; [checkCredentials](./ibm-cloud-sdk-core.checkcredentials.md)
+
+## checkCredentials() function
+
+Checks credentials for common user mistakes of copying {<!-- -->, }<!-- -->, or " characters from the documentation
+
+<b>Signature:</b>
+
+```typescript
+export declare function checkCredentials(obj: any, credsToCheck: string[]): Error | null;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  obj | any | The options object holding credentials |
+|  credsToCheck | string\[\] | An array containing the keys of the credentials to check for problems |
+
+<b>Returns:</b>
+
+Error \| null
+
+{<!-- -->string \| null<!-- -->} - Returns a string with the error message if there were problems, null if not
+

package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator._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; [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md)
+
+## CloudPakForDataAuthenticator.(constructor)
+
+Create a new \[\[CloudPakForDataAuthenticator\]\] instance.
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: Options);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | Options | Configuration options for CloudPakForData authentication. |
+
+## Exceptions
+
+`Error` The username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.
+

package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.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; [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md)
+
+## CloudPakForDataAuthenticator.authenticationType() method
+
+Returns the authenticator's type ('cp4d').
+
+<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.cloudpakfordataauthenticator.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; [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md)
+
+## CloudPakForDataAuthenticator class
+
+The \[\[CloudPakForDataAuthenticator\]\] will either use a username/password pair or a username/apikey pair to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the 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 CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator 
+```
+<b>Extends:</b> [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md) |  | Create a new \[\[CloudPakForDataAuthenticator\]\] instance. |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [requiredOptions](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md) |  | string\[\] |  |
+|  [tokenManager](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md) |  | [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [authenticationType()](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md) |  | Returns the authenticator's type ('cp4d'). |
+

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

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

package/build/docs/ibm-cloud-sdk-core.computebasicauthheader.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; [computeBasicAuthHeader](./ibm-cloud-sdk-core.computebasicauthheader.md)
+
+## computeBasicAuthHeader() function
+
+Compute and return a Basic Authorization header from a username and password.
+
+<b>Signature:</b>
+
+```typescript
+export declare function computeBasicAuthHeader(username: string, password: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  username | string | The username or client id |
+|  password | string | The password or client secret |
+
+<b>Returns:</b>
+
+string
+
+{<!-- -->string<!-- -->} - A Basic Auth header with format "Basic <encoded-credentials>"
+

package/build/docs/ibm-cloud-sdk-core.constructfilepath.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; [constructFilepath](./ibm-cloud-sdk-core.constructfilepath.md)
+
+## constructFilepath() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function constructFilepath(filepath: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  filepath | string |  |
+
+<b>Returns:</b>
+
+string
+