@sap-cloud-sdk/odata-common/dist/request-builder/request-builder-base.d.ts

SAP Cloud SDK for JavaScript common functions of OData client generator and OpenAPI clint generator.

import { ODataRequest } from '../request';
import type { HttpDestinationOrFetchOptions } from '@sap-cloud-sdk/connectivity';
import type { HttpMiddleware } from '@sap-cloud-sdk/http-client/internal';
import type { CustomRequestConfig } from '@sap-cloud-sdk/http-client';
import type { ODataRequestConfig } from '../request';
/**
 * Base class for all request builders.
 * @typeParam EntityT - Type of the entity to create a request for.
 * @internal
 */
export declare abstract class MethodRequestBuilder<RequestConfigT extends ODataRequestConfig = any> {
    requestConfig: RequestConfigT;
    /**
     * Creates an instance of MethodRequestBuilder.
     * @param requestConfig - Request configuration to initialize with.
     */
    constructor(requestConfig: RequestConfigT);
    /**
     * Create the URL based on configuration of the given builder.
     * @param destination - Destination or DestinationFetchOptions to execute the request against.
     * @returns Promise resolving to the URL for the request.
     */
    url(destination: HttpDestinationOrFetchOptions): Promise<string>;
    /**
     * Create the relative URL based on configuration of the given builder.
     * @returns The relative URL for the request.
     */
    relativeUrl(): string;
    /**
     * Add custom headers to the request. Existing headers will be overwritten.
     * @param headers - Key-value pairs denoting additional custom headers.
     * @returns The request builder itself, to facilitate method chaining.
     */
    addCustomHeaders(headers: Record<string, string>): this;
    /**
     * Set middleware for requests towards the target system given in the destination.
     * @param middlewares - Middlewares to be applied to the executeHttpRequest().
     * @returns The request builder itself, to facilitate method chaining.
     */
    middleware(middlewares: HttpMiddleware | HttpMiddleware[]): this;
    middleware(...middlewares: HttpMiddleware[]): this;
    /**
     * Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
     * @param queryParameters - Key-value pairs denoting additional custom query parameters to be set in the request.
     * @returns The request builder itself, to facilitate method chaining.
     */
    addCustomQueryParameters(queryParameters: Record<string, string>): this;
    /**
     * Replace the default service path with the given custom path.
     * In case of the SAP S/4HANA APIs the basePath defaults to `/sap/opu/odata/sap/<SERVICE_NAME>` and can be overwritten here.
     * @param basePath - Path to override the default with.
     * @returns The request builder itself, to facilitate method chaining.
     */
    setBasePath(basePath: string): this;
    /**
     * Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files.
     * If the custom request configuration contains {@link @sap-cloud-sdk/http-client!defaultDisallowedKeys | disallowed keys}, those will be ignored.
     * @param requestConfiguration - Key-value pairs denoting additional custom request configuration options to be set in the request.
     * @returns The request builder itself, to facilitate method chaining.
     */
    addCustomRequestConfiguration(requestConfiguration: CustomRequestConfig): this;
    /**
     * Append the given path to the URL.
     * This can be used for querying navigation properties of an entity.
     * To execute a request with an appended path use `executeRaw` to avoid errors during deserialization. When using this, the `execute` method is omitted from the return type.
     * @param path - Path to be appended.
     * @returns The request builder itself without "execute" function, to facilitate method chaining.
     */
    appendPath(...path: string[]): Omit<this, 'execute'>;
    /**
     * Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
     * @returns The request builder itself, to facilitate method chaining.
     */
    skipCsrfTokenFetching(): this;
    protected build(): ODataRequest<RequestConfigT>;
    protected build(destination: HttpDestinationOrFetchOptions): Promise<ODataRequest<RequestConfigT>>;
}