liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
1 lines • 15.7 kB
TypeScript
import type{Options as ClientOptions,TDataShape,Client}from'@hey-api/client-fetch';import type{GetFieldMappingInfosPageData,GetFieldMappingInfosPageResponses,PostFieldMappingInfosPageExportBatchData,PostFieldMappingInfosPageExportBatchResponses,GetKeywordQueryContributorsPageData,GetKeywordQueryContributorsPageResponses,PostKeywordQueryContributorsPageExportBatchData,PostKeywordQueryContributorsPageExportBatchResponses,GetModelPrefilterContributorsPageData,GetModelPrefilterContributorsPageResponses,PostModelPrefilterContributorsPageExportBatchData,PostModelPrefilterContributorsPageExportBatchResponses,GetQueryPrefilterContributorsPageData,GetQueryPrefilterContributorsPageResponses,PostQueryPrefilterContributorsPageExportBatchData,PostQueryPrefilterContributorsPageExportBatchResponses,DeleteSxpBlueprintData,DeleteSxpBlueprintResponses,GetSxpBlueprintData,GetSxpBlueprintResponses,PatchSxpBlueprintData,PatchSxpBlueprintResponses,PutSxpBlueprintData,PutSxpBlueprintResponses,DeleteSxpBlueprintBatchData,DeleteSxpBlueprintBatchResponses,PostSxpBlueprintBatchData,PostSxpBlueprintBatchResponses,PutSxpBlueprintBatchData,PutSxpBlueprintBatchResponses,GetSxpBlueprintByExternalReferenceCodeData,GetSxpBlueprintByExternalReferenceCodeResponses,PutSxpBlueprintByExternalReferenceCodeData,PutSxpBlueprintByExternalReferenceCodeResponses,GetSxpBlueprintExportData,GetSxpBlueprintExportResponses,GetSxpBlueprintsPageData,GetSxpBlueprintsPageResponses,PostSxpBlueprintData,PostSxpBlueprintResponses,PostSxpBlueprintCopyData,PostSxpBlueprintCopyResponses,PostSxpBlueprintValidateData,PostSxpBlueprintValidateResponses,PostSxpBlueprintsPageExportBatchData,PostSxpBlueprintsPageExportBatchResponses,DeleteSxpElementData,DeleteSxpElementResponses,GetSxpElementData,GetSxpElementResponses,PatchSxpElementData,PatchSxpElementResponses,PutSxpElementData,PutSxpElementResponses,DeleteSxpElementBatchData,DeleteSxpElementBatchResponses,PostSxpElementBatchData,PostSxpElementBatchResponses,PutSxpElementBatchData,PutSxpElementBatchResponses,GetSxpElementByExternalReferenceCodeData,GetSxpElementByExternalReferenceCodeResponses,PutSxpElementByExternalReferenceCodeData,PutSxpElementByExternalReferenceCodeResponses,GetSxpElementExportData,GetSxpElementExportResponses,GetSxpElementsPageData,GetSxpElementsPageResponses,PostSxpElementData,PostSxpElementResponses,PostSxpElementCopyData,PostSxpElementCopyResponses,PostSxpElementPreviewData,PostSxpElementPreviewResponses,PostSxpElementValidateData,PostSxpElementValidateResponses,PostSxpElementsPageExportBatchData,PostSxpElementsPageExportBatchResponses,GetSxpParameterContributorDefinitionsPageData,GetSxpParameterContributorDefinitionsPageResponses,PostSxpParameterContributorDefinitionsPageExportBatchData,PostSxpParameterContributorDefinitionsPageExportBatchResponses,GetSearchIndexesPageData,GetSearchIndexesPageResponses,PostSearchIndexesPageExportBatchData,PostSearchIndexesPageExportBatchResponses,PostSearchData,PostSearchResponses,GetSearchableAssetNameLanguagePageData,GetSearchableAssetNameLanguagePageResponses,GetSearchableAssetNamesPageData,GetSearchableAssetNamesPageResponses,PostSearchableAssetNamesPageExportBatchData,PostSearchableAssetNamesPageExportBatchResponses}from'./types.gen';export type Options<TData extends TDataShape=TDataShape,ThrowOnError extends boolean=boolean>=ClientOptions<TData,ThrowOnError>&{client?:Client;meta?:Record<string,unknown>;};export declare const getFieldMappingInfosPage:<ThrowOnError extends boolean=false>(options?:Options<GetFieldMappingInfosPageData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetFieldMappingInfosPageResponses,unknown,ThrowOnError,"fields">;export declare const postFieldMappingInfosPageExportBatch:<ThrowOnError extends boolean=false>(options?:Options<PostFieldMappingInfosPageExportBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostFieldMappingInfosPageExportBatchResponses,unknown,ThrowOnError,"fields">;export declare const getKeywordQueryContributorsPage:<ThrowOnError extends boolean=false>(options?:Options<GetKeywordQueryContributorsPageData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetKeywordQueryContributorsPageResponses,unknown,ThrowOnError,"fields">;export declare const postKeywordQueryContributorsPageExportBatch:<ThrowOnError extends boolean=false>(options?:Options<PostKeywordQueryContributorsPageExportBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostKeywordQueryContributorsPageExportBatchResponses,unknown,ThrowOnError,"fields">;export declare const getModelPrefilterContributorsPage:<ThrowOnError extends boolean=false>(options?:Options<GetModelPrefilterContributorsPageData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetModelPrefilterContributorsPageResponses,unknown,ThrowOnError,"fields">;export declare const postModelPrefilterContributorsPageExportBatch:<ThrowOnError extends boolean=false>(options?:Options<PostModelPrefilterContributorsPageExportBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostModelPrefilterContributorsPageExportBatchResponses,unknown,ThrowOnError,"fields">;export declare const getQueryPrefilterContributorsPage:<ThrowOnError extends boolean=false>(options?:Options<GetQueryPrefilterContributorsPageData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetQueryPrefilterContributorsPageResponses,unknown,ThrowOnError,"fields">;export declare const postQueryPrefilterContributorsPageExportBatch:<ThrowOnError extends boolean=false>(options?:Options<PostQueryPrefilterContributorsPageExportBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostQueryPrefilterContributorsPageExportBatchResponses,unknown,ThrowOnError,"fields">;export declare const deleteSxpBlueprint:<ThrowOnError extends boolean=false>(options:Options<DeleteSxpBlueprintData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<DeleteSxpBlueprintResponses,unknown,ThrowOnError,"fields">;export declare const getSxpBlueprint:<ThrowOnError extends boolean=false>(options:Options<GetSxpBlueprintData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetSxpBlueprintResponses,unknown,ThrowOnError,"fields">;export declare const patchSxpBlueprint:<ThrowOnError extends boolean=false>(options:Options<PatchSxpBlueprintData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PatchSxpBlueprintResponses,unknown,ThrowOnError,"fields">;export declare const putSxpBlueprint:<ThrowOnError extends boolean=false>(options:Options<PutSxpBlueprintData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PutSxpBlueprintResponses,unknown,ThrowOnError,"fields">;export declare const deleteSxpBlueprintBatch:<ThrowOnError extends boolean=false>(options?:Options<DeleteSxpBlueprintBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<DeleteSxpBlueprintBatchResponses,unknown,ThrowOnError,"fields">;export declare const postSxpBlueprintBatch:<ThrowOnError extends boolean=false>(options?:Options<PostSxpBlueprintBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSxpBlueprintBatchResponses,unknown,ThrowOnError,"fields">;export declare const putSxpBlueprintBatch:<ThrowOnError extends boolean=false>(options?:Options<PutSxpBlueprintBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PutSxpBlueprintBatchResponses,unknown,ThrowOnError,"fields">;export declare const getSxpBlueprintByExternalReferenceCode:<ThrowOnError extends boolean=false>(options:Options<GetSxpBlueprintByExternalReferenceCodeData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetSxpBlueprintByExternalReferenceCodeResponses,unknown,ThrowOnError,"fields">;export declare const putSxpBlueprintByExternalReferenceCode:<ThrowOnError extends boolean=false>(options:Options<PutSxpBlueprintByExternalReferenceCodeData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PutSxpBlueprintByExternalReferenceCodeResponses,unknown,ThrowOnError,"fields">;export declare const getSxpBlueprintExport:<ThrowOnError extends boolean=false>(options:Options<GetSxpBlueprintExportData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetSxpBlueprintExportResponses,unknown,ThrowOnError,"fields">;export declare const getSxpBlueprintsPage:<ThrowOnError extends boolean=false>(options?:Options<GetSxpBlueprintsPageData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetSxpBlueprintsPageResponses,unknown,ThrowOnError,"fields">;export declare const postSxpBlueprint:<ThrowOnError extends boolean=false>(options?:Options<PostSxpBlueprintData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSxpBlueprintResponses,unknown,ThrowOnError,"fields">;export declare const postSxpBlueprintCopy:<ThrowOnError extends boolean=false>(options:Options<PostSxpBlueprintCopyData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSxpBlueprintCopyResponses,unknown,ThrowOnError,"fields">;export declare const postSxpBlueprintValidate:<ThrowOnError extends boolean=false>(options?:Options<PostSxpBlueprintValidateData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSxpBlueprintValidateResponses,unknown,ThrowOnError,"fields">;export declare const postSxpBlueprintsPageExportBatch:<ThrowOnError extends boolean=false>(options?:Options<PostSxpBlueprintsPageExportBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSxpBlueprintsPageExportBatchResponses,unknown,ThrowOnError,"fields">;export declare const deleteSxpElement:<ThrowOnError extends boolean=false>(options:Options<DeleteSxpElementData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<DeleteSxpElementResponses,unknown,ThrowOnError,"fields">;export declare const getSxpElement:<ThrowOnError extends boolean=false>(options:Options<GetSxpElementData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetSxpElementResponses,unknown,ThrowOnError,"fields">;export declare const patchSxpElement:<ThrowOnError extends boolean=false>(options:Options<PatchSxpElementData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PatchSxpElementResponses,unknown,ThrowOnError,"fields">;export declare const putSxpElement:<ThrowOnError extends boolean=false>(options:Options<PutSxpElementData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PutSxpElementResponses,unknown,ThrowOnError,"fields">;export declare const deleteSxpElementBatch:<ThrowOnError extends boolean=false>(options?:Options<DeleteSxpElementBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<DeleteSxpElementBatchResponses,unknown,ThrowOnError,"fields">;export declare const postSxpElementBatch:<ThrowOnError extends boolean=false>(options?:Options<PostSxpElementBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSxpElementBatchResponses,unknown,ThrowOnError,"fields">;export declare const putSxpElementBatch:<ThrowOnError extends boolean=false>(options?:Options<PutSxpElementBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PutSxpElementBatchResponses,unknown,ThrowOnError,"fields">;export declare const getSxpElementByExternalReferenceCode:<ThrowOnError extends boolean=false>(options:Options<GetSxpElementByExternalReferenceCodeData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetSxpElementByExternalReferenceCodeResponses,unknown,ThrowOnError,"fields">;export declare const putSxpElementByExternalReferenceCode:<ThrowOnError extends boolean=false>(options:Options<PutSxpElementByExternalReferenceCodeData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PutSxpElementByExternalReferenceCodeResponses,unknown,ThrowOnError,"fields">;export declare const getSxpElementExport:<ThrowOnError extends boolean=false>(options:Options<GetSxpElementExportData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetSxpElementExportResponses,unknown,ThrowOnError,"fields">;export declare const getSxpElementsPage:<ThrowOnError extends boolean=false>(options?:Options<GetSxpElementsPageData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetSxpElementsPageResponses,unknown,ThrowOnError,"fields">;export declare const postSxpElement:<ThrowOnError extends boolean=false>(options?:Options<PostSxpElementData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSxpElementResponses,unknown,ThrowOnError,"fields">;export declare const postSxpElementCopy:<ThrowOnError extends boolean=false>(options:Options<PostSxpElementCopyData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSxpElementCopyResponses,unknown,ThrowOnError,"fields">;export declare const postSxpElementPreview:<ThrowOnError extends boolean=false>(options?:Options<PostSxpElementPreviewData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSxpElementPreviewResponses,unknown,ThrowOnError,"fields">;export declare const postSxpElementValidate:<ThrowOnError extends boolean=false>(options?:Options<PostSxpElementValidateData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSxpElementValidateResponses,unknown,ThrowOnError,"fields">;export declare const postSxpElementsPageExportBatch:<ThrowOnError extends boolean=false>(options?:Options<PostSxpElementsPageExportBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSxpElementsPageExportBatchResponses,unknown,ThrowOnError,"fields">;export declare const getSxpParameterContributorDefinitionsPage:<ThrowOnError extends boolean=false>(options?:Options<GetSxpParameterContributorDefinitionsPageData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetSxpParameterContributorDefinitionsPageResponses,unknown,ThrowOnError,"fields">;export declare const postSxpParameterContributorDefinitionsPageExportBatch:<ThrowOnError extends boolean=false>(options?:Options<PostSxpParameterContributorDefinitionsPageExportBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSxpParameterContributorDefinitionsPageExportBatchResponses,unknown,ThrowOnError,"fields">;export declare const getSearchIndexesPage:<ThrowOnError extends boolean=false>(options?:Options<GetSearchIndexesPageData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetSearchIndexesPageResponses,unknown,ThrowOnError,"fields">;export declare const postSearchIndexesPageExportBatch:<ThrowOnError extends boolean=false>(options?:Options<PostSearchIndexesPageExportBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSearchIndexesPageExportBatchResponses,unknown,ThrowOnError,"fields">;export declare const postSearch:<ThrowOnError extends boolean=false>(options?:Options<PostSearchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSearchResponses,unknown,ThrowOnError,"fields">;export declare const getSearchableAssetNameLanguagePage:<ThrowOnError extends boolean=false>(options:Options<GetSearchableAssetNameLanguagePageData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetSearchableAssetNameLanguagePageResponses,unknown,ThrowOnError,"fields">;export declare const getSearchableAssetNamesPage:<ThrowOnError extends boolean=false>(options?:Options<GetSearchableAssetNamesPageData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<GetSearchableAssetNamesPageResponses,unknown,ThrowOnError,"fields">;export declare const postSearchableAssetNamesPageExportBatch:<ThrowOnError extends boolean=false>(options?:Options<PostSearchableAssetNamesPageExportBatchData,ThrowOnError>)=>import("@hey-api/client-fetch").RequestResult<PostSearchableAssetNamesPageExportBatchResponses,unknown,ThrowOnError,"fields">;