ibm-cloud-sdk-core 4.2.5 → 4.3.0

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

@@ -14,31 +14,339 @@ export declare class TokenManager
 
 ## Constructors
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.tokenmanager._constructor_.md) |  | Create a new TokenManager instance. |
+<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
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [accessToken](./ibm-cloud-sdk-core.tokenmanager.accesstoken.md) | <code>protected</code> | string |  |
-|  [disableSslVerification](./ibm-cloud-sdk-core.tokenmanager.disablesslverification.md) | <code>protected</code> | boolean |  |
-|  [expireTime](./ibm-cloud-sdk-core.tokenmanager.expiretime.md) | <code>protected</code> | number |  |
-|  [headers](./ibm-cloud-sdk-core.tokenmanager.headers.md) | <code>protected</code> | OutgoingHttpHeaders |  |
-|  [refreshTime](./ibm-cloud-sdk-core.tokenmanager.refreshtime.md) | <code>protected</code> | number |  |
-|  [requestWrapperInstance](./ibm-cloud-sdk-core.tokenmanager.requestwrapperinstance.md) | <code>protected</code> | RequestWrapper |  |
-|  [url](./ibm-cloud-sdk-core.tokenmanager.url.md) | <code>protected</code> | string |  |
+<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
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [getToken()](./ibm-cloud-sdk-core.tokenmanager.gettoken.md) |  | Retrieves a new token using "requestToken()" if there is not a currently stored token from a previous call, or the previous token has expired. |
-|  [isTokenExpired()](./ibm-cloud-sdk-core.tokenmanager.istokenexpired.md) | <code>protected</code> | Checks if currently-stored token is expired |
-|  [pacedRequestToken()](./ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md) | <code>protected</code> | <p>Paces requests to requestToken().</p><p>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 <code>requestTime</code> and then issues the token request. Subsequent callers will check the <code>requestTime</code> 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.</p> |
-|  [requestToken()](./ibm-cloud-sdk-core.tokenmanager.requesttoken.md) | <code>protected</code> | Request a token using an API endpoint. |
-|  [saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md) | <code>protected</code> | Parse and save token information from the response. Save the requested token into field <code>accessToken</code>. Calculate expiration and refresh time from the received info and store them in fields <code>expireTime</code> and <code>refreshTime</code>. |
-|  [setDisableSslVerification(value)](./ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md) |  | Sets the "disableSslVerification" property. |
-|  [setHeaders(headers)](./ibm-cloud-sdk-core.tokenmanager.setheaders.md) |  | Sets the headers to be included with each outbound request to the token server. |
+<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.savetokeninfo.md

@@ -14,10 +14,39 @@ protected saveTokenInfo(tokenResponse: any): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  tokenResponse | any | the response object from a token service request |
+<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

@@ -14,10 +14,39 @@ setDisableSslVerification(value: boolean): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  value | boolean | the new value for the disableSslVerification property |
+<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

@@ -14,10 +14,39 @@ setHeaders(headers: OutgoingHttpHeaders): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  headers | OutgoingHttpHeaders | the set of headers to send with each request to the token server |
+<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.useragent.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; [userAgent](./ibm-cloud-sdk-core.tokenmanager.useragent.md)
+
+## TokenManager.userAgent property
+
+**Signature:**
+
+```typescript
+protected userAgent: string;
+```

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

@@ -14,7 +14,36 @@ constructor(options: BaseOptions);
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  options | BaseOptions | 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 |
+<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

@@ -16,10 +16,39 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  requestOptions | AuthenticateOptions | The request to augment with authentication information. |
+<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;