/**
 * (C) Copyright IBM Corp. 2019, 2022.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 * This module provides a set of helper methods used to reduce code duplication in the generated unit tests
 * for the SDKs that depend on this core package. Note that these methods are not used by the tests for this
 * package - they are meant to be exported and made available to dependent libraries.
 */
/**
 * Takes the request options constructed by the SDK and checks that the `url` and `method` properties
 * were set to their correct values.
 *
 * @param options - the options object put together by the SDK, retrieved from the createRequest mock
 * @param url - The URL path of the service endpoint, from the paths section of the API definition
 * @param method - The HTTP method for the request, from the API definition
 */
export declare function checkUrlAndMethod(options: any, url: string, method: any): void;
/**
 * 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.
 *
 * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
 * @param accept - the expected value for the `Accept` header
 * @param contentType - the expected value for the `Content-Type` header
 */
export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
/**
 * 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.
 *
 * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
 * @param userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`
 * @param userHeaderValue - the expected value for the header passed by the user
 */
export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
/**
 * 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.
 *
 * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
 */
export declare function checkForSuccessfulExecution(createRequestMock: any): void;
/**
 * 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.
 *
 * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
 * @returns Object
 */
export declare function getOptions(createRequestMock: any): any;
/**
 * 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.
 *
 * @param sdkPromise - the Promise returned by an SDK method
 */
export declare function expectToBePromise(sdkPromise: any): void;