liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
56 lines (55 loc) • 14 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { DeleteCtCollectionData, DeleteCtCollectionResponses, GetCtCollectionData, GetCtCollectionResponses, PatchCtCollectionData, PatchCtCollectionResponses, PutCtCollectionData, PutCtCollectionResponses, DeleteCtCollectionBatchData, DeleteCtCollectionBatchResponses, PostCtCollectionBatchData, PostCtCollectionBatchResponses, PutCtCollectionBatchData, PutCtCollectionBatchResponses, DeleteCtCollectionByExternalReferenceCodeData, DeleteCtCollectionByExternalReferenceCodeResponses, GetCtCollectionByExternalReferenceCodeData, GetCtCollectionByExternalReferenceCodeResponses, PatchCtCollectionByExternalReferenceCodeData, PatchCtCollectionByExternalReferenceCodeResponses, GetCtCollectionByExternalReferenceCodeShareLinkData, GetCtCollectionByExternalReferenceCodeShareLinkResponses, GetCtCollectionShareLinkData, GetCtCollectionShareLinkResponses, GetCtCollectionsPageData, GetCtCollectionsPageResponses, PostCtCollectionData, PostCtCollectionResponses, PostCtCollectionByExternalReferenceCodePublishData, PostCtCollectionByExternalReferenceCodePublishResponses, PostCtCollectionByExternalReferenceCodeSchedulePublishData, PostCtCollectionByExternalReferenceCodeSchedulePublishResponses, PostCtCollectionCheckoutData, PostCtCollectionCheckoutResponses, PostCtCollectionPublishData, PostCtCollectionPublishResponses, PostCtCollectionSchedulePublishData, PostCtCollectionSchedulePublishResponses, PostCtCollectionsPageExportBatchData, PostCtCollectionsPageExportBatchResponses, GetCtEntriesHistoryPageData, GetCtEntriesHistoryPageResponses, GetCtEntryData, GetCtEntryResponses, GetCtCollectionCtEntriesPageData, GetCtCollectionCtEntriesPageResponses, GetCtCollectionCtEntryByModelClassNameByModelClassPkModelClassPkData, GetCtCollectionCtEntryByModelClassNameByModelClassPkModelClassPkResponses, DeleteCtProcessData, DeleteCtProcessResponses, GetCtProcessData, GetCtProcessResponses, DeleteCtProcessBatchData, DeleteCtProcessBatchResponses, GetCtProcessesPageData, GetCtProcessesPageResponses, PostCtProcessRevertData, PostCtProcessRevertResponses, PostCtProcessesPageExportBatchData, PostCtProcessesPageExportBatchResponses, DeleteCtRemoteData, DeleteCtRemoteResponses, GetCtRemoteData, GetCtRemoteResponses, PatchCtRemoteData, PatchCtRemoteResponses, PutCtRemoteData, PutCtRemoteResponses, DeleteCtRemoteBatchData, DeleteCtRemoteBatchResponses, PostCtRemoteBatchData, PostCtRemoteBatchResponses, PutCtRemoteBatchData, PutCtRemoteBatchResponses, GetCtRemotesPageData, GetCtRemotesPageResponses, PostCtRemoteData, PostCtRemoteResponses, PostCtRemotesPageExportBatchData, PostCtRemotesPageExportBatchResponses } 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 deleteCtCollection: <ThrowOnError extends boolean = false>(options: Options<DeleteCtCollectionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteCtCollectionResponses, unknown, ThrowOnError, "fields">;
export declare const getCtCollection: <ThrowOnError extends boolean = false>(options: Options<GetCtCollectionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCtCollectionResponses, unknown, ThrowOnError, "fields">;
export declare const patchCtCollection: <ThrowOnError extends boolean = false>(options: Options<PatchCtCollectionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchCtCollectionResponses, unknown, ThrowOnError, "fields">;
export declare const putCtCollection: <ThrowOnError extends boolean = false>(options: Options<PutCtCollectionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutCtCollectionResponses, unknown, ThrowOnError, "fields">;
export declare const deleteCtCollectionBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteCtCollectionBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteCtCollectionBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postCtCollectionBatch: <ThrowOnError extends boolean = false>(options?: Options<PostCtCollectionBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCtCollectionBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putCtCollectionBatch: <ThrowOnError extends boolean = false>(options?: Options<PutCtCollectionBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutCtCollectionBatchResponses, unknown, ThrowOnError, "fields">;
export declare const deleteCtCollectionByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteCtCollectionByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteCtCollectionByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const getCtCollectionByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetCtCollectionByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCtCollectionByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const patchCtCollectionByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PatchCtCollectionByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchCtCollectionByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const getCtCollectionByExternalReferenceCodeShareLink: <ThrowOnError extends boolean = false>(options: Options<GetCtCollectionByExternalReferenceCodeShareLinkData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCtCollectionByExternalReferenceCodeShareLinkResponses, unknown, ThrowOnError, "fields">;
export declare const getCtCollectionShareLink: <ThrowOnError extends boolean = false>(options: Options<GetCtCollectionShareLinkData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCtCollectionShareLinkResponses, unknown, ThrowOnError, "fields">;
export declare const getCtCollectionsPage: <ThrowOnError extends boolean = false>(options?: Options<GetCtCollectionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCtCollectionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postCtCollection: <ThrowOnError extends boolean = false>(options?: Options<PostCtCollectionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCtCollectionResponses, unknown, ThrowOnError, "fields">;
export declare const postCtCollectionByExternalReferenceCodePublish: <ThrowOnError extends boolean = false>(options: Options<PostCtCollectionByExternalReferenceCodePublishData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCtCollectionByExternalReferenceCodePublishResponses, unknown, ThrowOnError, "fields">;
export declare const postCtCollectionByExternalReferenceCodeSchedulePublish: <ThrowOnError extends boolean = false>(options: Options<PostCtCollectionByExternalReferenceCodeSchedulePublishData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCtCollectionByExternalReferenceCodeSchedulePublishResponses, unknown, ThrowOnError, "fields">;
export declare const postCtCollectionCheckout: <ThrowOnError extends boolean = false>(options: Options<PostCtCollectionCheckoutData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCtCollectionCheckoutResponses, unknown, ThrowOnError, "fields">;
export declare const postCtCollectionPublish: <ThrowOnError extends boolean = false>(options: Options<PostCtCollectionPublishData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCtCollectionPublishResponses, unknown, ThrowOnError, "fields">;
export declare const postCtCollectionSchedulePublish: <ThrowOnError extends boolean = false>(options: Options<PostCtCollectionSchedulePublishData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCtCollectionSchedulePublishResponses, unknown, ThrowOnError, "fields">;
export declare const postCtCollectionsPageExportBatch: <ThrowOnError extends boolean = false>(options?: Options<PostCtCollectionsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCtCollectionsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const getCtEntriesHistoryPage: <ThrowOnError extends boolean = false>(options?: Options<GetCtEntriesHistoryPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCtEntriesHistoryPageResponses, unknown, ThrowOnError, "fields">;
export declare const getCtEntry: <ThrowOnError extends boolean = false>(options: Options<GetCtEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCtEntryResponses, unknown, ThrowOnError, "fields">;
export declare const getCtCollectionCtEntriesPage: <ThrowOnError extends boolean = false>(options: Options<GetCtCollectionCtEntriesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCtCollectionCtEntriesPageResponses, unknown, ThrowOnError, "fields">;
export declare const getCtCollectionCtEntryByModelClassNameByModelClassPkModelClassPk: <ThrowOnError extends boolean = false>(options: Options<GetCtCollectionCtEntryByModelClassNameByModelClassPkModelClassPkData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCtCollectionCtEntryByModelClassNameByModelClassPkModelClassPkResponses, unknown, ThrowOnError, "fields">;
export declare const deleteCtProcess: <ThrowOnError extends boolean = false>(options: Options<DeleteCtProcessData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteCtProcessResponses, unknown, ThrowOnError, "fields">;
export declare const getCtProcess: <ThrowOnError extends boolean = false>(options: Options<GetCtProcessData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCtProcessResponses, unknown, ThrowOnError, "fields">;
export declare const deleteCtProcessBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteCtProcessBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteCtProcessBatchResponses, unknown, ThrowOnError, "fields">;
export declare const getCtProcessesPage: <ThrowOnError extends boolean = false>(options?: Options<GetCtProcessesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCtProcessesPageResponses, unknown, ThrowOnError, "fields">;
export declare const postCtProcessRevert: <ThrowOnError extends boolean = false>(options: Options<PostCtProcessRevertData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCtProcessRevertResponses, unknown, ThrowOnError, "fields">;
export declare const postCtProcessesPageExportBatch: <ThrowOnError extends boolean = false>(options?: Options<PostCtProcessesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCtProcessesPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const deleteCtRemote: <ThrowOnError extends boolean = false>(options: Options<DeleteCtRemoteData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteCtRemoteResponses, unknown, ThrowOnError, "fields">;
export declare const getCtRemote: <ThrowOnError extends boolean = false>(options: Options<GetCtRemoteData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCtRemoteResponses, unknown, ThrowOnError, "fields">;
export declare const patchCtRemote: <ThrowOnError extends boolean = false>(options: Options<PatchCtRemoteData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchCtRemoteResponses, unknown, ThrowOnError, "fields">;
export declare const putCtRemote: <ThrowOnError extends boolean = false>(options: Options<PutCtRemoteData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutCtRemoteResponses, unknown, ThrowOnError, "fields">;
export declare const deleteCtRemoteBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteCtRemoteBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteCtRemoteBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postCtRemoteBatch: <ThrowOnError extends boolean = false>(options?: Options<PostCtRemoteBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCtRemoteBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putCtRemoteBatch: <ThrowOnError extends boolean = false>(options?: Options<PutCtRemoteBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutCtRemoteBatchResponses, unknown, ThrowOnError, "fields">;
export declare const getCtRemotesPage: <ThrowOnError extends boolean = false>(options?: Options<GetCtRemotesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCtRemotesPageResponses, unknown, ThrowOnError, "fields">;
export declare const postCtRemote: <ThrowOnError extends boolean = false>(options?: Options<PostCtRemoteData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCtRemoteResponses, unknown, ThrowOnError, "fields">;
export declare const postCtRemotesPageExportBatch: <ThrowOnError extends boolean = false>(options?: Options<PostCtRemotesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostCtRemotesPageExportBatchResponses, unknown, ThrowOnError, "fields">;