npm - ibm-cloud-sdk-core - Versions diffs - 4.3.3 → 5.0.1 - Mend

ibm-cloud-sdk-core 4.3.3 → 5.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (249) hide show

package/build/docs/ibm-cloud-sdk-core.isjsonmimetype.md DELETED Viewed

@@ -1,55 +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; [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 DELETED Viewed

@@ -1,49 +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; [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 DELETED Viewed

@@ -1,163 +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; [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 DELETED Viewed

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

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

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

@@ -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; [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) &gt; [tokenInfo](./ibm-cloud-sdk-core.jwttokenmanager.tokeninfo.md)
-## JwtTokenManager.tokenInfo property
-**Signature:**
-```typescript
-protected tokenInfo: any;
-```

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

@@ -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; [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) &gt; [tokenName](./ibm-cloud-sdk-core.jwttokenmanager.tokenname.md)
-## JwtTokenManager.tokenName property
-**Signature:**
-```typescript
-protected tokenName: string;
-```

package/build/docs/ibm-cloud-sdk-core.jwttokenmanageroptions.md DELETED Viewed

@@ -1,15 +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; [JwtTokenManagerOptions](./ibm-cloud-sdk-core.jwttokenmanageroptions.md)
-## JwtTokenManagerOptions type
-Configuration options for JWT token retrieval.
-**Signature:**
-```typescript
-export type JwtTokenManagerOptions = TokenManagerOptions;
-```
-**References:** [TokenManagerOptions](./ibm-cloud-sdk-core.tokenmanageroptions.md)

package/build/docs/ibm-cloud-sdk-core.mcspauthenticator._constructor_.md DELETED Viewed

@@ -1,54 +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; [McspAuthenticator](./ibm-cloud-sdk-core.mcspauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.mcspauthenticator._constructor_.md)
-## McspAuthenticator.(constructor)
-Create a new McspAuthenticator 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.mcspauthenticator.authenticationtype.md DELETED Viewed

@@ -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; [McspAuthenticator](./ibm-cloud-sdk-core.mcspauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.mcspauthenticator.authenticationtype.md)
-## McspAuthenticator.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.mcspauthenticator.md DELETED Viewed

@@ -1,145 +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; [McspAuthenticator](./ibm-cloud-sdk-core.mcspauthenticator.md)
-## McspAuthenticator class
-The McspAuthenticator uses an apikey to obtain an access token from the MCSP token server. When the access token expires, a new access token is obtained from the token server. The access token will be added to outbound requests via the Authorization header of the form: "Authorization: Bearer <access-token>"
-**Signature:**
-```typescript
-export declare class McspAuthenticator 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.mcspauthenticator._constructor_.md)
-</td><td>
-</td><td>
-Create a new McspAuthenticator 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.mcspauthenticator.requiredoptions.md)
-</td><td>
-`protected`
-</td><td>
-string\[\]
-</td><td>
-</td></tr>
-<tr><td>
-[tokenManager](./ibm-cloud-sdk-core.mcspauthenticator.tokenmanager.md)
-</td><td>
-`protected`
-</td><td>
-[McspTokenManager](./ibm-cloud-sdk-core.mcsptokenmanager.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.mcspauthenticator.authenticationtype.md)
-</td><td>
-</td><td>
-Returns the authenticator's type ('cp4d').
-</td></tr>
-</tbody></table>

package/build/docs/ibm-cloud-sdk-core.mcspauthenticator.requiredoptions.md DELETED Viewed

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

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

@@ -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; [McspAuthenticator](./ibm-cloud-sdk-core.mcspauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.mcspauthenticator.tokenmanager.md)
-## McspAuthenticator.tokenManager property
-**Signature:**
-```typescript
-protected tokenManager: McspTokenManager;
-```

package/build/docs/ibm-cloud-sdk-core.mcsptokenmanager._constructor_.md DELETED Viewed

@@ -1,54 +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; [McspTokenManager](./ibm-cloud-sdk-core.mcsptokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.mcsptokenmanager._constructor_.md)
-## McspTokenManager.(constructor)
-Create a new McspTokenManager 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: (required) the base endpoint URL for the MCSP token service - apikey: (required) the API key used to obtain the MCSP access token. - 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 configuration options were invalid.