ibm-cloud-sdk-core 4.3.3 → 5.0.0

package/temp/ibm-cloud-sdk-core.api.json

@@ -7405,384 +7405,6 @@
           ],
           "name": "toLowerKeys"
         },
-        {
-          "kind": "Namespace",
-          "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils:namespace",
-          "docComment": "",
-          "excerptTokens": [],
-          "fileUrlPath": "dist/es/index.d.ts",
-          "releaseTag": "None",
-          "name": "unitTestUtils",
-          "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "Function",
-              "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.checkForSuccessfulExecution:function(1)",
-              "docComment": "/**\n * 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.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "export declare function checkForSuccessfulExecution(createRequestMock: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
-              "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "createRequestMock",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                }
-              ],
-              "name": "checkForSuccessfulExecution"
-            },
-            {
-              "kind": "Function",
-              "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.checkMediaHeaders:function(1)",
-              "docComment": "/**\n * 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.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n *\n * @param accept - the expected value for the `Accept` header\n *\n * @param contentType - the expected value for the `Content-Type` header\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "export declare function checkMediaHeaders(createRequestMock: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", accept: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", contentType: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
-              "returnTypeTokenRange": {
-                "startIndex": 7,
-                "endIndex": 8
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "createRequestMock",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "accept",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 3,
-                    "endIndex": 4
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "contentType",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 5,
-                    "endIndex": 6
-                  },
-                  "isOptional": false
-                }
-              ],
-              "name": "checkMediaHeaders"
-            },
-            {
-              "kind": "Function",
-              "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.checkUrlAndMethod:function(1)",
-              "docComment": "/**\n * Takes the request options constructed by the SDK and checks that the `url` and `method` properties were set to their correct values.\n *\n * @param options - the options object put together by the SDK, retrieved from the createRequest mock\n *\n * @param url - The URL path of the service endpoint, from the paths section of the API definition\n *\n * @param method - The HTTP method for the request, from the API definition\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "export declare function checkUrlAndMethod(options: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", url: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", method: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
-              "returnTypeTokenRange": {
-                "startIndex": 7,
-                "endIndex": 8
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "options",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "url",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 3,
-                    "endIndex": 4
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "method",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 5,
-                    "endIndex": 6
-                  },
-                  "isOptional": false
-                }
-              ],
-              "name": "checkUrlAndMethod"
-            },
-            {
-              "kind": "Function",
-              "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.checkUserHeader:function(1)",
-              "docComment": "/**\n * 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.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n *\n * @param userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`\n *\n * @param userHeaderValue - the expected value for the header passed by the user\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "export declare function checkUserHeader(createRequestMock: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", userHeaderName: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", userHeaderValue: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
-              "returnTypeTokenRange": {
-                "startIndex": 7,
-                "endIndex": 8
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "createRequestMock",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "userHeaderName",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 3,
-                    "endIndex": 4
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "userHeaderValue",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 5,
-                    "endIndex": 6
-                  },
-                  "isOptional": false
-                }
-              ],
-              "name": "checkUserHeader"
-            },
-            {
-              "kind": "Function",
-              "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.expectToBePromise:function(1)",
-              "docComment": "/**\n * 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.\n *\n * @param sdkPromise - the Promise returned by an SDK method\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "export declare function expectToBePromise(sdkPromise: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
-              "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "sdkPromise",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                }
-              ],
-              "name": "expectToBePromise"
-            },
-            {
-              "kind": "Function",
-              "canonicalReference": "ibm-cloud-sdk-core!unitTestUtils.getOptions:function(1)",
-              "docComment": "/**\n * 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.\n *\n * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class\n *\n * @returns Object\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "export declare function getOptions(createRequestMock: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "fileUrlPath": "dist/es/lib/sdk-test-helpers.d.ts",
-              "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "createRequestMock",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                }
-              ],
-              "name": "getOptions"
-            }
-          ]
-        },
         {
           "kind": "Interface",
           "canonicalReference": "ibm-cloud-sdk-core!UserOptions:interface",

package/temp/ibm-cloud-sdk-core.api.md

@@ -105,18 +105,6 @@ export function buildRequestFileObject(fileParam: FileWithMetadata): Promise<Fil
 // @public
 export function checkCredentials(obj: any, credsToCheck: string[]): Error | null;
 
-// @public
-function checkForSuccessfulExecution(createRequestMock: any): void;
-
-// @public
-function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
-
-// @public
-function checkUrlAndMethod(options: any, url: string, method: any): void;
-
-// @public
-function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
-
 // @public
 export class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator {
     // Warning: (ae-forgotten-export) The symbol "Options_4" needs to be exported by the entry point index.d.ts
@@ -176,9 +164,6 @@ export class Cp4dTokenManager extends JwtTokenManager {
     protected requiredOptions: string[];
 }
 
-// @public
-function expectToBePromise(sdkPromise: any): void;
-
 // @public (undocumented)
 export function fileExistsAtPath(filepath: string): boolean;
 
@@ -236,9 +221,6 @@ export function getMissingParams(params: {
 // @public
 export function getNewLogger(moduleName: string): SDKLogger;
 
-// @public
-function getOptions(createRequestMock: any): any;
-
 // @public
 export function getQueryParam(urlStr: string, param: string): string;
 
@@ -458,18 +440,6 @@ export class TokenRequestBasedAuthenticator extends Authenticator {
 // @public
 export function toLowerKeys(obj: Object): Object;
 
-declare namespace unitTestUtils {
-    export {
-        checkUrlAndMethod,
-        checkMediaHeaders,
-        checkUserHeader,
-        checkForSuccessfulExecution,
-        getOptions,
-        expectToBePromise
-    }
-}
-export { unitTestUtils }
-
 // @public
 export interface UserOptions {
     [propName: string]: any;

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

@@ -1,53 +0,0 @@
-<!-- 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

@@ -1,85 +0,0 @@
-<!-- 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

@@ -1,85 +0,0 @@
-<!-- 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
-