liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
25 lines (24 loc) • 3.27 kB
TypeScript
import { type Options as ClientOptions, type TDataShape, type Client } from '@hey-api/client-fetch';
import type { DeleteMessageData, DeleteMessageResponses, GetMessageData, GetMessageResponses, PostMessageData, PostMessageResponses, PutMessageData, PutMessageResponses, DeleteMessageBatchData, DeleteMessageBatchResponses, PostMessageBatchData, PostMessageBatchResponses, PutMessageBatchData, PutMessageBatchResponses, PostMessageImportData, PostMessageImportResponses, PostMessagesExportPageData, PostMessagesExportPageResponses } from './types.gen';
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
/**
* You can provide a client instance returned by `createClient()` instead of
* individual options. This might be also useful if you want to implement a
* custom client.
*/
client?: Client;
/**
* You can pass arbitrary values through the `meta` object. This can be
* used to access values that aren't defined as part of the SDK function.
*/
meta?: Record<string, unknown>;
};
export declare const deleteMessage: <ThrowOnError extends boolean = false>(options?: Options<DeleteMessageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteMessageResponses, unknown, ThrowOnError, "fields">;
export declare const getMessage: <ThrowOnError extends boolean = false>(options?: Options<GetMessageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetMessageResponses, unknown, ThrowOnError, "fields">;
export declare const postMessage: <ThrowOnError extends boolean = false>(options?: Options<PostMessageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostMessageResponses, unknown, ThrowOnError, "fields">;
export declare const putMessage: <ThrowOnError extends boolean = false>(options?: Options<PutMessageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutMessageResponses, unknown, ThrowOnError, "fields">;
export declare const deleteMessageBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteMessageBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteMessageBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postMessageBatch: <ThrowOnError extends boolean = false>(options?: Options<PostMessageBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostMessageBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putMessageBatch: <ThrowOnError extends boolean = false>(options?: Options<PutMessageBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutMessageBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postMessageImport: <ThrowOnError extends boolean = false>(options?: Options<PostMessageImportData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostMessageImportResponses, unknown, ThrowOnError, "fields">;
export declare const postMessagesExportPage: <ThrowOnError extends boolean = false>(options?: Options<PostMessagesExportPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostMessagesExportPageResponses, unknown, ThrowOnError, "fields">;