@sap-cloud-sdk/odata-v4
Version:
SAP Cloud SDK for JavaScript common functions of OData client generator and OpenAPI clint generator.
32 lines (31 loc) • 1.76 kB
TypeScript
import { UpdateRequestBuilderBase } from '@sap-cloud-sdk/odata-common/internal';
import type { HttpDestinationOrFetchOptions } from '@sap-cloud-sdk/connectivity';
import type { HttpResponse } from '@sap-cloud-sdk/http-client';
import type { EntityIdentifiable, EntityApi } from '@sap-cloud-sdk/odata-common/internal';
import type { Entity } from '../entity';
import type { DefaultDeSerializers, DeSerializers } from '../de-serializers';
/**
* Create OData query to update an entity.
* @typeParam EntityT - Type of the entity to be updated.
*/
export declare class UpdateRequestBuilder<EntityT extends Entity, DeSerializersT extends DeSerializers = DefaultDeSerializers> extends UpdateRequestBuilderBase<EntityT, DeSerializersT> implements EntityIdentifiable<EntityT, DeSerializersT> {
readonly _entity: EntityT;
/**
* Creates an instance of UpdateRequestBuilder.
* @param entityApi - Entity API for building and executing the request.
* @param _entity - Entity to be updated.
*/
constructor(entityApi: EntityApi<EntityT, DeSerializersT>, _entity: EntityT);
/**
* Executes the query.
* @param destination - Destination or DestinationFetchOptions to execute the request against.
* @returns A promise resolving to the entity once it was updated.
*/
execute(destination: HttpDestinationOrFetchOptions): Promise<EntityT>;
/**
* 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>;
}