ibm-cloud-sdk-core 4.2.5 → 4.3.0

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

@@ -19,24 +19,199 @@ export declare class TokenRequestBasedAuthenticator extends Authenticator
 
 ## Constructors
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator._constructor_.md) |  | Create a new TokenRequestBasedAuthenticator instance with an internal JwtTokenManager. |
+<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
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [disableSslVerification](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.disablesslverification.md) | <code>protected</code> | boolean |  |
-|  [headers](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.headers.md) | <code>protected</code> | OutgoingHttpHeaders |  |
-|  [tokenManager](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.tokenmanager.md) | <code>protected</code> | [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) |  |
-|  [url](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.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>
+
+[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
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md) |  | <p>Adds bearer token information to "requestOptions". The bearer token information will be set in the Authorization property of "requestOptions.headers" in the form:</p><p>Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;</p> |
-|  [setDisableSslVerification(value)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md) |  | Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not. |
-|  [setHeaders(headers)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md) |  | Set headers. |
+<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

@@ -14,10 +14,39 @@ setDisableSslVerification(value: boolean): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  value | boolean | a flag that indicates whether verification of the token server's SSL certificate should be disabled or not. |
+<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

@@ -14,10 +14,39 @@ setHeaders(headers: OutgoingHttpHeaders): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  headers | OutgoingHttpHeaders | a set of HTTP headers to be sent with each outbound token server request. Overwrites previous default headers. |
+<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.tolowerkeys.md

@@ -14,10 +14,39 @@ export declare function toLowerKeys(obj: Object): Object;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  obj | Object | The object to convert the keys of. |
+<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

package/build/docs/ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.md

@@ -14,10 +14,39 @@ export declare function checkForSuccessfulExecution(createRequestMock: any): voi
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  createRequestMock | any | the jest mock object for the <code>createRequest</code> method in the <code>RequestWrapper</code> class |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+createRequestMock
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the jest mock object for the `createRequest` method in the `RequestWrapper` class
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

package/build/docs/ibm-cloud-sdk-core.unittestutils.checkmediaheaders.md

@@ -14,12 +14,71 @@ export declare function checkMediaHeaders(createRequestMock: any, accept: string
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  createRequestMock | any | the jest mock object for the <code>createRequest</code> method in the <code>RequestWrapper</code> class |
-|  accept | string | the expected value for the <code>Accept</code> header |
-|  contentType | string | the expected value for the <code>Content-Type</code> header |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+createRequestMock
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the jest mock object for the `createRequest` method in the `RequestWrapper` class
+
+
+</td></tr>
+<tr><td>
+
+accept
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the expected value for the `Accept` header
+
+
+</td></tr>
+<tr><td>
+
+contentType
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the expected value for the `Content-Type` header
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

package/build/docs/ibm-cloud-sdk-core.unittestutils.checkurlandmethod.md

@@ -14,12 +14,71 @@ export declare function checkUrlAndMethod(options: any, url: string, method: any
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  options | any | the options object put together by the SDK, retrieved from the createRequest mock |
-|  url | string | The URL path of the service endpoint, from the paths section of the API definition |
-|  method | any | The HTTP method for the request, from the API definition |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the options object put together by the SDK, retrieved from the createRequest mock
+
+
+</td></tr>
+<tr><td>
+
+url
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The URL path of the service endpoint, from the paths section of the API definition
+
+
+</td></tr>
+<tr><td>
+
+method
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+The HTTP method for the request, from the API definition
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

package/build/docs/ibm-cloud-sdk-core.unittestutils.checkuserheader.md

@@ -14,12 +14,71 @@ export declare function checkUserHeader(createRequestMock: any, userHeaderName:
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  createRequestMock | any | the jest mock object for the <code>createRequest</code> method in the <code>RequestWrapper</code> class |
-|  userHeaderName | string | the name of the header passed by the user, e.g. <code>Contained-Content-Type</code> |
-|  userHeaderValue | string | the expected value for the header passed by the user |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+createRequestMock
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the jest mock object for the `createRequest` method in the `RequestWrapper` class
+
+
+</td></tr>
+<tr><td>
+
+userHeaderName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the name of the header passed by the user, e.g. `Contained-Content-Type`
+
+
+</td></tr>
+<tr><td>
+
+userHeaderValue
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the expected value for the header passed by the user
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

package/build/docs/ibm-cloud-sdk-core.unittestutils.expecttobepromise.md

@@ -14,10 +14,39 @@ export declare function expectToBePromise(sdkPromise: any): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  sdkPromise | any | the Promise returned by an SDK method |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+sdkPromise
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the Promise returned by an SDK method
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 void

package/build/docs/ibm-cloud-sdk-core.unittestutils.getoptions.md

@@ -14,10 +14,39 @@ export declare function getOptions(createRequestMock: any): any;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  createRequestMock | any | the jest mock object for the <code>createRequest</code> method in the <code>RequestWrapper</code> class |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+createRequestMock
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the jest mock object for the `createRequest` method in the `RequestWrapper` class
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 any