ibm-cloud-sdk-core 3.2.2-beta-5 → 4.0.0

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

@@ -0,0 +1,43 @@
+<!-- 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.
+
+<b>Signature:</b>
+
+```typescript
+export declare class TokenManager 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.tokenmanager._constructor_.md) |  | Create a new \[\[TokenManager\]\] instance.  |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [accessToken](./ibm-cloud-sdk-core.tokenmanager.accesstoken.md) |  | string |  |
+|  [disableSslVerification](./ibm-cloud-sdk-core.tokenmanager.disablesslverification.md) |  | boolean |  |
+|  [expireTime](./ibm-cloud-sdk-core.tokenmanager.expiretime.md) |  | number |  |
+|  [headers](./ibm-cloud-sdk-core.tokenmanager.headers.md) |  | OutgoingHttpHeaders |  |
+|  [refreshTime](./ibm-cloud-sdk-core.tokenmanager.refreshtime.md) |  | number |  |
+|  [requestWrapperInstance](./ibm-cloud-sdk-core.tokenmanager.requestwrapperinstance.md) |  | RequestWrapper |  |
+|  [url](./ibm-cloud-sdk-core.tokenmanager.url.md) |  | string |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [getToken()](./ibm-cloud-sdk-core.tokenmanager.gettoken.md) |  | Retrieve a new token using <code>requestToken()</code> in the case there is not a currently stored token from a previous call, or the previous token has expired. |
+|  [pacedRequestToken()](./ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md) |  | Paces requests to request\_token.<!-- -->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. |
+|  [requestToken()](./ibm-cloud-sdk-core.tokenmanager.requesttoken.md) |  | Request a token using an API endpoint. |
+|  [saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md) |  | 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) |  | Setter for the disableSslVerification property. |
+|  [setHeaders(headers)](./ibm-cloud-sdk-core.tokenmanager.setheaders.md) |  | Set a completely new set of headers. |
+

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 request\_token.
+
+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.
+
+<b>Signature:</b>
+
+```typescript
+protected pacedRequestToken(): Promise<any>;
+```
+<b>Returns:</b>
+
+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
+
+<b>Signature:</b>
+
+```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.
+
+<b>Signature:</b>
+
+```typescript
+protected requestToken(): Promise<any>;
+```
+<b>Returns:</b>
+
+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
+
+<b>Signature:</b>
+
+```typescript
+protected requestWrapperInstance: RequestWrapper;
+```

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

@@ -0,0 +1,26 @@
+<!-- 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`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+protected saveTokenInfo(tokenResponse: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  tokenResponse | any | Response object from a token service request  |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

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

@@ -0,0 +1,26 @@
+<!-- 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
+
+Setter for the disableSslVerification property.
+
+<b>Signature:</b>
+
+```typescript
+setDisableSslVerification(value: boolean): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  value | boolean | the new value for the disableSslVerification property |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

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

@@ -0,0 +1,26 @@
+<!-- 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
+
+Set a completely new set of headers.
+
+<b>Signature:</b>
+
+```typescript
+setHeaders(headers: OutgoingHttpHeaders): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  headers | OutgoingHttpHeaders | the new set of headers as an object |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

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

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

@@ -0,0 +1,18 @@
+<!-- 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.
+
+<b>Signature:</b>
+
+```typescript
+export type TokenManagerOptions = {
+    url?: string;
+    headers?: OutgoingHttpHeaders;
+    disableSslVerification?: boolean;
+    [propName: string]: any;
+};
+```

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

@@ -0,0 +1,20 @@
+<!-- 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\]\].
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: BaseOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | BaseOptions | Configuration options. |
+

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

@@ -0,0 +1,26 @@
+<!-- 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 `request`<!-- -->. The bearer token information will be set in the Authorization property of`request.headers` in the form:
+
+Authorization: Bearer <bearer-token>
+
+<b>Signature:</b>
+
+```typescript
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  requestOptions | AuthenticateOptions | The request to augment with authentication information. |
+
+<b>Returns:</b>
+
+Promise&lt;void&gt;
+

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

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

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

