@itwin/imodels-client-management/lib/cjs/base/types/RestClient.d.ts

iModels API client wrapper for applications that manage iModels.

import { Dictionary } from "./UtilityTypes";
/**
 * Content-Type header values that are used with for iModels API.
 */
export declare enum ContentType {
    Json = "application/json",
    Png = "image/png",
    Jpeg = "image/jpeg"
}
/** Helper type to group all supported binary content types. */
export type BinaryContentType = ContentType.Png | ContentType.Jpeg;
/** Helper type to group all response content types that are supported in GET requests. */
export type SupportedGetResponseTypes = ContentType.Json | ContentType.Png;
/** Request body that contains JSON content. */
export interface JsonBody {
    /** Type of the content described by `Content-Type` header value - `application/json`. */
    contentType: ContentType.Json;
    /** Object to be serialized to JSON. */
    content: object | undefined;
}
/** Request body that contains binary data. */
export interface BinaryBody {
    /** Type of the content described by standard `Content-Type` header values. */
    contentType: BinaryContentType;
    /** Binary data. */
    content: Uint8Array;
}
/** Common parameters for all HTTP request operations. */
export interface HttpRequestParams {
    /** Request url. */
    url: string;
    /** Headers to be sent with the request. */
    headers: Dictionary<string>;
}
/** Abstraction for accessing HTTP response headers that the server responded with. */
export interface HttpResponseHeaders {
    /**
     * Gets HTTP response header's value by the specified {@link headerName}.
     * It is expected that the header name matcher is case-insensitive.
     */
    get(headerName: string): unknown;
    /** Gets all HTTP response headers. */
    getAll(): Dictionary<unknown>;
}
/** HTTP response. */
export interface HttpResponse<TBody> {
    /** Response body that was provided by the server. */
    body: TBody;
    /** Headers that the server responded with. */
    headers: HttpResponseHeaders;
}
/** Common parameters for HTTP GET request operation. */
export interface HttpGetRequestParams extends HttpRequestParams {
    /**
     * Expected type of the response content. This information is relevant when deserializing the
     * response data as usually binary and JSON response types require different handling.
     */
    responseType: SupportedGetResponseTypes;
}
/** Common parameters for HTTP request operations that can contain a JSON body. */
export interface HttpRequestWithJsonBodyParams extends HttpRequestParams {
    /** Request body. */
    body: JsonBody;
}
/** Common parameters for HTTP request operations that contain a binary body. */
export interface HttpRequestWithBinaryBodyParams extends HttpRequestParams {
    /** Request body. */
    body?: BinaryBody;
}
/**
 * Client used for sending HTTP requests. It supports common HTTP methods that are used by
 * operations in this library.
 */
export interface RestClient {
    /**
     * Sends GET HTTP request to get JSON response.
     * @param {HttpGetRequestParams} params parameters for this operation. See {@link HttpGetRequestParams}.
     * @throws an error if the request fails.
     */
    sendGetRequest<TBody>(params: HttpGetRequestParams & {
        responseType: ContentType.Json;
    }): Promise<HttpResponse<TBody>>;
    /**
     * Sends GET HTTP request to get binary response.
     * @param {HttpGetRequestParams} params parameters for this operation. See {@link HttpGetRequestParams}.
     * @throws an error if the request fails.
     */
    sendGetRequest(params: HttpGetRequestParams & {
        responseType: ContentType.Png;
    }): Promise<HttpResponse<Uint8Array>>;
    /**
     * Sends POST HTTP request.
     * @param {HttpRequestWithBodyParams} params parameters for this operation. See {@link HttpRequestWithBodyParams}.
     * @throws an error if the request fails.
     */
    sendPostRequest<TBody>(params: HttpRequestWithJsonBodyParams): Promise<HttpResponse<TBody>>;
    /**
     * Sends PUT HTTP request.
     * @param {HttpPutRequestParams} params parameters for this operation. See {@link HttpRequestWithBodyParams}.
     * @throws an error if the request fails.
     */
    sendPutRequest<TBody>(params: HttpRequestWithBinaryBodyParams): Promise<HttpResponse<TBody>>;
    /**
     * Sends PATCH HTTP request.
     * @param {HttpRequestWithBodyParams} params parameters for this operation. See {@link HttpRequestWithBodyParams}.
     * @throws an error if the request fails.
     */
    sendPatchRequest<TBody>(params: HttpRequestWithJsonBodyParams): Promise<HttpResponse<TBody>>;
    /**
     * Sends DELETE HTTP request.
     * @param {HttpRequestParams} params parameters for this operation. See {@link HttpRequestParams}.
     * @throws an error if the request fails.
     */
    sendDeleteRequest<TBody>(params: HttpRequestParams): Promise<HttpResponse<TBody>>;
}
//# sourceMappingURL=RestClient.d.ts.map