ibm-cloud-sdk-core 4.3.2-beta-2 → 4.3.3

package/build/docs/ibm-cloud-sdk-core.iamtokenmanager._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; [IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.iamtokenmanager._constructor_.md)
+
+## IamTokenManager.(constructor)
+
+Create a new IamTokenManager 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. This should be an object containing these fields: - url: (optional) the endpoint URL for the IAM token service (default value: "https://iam.cloud.ibm.com") - apikey: (required) the IAM api key - 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 - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service
+
+
+</td></tr>
+</tbody></table>
+
+## Exceptions
+
+Error: the configuration options are not valid.
+

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

@@ -0,0 +1,92 @@
+<!-- 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; [IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.md)
+
+## IamTokenManager class
+
+The IAMTokenManager takes an api key and performs the necessary interactions with the IAM token service to obtain and store a suitable bearer token. Additionally, the IAMTokenManager will retrieve bearer tokens via basic auth using a supplied "clientId" and "clientSecret" pair.
+
+**Signature:**
+
+```typescript
+export declare class IamTokenManager extends IamRequestBasedTokenManager 
+```
+**Extends:** [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.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.iamtokenmanager._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new IamTokenManager 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.iamtokenmanager.requiredoptions.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

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

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

@@ -0,0 +1,49 @@
+<!-- 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; [isEmptyObject](./ibm-cloud-sdk-core.isemptyobject.md)
+
+## isEmptyObject() function
+
+**Signature:**
+
+```typescript
+export declare function isEmptyObject(obj: any): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+obj
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+

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

@@ -0,0 +1,49 @@
+<!-- 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; [isFileData](./ibm-cloud-sdk-core.isfiledata.md)
+
+## isFileData() function
+
+**Signature:**
+
+```typescript
+export declare function isFileData(obj: any): obj is NodeJS.ReadableStream | Buffer;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+obj
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+obj is NodeJS.ReadableStream \| Buffer
+

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

@@ -0,0 +1,49 @@
+<!-- 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; [isFileWithMetadata](./ibm-cloud-sdk-core.isfilewithmetadata.md)
+
+## isFileWithMetadata() function
+
+**Signature:**
+
+```typescript
+export declare function isFileWithMetadata(obj: any): obj is FileWithMetadata;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+obj
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+obj is [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md)
+

package/build/docs/ibm-cloud-sdk-core.ishtml.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; [isHTML](./ibm-cloud-sdk-core.ishtml.md)
+
+## isHTML() function
+
+Return true if 'text' is html
+
+**Signature:**
+
+```typescript
+export declare function isHTML(text: string): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+text
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The 'text' to analyze
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+
+true if 'text' has html tags
+

package/build/docs/ibm-cloud-sdk-core.isjsonmimetype.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; [isJsonMimeType](./ibm-cloud-sdk-core.isjsonmimetype.md)
+
+## isJsonMimeType() function
+
+Returns true if and only if "mimeType" is a "JSON-like" mime type (e.g. "application/json; charset=utf-8").
+
+**Signature:**
+
+```typescript
+export declare function isJsonMimeType(mimeType: string): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+mimeType
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the mimeType string
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+
+true if "mimeType" represents a JSON media type and false otherwise
+

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

@@ -0,0 +1,49 @@
+<!-- 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; [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.jwttokenmanager._constructor_.md)
+
+## JwtTokenManager.(constructor)
+
+Create a new JwtTokenManager instance.
+
+**Signature:**
+
+```typescript
+constructor(options: JwtTokenManagerOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[JwtTokenManagerOptions](./ibm-cloud-sdk-core.jwttokenmanageroptions.md)
+
+
+</td><td>
+
+Configuration options. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - 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>

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

@@ -0,0 +1,163 @@
+<!-- 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; [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
+
+## JwtTokenManager class
+
+A class for shared functionality for parsing, storing, and requesting JWT tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement `requestToken()` to retrieve the bearer token from intended sources.
+
+**Signature:**
+
+```typescript
+export declare class JwtTokenManager extends TokenManager 
+```
+**Extends:** [TokenManager](./ibm-cloud-sdk-core.tokenmanager.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.jwttokenmanager._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new JwtTokenManager 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>
+
+[tokenInfo](./ibm-cloud-sdk-core.jwttokenmanager.tokeninfo.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[tokenName](./ibm-cloud-sdk-core.jwttokenmanager.tokenname.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>
+
+[requestToken()](./ibm-cloud-sdk-core.jwttokenmanager.requesttoken.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Request a JWT using an API key.
+
+
+</td></tr>
+<tr><td>
+
+[saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Save the JWT service response and the calculated expiration time to the object's state.
+
+
+</td></tr>
+</tbody></table>

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.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; [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) &gt; [requestToken](./ibm-cloud-sdk-core.jwttokenmanager.requesttoken.md)
+
+## JwtTokenManager.requestToken() method
+
+Request a JWT using an API key.
+
+**Signature:**
+
+```typescript
+protected requestToken(): Promise<any>;
+```
+**Returns:**
+
+Promise&lt;any&gt;
+
+Promise
+

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.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; [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) &gt; [saveTokenInfo](./ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md)
+
+## JwtTokenManager.saveTokenInfo() method
+
+Save the JWT service response and the calculated expiration time to the object's state.
+
+**Signature:**
+
+```typescript
+protected saveTokenInfo(tokenResponse: any): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+tokenResponse
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the response object from JWT service request
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+