@@ -0,0 +1,42 @@
+<!-- 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. \[\[TokenRequestBasedAuthenticator\]\]s use token managers to retrieve, store, and refresh tokens. Not intended to be used as stand-alone authenticator, but as parent class to authenticators that have their own token manager implementations.
+
+The tokens will be added as an Authorization headers in the form:
+
+Authorization: Bearer <bearer-token>
+
+<b>Signature:</b>
+
+```typescript
+export declare class TokenRequestBasedAuthenticator extends Authenticator 
+```
+<b>Extends:</b> [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator._constructor_.md) |  | Create a new \[\[TokenRequestBasedAuthenticator\]\] instance with an internal \[\[JwtTokenManager\]\]. |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [disableSslVerification](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.disablesslverification.md) |  | boolean |  |
+|  [headers](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.headers.md) |  | OutgoingHttpHeaders |  |
+|  [tokenManager](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.tokenmanager.md) |  | [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) |  |
+|  [url](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.url.md) |  | string |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md) |  | Adds bearer token information to <code>request</code>. The bearer token information will be set in the Authorization property of<code>request.headers</code> in the form:<!-- -->Authorization: Bearer <bearer-token> |
+|  [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. |
+

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

@@ -0,0 +1,24 @@
+<!-- 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.
+
+<b>Signature:</b>
+
+```typescript
+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. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -0,0 +1,24 @@
+<!-- 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.
+
+<b>Signature:</b>
+
+```typescript
+setHeaders(headers: OutgoingHttpHeaders): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  headers | OutgoingHttpHeaders | Default headers to be sent with every Cloud Pak For Data token request. Overwrites previous default headers. |
+
+<b>Returns:</b>
+
+void
+

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

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

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

@@ -0,0 +1,26 @@
+<!-- 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
+
+<b>Signature:</b>
+
+```typescript
+export declare function toLowerKeys(obj: Object): Object;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  obj | Object | The object to convert the keys of. |
+
+<b>Returns:</b>
+
+Object
+
+{<!-- -->Object<!-- -->}
+

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

@@ -0,0 +1,26 @@
+<!-- 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; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [checkForSuccessfulExecution](./ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.md)
+
+## unitTestUtils.checkForSuccessfulExecution() function
+
+This method simply ensures that the method executed without any issues by extracting the argument from the mock object for the `createRequest` method and verifying that it is an object.
+
+<b>Signature:</b>
+
+```typescript
+export declare function checkForSuccessfulExecution(createRequestMock: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  createRequestMock | any | the jest mock object for the <code>createRequest</code> method in the <code>RequestWrapper</code> class |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

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

@@ -0,0 +1,28 @@
+<!-- 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; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [checkMediaHeaders](./ibm-cloud-sdk-core.unittestutils.checkmediaheaders.md)
+
+## unitTestUtils.checkMediaHeaders() function
+
+Takes the mock object for the `createRequest` method, extracts the headers that were sent with the call, and checks for the expected values for `Accept` and `Content-Type`<!-- -->. This to verify that the SDK sets the correct values in the code.
+
+<b>Signature:</b>
+
+```typescript
+export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
+```
+
+## 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 |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

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

@@ -0,0 +1,28 @@
+<!-- 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; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [checkUrlAndMethod](./ibm-cloud-sdk-core.unittestutils.checkurlandmethod.md)
+
+## unitTestUtils.checkUrlAndMethod() function
+
+Takes the request options constructed by the SDK and checks that the `url` and `method` properties were set to their correct values.
+
+<b>Signature:</b>
+
+```typescript
+export declare function checkUrlAndMethod(options: any, url: string, method: any): void;
+```
+
+## 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 |  |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

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

@@ -0,0 +1,28 @@
+<!-- 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; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [checkUserHeader](./ibm-cloud-sdk-core.unittestutils.checkuserheader.md)
+
+## unitTestUtils.checkUserHeader() function
+
+Takes the mock object for the `createRequest` method, extracts the headers that were sent with the call, and checks for the expected value for a user-defined header. This is verify that the SDK accepts header parameters and sends them as headers in the request.
+
+<b>Signature:</b>
+
+```typescript
+export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
+```
+
+## 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 |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

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

@@ -0,0 +1,26 @@
+<!-- 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; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [expectToBePromise](./ibm-cloud-sdk-core.unittestutils.expecttobepromise.md)
+
+## unitTestUtils.expectToBePromise() function
+
+This method simply ensures that the SDK methods return Promises by checking for the `then` function - common way to assess whether or not an object is a Promise.
+
+<b>Signature:</b>
+
+```typescript
+export declare function expectToBePromise(sdkPromise: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  sdkPromise | any | the Promise returned by an SDK method |
+
+<b>Returns:</b>
+
+void
+
+{<!-- -->void<!-- -->}
+

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

@@ -0,0 +1,26 @@
+<!-- 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; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md) &gt; [getOptions](./ibm-cloud-sdk-core.unittestutils.getoptions.md)
+
+## unitTestUtils.getOptions() function
+
+This method extracts the `options` property from the object passed into `createRequest`<!-- -->. This property is an object containing all of the SDK method-specific information (like `path` and `body`<!-- -->) used to build a request. This method is just a convenience method for the unit tests to be able to make assertions on the items in the request.
+
+<b>Signature:</b>
+
+```typescript
+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 |
+
+<b>Returns:</b>
+
+any
+
+{<!-- -->Object<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.unittestutils.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; [unitTestUtils](./ibm-cloud-sdk-core.unittestutils.md)
+
+## unitTestUtils namespace
+
+## Functions
+
+|  Function | Description |
+|  --- | --- |
+|  [checkForSuccessfulExecution(createRequestMock)](./ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.md) | This method simply ensures that the method executed without any issues by extracting the argument from the mock object for the <code>createRequest</code> method and verifying that it is an object. |
+|  [checkMediaHeaders(createRequestMock, accept, contentType)](./ibm-cloud-sdk-core.unittestutils.checkmediaheaders.md) | Takes the mock object for the <code>createRequest</code> method, extracts the headers that were sent with the call, and checks for the expected values for <code>Accept</code> and <code>Content-Type</code>. This to verify that the SDK sets the correct values in the code. |
+|  [checkUrlAndMethod(options, url, method)](./ibm-cloud-sdk-core.unittestutils.checkurlandmethod.md) | Takes the request options constructed by the SDK and checks that the <code>url</code> and <code>method</code> properties were set to their correct values. |
+|  [checkUserHeader(createRequestMock, userHeaderName, userHeaderValue)](./ibm-cloud-sdk-core.unittestutils.checkuserheader.md) | Takes the mock object for the <code>createRequest</code> method, extracts the headers that were sent with the call, and checks for the expected value for a user-defined header. This is verify that the SDK accepts header parameters and sends them as headers in the request. |
+|  [expectToBePromise(sdkPromise)](./ibm-cloud-sdk-core.unittestutils.expecttobepromise.md) | This method simply ensures that the SDK methods return Promises by checking for the <code>then</code> function - common way to assess whether or not an object is a Promise. |
+|  [getOptions(createRequestMock)](./ibm-cloud-sdk-core.unittestutils.getoptions.md) | This method extracts the <code>options</code> property from the object passed into <code>createRequest</code>. This property is an object containing all of the SDK method-specific information (like <code>path</code> and <code>body</code>) used to build a request. This method is just a convenience method for the unit tests to be able to make assertions on the items in the request. |
+

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

@@ -0,0 +1,13 @@
+<!-- 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
+
+<b>Signature:</b>
+
+```typescript
+authenticator?: AuthenticatorInterface;
+```