@algolia/client-common 5.55.2 → 5.57.0

package/dist/common.d.cts

@@ -1,3 +1,96 @@
+type Headers = Record<string, string>;
+type QueryParameters = Record<string, any>;
+/**
+ * The method of the request.
+ */
+type Method = 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT';
+type Request = {
+    method: Method;
+    /**
+     * The path of the REST API to send the request to.
+     */
+    path: string;
+    queryParameters: QueryParameters;
+    data?: Array<Record<string, any>> | Record<string, any> | undefined;
+    headers: Headers;
+    /**
+     * If the given request should persist on the cache. Keep in mind,
+     * that some methods may have this option enabled by default.
+     */
+    cacheable?: boolean | undefined;
+    /**
+     * Some POST methods in the Algolia REST API uses the `read` transporter.
+     * This information is defined at the spec level.
+     */
+    useReadTransporter?: boolean | undefined;
+};
+type EndRequest = Pick<Request, 'headers' | 'method'> & {
+    /**
+     * The full URL of the REST API.
+     */
+    url: string;
+    /**
+     * The connection timeout, in milliseconds.
+     */
+    connectTimeout: number;
+    /**
+     * The response timeout, in milliseconds.
+     */
+    responseTimeout: number;
+    data?: string | Uint8Array | undefined;
+};
+type Response = {
+    /**
+     * The body of the response.
+     */
+    content: string;
+    /**
+     * The headers of the response, with lower-cased names. Optional so that custom requesters that
+     * don't capture headers remain valid, in which case the `WithHTTPInfo` methods expose no headers.
+     */
+    headers?: Headers | undefined;
+    /**
+     * Whether the API call is timed out or not.
+     */
+    isTimedOut: boolean;
+    /**
+     * The HTTP status code of the response.
+     */
+    status: number;
+};
+type Requester = {
+    /**
+     * Sends the given `request` to the server.
+     */
+    send: (request: EndRequest) => Promise<Response>;
+    /**
+     * Sends the given `request` and returns a raw byte stream for streaming responses (e.g. SSE).
+     */
+    sendStream?: (request: EndRequest) => Promise<ReadableStream<Uint8Array>>;
+};
+
+/**
+ * The full HTTP response of an API call, as returned by the `WithHTTPInfo` variant of each method.
+ */
+type AlgoliaHttpResponse<TData> = {
+    /**
+     * The HTTP status code of the response.
+     */
+    status: number;
+    /**
+     * The headers of the response, with lower-cased names. Undefined when the requester does not capture headers.
+     */
+    headers?: Headers | undefined;
+    /**
+     * The raw body of the response.
+     */
+    content: string;
+    /**
+     * The deserialized body of the response.
+     */
+    data: TData;
+};
+
 type Cache = {
     /**
      * Gets the value of the given `key`.
@@ -169,75 +262,13 @@ type Logger = {
      */
     info: (message: string, args?: any | undefined) => Promise<void>;
     /**
-     * Logs error messages.
-     */
-    error: (message: string, args?: any | undefined) => Promise<void>;
-};
-
-type Headers = Record<string, string>;
-type QueryParameters = Record<string, any>;
-/**
- * The method of the request.
- */
-type Method = 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT';
-type Request = {
-    method: Method;
-    /**
-     * The path of the REST API to send the request to.
-     */
-    path: string;
-    queryParameters: QueryParameters;
-    data?: Array<Record<string, any>> | Record<string, any> | undefined;
-    headers: Headers;
-    /**
-     * If the given request should persist on the cache. Keep in mind,
-     * that some methods may have this option enabled by default.
+     * Logs warning messages. When not implemented, warnings fall back to `console.warn` so they stay visible with the default no-op logger.
      */
-    cacheable?: boolean | undefined;
+    warn?: (message: string, args?: any | undefined) => Promise<void>;
     /**
-     * Some POST methods in the Algolia REST API uses the `read` transporter.
-     * This information is defined at the spec level.
-     */
-    useReadTransporter?: boolean | undefined;
-};
-type EndRequest = Pick<Request, 'headers' | 'method'> & {
-    /**
-     * The full URL of the REST API.
-     */
-    url: string;
-    /**
-     * The connection timeout, in milliseconds.
-     */
-    connectTimeout: number;
-    /**
-     * The response timeout, in milliseconds.
-     */
-    responseTimeout: number;
-    data?: string | Uint8Array | undefined;
-};
-type Response = {
-    /**
-     * The body of the response.
-     */
-    content: string;
-    /**
-     * Whether the API call is timed out or not.
-     */
-    isTimedOut: boolean;
-    /**
-     * The HTTP status code of the response.
-     */
-    status: number;
-};
-type Requester = {
-    /**
-     * Sends the given `request` to the server.
-     */
-    send: (request: EndRequest) => Promise<Response>;
-    /**
-     * Sends the given `request` and returns a raw byte stream for streaming responses (e.g. SSE).
+     * Logs error messages.
      */
-    sendStream?: (request: EndRequest) => Promise<ReadableStream<Uint8Array>>;
+    error: (message: string, args?: any | undefined) => Promise<void>;
 };
 
 type RequestOptions = Pick<Request, 'cacheable'> & {
@@ -374,6 +405,12 @@ type TransporterOptions = {
      */
     compress?: (data: string) => Promise<Uint8Array>;
     compression?: 'gzip';
+    /**
+     * Where the generated Request-ID is sent: as the `Request-ID` header, or as the
+     * `x-algolia-request-id` query parameter. When undefined, no Request-ID is sent.
+     * A caller-supplied Request-ID is never overwritten.
+     */
+    requestIdChannel?: 'headers' | 'queryParameters' | undefined;
 };
 type Transporter = TransporterOptions & {
     /**
@@ -383,6 +420,18 @@ type Transporter = TransporterOptions & {
     request: <TResponse>(baseRequest: Request, baseRequestOptions?: RequestOptions) => Promise<TResponse>;
     requestStream: (baseRequest: Request, baseRequestOptions?: RequestOptions) => AsyncGenerator<ServerSentEvent>;
 };
+/**
+ * The transporter returned by `createTransporter`. Kept separate from `Transporter` so that
+ * existing implementations of `Transporter` remain type-valid.
+ */
+type TransporterWithHttpInfo = Transporter & {
+    /**
+     * Performs a request and returns the full HTTP response information — status code,
+     * headers (when the requester captures them), raw body and deserialized data.
+     * Both the requests and the responses caches are bypassed: it always hits the network.
+     */
+    requestWithHttpInfo: <TData>(baseRequest: Request, baseRequestOptions?: RequestOptions) => Promise<AlgoliaHttpResponse<TData>>;
+};
 
 type AuthMode = 'WithinHeaders' | 'WithinQueryParameters';
 type OverriddenTransporterOptions = 'baseHeaders' | 'baseQueryParameters' | 'hosts';
@@ -474,11 +523,16 @@ declare function getAlgoliaAgent({ algoliaAgents, client, version }: GetAlgoliaA
 
 declare function createNullLogger(): Logger;
 
+/**
+ * Prefers the logger's optional `warn` method and falls back to `console.warn`, so warnings stay visible with the default no-op logger.
+ */
+declare function logWarning(logger: Logger, message: string): void;
+
 declare const COMPRESSION_THRESHOLD = 750;
 
 declare function createStatefulHost(host: Host, status?: StatefulHost['status']): StatefulHost;
 
-declare function createTransporter({ hosts, hostsCache, baseHeaders, logger, baseQueryParameters, algoliaAgent, timeouts, requester, requestsCache, responsesCache, compress, compression, }: TransporterOptions): Transporter;
+declare function createTransporter({ hosts, hostsCache, baseHeaders, logger, baseQueryParameters, algoliaAgent, timeouts, requester, requestsCache, responsesCache, compress, compression, requestIdChannel, }: TransporterOptions): TransporterWithHttpInfo;
 
 declare class AlgoliaError extends Error {
     name: string;
@@ -495,18 +549,20 @@ declare class IndexAlreadyExistsError extends AlgoliaError {
 }
 declare class ErrorWithStackTrace extends AlgoliaError {
     stackTrace: StackFrame[];
-    constructor(message: string, stackTrace: StackFrame[], name: string);
+    correlationId?: string | undefined;
+    constructor(message: string, stackTrace: StackFrame[], name: string, correlationId?: string | undefined);
 }
 declare class RetryError extends ErrorWithStackTrace {
-    constructor(stackTrace: StackFrame[]);
+    constructor(stackTrace: StackFrame[], correlationId?: string | undefined);
 }
 declare class ApiError extends ErrorWithStackTrace {
     status: number;
-    constructor(message: string, status: number, stackTrace: StackFrame[], name?: string);
+    constructor(message: string, status: number, stackTrace: StackFrame[], name?: string, correlationId?: string | undefined);
 }
 declare class DeserializationError extends AlgoliaError {
     response: Response;
-    constructor(message: string, response: Response);
+    correlationId?: string | undefined;
+    constructor(message: string, response: Response, correlationId?: string | undefined);
 }
 type DetailedErrorWithMessage = {
     message: string;
@@ -523,7 +579,7 @@ type DetailedError = {
 };
 declare class DetailedApiError extends ApiError {
     error: DetailedError;
-    constructor(message: string, status: number, error: DetailedError, stackTrace: StackFrame[]);
+    constructor(message: string, status: number, error: DetailedError, stackTrace: StackFrame[], correlationId?: string | undefined);
 }
 
 declare function shuffle<TData>(array: TData[]): TData[];
@@ -532,7 +588,19 @@ declare function serializeQueryParameters(parameters: QueryParameters): string;
 declare function serializeData(request: Request, requestOptions: RequestOptions): string | undefined;
 declare function serializeHeaders(baseHeaders: Headers, requestHeaders: Headers, requestOptionsHeaders?: Headers | undefined): Headers;
 declare function deserializeSuccess<TObject>(response: Response): TObject;
-declare function deserializeFailure({ content, status }: Response, stackFrame: StackFrame[]): Error;
+declare function deserializeSuccessWithHttpInfo<TData>(response: Response): AlgoliaHttpResponse<TData>;
+declare function getCorrelationId(headers: Headers | undefined): string | undefined;
+declare function getLastCorrelationId(stackTrace: StackFrame[]): string | undefined;
+declare function deserializeFailure(response: Response, stackFrame: StackFrame[]): Error;
+
+declare function generateRequestId(): string;
+/**
+ * Returns request options carrying a Request-ID on the transporter's channel, so that every
+ * request a multi-request helper performs shares the same ID. Returns the options unchanged
+ * when the channel is off or when a Request-ID is already supplied. Never apply ahead of a
+ * cacheable operation: the ID enters the cache key and defeats caching and deduplication.
+ */
+declare function withRequestId(transporter: Pick<Transporter, 'requestIdChannel' | 'baseHeaders' | 'baseQueryParameters'>, requestOptions?: RequestOptions | undefined): RequestOptions | undefined;
 
 declare function isNetworkError({ isTimedOut, status }: Omit<Response, 'content'>): boolean;
 declare function isRetryable({ isTimedOut, status }: Omit<Response, 'content'>): boolean;
@@ -543,4 +611,4 @@ declare function stackFrameWithoutCredentials(stackFrame: StackFrame): StackFram
 
 declare function validateRequired(field: string, method: string, value: unknown): void;
 
-export { type AlgoliaAgent, type AlgoliaAgentOptions, AlgoliaError, ApiError, type AuthMode, type BrowserLocalStorageCacheItem, type BrowserLocalStorageOptions, COMPRESSION_THRESHOLD, type Cache, type CacheEvents, type ChunkedHelperOptions, type ClientOptions, type CreateClientOptions, type CreateIterablePromise, DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES, DEFAULT_WRITE_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_NODE, DeserializationError, DetailedApiError, type DetailedError, type DetailedErrorWithMessage, type DetailedErrorWithTypeID, type EndRequest, ErrorWithStackTrace, type FallbackableCacheOptions, type GetAlgoliaAgent, type Headers, type Host, IndexAlreadyExistsError, IndexNotFoundError, IndicesInSameAppError, type IterableOptions, LogLevelEnum, type LogLevelType, type Logger, type MemoryCacheOptions, type Method, type QueryParameters, type Request, type RequestOptions, type Requester, type Response, RetryError, type ServerSentEvent, type StackFrame, type StatefulHost, type StreamEvent, type Timeouts, type Transporter, type TransporterOptions, createAlgoliaAgent, createAuth, createBrowserLocalStorageCache, createFallbackableCache, createIterablePromise, createMemoryCache, createNullCache, createNullLogger, createStatefulHost, createTransporter, deserializeFailure, deserializeSuccess, getAlgoliaAgent, isNetworkError, isRetryable, isSuccess, iterSSEEvents, serializeData, serializeHeaders, serializeQueryParameters, serializeUrl, shuffle, stackFrameWithoutCredentials, stackTraceWithoutCredentials, validateRequired };
+export { type AlgoliaAgent, type AlgoliaAgentOptions, AlgoliaError, type AlgoliaHttpResponse, ApiError, type AuthMode, type BrowserLocalStorageCacheItem, type BrowserLocalStorageOptions, COMPRESSION_THRESHOLD, type Cache, type CacheEvents, type ChunkedHelperOptions, type ClientOptions, type CreateClientOptions, type CreateIterablePromise, DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES, DEFAULT_WRITE_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_NODE, DeserializationError, DetailedApiError, type DetailedError, type DetailedErrorWithMessage, type DetailedErrorWithTypeID, type EndRequest, ErrorWithStackTrace, type FallbackableCacheOptions, type GetAlgoliaAgent, type Headers, type Host, IndexAlreadyExistsError, IndexNotFoundError, IndicesInSameAppError, type IterableOptions, LogLevelEnum, type LogLevelType, type Logger, type MemoryCacheOptions, type Method, type QueryParameters, type Request, type RequestOptions, type Requester, type Response, RetryError, type ServerSentEvent, type StackFrame, type StatefulHost, type StreamEvent, type Timeouts, type Transporter, type TransporterOptions, type TransporterWithHttpInfo, createAlgoliaAgent, createAuth, createBrowserLocalStorageCache, createFallbackableCache, createIterablePromise, createMemoryCache, createNullCache, createNullLogger, createStatefulHost, createTransporter, deserializeFailure, deserializeSuccess, deserializeSuccessWithHttpInfo, generateRequestId, getAlgoliaAgent, getCorrelationId, getLastCorrelationId, isNetworkError, isRetryable, isSuccess, iterSSEEvents, logWarning, serializeData, serializeHeaders, serializeQueryParameters, serializeUrl, shuffle, stackFrameWithoutCredentials, stackTraceWithoutCredentials, validateRequired, withRequestId };

package/dist/common.d.ts

@@ -1,3 +1,96 @@
+type Headers = Record<string, string>;
+type QueryParameters = Record<string, any>;
+/**
+ * The method of the request.
+ */
+type Method = 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT';
+type Request = {
+    method: Method;
+    /**
+     * The path of the REST API to send the request to.
+     */
+    path: string;
+    queryParameters: QueryParameters;
+    data?: Array<Record<string, any>> | Record<string, any> | undefined;
+    headers: Headers;
+    /**
+     * If the given request should persist on the cache. Keep in mind,
+     * that some methods may have this option enabled by default.
+     */
+    cacheable?: boolean | undefined;
+    /**
+     * Some POST methods in the Algolia REST API uses the `read` transporter.
+     * This information is defined at the spec level.
+     */
+    useReadTransporter?: boolean | undefined;
+};
+type EndRequest = Pick<Request, 'headers' | 'method'> & {
+    /**
+     * The full URL of the REST API.
+     */
+    url: string;
+    /**
+     * The connection timeout, in milliseconds.
+     */
+    connectTimeout: number;
+    /**
+     * The response timeout, in milliseconds.
+     */
+    responseTimeout: number;
+    data?: string | Uint8Array | undefined;
+};
+type Response = {
+    /**
+     * The body of the response.
+     */
+    content: string;
+    /**
+     * The headers of the response, with lower-cased names. Optional so that custom requesters that
+     * don't capture headers remain valid, in which case the `WithHTTPInfo` methods expose no headers.
+     */
+    headers?: Headers | undefined;
+    /**
+     * Whether the API call is timed out or not.
+     */
+    isTimedOut: boolean;
+    /**
+     * The HTTP status code of the response.
+     */
+    status: number;
+};
+type Requester = {
+    /**
+     * Sends the given `request` to the server.
+     */
+    send: (request: EndRequest) => Promise<Response>;
+    /**
+     * Sends the given `request` and returns a raw byte stream for streaming responses (e.g. SSE).
+     */
+    sendStream?: (request: EndRequest) => Promise<ReadableStream<Uint8Array>>;
+};
+
+/**
+ * The full HTTP response of an API call, as returned by the `WithHTTPInfo` variant of each method.
+ */
+type AlgoliaHttpResponse<TData> = {
+    /**
+     * The HTTP status code of the response.
+     */
+    status: number;
+    /**
+     * The headers of the response, with lower-cased names. Undefined when the requester does not capture headers.
+     */
+    headers?: Headers | undefined;
+    /**
+     * The raw body of the response.
+     */
+    content: string;
+    /**
+     * The deserialized body of the response.
+     */
+    data: TData;
+};
+
 type Cache = {
     /**
      * Gets the value of the given `key`.
@@ -169,75 +262,13 @@ type Logger = {
      */
     info: (message: string, args?: any | undefined) => Promise<void>;
     /**
-     * Logs error messages.
-     */
-    error: (message: string, args?: any | undefined) => Promise<void>;
-};
-
-type Headers = Record<string, string>;
-type QueryParameters = Record<string, any>;
-/**
- * The method of the request.
- */
-type Method = 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT';
-type Request = {
-    method: Method;
-    /**
-     * The path of the REST API to send the request to.
-     */
-    path: string;
-    queryParameters: QueryParameters;
-    data?: Array<Record<string, any>> | Record<string, any> | undefined;
-    headers: Headers;
-    /**
-     * If the given request should persist on the cache. Keep in mind,
-     * that some methods may have this option enabled by default.
+     * Logs warning messages. When not implemented, warnings fall back to `console.warn` so they stay visible with the default no-op logger.
      */
-    cacheable?: boolean | undefined;
+    warn?: (message: string, args?: any | undefined) => Promise<void>;
     /**
-     * Some POST methods in the Algolia REST API uses the `read` transporter.
-     * This information is defined at the spec level.
-     */
-    useReadTransporter?: boolean | undefined;
-};
-type EndRequest = Pick<Request, 'headers' | 'method'> & {
-    /**
-     * The full URL of the REST API.
-     */
-    url: string;
-    /**
-     * The connection timeout, in milliseconds.
-     */
-    connectTimeout: number;
-    /**
-     * The response timeout, in milliseconds.
-     */
-    responseTimeout: number;
-    data?: string | Uint8Array | undefined;
-};
-type Response = {
-    /**
-     * The body of the response.
-     */
-    content: string;
-    /**
-     * Whether the API call is timed out or not.
-     */
-    isTimedOut: boolean;
-    /**
-     * The HTTP status code of the response.
-     */
-    status: number;
-};
-type Requester = {
-    /**
-     * Sends the given `request` to the server.
-     */
-    send: (request: EndRequest) => Promise<Response>;
-    /**
-     * Sends the given `request` and returns a raw byte stream for streaming responses (e.g. SSE).
+     * Logs error messages.
      */
-    sendStream?: (request: EndRequest) => Promise<ReadableStream<Uint8Array>>;
+    error: (message: string, args?: any | undefined) => Promise<void>;
 };
 
 type RequestOptions = Pick<Request, 'cacheable'> & {
@@ -374,6 +405,12 @@ type TransporterOptions = {
      */
     compress?: (data: string) => Promise<Uint8Array>;
     compression?: 'gzip';
+    /**
+     * Where the generated Request-ID is sent: as the `Request-ID` header, or as the
+     * `x-algolia-request-id` query parameter. When undefined, no Request-ID is sent.
+     * A caller-supplied Request-ID is never overwritten.
+     */
+    requestIdChannel?: 'headers' | 'queryParameters' | undefined;
 };
 type Transporter = TransporterOptions & {
     /**
@@ -383,6 +420,18 @@ type Transporter = TransporterOptions & {
     request: <TResponse>(baseRequest: Request, baseRequestOptions?: RequestOptions) => Promise<TResponse>;
     requestStream: (baseRequest: Request, baseRequestOptions?: RequestOptions) => AsyncGenerator<ServerSentEvent>;
 };
+/**
+ * The transporter returned by `createTransporter`. Kept separate from `Transporter` so that
+ * existing implementations of `Transporter` remain type-valid.
+ */
+type TransporterWithHttpInfo = Transporter & {
+    /**
+     * Performs a request and returns the full HTTP response information — status code,
+     * headers (when the requester captures them), raw body and deserialized data.
+     * Both the requests and the responses caches are bypassed: it always hits the network.
+     */
+    requestWithHttpInfo: <TData>(baseRequest: Request, baseRequestOptions?: RequestOptions) => Promise<AlgoliaHttpResponse<TData>>;
+};
 
 type AuthMode = 'WithinHeaders' | 'WithinQueryParameters';
 type OverriddenTransporterOptions = 'baseHeaders' | 'baseQueryParameters' | 'hosts';
@@ -474,11 +523,16 @@ declare function getAlgoliaAgent({ algoliaAgents, client, version }: GetAlgoliaA
 
 declare function createNullLogger(): Logger;
 
+/**
+ * Prefers the logger's optional `warn` method and falls back to `console.warn`, so warnings stay visible with the default no-op logger.
+ */
+declare function logWarning(logger: Logger, message: string): void;
+
 declare const COMPRESSION_THRESHOLD = 750;
 
 declare function createStatefulHost(host: Host, status?: StatefulHost['status']): StatefulHost;
 
-declare function createTransporter({ hosts, hostsCache, baseHeaders, logger, baseQueryParameters, algoliaAgent, timeouts, requester, requestsCache, responsesCache, compress, compression, }: TransporterOptions): Transporter;
+declare function createTransporter({ hosts, hostsCache, baseHeaders, logger, baseQueryParameters, algoliaAgent, timeouts, requester, requestsCache, responsesCache, compress, compression, requestIdChannel, }: TransporterOptions): TransporterWithHttpInfo;
 
 declare class AlgoliaError extends Error {
     name: string;
@@ -495,18 +549,20 @@ declare class IndexAlreadyExistsError extends AlgoliaError {
 }
 declare class ErrorWithStackTrace extends AlgoliaError {
     stackTrace: StackFrame[];
-    constructor(message: string, stackTrace: StackFrame[], name: string);
+    correlationId?: string | undefined;
+    constructor(message: string, stackTrace: StackFrame[], name: string, correlationId?: string | undefined);
 }
 declare class RetryError extends ErrorWithStackTrace {
-    constructor(stackTrace: StackFrame[]);
+    constructor(stackTrace: StackFrame[], correlationId?: string | undefined);
 }
 declare class ApiError extends ErrorWithStackTrace {
     status: number;
-    constructor(message: string, status: number, stackTrace: StackFrame[], name?: string);
+    constructor(message: string, status: number, stackTrace: StackFrame[], name?: string, correlationId?: string | undefined);
 }
 declare class DeserializationError extends AlgoliaError {
     response: Response;
-    constructor(message: string, response: Response);
+    correlationId?: string | undefined;
+    constructor(message: string, response: Response, correlationId?: string | undefined);
 }
 type DetailedErrorWithMessage = {
     message: string;
@@ -523,7 +579,7 @@ type DetailedError = {
 };
 declare class DetailedApiError extends ApiError {
     error: DetailedError;
-    constructor(message: string, status: number, error: DetailedError, stackTrace: StackFrame[]);
+    constructor(message: string, status: number, error: DetailedError, stackTrace: StackFrame[], correlationId?: string | undefined);
 }
 
 declare function shuffle<TData>(array: TData[]): TData[];
@@ -532,7 +588,19 @@ declare function serializeQueryParameters(parameters: QueryParameters): string;
 declare function serializeData(request: Request, requestOptions: RequestOptions): string | undefined;
 declare function serializeHeaders(baseHeaders: Headers, requestHeaders: Headers, requestOptionsHeaders?: Headers | undefined): Headers;
 declare function deserializeSuccess<TObject>(response: Response): TObject;
-declare function deserializeFailure({ content, status }: Response, stackFrame: StackFrame[]): Error;
+declare function deserializeSuccessWithHttpInfo<TData>(response: Response): AlgoliaHttpResponse<TData>;
+declare function getCorrelationId(headers: Headers | undefined): string | undefined;
+declare function getLastCorrelationId(stackTrace: StackFrame[]): string | undefined;
+declare function deserializeFailure(response: Response, stackFrame: StackFrame[]): Error;
+
+declare function generateRequestId(): string;
+/**
+ * Returns request options carrying a Request-ID on the transporter's channel, so that every
+ * request a multi-request helper performs shares the same ID. Returns the options unchanged
+ * when the channel is off or when a Request-ID is already supplied. Never apply ahead of a
+ * cacheable operation: the ID enters the cache key and defeats caching and deduplication.
+ */
+declare function withRequestId(transporter: Pick<Transporter, 'requestIdChannel' | 'baseHeaders' | 'baseQueryParameters'>, requestOptions?: RequestOptions | undefined): RequestOptions | undefined;
 
 declare function isNetworkError({ isTimedOut, status }: Omit<Response, 'content'>): boolean;
 declare function isRetryable({ isTimedOut, status }: Omit<Response, 'content'>): boolean;
@@ -543,4 +611,4 @@ declare function stackFrameWithoutCredentials(stackFrame: StackFrame): StackFram
 
 declare function validateRequired(field: string, method: string, value: unknown): void;
 
-export { type AlgoliaAgent, type AlgoliaAgentOptions, AlgoliaError, ApiError, type AuthMode, type BrowserLocalStorageCacheItem, type BrowserLocalStorageOptions, COMPRESSION_THRESHOLD, type Cache, type CacheEvents, type ChunkedHelperOptions, type ClientOptions, type CreateClientOptions, type CreateIterablePromise, DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES, DEFAULT_WRITE_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_NODE, DeserializationError, DetailedApiError, type DetailedError, type DetailedErrorWithMessage, type DetailedErrorWithTypeID, type EndRequest, ErrorWithStackTrace, type FallbackableCacheOptions, type GetAlgoliaAgent, type Headers, type Host, IndexAlreadyExistsError, IndexNotFoundError, IndicesInSameAppError, type IterableOptions, LogLevelEnum, type LogLevelType, type Logger, type MemoryCacheOptions, type Method, type QueryParameters, type Request, type RequestOptions, type Requester, type Response, RetryError, type ServerSentEvent, type StackFrame, type StatefulHost, type StreamEvent, type Timeouts, type Transporter, type TransporterOptions, createAlgoliaAgent, createAuth, createBrowserLocalStorageCache, createFallbackableCache, createIterablePromise, createMemoryCache, createNullCache, createNullLogger, createStatefulHost, createTransporter, deserializeFailure, deserializeSuccess, getAlgoliaAgent, isNetworkError, isRetryable, isSuccess, iterSSEEvents, serializeData, serializeHeaders, serializeQueryParameters, serializeUrl, shuffle, stackFrameWithoutCredentials, stackTraceWithoutCredentials, validateRequired };
+export { type AlgoliaAgent, type AlgoliaAgentOptions, AlgoliaError, type AlgoliaHttpResponse, ApiError, type AuthMode, type BrowserLocalStorageCacheItem, type BrowserLocalStorageOptions, COMPRESSION_THRESHOLD, type Cache, type CacheEvents, type ChunkedHelperOptions, type ClientOptions, type CreateClientOptions, type CreateIterablePromise, DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES, DEFAULT_WRITE_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_NODE, DeserializationError, DetailedApiError, type DetailedError, type DetailedErrorWithMessage, type DetailedErrorWithTypeID, type EndRequest, ErrorWithStackTrace, type FallbackableCacheOptions, type GetAlgoliaAgent, type Headers, type Host, IndexAlreadyExistsError, IndexNotFoundError, IndicesInSameAppError, type IterableOptions, LogLevelEnum, type LogLevelType, type Logger, type MemoryCacheOptions, type Method, type QueryParameters, type Request, type RequestOptions, type Requester, type Response, RetryError, type ServerSentEvent, type StackFrame, type StatefulHost, type StreamEvent, type Timeouts, type Transporter, type TransporterOptions, type TransporterWithHttpInfo, createAlgoliaAgent, createAuth, createBrowserLocalStorageCache, createFallbackableCache, createIterablePromise, createMemoryCache, createNullCache, createNullLogger, createStatefulHost, createTransporter, deserializeFailure, deserializeSuccess, deserializeSuccessWithHttpInfo, generateRequestId, getAlgoliaAgent, getCorrelationId, getLastCorrelationId, isNetworkError, isRetryable, isSuccess, iterSSEEvents, logWarning, serializeData, serializeHeaders, serializeQueryParameters, serializeUrl, shuffle, stackFrameWithoutCredentials, stackTraceWithoutCredentials, validateRequired, withRequestId };