liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
170 lines (169 loc) • 22.5 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { DeleteAssetLibraryData, DeleteAssetLibraryResponses, GetAssetLibraryData, GetAssetLibraryResponses, PatchAssetLibraryData, PatchAssetLibraryResponses, DeleteAssetLibraryBatchData, DeleteAssetLibraryBatchResponses, PostAssetLibraryBatchData, PostAssetLibraryBatchResponses, DeleteAssetLibraryByExternalReferenceCodeData, DeleteAssetLibraryByExternalReferenceCodeResponses, GetAssetLibraryByExternalReferenceCodeData, GetAssetLibraryByExternalReferenceCodeResponses, PatchAssetLibraryByExternalReferenceCodeData, PatchAssetLibraryByExternalReferenceCodeResponses, PutAssetLibraryByExternalReferenceCodeData, PutAssetLibraryByExternalReferenceCodeResponses, DeleteAssetLibraryByExternalReferenceCodePinData, DeleteAssetLibraryByExternalReferenceCodePinResponses, PutAssetLibraryByExternalReferenceCodePinData, PutAssetLibraryByExternalReferenceCodePinResponses, DeleteAssetLibraryPinData, DeleteAssetLibraryPinResponses, PutAssetLibraryPinData, PutAssetLibraryPinResponses, GetAssetLibrariesPageData, GetAssetLibrariesPageResponses, PostAssetLibraryData, PostAssetLibraryResponses, GetAssetLibrariesPinnedByMePageData, GetAssetLibrariesPinnedByMePageResponses, DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeData, DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponses, GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeData, GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponses, PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeData, PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponses, DeleteAssetLibrarySiteData, DeleteAssetLibrarySiteResponses, GetAssetLibrarySiteData, GetAssetLibrarySiteResponses, PutAssetLibrarySiteData, PutAssetLibrarySiteResponses, GetAssetLibraryByExternalReferenceCodeSitesPageData, GetAssetLibraryByExternalReferenceCodeSitesPageResponses, GetAssetLibrarySitesPageData, GetAssetLibrarySitesPageResponses, DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeData, DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponses, GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeData, GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponses, PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeData, PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponses, DeleteAssetLibraryUserAccountData, DeleteAssetLibraryUserAccountResponses, GetAssetLibraryUserAccountData, GetAssetLibraryUserAccountResponses, PutAssetLibraryUserAccountData, PutAssetLibraryUserAccountResponses, GetAssetLibraryByExternalReferenceCodeUserAccountsPageData, GetAssetLibraryByExternalReferenceCodeUserAccountsPageResponses, GetAssetLibraryUserAccountsPageData, GetAssetLibraryUserAccountsPageResponses, DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeData, DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponses, GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeData, GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponses, PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeData, PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponses, DeleteAssetLibraryUserGroupData, DeleteAssetLibraryUserGroupResponses, GetAssetLibraryUserGroupData, GetAssetLibraryUserGroupResponses, PutAssetLibraryUserGroupData, PutAssetLibraryUserGroupResponses, GetAssetLibraryByExternalReferenceCodeUserGroupsPageData, GetAssetLibraryByExternalReferenceCodeUserGroupsPageResponses, GetAssetLibraryUserGroupsPageData, GetAssetLibraryUserGroupsPageResponses } 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.
*/
export declare const deleteAssetLibrary: <ThrowOnError extends boolean = false>(options: Options<DeleteAssetLibraryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteAssetLibraryResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the asset library.
*/
export declare const getAssetLibrary: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryResponses, unknown, ThrowOnError, "fields">;
/**
* Updates the asset library using only the fields received in the request body. Any other fields are left untouched.
*/
export declare const patchAssetLibrary: <ThrowOnError extends boolean = false>(options: Options<PatchAssetLibraryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchAssetLibraryResponses, unknown, ThrowOnError, "fields">;
export declare const deleteAssetLibraryBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteAssetLibraryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteAssetLibraryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postAssetLibraryBatch: <ThrowOnError extends boolean = false>(options?: Options<PostAssetLibraryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostAssetLibraryBatchResponses, unknown, ThrowOnError, "fields">;
/**
* Deletes the asset library by external reference code.
*/
export declare const deleteAssetLibraryByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteAssetLibraryByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteAssetLibraryByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the asset library by external reference code.
*/
export declare const getAssetLibraryByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Updates the asset library using only the fields received in the request body with the given external reference code. Any other fields are left untouched.
*/
export declare const patchAssetLibraryByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PatchAssetLibraryByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchAssetLibraryByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Replaces the asset library with information sent in the request body with the given external reference code. Any missing fields are deleted unless they are required.
*/
export declare const putAssetLibraryByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutAssetLibraryByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutAssetLibraryByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Unpins the asset library.
*/
export declare const deleteAssetLibraryByExternalReferenceCodePin: <ThrowOnError extends boolean = false>(options: Options<DeleteAssetLibraryByExternalReferenceCodePinData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteAssetLibraryByExternalReferenceCodePinResponses, unknown, ThrowOnError, "fields">;
/**
* Pins the asset library.
*/
export declare const putAssetLibraryByExternalReferenceCodePin: <ThrowOnError extends boolean = false>(options: Options<PutAssetLibraryByExternalReferenceCodePinData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutAssetLibraryByExternalReferenceCodePinResponses, unknown, ThrowOnError, "fields">;
/**
* Unpins the asset library.
*/
export declare const deleteAssetLibraryPin: <ThrowOnError extends boolean = false>(options: Options<DeleteAssetLibraryPinData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteAssetLibraryPinResponses, unknown, ThrowOnError, "fields">;
/**
* Pins the asset library.
*/
export declare const putAssetLibraryPin: <ThrowOnError extends boolean = false>(options: Options<PutAssetLibraryPinData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutAssetLibraryPinResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the asset libraries. Results can be paginated, filtered, searched, and sorted.
*/
export declare const getAssetLibrariesPage: <ThrowOnError extends boolean = false>(options?: Options<GetAssetLibrariesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibrariesPageResponses, unknown, ThrowOnError, "fields">;
/**
* Adds a new asset library
*/
export declare const postAssetLibrary: <ThrowOnError extends boolean = false>(options?: Options<PostAssetLibraryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostAssetLibraryResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the pinned asset libraries.
*/
export declare const getAssetLibrariesPinnedByMePage: <ThrowOnError extends boolean = false>(options?: Options<GetAssetLibrariesPinnedByMePageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibrariesPinnedByMePageResponses, unknown, ThrowOnError, "fields">;
/**
* Disconnects the site with the given external reference code from the asset library.
*/
export declare const deleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Gets a site from the asset library using the provided external reference codes.
*/
export declare const getAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Connects the site with the given external reference code to the asset library.
*/
export declare const putAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Disconnects the site from the asset library.
*/
export declare const deleteAssetLibrarySite: <ThrowOnError extends boolean = false>(options: Options<DeleteAssetLibrarySiteData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteAssetLibrarySiteResponses, unknown, ThrowOnError, "fields">;
/**
* Gets a site connected to the asset library.
*/
export declare const getAssetLibrarySite: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibrarySiteData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibrarySiteResponses, unknown, ThrowOnError, "fields">;
/**
* Connects the site to the asset library.
*/
export declare const putAssetLibrarySite: <ThrowOnError extends boolean = false>(options: Options<PutAssetLibrarySiteData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutAssetLibrarySiteResponses, unknown, ThrowOnError, "fields">;
/**
* Get the asset library's with the provided external reference code connected sites. Results can be paginated.
*/
export declare const getAssetLibraryByExternalReferenceCodeSitesPage: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryByExternalReferenceCodeSitesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryByExternalReferenceCodeSitesPageResponses, unknown, ThrowOnError, "fields">;
/**
* Get the asset library's connected sites. Results can be paginated.
*/
export declare const getAssetLibrarySitesPage: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibrarySitesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibrarySitesPageResponses, unknown, ThrowOnError, "fields">;
/**
* Removes the user from the asset library using the provided external reference codes.
*/
export declare const deleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Gets a user connected to the asset library using the provided external reference codes.
*/
export declare const getAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Adds the user to the asset library using the provided external reference codes.
*/
export declare const putAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Removes the user from the asset library.
*/
export declare const deleteAssetLibraryUserAccount: <ThrowOnError extends boolean = false>(options: Options<DeleteAssetLibraryUserAccountData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteAssetLibraryUserAccountResponses, unknown, ThrowOnError, "fields">;
/**
* Gets a user connected to the asset library.
*/
export declare const getAssetLibraryUserAccount: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryUserAccountData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryUserAccountResponses, unknown, ThrowOnError, "fields">;
/**
* Adds the user to the asset library.
*/
export declare const putAssetLibraryUserAccount: <ThrowOnError extends boolean = false>(options: Options<PutAssetLibraryUserAccountData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutAssetLibraryUserAccountResponses, unknown, ThrowOnError, "fields">;
/**
* Get the asset library with the provided external reference code associated users. Results can be paginated, filtered, searched, and sorted.
*/
export declare const getAssetLibraryByExternalReferenceCodeUserAccountsPage: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryByExternalReferenceCodeUserAccountsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryByExternalReferenceCodeUserAccountsPageResponses, unknown, ThrowOnError, "fields">;
/**
* Get the asset library associated users. Results can be paginated, filtered, searched, and sorted.
*/
export declare const getAssetLibraryUserAccountsPage: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryUserAccountsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryUserAccountsPageResponses, unknown, ThrowOnError, "fields">;
/**
* Removes a user group from the asset library using the provided external reference codes.
*/
export declare const deleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Gets a user group from the asset library.
*/
export declare const getAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Associates the user group with the given external reference code to the asset library.
*/
export declare const putAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
* Removes a user group from the asset library.
*/
export declare const deleteAssetLibraryUserGroup: <ThrowOnError extends boolean = false>(options: Options<DeleteAssetLibraryUserGroupData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteAssetLibraryUserGroupResponses, unknown, ThrowOnError, "fields">;
/**
* Gets a user group from the asset library.
*/
export declare const getAssetLibraryUserGroup: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryUserGroupData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryUserGroupResponses, unknown, ThrowOnError, "fields">;
/**
* Associates the user group to the asset library.
*/
export declare const putAssetLibraryUserGroup: <ThrowOnError extends boolean = false>(options: Options<PutAssetLibraryUserGroupData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutAssetLibraryUserGroupResponses, unknown, ThrowOnError, "fields">;
/**
* Get the asset library associated with the provided external reference code user groups. Results can be paginated, filtered, searched, and sorted.
*/
export declare const getAssetLibraryByExternalReferenceCodeUserGroupsPage: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryByExternalReferenceCodeUserGroupsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryByExternalReferenceCodeUserGroupsPageResponses, unknown, ThrowOnError, "fields">;
/**
* Get the asset library associated user groups. Results can be paginated, filtered, searched, and sorted.
*/
export declare const getAssetLibraryUserGroupsPage: <ThrowOnError extends boolean = false>(options: Options<GetAssetLibraryUserGroupsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAssetLibraryUserGroupsPageResponses, unknown, ThrowOnError, "fields">;