liferay-headless-rest-client/dist/clients/functional-cookies-entries/sdk.gen.d.ts

A collection of Headless Clients used in Liferay Portal

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, DeleteFunctionalCookieEntryBatchData, DeleteFunctionalCookieEntryBatchResponses, PostFunctionalCookieEntryBatchData, PostFunctionalCookieEntryBatchResponses, PutFunctionalCookieEntryBatchData, PutFunctionalCookieEntryBatchResponses, GetByExternalReferenceCodeVersionsPageData, GetByExternalReferenceCodeVersionsPageResponses, GetFunctionalCookieEntriesPageData, GetFunctionalCookieEntriesPageResponses, PostFunctionalCookieEntryData, PostFunctionalCookieEntryResponses, PostByExternalReferenceCodeByVersionCopyData, PostByExternalReferenceCodeByVersionCopyResponses, PostByExternalReferenceCodeByVersionExpireData, PostByExternalReferenceCodeByVersionExpireResponses, PostFunctionalCookieEntriesPageExportBatchData, PostFunctionalCookieEntriesPageExportBatchResponses, PostValidateData, PostValidateResponses, PutByExternalReferenceCodeByVersionRestoreData, PutByExternalReferenceCodeByVersionRestoreResponses, GetOpenApiData, GetOpenApiResponses, DeleteFunctionalCookieEntryCollaboratorByTypeCollaboratorData, DeleteFunctionalCookieEntryCollaboratorByTypeCollaboratorResponses, GetFunctionalCookieEntryCollaboratorByTypeCollaboratorData, GetFunctionalCookieEntryCollaboratorByTypeCollaboratorResponses, PutFunctionalCookieEntryCollaboratorByTypeCollaboratorData, PutFunctionalCookieEntryCollaboratorByTypeCollaboratorResponses, GetFunctionalCookieEntryCollaboratorsPageData, GetFunctionalCookieEntryCollaboratorsPageResponses, PostFunctionalCookieEntryCollaboratorsPageData, PostFunctionalCookieEntryCollaboratorsPageResponses, PostFunctionalCookieEntryCollaboratorsPageExportBatchData, PostFunctionalCookieEntryCollaboratorsPageExportBatchResponses, DeleteFunctionalCookieEntryData, DeleteFunctionalCookieEntryResponses, GetFunctionalCookieEntryData, GetFunctionalCookieEntryResponses, PatchFunctionalCookieEntryData, PatchFunctionalCookieEntryResponses, PutFunctionalCookieEntryData, PutFunctionalCookieEntryResponses, DeleteFunctionalCookieEntryByVersionData, DeleteFunctionalCookieEntryByVersionResponses, GetFunctionalCookieEntryByVersionData, GetFunctionalCookieEntryByVersionResponses, GetFunctionalCookieEntriesVersionsPageData, GetFunctionalCookieEntriesVersionsPageResponses, GetFunctionalCookieEntryPermissionsPageData, GetFunctionalCookieEntryPermissionsPageResponses, PutFunctionalCookieEntryPermissionsPageData, PutFunctionalCookieEntryPermissionsPageResponses, PostFunctionalCookieEntryByVersionCopyData, PostFunctionalCookieEntryByVersionCopyResponses, PostFunctionalCookieEntryByVersionExpireData, PostFunctionalCookieEntryByVersionExpireResponses, PostFunctionalCookieEntryExpireData, PostFunctionalCookieEntryExpireResponses, PutFunctionalCookieEntryByVersionRestoreData, PutFunctionalCookieEntryByVersionRestoreResponses } 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 deleteFunctionalCookieEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteFunctionalCookieEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteFunctionalCookieEntryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postFunctionalCookieEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<PostFunctionalCookieEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostFunctionalCookieEntryBatchResponses, unknown, ThrowOnError, "fields">;
export declare const putFunctionalCookieEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<PutFunctionalCookieEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutFunctionalCookieEntryBatchResponses, 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 getFunctionalCookieEntriesPage: <ThrowOnError extends boolean = false>(options?: Options<GetFunctionalCookieEntriesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFunctionalCookieEntriesPageResponses, unknown, ThrowOnError, "fields">;
export declare const postFunctionalCookieEntry: <ThrowOnError extends boolean = false>(options?: Options<PostFunctionalCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostFunctionalCookieEntryResponses, 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 postFunctionalCookieEntriesPageExportBatch: <ThrowOnError extends boolean = false>(options?: Options<PostFunctionalCookieEntriesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostFunctionalCookieEntriesPageExportBatchResponses, 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 deleteFunctionalCookieEntryCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<DeleteFunctionalCookieEntryCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteFunctionalCookieEntryCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieves the collaborator for an object entry.
 */
export declare const getFunctionalCookieEntryCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<GetFunctionalCookieEntryCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFunctionalCookieEntryCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">;
/**
 * Add or update a collaborator received in the request.
 */
export declare const putFunctionalCookieEntryCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<PutFunctionalCookieEntryCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutFunctionalCookieEntryCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieves the collaborators of an object entry.
 */
export declare const getFunctionalCookieEntryCollaboratorsPage: <ThrowOnError extends boolean = false>(options: Options<GetFunctionalCookieEntryCollaboratorsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFunctionalCookieEntryCollaboratorsPageResponses, 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 postFunctionalCookieEntryCollaboratorsPage: <ThrowOnError extends boolean = false>(options: Options<PostFunctionalCookieEntryCollaboratorsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostFunctionalCookieEntryCollaboratorsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postFunctionalCookieEntryCollaboratorsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostFunctionalCookieEntryCollaboratorsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostFunctionalCookieEntryCollaboratorsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const deleteFunctionalCookieEntry: <ThrowOnError extends boolean = false>(options: Options<DeleteFunctionalCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteFunctionalCookieEntryResponses, unknown, ThrowOnError, "fields">;
export declare const getFunctionalCookieEntry: <ThrowOnError extends boolean = false>(options: Options<GetFunctionalCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFunctionalCookieEntryResponses, unknown, ThrowOnError, "fields">;
export declare const patchFunctionalCookieEntry: <ThrowOnError extends boolean = false>(options: Options<PatchFunctionalCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchFunctionalCookieEntryResponses, unknown, ThrowOnError, "fields">;
export declare const putFunctionalCookieEntry: <ThrowOnError extends boolean = false>(options: Options<PutFunctionalCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutFunctionalCookieEntryResponses, unknown, ThrowOnError, "fields">;
export declare const deleteFunctionalCookieEntryByVersion: <ThrowOnError extends boolean = false>(options: Options<DeleteFunctionalCookieEntryByVersionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteFunctionalCookieEntryByVersionResponses, unknown, ThrowOnError, "fields">;
export declare const getFunctionalCookieEntryByVersion: <ThrowOnError extends boolean = false>(options: Options<GetFunctionalCookieEntryByVersionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFunctionalCookieEntryByVersionResponses, unknown, ThrowOnError, "fields">;
export declare const getFunctionalCookieEntriesVersionsPage: <ThrowOnError extends boolean = false>(options: Options<GetFunctionalCookieEntriesVersionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFunctionalCookieEntriesVersionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const getFunctionalCookieEntryPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<GetFunctionalCookieEntryPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFunctionalCookieEntryPermissionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const putFunctionalCookieEntryPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<PutFunctionalCookieEntryPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutFunctionalCookieEntryPermissionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postFunctionalCookieEntryByVersionCopy: <ThrowOnError extends boolean = false>(options: Options<PostFunctionalCookieEntryByVersionCopyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostFunctionalCookieEntryByVersionCopyResponses, unknown, ThrowOnError, "fields">;
export declare const postFunctionalCookieEntryByVersionExpire: <ThrowOnError extends boolean = false>(options: Options<PostFunctionalCookieEntryByVersionExpireData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostFunctionalCookieEntryByVersionExpireResponses, unknown, ThrowOnError, "fields">;
export declare const postFunctionalCookieEntryExpire: <ThrowOnError extends boolean = false>(options: Options<PostFunctionalCookieEntryExpireData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostFunctionalCookieEntryExpireResponses, unknown, ThrowOnError, "fields">;
export declare const putFunctionalCookieEntryByVersionRestore: <ThrowOnError extends boolean = false>(options: Options<PutFunctionalCookieEntryByVersionRestoreData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutFunctionalCookieEntryByVersionRestoreResponses, unknown, ThrowOnError, "fields">;