npm - ibm-cloud-sdk-core - Versions diffs - 5.1.1 → 5.1.3 - Mend

ibm-cloud-sdk-core 5.1.1 → 5.1.3

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 (246) hide show

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

@@ -1,96 +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; [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md)
-## IamRequestOptions interface
-Configuration options for IAM token retrieval.
-**Signature:**
-```typescript
-export interface IamRequestOptions extends JwtTokenManagerOptions
-```
-**Extends:** [JwtTokenManagerOptions](./ibm-cloud-sdk-core.jwttokenmanageroptions.md)
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[clientId?](./ibm-cloud-sdk-core.iamrequestoptions.clientid.md)
-</td><td>
-</td><td>
-string
-</td><td>
-_(Optional)_
-</td></tr>
-<tr><td>
-[clientSecret?](./ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md)
-</td><td>
-</td><td>
-string
-</td><td>
-_(Optional)_
-</td></tr>
-<tr><td>
-[scope?](./ibm-cloud-sdk-core.iamrequestoptions.scope.md)
-</td><td>
-</td><td>
-string
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>

package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.scope.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; [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md) &gt; [scope](./ibm-cloud-sdk-core.iamrequestoptions.scope.md)
-## IamRequestOptions.scope property
-**Signature:**
-```typescript
-scope?: string;
-```

package/build/docs/ibm-cloud-sdk-core.iamtokenmanager._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; [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.getrefreshtoken.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; [IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.md) &gt; [getRefreshToken](./ibm-cloud-sdk-core.iamtokenmanager.getrefreshtoken.md)
-## IamTokenManager.getRefreshToken() method
-Returns the most recently stored refresh token.
-**Signature:**
-```typescript
-getRefreshToken(): string;
-```
-**Returns:**
-string
-the refresh token

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

@@ -1,126 +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; [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>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[getRefreshToken()](./ibm-cloud-sdk-core.iamtokenmanager.getrefreshtoken.md)
-</td><td>
-</td><td>
-Returns the most recently stored refresh token.
-</td></tr>
-</tbody></table>

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