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.4 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, DeleteNecessaryCookieEntryBatchData, DeleteNecessaryCookieEntryBatchResponses, PostNecessaryCookieEntryBatchData, PostNecessaryCookieEntryBatchResponses, PutNecessaryCookieEntryBatchData, PutNecessaryCookieEntryBatchResponses, GetByExternalReferenceCodeVersionsPageData, GetByExternalReferenceCodeVersionsPageResponses, GetNecessaryCookieEntriesPageData, GetNecessaryCookieEntriesPageResponses, PostNecessaryCookieEntryData, PostNecessaryCookieEntryResponses, PostByExternalReferenceCodeByVersionCopyData, PostByExternalReferenceCodeByVersionCopyResponses, PostByExternalReferenceCodeByVersionExpireData, PostByExternalReferenceCodeByVersionExpireResponses, PostNecessaryCookieEntriesPageExportBatchData, PostNecessaryCookieEntriesPageExportBatchResponses, PostValidateData, PostValidateResponses, PutByExternalReferenceCodeByVersionRestoreData, PutByExternalReferenceCodeByVersionRestoreResponses, GetOpenApiData, GetOpenApiResponses, DeleteNecessaryCookieEntryCollaboratorByTypeCollaboratorData, DeleteNecessaryCookieEntryCollaboratorByTypeCollaboratorResponses, GetNecessaryCookieEntryCollaboratorByTypeCollaboratorData, GetNecessaryCookieEntryCollaboratorByTypeCollaboratorResponses, PutNecessaryCookieEntryCollaboratorByTypeCollaboratorData, PutNecessaryCookieEntryCollaboratorByTypeCollaboratorResponses, GetNecessaryCookieEntryCollaboratorsPageData, GetNecessaryCookieEntryCollaboratorsPageResponses, PostNecessaryCookieEntryCollaboratorsPageData, PostNecessaryCookieEntryCollaboratorsPageResponses, PostNecessaryCookieEntryCollaboratorsPageExportBatchData, PostNecessaryCookieEntryCollaboratorsPageExportBatchResponses, DeleteNecessaryCookieEntryData, DeleteNecessaryCookieEntryResponses, GetNecessaryCookieEntryData, GetNecessaryCookieEntryResponses, PatchNecessaryCookieEntryData, PatchNecessaryCookieEntryResponses, PutNecessaryCookieEntryData, PutNecessaryCookieEntryResponses, DeleteNecessaryCookieEntryByVersionData, DeleteNecessaryCookieEntryByVersionResponses, GetNecessaryCookieEntryByVersionData, GetNecessaryCookieEntryByVersionResponses, GetNecessaryCookieEntriesVersionsPageData, GetNecessaryCookieEntriesVersionsPageResponses, GetNecessaryCookieEntryPermissionsPageData, GetNecessaryCookieEntryPermissionsPageResponses, PutNecessaryCookieEntryPermissionsPageData, PutNecessaryCookieEntryPermissionsPageResponses, PostNecessaryCookieEntryByVersionCopyData, PostNecessaryCookieEntryByVersionCopyResponses, PostNecessaryCookieEntryByVersionExpireData, PostNecessaryCookieEntryByVersionExpireResponses, PostNecessaryCookieEntryExpireData, PostNecessaryCookieEntryExpireResponses, PutNecessaryCookieEntryByVersionRestoreData, PutNecessaryCookieEntryByVersionRestoreResponses } 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 deleteNecessaryCookieEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteNecessaryCookieEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteNecessaryCookieEntryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postNecessaryCookieEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<PostNecessaryCookieEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNecessaryCookieEntryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putNecessaryCookieEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<PutNecessaryCookieEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutNecessaryCookieEntryBatchResponses, 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 getNecessaryCookieEntriesPage: <ThrowOnError extends boolean = false>(options?: Options<GetNecessaryCookieEntriesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetNecessaryCookieEntriesPageResponses, unknown, ThrowOnError, "fields">;
export declare const postNecessaryCookieEntry: <ThrowOnError extends boolean = false>(options?: Options<PostNecessaryCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNecessaryCookieEntryResponses, 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 postNecessaryCookieEntriesPageExportBatch: <ThrowOnError extends boolean = false>(options?: Options<PostNecessaryCookieEntriesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNecessaryCookieEntriesPageExportBatchResponses, 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 deleteNecessaryCookieEntryCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<DeleteNecessaryCookieEntryCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteNecessaryCookieEntryCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieves the collaborator for an object entry.
 */
export declare const getNecessaryCookieEntryCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<GetNecessaryCookieEntryCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetNecessaryCookieEntryCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">;
/**
 * Add or update a collaborator received in the request.
 */
export declare const putNecessaryCookieEntryCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<PutNecessaryCookieEntryCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutNecessaryCookieEntryCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieves the collaborators of an object entry.
 */
export declare const getNecessaryCookieEntryCollaboratorsPage: <ThrowOnError extends boolean = false>(options: Options<GetNecessaryCookieEntryCollaboratorsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetNecessaryCookieEntryCollaboratorsPageResponses, 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 postNecessaryCookieEntryCollaboratorsPage: <ThrowOnError extends boolean = false>(options: Options<PostNecessaryCookieEntryCollaboratorsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNecessaryCookieEntryCollaboratorsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postNecessaryCookieEntryCollaboratorsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostNecessaryCookieEntryCollaboratorsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNecessaryCookieEntryCollaboratorsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const deleteNecessaryCookieEntry: <ThrowOnError extends boolean = false>(options: Options<DeleteNecessaryCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteNecessaryCookieEntryResponses, unknown, ThrowOnError, "fields">;
export declare const getNecessaryCookieEntry: <ThrowOnError extends boolean = false>(options: Options<GetNecessaryCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetNecessaryCookieEntryResponses, unknown, ThrowOnError, "fields">;
export declare const patchNecessaryCookieEntry: <ThrowOnError extends boolean = false>(options: Options<PatchNecessaryCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchNecessaryCookieEntryResponses, unknown, ThrowOnError, "fields">;
export declare const putNecessaryCookieEntry: <ThrowOnError extends boolean = false>(options: Options<PutNecessaryCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutNecessaryCookieEntryResponses, unknown, ThrowOnError, "fields">;
export declare const deleteNecessaryCookieEntryByVersion: <ThrowOnError extends boolean = false>(options: Options<DeleteNecessaryCookieEntryByVersionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteNecessaryCookieEntryByVersionResponses, unknown, ThrowOnError, "fields">;
export declare const getNecessaryCookieEntryByVersion: <ThrowOnError extends boolean = false>(options: Options<GetNecessaryCookieEntryByVersionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetNecessaryCookieEntryByVersionResponses, unknown, ThrowOnError, "fields">;
export declare const getNecessaryCookieEntriesVersionsPage: <ThrowOnError extends boolean = false>(options: Options<GetNecessaryCookieEntriesVersionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetNecessaryCookieEntriesVersionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const getNecessaryCookieEntryPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<GetNecessaryCookieEntryPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetNecessaryCookieEntryPermissionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const putNecessaryCookieEntryPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<PutNecessaryCookieEntryPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutNecessaryCookieEntryPermissionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postNecessaryCookieEntryByVersionCopy: <ThrowOnError extends boolean = false>(options: Options<PostNecessaryCookieEntryByVersionCopyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNecessaryCookieEntryByVersionCopyResponses, unknown, ThrowOnError, "fields">;
export declare const postNecessaryCookieEntryByVersionExpire: <ThrowOnError extends boolean = false>(options: Options<PostNecessaryCookieEntryByVersionExpireData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNecessaryCookieEntryByVersionExpireResponses, unknown, ThrowOnError, "fields">;
export declare const postNecessaryCookieEntryExpire: <ThrowOnError extends boolean = false>(options: Options<PostNecessaryCookieEntryExpireData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostNecessaryCookieEntryExpireResponses, unknown, ThrowOnError, "fields">;
export declare const putNecessaryCookieEntryByVersionRestore: <ThrowOnError extends boolean = false>(options: Options<PutNecessaryCookieEntryByVersionRestoreData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutNecessaryCookieEntryByVersionRestoreResponses, unknown, ThrowOnError, "fields">;