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

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

import { EntityBase } from '../entity-base';
import { ODataDeleteRequestConfig } from '../request';
import { MethodRequestBuilder } from './request-builder-base';
import type { HttpDestinationOrFetchOptions } from '@sap-cloud-sdk/connectivity';
import type { HttpResponse } from '@sap-cloud-sdk/http-client';
import type { EntityIdentifiable } from '../entity-base';
import type { ODataUri } from '../uri-conversion';
import type { DeSerializers } from '../de-serializers';
import type { EntityApi } from '../entity-api';
import type { BatchReference, WithBatchReference } from '../request';
/**
 * Abstract class to delete an entity holding the shared parts between OData v2 and v4.
 * @typeParam EntityT - Type of the entity to be deleted
 */
export declare abstract class DeleteRequestBuilderBase<EntityT extends EntityBase, DeSerializersT extends DeSerializers> extends MethodRequestBuilder<ODataDeleteRequestConfig<EntityT, DeSerializersT>> implements EntityIdentifiable<EntityT, DeSerializersT>, WithBatchReference {
    readonly _entityApi: EntityApi<EntityT, DeSerializersT>;
    readonly _entity: EntityT;
    readonly _deSerializers: DeSerializersT;
    private _batchReference;
    /**
     * Creates an instance of DeleteRequestBuilder. If the entity is passed, version identifier will also be added.
     * @param _entityApi - Entity API for building and executing the request.
     * @param oDataUri - URI conversion functions.
     * @param keysOrEntity - Entity or key-value pairs of key properties for the given entity.
     */
    constructor(_entityApi: EntityApi<EntityT, DeSerializersT>, oDataUri: ODataUri<DeSerializersT>, keysOrEntity: Record<string, any> | EntityBase);
    /**
     * Gets identifier for the batch request.
     * @returns Batch request identifier.
     */
    getBatchReference(): BatchReference;
    /**
     * Sets user-defined identifier for the batch reference.
     * @param id - User-defined batch request identifier.
     */
    setBatchId(id: string): void;
    /**
     * Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.
     * @returns The request itself to ease chaining while executing the request.
     */
    ignoreVersionIdentifier(): this;
    /**
     * Execute query.
     * @param destination - Destination or DestinationFetchOptions to execute the request against.
     * @returns A promise resolving once the entity was deleted.
     */
    execute(destination: HttpDestinationOrFetchOptions): Promise<void>;
    /**
     * Execute request and return an {@link @sap-cloud-sdk/http-client!HttpResponse}.
     * @param destination - Destination or DestinationFetchOptions to execute the request against.
     * @returns A promise resolving to an {@link @sap-cloud-sdk/http-client!HttpResponse}.
     */
    executeRaw(destination: HttpDestinationOrFetchOptions): Promise<HttpResponse>;
    abstract setVersionIdentifier(eTag: string): this;
}