liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
247 lines (246 loc) • 40.3 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { DeleteAssetLibraryKeywordByExternalReferenceCodeData, DeleteAssetLibraryKeywordByExternalReferenceCodeResponses, GetAssetLibraryKeywordByExternalReferenceCodeData, GetAssetLibraryKeywordByExternalReferenceCodeResponses, PutAssetLibraryKeywordByExternalReferenceCodeData, PutAssetLibraryKeywordByExternalReferenceCodeResponses, DeleteKeywordData, DeleteKeywordResponses, GetKeywordData, GetKeywordResponses, PutKeywordData, PutKeywordResponses, DeleteKeywordBatchData, DeleteKeywordBatchResponses, PostKeywordBatchData, PostKeywordBatchResponses, PutKeywordBatchData, PutKeywordBatchResponses, DeleteSiteKeywordByExternalReferenceCodeData, DeleteSiteKeywordByExternalReferenceCodeResponses, GetSiteKeywordByExternalReferenceCodeData, GetSiteKeywordByExternalReferenceCodeResponses, PutSiteKeywordByExternalReferenceCodeData, PutSiteKeywordByExternalReferenceCodeResponses, GetAssetLibraryKeywordPermissionsPageData, GetAssetLibraryKeywordPermissionsPageResponses, PutAssetLibraryKeywordPermissionsPageData, PutAssetLibraryKeywordPermissionsPageResponses, GetAssetLibraryKeywordsPageData, GetAssetLibraryKeywordsPageResponses, PostAssetLibraryKeywordData, PostAssetLibraryKeywordResponses, GetKeywordsPageData, GetKeywordsPageResponses, PostKeywordData, PostKeywordResponses, GetKeywordsRankedPageData, GetKeywordsRankedPageResponses, GetSiteKeywordPermissionsPageData, GetSiteKeywordPermissionsPageResponses, PutSiteKeywordPermissionsPageData, PutSiteKeywordPermissionsPageResponses, GetSiteKeywordsPageData, GetSiteKeywordsPageResponses, PostSiteKeywordData, PostSiteKeywordResponses, PostAssetLibraryKeywordBatchData, PostAssetLibraryKeywordBatchResponses, PostAssetLibraryKeywordsPageExportBatchData, PostAssetLibraryKeywordsPageExportBatchResponses, PostKeywordsPageExportBatchData, PostKeywordsPageExportBatchResponses, PostSiteKeywordBatchData, PostSiteKeywordBatchResponses, PostSiteKeywordsPageExportBatchData, PostSiteKeywordsPageExportBatchResponses, PutKeywordMergeData, PutKeywordMergeResponses, PutKeywordSubscribeData, PutKeywordSubscribeResponses, PutKeywordUnsubscribeData, PutKeywordUnsubscribeResponses, DeleteAssetLibraryTaxonomyCategoryByExternalReferenceCodeData, DeleteAssetLibraryTaxonomyCategoryByExternalReferenceCodeResponses, GetAssetLibraryTaxonomyCategoryByExternalReferenceCodeData, GetAssetLibraryTaxonomyCategoryByExternalReferenceCodeResponses, PutAssetLibraryTaxonomyCategoryByExternalReferenceCodeData, PutAssetLibraryTaxonomyCategoryByExternalReferenceCodeResponses, DeleteSiteTaxonomyCategoryByExternalReferenceCodeData, DeleteSiteTaxonomyCategoryByExternalReferenceCodeResponses, GetSiteTaxonomyCategoryByExternalReferenceCodeData, GetSiteTaxonomyCategoryByExternalReferenceCodeResponses, PutSiteTaxonomyCategoryByExternalReferenceCodeData, PutSiteTaxonomyCategoryByExternalReferenceCodeResponses, DeleteTaxonomyCategoryData, DeleteTaxonomyCategoryResponses, GetTaxonomyCategoryData, GetTaxonomyCategoryResponses, PatchTaxonomyCategoryData, PatchTaxonomyCategoryResponses, PutTaxonomyCategoryData, PutTaxonomyCategoryResponses, DeleteTaxonomyCategoryBatchData, DeleteTaxonomyCategoryBatchResponses, PutTaxonomyCategoryBatchData, PutTaxonomyCategoryBatchResponses, DeleteTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCodeData, DeleteTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCodeResponses, GetTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCodeData, GetTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCodeResponses, PutTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCodeData, PutTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCodeResponses, GetAssetLibraryTaxonomyCategoriesPageData, GetAssetLibraryTaxonomyCategoriesPageResponses, PostAssetLibraryTaxonomyCategoryData, PostAssetLibraryTaxonomyCategoryResponses, GetSiteTaxonomyCategoriesPageData, GetSiteTaxonomyCategoriesPageResponses, PostSiteTaxonomyCategoryData, PostSiteTaxonomyCategoryResponses, GetTaxonomyCategoriesRankedPageData, GetTaxonomyCategoriesRankedPageResponses, GetTaxonomyCategoryPermissionsPageData, GetTaxonomyCategoryPermissionsPageResponses, PutTaxonomyCategoryPermissionsPageData, PutTaxonomyCategoryPermissionsPageResponses, GetTaxonomyCategoryTaxonomyCategoriesPageData, GetTaxonomyCategoryTaxonomyCategoriesPageResponses, PostTaxonomyCategoryTaxonomyCategoryData, PostTaxonomyCategoryTaxonomyCategoryResponses, GetTaxonomyVocabularyTaxonomyCategoriesPageData, GetTaxonomyVocabularyTaxonomyCategoriesPageResponses, PostTaxonomyVocabularyTaxonomyCategoryData, PostTaxonomyVocabularyTaxonomyCategoryResponses, PostAssetLibraryTaxonomyCategoriesPageExportBatchData, PostAssetLibraryTaxonomyCategoriesPageExportBatchResponses, PostAssetLibraryTaxonomyCategoryBatchData, PostAssetLibraryTaxonomyCategoryBatchResponses, PostSiteTaxonomyCategoriesPageExportBatchData, PostSiteTaxonomyCategoriesPageExportBatchResponses, PostSiteTaxonomyCategoryBatchData, PostSiteTaxonomyCategoryBatchResponses, PostTaxonomyVocabularyTaxonomyCategoriesPageExportBatchData, PostTaxonomyVocabularyTaxonomyCategoriesPageExportBatchResponses, PostTaxonomyVocabularyTaxonomyCategoryBatchData, PostTaxonomyVocabularyTaxonomyCategoryBatchResponses, DeleteAssetLibraryTaxonomyVocabularyByExternalReferenceCodeData, DeleteAssetLibraryTaxonomyVocabularyByExternalReferenceCodeResponses, GetAssetLibraryTaxonomyVocabularyByExternalReferenceCodeData, GetAssetLibraryTaxonomyVocabularyByExternalReferenceCodeResponses, PutAssetLibraryTaxonomyVocabularyByExternalReferenceCodeData, PutAssetLibraryTaxonomyVocabularyByExternalReferenceCodeResponses, DeleteSiteTaxonomyVocabularyByExternalReferenceCodeData, DeleteSiteTaxonomyVocabularyByExternalReferenceCodeResponses, GetSiteTaxonomyVocabularyByExternalReferenceCodeData, GetSiteTaxonomyVocabularyByExternalReferenceCodeResponses, PutSiteTaxonomyVocabularyByExternalReferenceCodeData, PutSiteTaxonomyVocabularyByExternalReferenceCodeResponses, DeleteTaxonomyVocabularyData, DeleteTaxonomyVocabularyResponses, GetTaxonomyVocabularyData, GetTaxonomyVocabularyResponses, PatchTaxonomyVocabularyData, PatchTaxonomyVocabularyResponses, PutTaxonomyVocabularyData, PutTaxonomyVocabularyResponses, DeleteTaxonomyVocabularyBatchData, DeleteTaxonomyVocabularyBatchResponses, PostTaxonomyVocabularyBatchData, PostTaxonomyVocabularyBatchResponses, PutTaxonomyVocabularyBatchData, PutTaxonomyVocabularyBatchResponses, GetAssetLibraryTaxonomyVocabulariesPageData, GetAssetLibraryTaxonomyVocabulariesPageResponses, PostAssetLibraryTaxonomyVocabularyData, PostAssetLibraryTaxonomyVocabularyResponses, GetAssetLibraryTaxonomyVocabularyPermissionsPageData, GetAssetLibraryTaxonomyVocabularyPermissionsPageResponses, PutAssetLibraryTaxonomyVocabularyPermissionsPageData, PutAssetLibraryTaxonomyVocabularyPermissionsPageResponses, GetSiteTaxonomyVocabulariesPageData, GetSiteTaxonomyVocabulariesPageResponses, PostSiteTaxonomyVocabularyData, PostSiteTaxonomyVocabularyResponses, GetSiteTaxonomyVocabularyPermissionsPageData, GetSiteTaxonomyVocabularyPermissionsPageResponses, PutSiteTaxonomyVocabularyPermissionsPageData, PutSiteTaxonomyVocabularyPermissionsPageResponses, GetTaxonomyVocabulariesPageData, GetTaxonomyVocabulariesPageResponses, PostTaxonomyVocabularyData, PostTaxonomyVocabularyResponses, GetTaxonomyVocabularyPermissionsPageData, GetTaxonomyVocabularyPermissionsPageResponses, PutTaxonomyVocabularyPermissionsPageData, PutTaxonomyVocabularyPermissionsPageResponses, PostAssetLibraryTaxonomyVocabulariesPageExportBatchData, PostAssetLibraryTaxonomyVocabulariesPageExportBatchResponses, PostAssetLibraryTaxonomyVocabularyBatchData, PostAssetLibraryTaxonomyVocabularyBatchResponses, PostSiteTaxonomyVocabulariesPageExportBatchData, PostSiteTaxonomyVocabulariesPageExportBatchResponses, PostSiteTaxonomyVocabularyBatchData, PostSiteTaxonomyVocabularyBatchResponses, PostTaxonomyVocabulariesPageExportBatchData, PostTaxonomyVocabulariesPageExportBatchResponses } 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>;
};
/**
* Deletes the asset library's keyword by external reference code.
*/
export declare const deleteAssetLibraryKeywordByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteAssetLibraryKeywordByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteAssetLibraryKeywordByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the asset library's keyword by external reference code.
*/
export declare const getAssetLibraryKeywordByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryKeywordByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryKeywordByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Updates the asset library's keyword with the given external reference code, or creates it if it not exists.
*/
export declare const putAssetLibraryKeywordByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutAssetLibraryKeywordByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutAssetLibraryKeywordByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Deletes the keyword and returns a 204 if the operation succeeds.
*/
export declare const deleteKeyword: <ThrowOnError extends boolean = false>(options: Options<DeleteKeywordData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteKeywordResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves a keyword.
*/
export declare const getKeyword: <ThrowOnError extends boolean = false>(options: Options<GetKeywordData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetKeywordResponses, unknown, ThrowOnError, "fields">;
/**
* Replaces the keyword with the information sent in the request body. Any missing fields are deleted, unless required.
*/
export declare const putKeyword: <ThrowOnError extends boolean = false>(options: Options<PutKeywordData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutKeywordResponses, unknown, ThrowOnError, "fields">;
export declare const deleteKeywordBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteKeywordBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteKeywordBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postKeywordBatch: <ThrowOnError extends boolean = false>(options?: Options<PostKeywordBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostKeywordBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putKeywordBatch: <ThrowOnError extends boolean = false>(options?: Options<PutKeywordBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutKeywordBatchResponses, unknown, ThrowOnError, "fields">;
/**
* Deletes the site's keyword by external reference code.
*/
export declare const deleteSiteKeywordByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteSiteKeywordByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteSiteKeywordByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the site's keyword by external reference code.
*/
export declare const getSiteKeywordByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetSiteKeywordByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteKeywordByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Updates the site's keyword with the given external reference code, or creates it if it not exists.
*/
export declare const putSiteKeywordByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutSiteKeywordByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutSiteKeywordByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const getAssetLibraryKeywordPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryKeywordPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryKeywordPermissionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const putAssetLibraryKeywordPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<PutAssetLibraryKeywordPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutAssetLibraryKeywordPermissionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const getAssetLibraryKeywordsPage: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryKeywordsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryKeywordsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postAssetLibraryKeyword: <ThrowOnError extends boolean = false>(options: Options<PostAssetLibraryKeywordData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostAssetLibraryKeywordResponses, unknown, ThrowOnError, "fields">;
export declare const getKeywordsPage: <ThrowOnError extends boolean = false>(options?: Options<GetKeywordsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetKeywordsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postKeyword: <ThrowOnError extends boolean = false>(options?: Options<PostKeywordData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostKeywordResponses, unknown, ThrowOnError, "fields">;
export declare const getKeywordsRankedPage: <ThrowOnError extends boolean = false>(options?: Options<GetKeywordsRankedPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetKeywordsRankedPageResponses, unknown, ThrowOnError, "fields">;
export declare const getSiteKeywordPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<GetSiteKeywordPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteKeywordPermissionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const putSiteKeywordPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<PutSiteKeywordPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutSiteKeywordPermissionsPageResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves a Site's keywords. Results can be paginated, filtered, searched, and sorted.
*/
export declare const getSiteKeywordsPage: <ThrowOnError extends boolean = false>(options: Options<GetSiteKeywordsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteKeywordsPageResponses, unknown, ThrowOnError, "fields">;
/**
* Inserts a new keyword in a Site.
*/
export declare const postSiteKeyword: <ThrowOnError extends boolean = false>(options: Options<PostSiteKeywordData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteKeywordResponses, unknown, ThrowOnError, "fields">;
export declare const postAssetLibraryKeywordBatch: <ThrowOnError extends boolean = false>(options: Options<PostAssetLibraryKeywordBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostAssetLibraryKeywordBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postAssetLibraryKeywordsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostAssetLibraryKeywordsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostAssetLibraryKeywordsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postKeywordsPageExportBatch: <ThrowOnError extends boolean = false>(options?: Options<PostKeywordsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostKeywordsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postSiteKeywordBatch: <ThrowOnError extends boolean = false>(options: Options<PostSiteKeywordBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteKeywordBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postSiteKeywordsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostSiteKeywordsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteKeywordsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putKeywordMerge: <ThrowOnError extends boolean = false>(options: Options<PutKeywordMergeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutKeywordMergeResponses, unknown, ThrowOnError, "fields">;
export declare const putKeywordSubscribe: <ThrowOnError extends boolean = false>(options: Options<PutKeywordSubscribeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutKeywordSubscribeResponses, unknown, ThrowOnError, "fields">;
export declare const putKeywordUnsubscribe: <ThrowOnError extends boolean = false>(options: Options<PutKeywordUnsubscribeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutKeywordUnsubscribeResponses, unknown, ThrowOnError, "fields">;
/**
* Deletes the asset library's taxonomy category by external reference code.
*/
export declare const deleteAssetLibraryTaxonomyCategoryByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteAssetLibraryTaxonomyCategoryByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteAssetLibraryTaxonomyCategoryByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the asset library's taxonomy category by external reference code.
*/
export declare const getAssetLibraryTaxonomyCategoryByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryTaxonomyCategoryByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryTaxonomyCategoryByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Updates the asset library's taxonomy category with the given external reference code, or creates it if it not exists.
*/
export declare const putAssetLibraryTaxonomyCategoryByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutAssetLibraryTaxonomyCategoryByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutAssetLibraryTaxonomyCategoryByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Deletes the site's taxonomy category by external reference code.
*/
export declare const deleteSiteTaxonomyCategoryByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteSiteTaxonomyCategoryByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteSiteTaxonomyCategoryByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the site's taxonomy category by external reference code.
*/
export declare const getSiteTaxonomyCategoryByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetSiteTaxonomyCategoryByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteTaxonomyCategoryByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Updates the site's taxonomy category with the given external reference code, or creates it if it not exists.
*/
export declare const putSiteTaxonomyCategoryByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutSiteTaxonomyCategoryByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutSiteTaxonomyCategoryByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Deletes the taxonomy category and returns a 204 if the operation succeeds.
*/
export declare const deleteTaxonomyCategory: <ThrowOnError extends boolean = false>(options: Options<DeleteTaxonomyCategoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteTaxonomyCategoryResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves a taxonomy category.
*/
export declare const getTaxonomyCategory: <ThrowOnError extends boolean = false>(options: Options<GetTaxonomyCategoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTaxonomyCategoryResponses, unknown, ThrowOnError, "fields">;
/**
* Updates only the fields received in the request body. Other fields are left untouched.
*/
export declare const patchTaxonomyCategory: <ThrowOnError extends boolean = false>(options: Options<PatchTaxonomyCategoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchTaxonomyCategoryResponses, unknown, ThrowOnError, "fields">;
/**
* Replaces the taxonomy category with the information sent in the request body. Any missing fields are deleted unless they are required.
*/
export declare const putTaxonomyCategory: <ThrowOnError extends boolean = false>(options: Options<PutTaxonomyCategoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutTaxonomyCategoryResponses, unknown, ThrowOnError, "fields">;
export declare const deleteTaxonomyCategoryBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteTaxonomyCategoryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteTaxonomyCategoryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putTaxonomyCategoryBatch: <ThrowOnError extends boolean = false>(options?: Options<PutTaxonomyCategoryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutTaxonomyCategoryBatchResponses, unknown, ThrowOnError, "fields">;
/**
* Deletes the site's taxonomy category by external reference code.
*/
export declare const deleteTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the site's taxonomy category by external reference code.
*/
export declare const getTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Updates the site's taxonomy category with the given external reference code, or creates it if it not exists.
*/
export declare const putTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutTaxonomyVocabularyTaxonomyCategoryByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the asset library's taxonomy categories.
*/
export declare const getAssetLibraryTaxonomyCategoriesPage: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryTaxonomyCategoriesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryTaxonomyCategoriesPageResponses, unknown, ThrowOnError, "fields">;
/**
* Inserts a new Category in a Scope.
*/
export declare const postAssetLibraryTaxonomyCategory: <ThrowOnError extends boolean = false>(options: Options<PostAssetLibraryTaxonomyCategoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostAssetLibraryTaxonomyCategoryResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the site's taxonomy categories.
*/
export declare const getSiteTaxonomyCategoriesPage: <ThrowOnError extends boolean = false>(options: Options<GetSiteTaxonomyCategoriesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteTaxonomyCategoriesPageResponses, unknown, ThrowOnError, "fields">;
/**
* Inserts a new Category in a Scope.
*/
export declare const postSiteTaxonomyCategory: <ThrowOnError extends boolean = false>(options: Options<PostSiteTaxonomyCategoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteTaxonomyCategoryResponses, unknown, ThrowOnError, "fields">;
export declare const getTaxonomyCategoriesRankedPage: <ThrowOnError extends boolean = false>(options?: Options<GetTaxonomyCategoriesRankedPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTaxonomyCategoriesRankedPageResponses, unknown, ThrowOnError, "fields">;
export declare const getTaxonomyCategoryPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<GetTaxonomyCategoryPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTaxonomyCategoryPermissionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const putTaxonomyCategoryPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<PutTaxonomyCategoryPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutTaxonomyCategoryPermissionsPageResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves a taxonomy category's child taxonomy categories. Results can be paginated, filtered, searched, and sorted.
*/
export declare const getTaxonomyCategoryTaxonomyCategoriesPage: <ThrowOnError extends boolean = false>(options: Options<GetTaxonomyCategoryTaxonomyCategoriesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTaxonomyCategoryTaxonomyCategoriesPageResponses, unknown, ThrowOnError, "fields">;
/**
* Inserts a new child taxonomy category.
*/
export declare const postTaxonomyCategoryTaxonomyCategory: <ThrowOnError extends boolean = false>(options: Options<PostTaxonomyCategoryTaxonomyCategoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostTaxonomyCategoryTaxonomyCategoryResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves a vocabulary's taxonomy categories. Results can be paginated, filtered, searched, and sorted.
*/
export declare const getTaxonomyVocabularyTaxonomyCategoriesPage: <ThrowOnError extends boolean = false>(options: Options<GetTaxonomyVocabularyTaxonomyCategoriesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTaxonomyVocabularyTaxonomyCategoriesPageResponses, unknown, ThrowOnError, "fields">;
/**
* Inserts a new taxonomy category in a taxonomy vocabulary.
*/
export declare const postTaxonomyVocabularyTaxonomyCategory: <ThrowOnError extends boolean = false>(options: Options<PostTaxonomyVocabularyTaxonomyCategoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostTaxonomyVocabularyTaxonomyCategoryResponses, unknown, ThrowOnError, "fields">;
export declare const postAssetLibraryTaxonomyCategoriesPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostAssetLibraryTaxonomyCategoriesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostAssetLibraryTaxonomyCategoriesPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postAssetLibraryTaxonomyCategoryBatch: <ThrowOnError extends boolean = false>(options: Options<PostAssetLibraryTaxonomyCategoryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostAssetLibraryTaxonomyCategoryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postSiteTaxonomyCategoriesPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostSiteTaxonomyCategoriesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteTaxonomyCategoriesPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postSiteTaxonomyCategoryBatch: <ThrowOnError extends boolean = false>(options: Options<PostSiteTaxonomyCategoryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteTaxonomyCategoryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postTaxonomyVocabularyTaxonomyCategoriesPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostTaxonomyVocabularyTaxonomyCategoriesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostTaxonomyVocabularyTaxonomyCategoriesPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postTaxonomyVocabularyTaxonomyCategoryBatch: <ThrowOnError extends boolean = false>(options: Options<PostTaxonomyVocabularyTaxonomyCategoryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostTaxonomyVocabularyTaxonomyCategoryBatchResponses, unknown, ThrowOnError, "fields">;
/**
* Deletes the asset library's taxonomy vocabulary by external reference code.
*/
export declare const deleteAssetLibraryTaxonomyVocabularyByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteAssetLibraryTaxonomyVocabularyByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteAssetLibraryTaxonomyVocabularyByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the asset library's taxonomy vocabulary by external reference code.
*/
export declare const getAssetLibraryTaxonomyVocabularyByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryTaxonomyVocabularyByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryTaxonomyVocabularyByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Updates the asset library's taxonomy vocabulary with the given external reference code, or creates it if it not exists.
*/
export declare const putAssetLibraryTaxonomyVocabularyByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutAssetLibraryTaxonomyVocabularyByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutAssetLibraryTaxonomyVocabularyByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Deletes the site's taxonomy vocabulary by external reference code.
*/
export declare const deleteSiteTaxonomyVocabularyByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteSiteTaxonomyVocabularyByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteSiteTaxonomyVocabularyByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the site's taxonomy vocabulary by external reference code.
*/
export declare const getSiteTaxonomyVocabularyByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetSiteTaxonomyVocabularyByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteTaxonomyVocabularyByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Updates the site's taxonomy vocabulary with the given external reference code, or creates it if it not exists.
*/
export declare const putSiteTaxonomyVocabularyByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutSiteTaxonomyVocabularyByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutSiteTaxonomyVocabularyByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Deletes the taxonomy vocabulary and returns a 204 if the operation succeeds.
*/
export declare const deleteTaxonomyVocabulary: <ThrowOnError extends boolean = false>(options: Options<DeleteTaxonomyVocabularyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteTaxonomyVocabularyResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves a taxonomy vocabulary.
*/
export declare const getTaxonomyVocabulary: <ThrowOnError extends boolean = false>(options: Options<GetTaxonomyVocabularyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTaxonomyVocabularyResponses, unknown, ThrowOnError, "fields">;
/**
* Updates only the fields received in the request body. Any other fields are left untouched.
*/
export declare const patchTaxonomyVocabulary: <ThrowOnError extends boolean = false>(options: Options<PatchTaxonomyVocabularyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchTaxonomyVocabularyResponses, unknown, ThrowOnError, "fields">;
/**
* Replaces the taxonomy vocabulary with the information sent in the request body. Any missing fields are deleted unless they are required.
*/
export declare const putTaxonomyVocabulary: <ThrowOnError extends boolean = false>(options: Options<PutTaxonomyVocabularyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutTaxonomyVocabularyResponses, unknown, ThrowOnError, "fields">;
export declare const deleteTaxonomyVocabularyBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteTaxonomyVocabularyBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteTaxonomyVocabularyBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postTaxonomyVocabularyBatch: <ThrowOnError extends boolean = false>(options?: Options<PostTaxonomyVocabularyBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostTaxonomyVocabularyBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putTaxonomyVocabularyBatch: <ThrowOnError extends boolean = false>(options?: Options<PutTaxonomyVocabularyBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutTaxonomyVocabularyBatchResponses, unknown, ThrowOnError, "fields">;
export declare const getAssetLibraryTaxonomyVocabulariesPage: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryTaxonomyVocabulariesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryTaxonomyVocabulariesPageResponses, unknown, ThrowOnError, "fields">;
export declare const postAssetLibraryTaxonomyVocabulary: <ThrowOnError extends boolean = false>(options: Options<PostAssetLibraryTaxonomyVocabularyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostAssetLibraryTaxonomyVocabularyResponses, unknown, ThrowOnError, "fields">;
export declare const getAssetLibraryTaxonomyVocabularyPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryTaxonomyVocabularyPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryTaxonomyVocabularyPermissionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const putAssetLibraryTaxonomyVocabularyPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<PutAssetLibraryTaxonomyVocabularyPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutAssetLibraryTaxonomyVocabularyPermissionsPageResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves a Site's taxonomy vocabularies. Results can be paginated, filtered, searched, and sorted.
*/
export declare const getSiteTaxonomyVocabulariesPage: <ThrowOnError extends boolean = false>(options: Options<GetSiteTaxonomyVocabulariesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteTaxonomyVocabulariesPageResponses, unknown, ThrowOnError, "fields">;
/**
* Inserts a new taxonomy vocabulary in a Site.
*/
export declare const postSiteTaxonomyVocabulary: <ThrowOnError extends boolean = false>(options: Options<PostSiteTaxonomyVocabularyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteTaxonomyVocabularyResponses, unknown, ThrowOnError, "fields">;
export declare const getSiteTaxonomyVocabularyPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<GetSiteTaxonomyVocabularyPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteTaxonomyVocabularyPermissionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const putSiteTaxonomyVocabularyPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<PutSiteTaxonomyVocabularyPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutSiteTaxonomyVocabularyPermissionsPageResponses, unknown, ThrowOnError, "fields">;
/**
* Gets all taxonomy vocabularies that were created in CMS. Does not retrieve vocabularies created in DXP. CMS vocabularies are distinguished by having a `groupId = 0`.
*/
export declare const getTaxonomyVocabulariesPage: <ThrowOnError extends boolean = false>(options?: Options<GetTaxonomyVocabulariesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTaxonomyVocabulariesPageResponses, unknown, ThrowOnError, "fields">;
/**
* Creates the asset library's taxonomy vocabulary in the given spaces.
*/
export declare const postTaxonomyVocabulary: <ThrowOnError extends boolean = false>(options?: Options<PostTaxonomyVocabularyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostTaxonomyVocabularyResponses, unknown, ThrowOnError, "fields">;
export declare const getTaxonomyVocabularyPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<GetTaxonomyVocabularyPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTaxonomyVocabularyPermissionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const putTaxonomyVocabularyPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<PutTaxonomyVocabularyPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutTaxonomyVocabularyPermissionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postAssetLibraryTaxonomyVocabulariesPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostAssetLibraryTaxonomyVocabulariesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostAssetLibraryTaxonomyVocabulariesPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postAssetLibraryTaxonomyVocabularyBatch: <ThrowOnError extends boolean = false>(options: Options<PostAssetLibraryTaxonomyVocabularyBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostAssetLibraryTaxonomyVocabularyBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postSiteTaxonomyVocabulariesPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostSiteTaxonomyVocabulariesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteTaxonomyVocabulariesPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postSiteTaxonomyVocabularyBatch: <ThrowOnError extends boolean = false>(options: Options<PostSiteTaxonomyVocabularyBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteTaxonomyVocabularyBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postTaxonomyVocabulariesPageExportBatch: <ThrowOnError extends boolean = false>(options?: Options<PostTaxonomyVocabulariesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostTaxonomyVocabulariesPageExportBatchResponses, unknown, ThrowOnError, "fields">;