ibm-cloud-sdk-core 5.1.0 → 5.1.2

package/build/docs/ibm-cloud-sdk-core.tokenmanager._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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.tokenmanager._constructor_.md)
+
+## TokenManager.(constructor)
+
+Create a new TokenManager instance.
+
+**Signature:**
+
+```typescript
+constructor(options: TokenManagerOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[TokenManagerOptions](./ibm-cloud-sdk-core.tokenmanageroptions.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.tokenmanager.accesstoken.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [accessToken](./ibm-cloud-sdk-core.tokenmanager.accesstoken.md)
+
+## TokenManager.accessToken property
+
+**Signature:**
+
+```typescript
+protected accessToken: string;
+```

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

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

package/build/docs/ibm-cloud-sdk-core.tokenmanager.gettoken.md

@@ -0,0 +1,17 @@
+<!-- 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; [getToken](./ibm-cloud-sdk-core.tokenmanager.gettoken.md)
+
+## TokenManager.getToken() method
+
+Retrieves a new token using "requestToken()" if there is not a currently stored token from a previous call, or the previous token has expired.
+
+**Signature:**
+
+```typescript
+getToken(): Promise<any>;
+```
+**Returns:**
+
+Promise&lt;any&gt;
+

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

package/build/docs/ibm-cloud-sdk-core.tokenmanager.istokenexpired.md

@@ -0,0 +1,17 @@
+<!-- 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; [isTokenExpired](./ibm-cloud-sdk-core.tokenmanager.istokenexpired.md)
+
+## TokenManager.isTokenExpired() method
+
+Checks if currently-stored token is expired
+
+**Signature:**
+
+```typescript
+protected isTokenExpired(): boolean;
+```
+**Returns:**
+
+boolean
+

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

@@ -0,0 +1,352 @@
+<!-- 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)
+
+## TokenManager class
+
+A class for shared functionality for storing, and requesting tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement "requestToken()" to retrieve the token from intended sources and "saveTokenInfo(tokenResponse)" to parse and save token information from the response.
+
+**Signature:**
+
+```typescript
+export declare class TokenManager 
+```
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./ibm-cloud-sdk-core.tokenmanager._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new TokenManager 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>
+
+[accessToken](./ibm-cloud-sdk-core.tokenmanager.accesstoken.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[disableSslVerification](./ibm-cloud-sdk-core.tokenmanager.disablesslverification.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[expireTime](./ibm-cloud-sdk-core.tokenmanager.expiretime.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[headers](./ibm-cloud-sdk-core.tokenmanager.headers.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+OutgoingHttpHeaders
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[refreshTime](./ibm-cloud-sdk-core.tokenmanager.refreshtime.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[requestWrapperInstance](./ibm-cloud-sdk-core.tokenmanager.requestwrapperinstance.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+RequestWrapper
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[url](./ibm-cloud-sdk-core.tokenmanager.url.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[userAgent](./ibm-cloud-sdk-core.tokenmanager.useragent.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>
+
+[getToken()](./ibm-cloud-sdk-core.tokenmanager.gettoken.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves a new token using "requestToken()" if there is not a currently stored token from a previous call, or the previous token has expired.
+
+
+</td></tr>
+<tr><td>
+
+[isTokenExpired()](./ibm-cloud-sdk-core.tokenmanager.istokenexpired.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Checks if currently-stored token is expired
+
+
+</td></tr>
+<tr><td>
+
+[pacedRequestToken()](./ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Paces requests to requestToken().
+
+This method pseudo-serializes requests for an access\_token when the current token is undefined or expired. The first caller to this method records its `requestTime` and then issues the token request. Subsequent callers will check the `requestTime` to see if a request is active (has been issued within the past 60 seconds), and if so will queue their promise for the active requestor to resolve when that request completes.
+
+
+</td></tr>
+<tr><td>
+
+[requestToken()](./ibm-cloud-sdk-core.tokenmanager.requesttoken.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Request a token using an API endpoint.
+
+
+</td></tr>
+<tr><td>
+
+[saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Parse and save token information from the response. Save the requested token into field `accessToken`<!-- -->. Calculate expiration and refresh time from the received info and store them in fields `expireTime` and `refreshTime`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[setDisableSslVerification(value)](./ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the "disableSslVerification" property.
+
+
+</td></tr>
+<tr><td>
+
+[setHeaders(headers)](./ibm-cloud-sdk-core.tokenmanager.setheaders.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the headers to be included with each outbound request to the token server.
+
+
+</td></tr>
+</tbody></table>

package/build/docs/ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [pacedRequestToken](./ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md)
+
+## TokenManager.pacedRequestToken() method
+
+Paces requests to requestToken().
+
+This method pseudo-serializes requests for an access\_token when the current token is undefined or expired. The first caller to this method records its `requestTime` and then issues the token request. Subsequent callers will check the `requestTime` to see if a request is active (has been issued within the past 60 seconds), and if so will queue their promise for the active requestor to resolve when that request completes.
+
+**Signature:**
+
+```typescript
+protected pacedRequestToken(): Promise<any>;
+```
+**Returns:**
+
+Promise&lt;any&gt;
+

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

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

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

package/build/docs/ibm-cloud-sdk-core.tokenmanager.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [saveTokenInfo](./ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md)
+
+## TokenManager.saveTokenInfo() method
+
+Parse and save token information from the response. Save the requested token into field `accessToken`<!-- -->. Calculate expiration and refresh time from the received info and store them in fields `expireTime` and `refreshTime`<!-- -->.
+
+**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 a token service request
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

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