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

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

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

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
+
+**Signature:**
+
+```typescript
+protected requiredOptions: string[];
+```

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

@@ -0,0 +1,53 @@
+<!-- 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.
+
+**Signature:**
+
+```typescript
+setBearerToken(bearerToken: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+bearerToken
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The bearer token that will be sent in service requests.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

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

@@ -0,0 +1,55 @@
+<!-- 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.
+
+**Signature:**
+
+```typescript
+export declare function buildRequestFileObject(fileParam: FileWithMetadata): Promise<FileObject>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+fileParam
+
+
+</td><td>
+
+[FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md)
+
+
+</td><td>
+
+The FileWithMetadata instance that contains the file information
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Promise&lt;[FileObject](./ibm-cloud-sdk-core.fileobject.md)<!-- -->&gt;
+
+the FileObject instance
+

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

@@ -0,0 +1,71 @@
+<!-- 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
+
+**Signature:**
+
+```typescript
+export declare function checkCredentials(obj: any, credsToCheck: string[]): Error | null;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+obj
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the options object holding credentials
+
+
+</td></tr>
+<tr><td>
+
+credsToCheck
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+an array containing the keys of the credentials to check for problems
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Error \| null
+
+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,54 @@
+<!-- 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.
+
+**Signature:**
+
+```typescript
+constructor(options: Options);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+Options
+
+
+</td><td>
+
+Configuration options for CloudPakForData authentication. This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+
+
+</td></tr>
+</tbody></table>
+
+## 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').
+
+**Signature:**
+
+```typescript
+authenticationType(): string;
+```
+**Returns:**
+
+string
+
+a string that indicates the authenticator's type
+

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

@@ -0,0 +1,149 @@
+<!-- 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 &lt;<!-- -->bearer-token<!-- -->&gt;
+
+**Signature:**
+
+```typescript
+export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator 
+```
+**Extends:** [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new CloudPakForDataAuthenticator instance.
+
+
+</td></tr>
+</tbody></table>
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[requiredOptions](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[tokenManager](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+[Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticationType()](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Returns the authenticator's type ('cp4d').
+
+
+</td></tr>
+</tbody></table>

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
+
+**Signature:**
+
+```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
+
+**Signature:**
+
+```typescript
+protected tokenManager: Cp4dTokenManager;
+```

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

@@ -0,0 +1,71 @@
+<!-- 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.
+
+**Signature:**
+
+```typescript
+export declare function computeBasicAuthHeader(username: string, password: string): string;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+username
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The username or client id
+
+
+</td></tr>
+<tr><td>
+
+password
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The password or client secret
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+string
+
+a Basic Auth header with format "Basic <encoded-credentials>"
+