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

ibm-cloud-sdk-core 5.0.0 → 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 (222) hide show

package/build/docs/ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [setDisableSslVerification](./ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md)
-## TokenManager.setDisableSslVerification() method
-Sets the "disableSslVerification" property.
-**Signature:**
-```typescript
-setDisableSslVerification(value: boolean): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-value
-</td><td>
-boolean
-</td><td>
-the new value for the disableSslVerification property
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/build/docs/ibm-cloud-sdk-core.tokenmanager.setheaders.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [setHeaders](./ibm-cloud-sdk-core.tokenmanager.setheaders.md)
-## TokenManager.setHeaders() method
-Sets the headers to be included with each outbound request to the token server.
-**Signature:**
-```typescript
-setHeaders(headers: OutgoingHttpHeaders): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-headers
-</td><td>
-OutgoingHttpHeaders
-</td><td>
-the set of headers to send with each request to the token server
-</td></tr>
-</tbody></table>
-**Returns:**
-void

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

package/build/docs/ibm-cloud-sdk-core.tokenmanager.useragent.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [userAgent](./ibm-cloud-sdk-core.tokenmanager.useragent.md)
-## TokenManager.userAgent property
-**Signature:**
-```typescript
-protected userAgent: string;
-```

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

@@ -1,18 +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; [TokenManagerOptions](./ibm-cloud-sdk-core.tokenmanageroptions.md)
-## TokenManagerOptions type
-Configuration options for token retrieval.
-**Signature:**
-```typescript
-export type TokenManagerOptions = {
-    url?: string;
-    headers?: OutgoingHttpHeaders;
-    disableSslVerification?: boolean;
-    [propName: string]: any;
-};
-```

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator._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; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator._constructor_.md)
-## TokenRequestBasedAuthenticator.(constructor)
-Create a new TokenRequestBasedAuthenticator instance with an internal JwtTokenManager.
-**Signature:**
-```typescript
-constructor(options: BaseOptions);
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-options
-</td><td>
-BaseOptions
-</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.tokenrequestbasedauthenticator.authenticate.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; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [authenticate](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md)
-## TokenRequestBasedAuthenticator.authenticate() method
-Adds bearer token information 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;
-**Signature:**
-```typescript
-authenticate(requestOptions: AuthenticateOptions): Promise<void>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-requestOptions
-</td><td>
-AuthenticateOptions
-</td><td>
-The request to augment with authentication information.
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;void&gt;

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.disablesslverification.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; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [disableSslVerification](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.disablesslverification.md)
-## TokenRequestBasedAuthenticator.disableSslVerification property
-**Signature:**
-```typescript
-protected disableSslVerification: boolean;
-```

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.headers.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; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [headers](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.headers.md)
-## TokenRequestBasedAuthenticator.headers property
-**Signature:**
-```typescript
-protected headers: OutgoingHttpHeaders;
-```

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

@@ -1,217 +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; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
-## TokenRequestBasedAuthenticator class
-Class for common functionality shared by token-request authenticators. TokenRequestBasedAuthenticators use token managers to retrieve, store, and refresh tokens. Not intended to be used as stand-alone authenticator, but as base class to authenticators that have their own token manager implementations.
-The token will be added as an Authorization header in the form:
-Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
-**Signature:**
-```typescript
-export declare class TokenRequestBasedAuthenticator 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.tokenrequestbasedauthenticator._constructor_.md)
-</td><td>
-</td><td>
-Create a new TokenRequestBasedAuthenticator instance with an internal JwtTokenManager.
-</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>
-[disableSslVerification](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.disablesslverification.md)
-</td><td>
-`protected`
-</td><td>
-boolean
-</td><td>
-</td></tr>
-<tr><td>
-[headers](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.headers.md)
-</td><td>
-`protected`
-</td><td>
-OutgoingHttpHeaders
-</td><td>
-</td></tr>
-<tr><td>
-[tokenManager](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.tokenmanager.md)
-</td><td>
-`protected`
-</td><td>
-[JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
-</td><td>
-</td></tr>
-<tr><td>
-[url](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.url.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.tokenrequestbasedauthenticator.authenticate.md)
-</td><td>
-</td><td>
-Adds bearer token information 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>
-[setDisableSslVerification(value)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md)
-</td><td>
-</td><td>
-Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not.
-</td></tr>
-<tr><td>
-[setHeaders(headers)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md)
-</td><td>
-</td><td>
-Set headers.
-</td></tr>
-</tbody></table>

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.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; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [setDisableSslVerification](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md)
-## TokenRequestBasedAuthenticator.setDisableSslVerification() method
-Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not.
-**Signature:**
-```typescript
-setDisableSslVerification(value: boolean): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-value
-</td><td>
-boolean
-</td><td>
-a flag that indicates whether verification of the token server's SSL certificate should be disabled or not.
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.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; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [setHeaders](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md)
-## TokenRequestBasedAuthenticator.setHeaders() method
-Set headers.
-**Signature:**
-```typescript
-setHeaders(headers: OutgoingHttpHeaders): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-headers
-</td><td>
-OutgoingHttpHeaders
-</td><td>
-a set of HTTP headers to be sent with each outbound token server request. Overwrites previous default headers.
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.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; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.tokenmanager.md)
-## TokenRequestBasedAuthenticator.tokenManager property
-**Signature:**
-```typescript
-protected tokenManager: JwtTokenManager;
-```

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

package/build/docs/ibm-cloud-sdk-core.tolowerkeys.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; [toLowerKeys](./ibm-cloud-sdk-core.tolowerkeys.md)
-## toLowerKeys() function
-This function converts an object's keys to lower case. note: does not convert nested keys
-**Signature:**
-```typescript
-export declare function toLowerKeys(obj: Object): Object;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-obj
-</td><td>
-Object
-</td><td>
-The object to convert the keys of.
-</td></tr>
-</tbody></table>
-**Returns:**
-Object
-the object with keys folded to lowercase

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

@@ -1,13 +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; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [authenticator](./ibm-cloud-sdk-core.useroptions.authenticator.md)
-## UserOptions.authenticator property
-The Authenticator object used to authenticate requests to the service
-**Signature:**
-```typescript
-authenticator?: AuthenticatorInterface;
-```