ibm-cloud-sdk-core 4.3.2-beta-2 → 4.3.2

package/build/docs/ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.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; [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.
+
+**Signature:**
+
+```typescript
+export declare function checkForSuccessfulExecution(createRequestMock: any): void;
+```
+
+## Parameters
+
+<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

@@ -0,0 +1,85 @@
+<!-- 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.
+
+**Signature:**
+
+```typescript
+export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
+```
+
+## Parameters
+
+<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

@@ -0,0 +1,85 @@
+<!-- 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.
+
+**Signature:**
+
+```typescript
+export declare function checkUrlAndMethod(options: any, url: string, method: any): void;
+```
+
+## Parameters
+
+<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

@@ -0,0 +1,85 @@
+<!-- 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.
+
+**Signature:**
+
+```typescript
+export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
+```
+
+## Parameters
+
+<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

@@ -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; [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.
+
+**Signature:**
+
+```typescript
+export declare function expectToBePromise(sdkPromise: any): void;
+```
+
+## Parameters
+
+<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

@@ -0,0 +1,55 @@
+<!-- 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.
+
+**Signature:**
+
+```typescript
+export declare function getOptions(createRequestMock: any): any;
+```
+
+## Parameters
+
+<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
+
+Object
+

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

@@ -0,0 +1,86 @@
+<!-- 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
+
+<table><thead><tr><th>
+
+Function
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[checkForSuccessfulExecution(createRequestMock)](./ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.md)
+
+
+</td><td>
+
+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.
+
+
+</td></tr>
+<tr><td>
+
+[checkMediaHeaders(createRequestMock, accept, contentType)](./ibm-cloud-sdk-core.unittestutils.checkmediaheaders.md)
+
+
+</td><td>
+
+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.
+
+
+</td></tr>
+<tr><td>
+
+[checkUrlAndMethod(options, url, method)](./ibm-cloud-sdk-core.unittestutils.checkurlandmethod.md)
+
+
+</td><td>
+
+Takes the request options constructed by the SDK and checks that the `url` and `method` properties were set to their correct values.
+
+
+</td></tr>
+<tr><td>
+
+[checkUserHeader(createRequestMock, userHeaderName, userHeaderValue)](./ibm-cloud-sdk-core.unittestutils.checkuserheader.md)
+
+
+</td><td>
+
+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.
+
+
+</td></tr>
+<tr><td>
+
+[expectToBePromise(sdkPromise)](./ibm-cloud-sdk-core.unittestutils.expecttobepromise.md)
+
+
+</td><td>
+
+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.
+
+
+</td></tr>
+<tr><td>
+
+[getOptions(createRequestMock)](./ibm-cloud-sdk-core.unittestutils.getoptions.md)
+
+
+</td><td>
+
+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.
+
+
+</td></tr>
+</tbody></table>

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
+
+**Signature:**
+
+```typescript
+authenticator?: AuthenticatorInterface;
+```

package/build/docs/ibm-cloud-sdk-core.useroptions.disablesslverification.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; [disableSslVerification](./ibm-cloud-sdk-core.useroptions.disablesslverification.md)
+
+## UserOptions.disableSslVerification property
+
+Set to `true` to allow unauthorized requests - not recommended for production use.
+
+**Signature:**
+
+```typescript
+disableSslVerification?: boolean;
+```

package/build/docs/ibm-cloud-sdk-core.useroptions.headers.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; [headers](./ibm-cloud-sdk-core.useroptions.headers.md)
+
+## UserOptions.headers property
+
+Default headers that shall be included with every request to the service.
+
+**Signature:**
+
+```typescript
+headers?: OutgoingHttpHeaders;
+```

package/build/docs/ibm-cloud-sdk-core.useroptions.jar.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; [jar](./ibm-cloud-sdk-core.useroptions.jar.md)
+
+## UserOptions.jar property
+
+Set your own cookie jar object
+
+**Signature:**
+
+```typescript
+jar?: CookieJar | boolean;
+```