liferay-headless-rest-client

Version:
A collection of Headless Clients used in Liferay Portal
github.com/kevenleone/liferay-headless-rest-client
37 lines (36 loc) • 8.36 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { DeleteNotificationQueueEntryData, DeleteNotificationQueueEntryResponses, GetNotificationQueueEntryData, GetNotificationQueueEntryResponses, DeleteNotificationQueueEntryBatchData, DeleteNotificationQueueEntryBatchResponses, PostNotificationQueueEntryBatchData, PostNotificationQueueEntryBatchResponses, GetNotificationQueueEntriesPageData, GetNotificationQueueEntriesPageResponses, PostNotificationQueueEntryData, PostNotificationQueueEntryResponses, PostNotificationQueueEntriesPageExportBatchData, PostNotificationQueueEntriesPageExportBatchResponses, PutNotificationQueueEntryResendData, PutNotificationQueueEntryResendResponses, DeleteNotificationTemplateData, DeleteNotificationTemplateResponses, GetNotificationTemplateData, GetNotificationTemplateResponses, PatchNotificationTemplateData, PatchNotificationTemplateResponses, PutNotificationTemplateData, PutNotificationTemplateResponses, DeleteNotificationTemplateBatchData, DeleteNotificationTemplateBatchResponses, PostNotificationTemplateBatchData, PostNotificationTemplateBatchResponses, PutNotificationTemplateBatchData, PutNotificationTemplateBatchResponses, GetNotificationTemplateByExternalReferenceCodeData, GetNotificationTemplateByExternalReferenceCodeResponses, PutNotificationTemplateByExternalReferenceCodeData, PutNotificationTemplateByExternalReferenceCodeResponses, GetNotificationTemplatesPageData, GetNotificationTemplatesPageResponses, PostNotificationTemplateData, PostNotificationTemplateResponses, PostNotificationTemplateCopyData, PostNotificationTemplateCopyResponses, PostNotificationTemplatesPageExportBatchData, PostNotificationTemplatesPageExportBatchResponses } 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 deleteNotificationQueueEntry: <ThrowOnError extends boolean = false>(options: Options<DeleteNotificationQueueEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteNotificationQueueEntryResponses, unknown, ThrowOnError, "fields">;
export declare const getNotificationQueueEntry: <ThrowOnError extends boolean = false>(options: Options<GetNotificationQueueEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetNotificationQueueEntryResponses, unknown, ThrowOnError, "fields">;
export declare const deleteNotificationQueueEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteNotificationQueueEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteNotificationQueueEntryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postNotificationQueueEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<PostNotificationQueueEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNotificationQueueEntryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const getNotificationQueueEntriesPage: <ThrowOnError extends boolean = false>(options?: Options<GetNotificationQueueEntriesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetNotificationQueueEntriesPageResponses, unknown, ThrowOnError, "fields">;
export declare const postNotificationQueueEntry: <ThrowOnError extends boolean = false>(options?: Options<PostNotificationQueueEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNotificationQueueEntryResponses, unknown, ThrowOnError, "fields">;
export declare const postNotificationQueueEntriesPageExportBatch: <ThrowOnError extends boolean = false>(options?: Options<PostNotificationQueueEntriesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNotificationQueueEntriesPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putNotificationQueueEntryResend: <ThrowOnError extends boolean = false>(options: Options<PutNotificationQueueEntryResendData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutNotificationQueueEntryResendResponses, unknown, ThrowOnError, "fields">;
export declare const deleteNotificationTemplate: <ThrowOnError extends boolean = false>(options: Options<DeleteNotificationTemplateData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteNotificationTemplateResponses, unknown, ThrowOnError, "fields">;
export declare const getNotificationTemplate: <ThrowOnError extends boolean = false>(options: Options<GetNotificationTemplateData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetNotificationTemplateResponses, unknown, ThrowOnError, "fields">;
export declare const patchNotificationTemplate: <ThrowOnError extends boolean = false>(options: Options<PatchNotificationTemplateData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchNotificationTemplateResponses, unknown, ThrowOnError, "fields">;
export declare const putNotificationTemplate: <ThrowOnError extends boolean = false>(options: Options<PutNotificationTemplateData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutNotificationTemplateResponses, unknown, ThrowOnError, "fields">;
export declare const deleteNotificationTemplateBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteNotificationTemplateBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteNotificationTemplateBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postNotificationTemplateBatch: <ThrowOnError extends boolean = false>(options?: Options<PostNotificationTemplateBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNotificationTemplateBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putNotificationTemplateBatch: <ThrowOnError extends boolean = false>(options?: Options<PutNotificationTemplateBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutNotificationTemplateBatchResponses, unknown, ThrowOnError, "fields">;
export declare const getNotificationTemplateByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetNotificationTemplateByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetNotificationTemplateByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const putNotificationTemplateByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutNotificationTemplateByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutNotificationTemplateByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const getNotificationTemplatesPage: <ThrowOnError extends boolean = false>(options?: Options<GetNotificationTemplatesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetNotificationTemplatesPageResponses, unknown, ThrowOnError, "fields">;
export declare const postNotificationTemplate: <ThrowOnError extends boolean = false>(options?: Options<PostNotificationTemplateData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNotificationTemplateResponses, unknown, ThrowOnError, "fields">;
export declare const postNotificationTemplateCopy: <ThrowOnError extends boolean = false>(options: Options<PostNotificationTemplateCopyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNotificationTemplateCopyResponses, unknown, ThrowOnError, "fields">;
export declare const postNotificationTemplatesPageExportBatch: <ThrowOnError extends boolean = false>(options?: Options<PostNotificationTemplatesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNotificationTemplatesPageExportBatchResponses, unknown, ThrowOnError, "fields">;