liferay-headless-rest-client

Version:
A collection of Headless Clients used in Liferay Portal
github.com/kevenleone/liferay-headless-rest-client
88 lines (87 loc) • 18.7 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { DeleteScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorData, DeleteScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses, GetScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorData, GetScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses, PutScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorData, PutScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses, GetScopeScopeKeyByExternalReferenceCodeCollaboratorsPageData, GetScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses, PostScopeScopeKeyByExternalReferenceCodeCollaboratorsPageData, PostScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses, DeleteByExternalReferenceCodeData, DeleteByExternalReferenceCodeResponses, GetByExternalReferenceCodeData, GetByExternalReferenceCodeResponses, PatchByExternalReferenceCodeData, PatchByExternalReferenceCodeResponses, PutByExternalReferenceCodeData, PutByExternalReferenceCodeResponses, DeleteByExternalReferenceCodeByVersionData, DeleteByExternalReferenceCodeByVersionResponses, GetByExternalReferenceCodeByVersionData, GetByExternalReferenceCodeByVersionResponses, DeletePerformanceCookieEntryBatchData, DeletePerformanceCookieEntryBatchResponses, PostPerformanceCookieEntryBatchData, PostPerformanceCookieEntryBatchResponses, PutPerformanceCookieEntryBatchData, PutPerformanceCookieEntryBatchResponses, GetByExternalReferenceCodeVersionsPageData, GetByExternalReferenceCodeVersionsPageResponses, GetPerformanceCookieEntriesPageData, GetPerformanceCookieEntriesPageResponses, PostPerformanceCookieEntryData, PostPerformanceCookieEntryResponses, PostByExternalReferenceCodeByVersionCopyData, PostByExternalReferenceCodeByVersionCopyResponses, PostByExternalReferenceCodeByVersionExpireData, PostByExternalReferenceCodeByVersionExpireResponses, PostPerformanceCookieEntriesPageExportBatchData, PostPerformanceCookieEntriesPageExportBatchResponses, PostValidateData, PostValidateResponses, PutByExternalReferenceCodeByVersionRestoreData, PutByExternalReferenceCodeByVersionRestoreResponses, GetOpenApiData, GetOpenApiResponses, DeletePerformanceCookieEntryCollaboratorByTypeCollaboratorData, DeletePerformanceCookieEntryCollaboratorByTypeCollaboratorResponses, GetPerformanceCookieEntryCollaboratorByTypeCollaboratorData, GetPerformanceCookieEntryCollaboratorByTypeCollaboratorResponses, PutPerformanceCookieEntryCollaboratorByTypeCollaboratorData, PutPerformanceCookieEntryCollaboratorByTypeCollaboratorResponses, GetPerformanceCookieEntryCollaboratorsPageData, GetPerformanceCookieEntryCollaboratorsPageResponses, PostPerformanceCookieEntryCollaboratorsPageData, PostPerformanceCookieEntryCollaboratorsPageResponses, PostPerformanceCookieEntryCollaboratorsPageExportBatchData, PostPerformanceCookieEntryCollaboratorsPageExportBatchResponses, DeletePerformanceCookieEntryData, DeletePerformanceCookieEntryResponses, GetPerformanceCookieEntryData, GetPerformanceCookieEntryResponses, PatchPerformanceCookieEntryData, PatchPerformanceCookieEntryResponses, PutPerformanceCookieEntryData, PutPerformanceCookieEntryResponses, DeletePerformanceCookieEntryByVersionData, DeletePerformanceCookieEntryByVersionResponses, GetPerformanceCookieEntryByVersionData, GetPerformanceCookieEntryByVersionResponses, GetPerformanceCookieEntriesVersionsPageData, GetPerformanceCookieEntriesVersionsPageResponses, GetPerformanceCookieEntryPermissionsPageData, GetPerformanceCookieEntryPermissionsPageResponses, PutPerformanceCookieEntryPermissionsPageData, PutPerformanceCookieEntryPermissionsPageResponses, PostPerformanceCookieEntryByVersionCopyData, PostPerformanceCookieEntryByVersionCopyResponses, PostPerformanceCookieEntryByVersionExpireData, PostPerformanceCookieEntryByVersionExpireResponses, PostPerformanceCookieEntryExpireData, PostPerformanceCookieEntryExpireResponses, PutPerformanceCookieEntryByVersionRestoreData, PutPerformanceCookieEntryByVersionRestoreResponses } 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 collaborator for an object entry and returns a 204 if the operation succeeds.
 */
export declare const deleteScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<DeleteScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieves the collaborator for an object entry.
 */
export declare const getScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<GetScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">;
/**
 * Add or update a collaborator received in the request.
 */
export declare const putScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<PutScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieves the collaborators of an object entry.
 */
export declare const getScopeScopeKeyByExternalReferenceCodeCollaboratorsPage: <ThrowOnError extends boolean = false>(options: Options<GetScopeScopeKeyByExternalReferenceCodeCollaboratorsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses, unknown, ThrowOnError, "fields">;
/**
 * Add or update all the collaborators received in the request. Delete existing collaborators that are not included in the request. Send a notification for the new collaborators and those whose permissions are different.
 */
export declare const postScopeScopeKeyByExternalReferenceCodeCollaboratorsPage: <ThrowOnError extends boolean = false>(options: Options<PostScopeScopeKeyByExternalReferenceCodeCollaboratorsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses, unknown, ThrowOnError, "fields">;
export declare const deleteByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const getByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const patchByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PatchByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const putByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const deleteByExternalReferenceCodeByVersion: <ThrowOnError extends boolean = false>(options: Options<DeleteByExternalReferenceCodeByVersionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteByExternalReferenceCodeByVersionResponses, unknown, ThrowOnError, "fields">;
export declare const getByExternalReferenceCodeByVersion: <ThrowOnError extends boolean = false>(options: Options<GetByExternalReferenceCodeByVersionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetByExternalReferenceCodeByVersionResponses, unknown, ThrowOnError, "fields">;
export declare const deletePerformanceCookieEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<DeletePerformanceCookieEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeletePerformanceCookieEntryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postPerformanceCookieEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<PostPerformanceCookieEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPerformanceCookieEntryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putPerformanceCookieEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<PutPerformanceCookieEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutPerformanceCookieEntryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const getByExternalReferenceCodeVersionsPage: <ThrowOnError extends boolean = false>(options: Options<GetByExternalReferenceCodeVersionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetByExternalReferenceCodeVersionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const getPerformanceCookieEntriesPage: <ThrowOnError extends boolean = false>(options?: Options<GetPerformanceCookieEntriesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPerformanceCookieEntriesPageResponses, unknown, ThrowOnError, "fields">;
export declare const postPerformanceCookieEntry: <ThrowOnError extends boolean = false>(options?: Options<PostPerformanceCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPerformanceCookieEntryResponses, unknown, ThrowOnError, "fields">;
export declare const postByExternalReferenceCodeByVersionCopy: <ThrowOnError extends boolean = false>(options: Options<PostByExternalReferenceCodeByVersionCopyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostByExternalReferenceCodeByVersionCopyResponses, unknown, ThrowOnError, "fields">;
export declare const postByExternalReferenceCodeByVersionExpire: <ThrowOnError extends boolean = false>(options: Options<PostByExternalReferenceCodeByVersionExpireData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostByExternalReferenceCodeByVersionExpireResponses, unknown, ThrowOnError, "fields">;
export declare const postPerformanceCookieEntriesPageExportBatch: <ThrowOnError extends boolean = false>(options?: Options<PostPerformanceCookieEntriesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPerformanceCookieEntriesPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postValidate: <ThrowOnError extends boolean = false>(options?: Options<PostValidateData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostValidateResponses, unknown, ThrowOnError, "fields">;
export declare const putByExternalReferenceCodeByVersionRestore: <ThrowOnError extends boolean = false>(options: Options<PutByExternalReferenceCodeByVersionRestoreData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutByExternalReferenceCodeByVersionRestoreResponses, unknown, ThrowOnError, "fields">;
export declare const getOpenApi: <ThrowOnError extends boolean = false>(options: Options<GetOpenApiData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetOpenApiResponses, unknown, ThrowOnError, "fields">;
/**
 * Deletes the collaborator for an object entry and returns a 204 if the operation succeeds.
 */
export declare const deletePerformanceCookieEntryCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<DeletePerformanceCookieEntryCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeletePerformanceCookieEntryCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieves the collaborator for an object entry.
 */
export declare const getPerformanceCookieEntryCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<GetPerformanceCookieEntryCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPerformanceCookieEntryCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">;
/**
 * Add or update a collaborator received in the request.
 */
export declare const putPerformanceCookieEntryCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<PutPerformanceCookieEntryCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutPerformanceCookieEntryCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieves the collaborators of an object entry.
 */
export declare const getPerformanceCookieEntryCollaboratorsPage: <ThrowOnError extends boolean = false>(options: Options<GetPerformanceCookieEntryCollaboratorsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPerformanceCookieEntryCollaboratorsPageResponses, unknown, ThrowOnError, "fields">;
/**
 * Add or update all the collaborators received in the request. Delete existing collaborators that are not included in the request.
 */
export declare const postPerformanceCookieEntryCollaboratorsPage: <ThrowOnError extends boolean = false>(options: Options<PostPerformanceCookieEntryCollaboratorsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPerformanceCookieEntryCollaboratorsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postPerformanceCookieEntryCollaboratorsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostPerformanceCookieEntryCollaboratorsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPerformanceCookieEntryCollaboratorsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const deletePerformanceCookieEntry: <ThrowOnError extends boolean = false>(options: Options<DeletePerformanceCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeletePerformanceCookieEntryResponses, unknown, ThrowOnError, "fields">;
export declare const getPerformanceCookieEntry: <ThrowOnError extends boolean = false>(options: Options<GetPerformanceCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPerformanceCookieEntryResponses, unknown, ThrowOnError, "fields">;
export declare const patchPerformanceCookieEntry: <ThrowOnError extends boolean = false>(options: Options<PatchPerformanceCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchPerformanceCookieEntryResponses, unknown, ThrowOnError, "fields">;
export declare const putPerformanceCookieEntry: <ThrowOnError extends boolean = false>(options: Options<PutPerformanceCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutPerformanceCookieEntryResponses, unknown, ThrowOnError, "fields">;
export declare const deletePerformanceCookieEntryByVersion: <ThrowOnError extends boolean = false>(options: Options<DeletePerformanceCookieEntryByVersionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeletePerformanceCookieEntryByVersionResponses, unknown, ThrowOnError, "fields">;
export declare const getPerformanceCookieEntryByVersion: <ThrowOnError extends boolean = false>(options: Options<GetPerformanceCookieEntryByVersionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPerformanceCookieEntryByVersionResponses, unknown, ThrowOnError, "fields">;
export declare const getPerformanceCookieEntriesVersionsPage: <ThrowOnError extends boolean = false>(options: Options<GetPerformanceCookieEntriesVersionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPerformanceCookieEntriesVersionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const getPerformanceCookieEntryPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<GetPerformanceCookieEntryPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPerformanceCookieEntryPermissionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const putPerformanceCookieEntryPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<PutPerformanceCookieEntryPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutPerformanceCookieEntryPermissionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postPerformanceCookieEntryByVersionCopy: <ThrowOnError extends boolean = false>(options: Options<PostPerformanceCookieEntryByVersionCopyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPerformanceCookieEntryByVersionCopyResponses, unknown, ThrowOnError, "fields">;
export declare const postPerformanceCookieEntryByVersionExpire: <ThrowOnError extends boolean = false>(options: Options<PostPerformanceCookieEntryByVersionExpireData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPerformanceCookieEntryByVersionExpireResponses, unknown, ThrowOnError, "fields">;
export declare const postPerformanceCookieEntryExpire: <ThrowOnError extends boolean = false>(options: Options<PostPerformanceCookieEntryExpireData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPerformanceCookieEntryExpireResponses, unknown, ThrowOnError, "fields">;
export declare const putPerformanceCookieEntryByVersionRestore: <ThrowOnError extends boolean = false>(options: Options<PutPerformanceCookieEntryByVersionRestoreData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutPerformanceCookieEntryByVersionRestoreResponses, unknown, ThrowOnError, "fields">;