UNPKG

liferay-headless-rest-client

Version:
88 lines (87 loc) 19.2 kB
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, DeletePersonalizationCookieEntryBatchData, DeletePersonalizationCookieEntryBatchResponses, PostPersonalizationCookieEntryBatchData, PostPersonalizationCookieEntryBatchResponses, PutPersonalizationCookieEntryBatchData, PutPersonalizationCookieEntryBatchResponses, GetByExternalReferenceCodeVersionsPageData, GetByExternalReferenceCodeVersionsPageResponses, GetPersonalizationCookieEntriesPageData, GetPersonalizationCookieEntriesPageResponses, PostPersonalizationCookieEntryData, PostPersonalizationCookieEntryResponses, PostByExternalReferenceCodeByVersionCopyData, PostByExternalReferenceCodeByVersionCopyResponses, PostByExternalReferenceCodeByVersionExpireData, PostByExternalReferenceCodeByVersionExpireResponses, PostPersonalizationCookieEntriesPageExportBatchData, PostPersonalizationCookieEntriesPageExportBatchResponses, PostValidateData, PostValidateResponses, PutByExternalReferenceCodeByVersionRestoreData, PutByExternalReferenceCodeByVersionRestoreResponses, GetOpenApiData, GetOpenApiResponses, DeletePersonalizationCookieEntryCollaboratorByTypeCollaboratorData, DeletePersonalizationCookieEntryCollaboratorByTypeCollaboratorResponses, GetPersonalizationCookieEntryCollaboratorByTypeCollaboratorData, GetPersonalizationCookieEntryCollaboratorByTypeCollaboratorResponses, PutPersonalizationCookieEntryCollaboratorByTypeCollaboratorData, PutPersonalizationCookieEntryCollaboratorByTypeCollaboratorResponses, GetPersonalizationCookieEntryCollaboratorsPageData, GetPersonalizationCookieEntryCollaboratorsPageResponses, PostPersonalizationCookieEntryCollaboratorsPageData, PostPersonalizationCookieEntryCollaboratorsPageResponses, PostPersonalizationCookieEntryCollaboratorsPageExportBatchData, PostPersonalizationCookieEntryCollaboratorsPageExportBatchResponses, DeletePersonalizationCookieEntryData, DeletePersonalizationCookieEntryResponses, GetPersonalizationCookieEntryData, GetPersonalizationCookieEntryResponses, PatchPersonalizationCookieEntryData, PatchPersonalizationCookieEntryResponses, PutPersonalizationCookieEntryData, PutPersonalizationCookieEntryResponses, DeletePersonalizationCookieEntryByVersionData, DeletePersonalizationCookieEntryByVersionResponses, GetPersonalizationCookieEntryByVersionData, GetPersonalizationCookieEntryByVersionResponses, GetPersonalizationCookieEntriesVersionsPageData, GetPersonalizationCookieEntriesVersionsPageResponses, GetPersonalizationCookieEntryPermissionsPageData, GetPersonalizationCookieEntryPermissionsPageResponses, PutPersonalizationCookieEntryPermissionsPageData, PutPersonalizationCookieEntryPermissionsPageResponses, PostPersonalizationCookieEntryByVersionCopyData, PostPersonalizationCookieEntryByVersionCopyResponses, PostPersonalizationCookieEntryByVersionExpireData, PostPersonalizationCookieEntryByVersionExpireResponses, PostPersonalizationCookieEntryExpireData, PostPersonalizationCookieEntryExpireResponses, PutPersonalizationCookieEntryByVersionRestoreData, PutPersonalizationCookieEntryByVersionRestoreResponses } 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 deletePersonalizationCookieEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<DeletePersonalizationCookieEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeletePersonalizationCookieEntryBatchResponses, unknown, ThrowOnError, "fields">; export declare const postPersonalizationCookieEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<PostPersonalizationCookieEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPersonalizationCookieEntryBatchResponses, unknown, ThrowOnError, "fields">; export declare const putPersonalizationCookieEntryBatch: <ThrowOnError extends boolean = false>(options?: Options<PutPersonalizationCookieEntryBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutPersonalizationCookieEntryBatchResponses, 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 getPersonalizationCookieEntriesPage: <ThrowOnError extends boolean = false>(options?: Options<GetPersonalizationCookieEntriesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPersonalizationCookieEntriesPageResponses, unknown, ThrowOnError, "fields">; export declare const postPersonalizationCookieEntry: <ThrowOnError extends boolean = false>(options?: Options<PostPersonalizationCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPersonalizationCookieEntryResponses, 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 postPersonalizationCookieEntriesPageExportBatch: <ThrowOnError extends boolean = false>(options?: Options<PostPersonalizationCookieEntriesPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPersonalizationCookieEntriesPageExportBatchResponses, 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 deletePersonalizationCookieEntryCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<DeletePersonalizationCookieEntryCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeletePersonalizationCookieEntryCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">; /** * Retrieves the collaborator for an object entry. */ export declare const getPersonalizationCookieEntryCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<GetPersonalizationCookieEntryCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPersonalizationCookieEntryCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">; /** * Add or update a collaborator received in the request. */ export declare const putPersonalizationCookieEntryCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<PutPersonalizationCookieEntryCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutPersonalizationCookieEntryCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">; /** * Retrieves the collaborators of an object entry. */ export declare const getPersonalizationCookieEntryCollaboratorsPage: <ThrowOnError extends boolean = false>(options: Options<GetPersonalizationCookieEntryCollaboratorsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPersonalizationCookieEntryCollaboratorsPageResponses, 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 postPersonalizationCookieEntryCollaboratorsPage: <ThrowOnError extends boolean = false>(options: Options<PostPersonalizationCookieEntryCollaboratorsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPersonalizationCookieEntryCollaboratorsPageResponses, unknown, ThrowOnError, "fields">; export declare const postPersonalizationCookieEntryCollaboratorsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostPersonalizationCookieEntryCollaboratorsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPersonalizationCookieEntryCollaboratorsPageExportBatchResponses, unknown, ThrowOnError, "fields">; export declare const deletePersonalizationCookieEntry: <ThrowOnError extends boolean = false>(options: Options<DeletePersonalizationCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeletePersonalizationCookieEntryResponses, unknown, ThrowOnError, "fields">; export declare const getPersonalizationCookieEntry: <ThrowOnError extends boolean = false>(options: Options<GetPersonalizationCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPersonalizationCookieEntryResponses, unknown, ThrowOnError, "fields">; export declare const patchPersonalizationCookieEntry: <ThrowOnError extends boolean = false>(options: Options<PatchPersonalizationCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchPersonalizationCookieEntryResponses, unknown, ThrowOnError, "fields">; export declare const putPersonalizationCookieEntry: <ThrowOnError extends boolean = false>(options: Options<PutPersonalizationCookieEntryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutPersonalizationCookieEntryResponses, unknown, ThrowOnError, "fields">; export declare const deletePersonalizationCookieEntryByVersion: <ThrowOnError extends boolean = false>(options: Options<DeletePersonalizationCookieEntryByVersionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeletePersonalizationCookieEntryByVersionResponses, unknown, ThrowOnError, "fields">; export declare const getPersonalizationCookieEntryByVersion: <ThrowOnError extends boolean = false>(options: Options<GetPersonalizationCookieEntryByVersionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPersonalizationCookieEntryByVersionResponses, unknown, ThrowOnError, "fields">; export declare const getPersonalizationCookieEntriesVersionsPage: <ThrowOnError extends boolean = false>(options: Options<GetPersonalizationCookieEntriesVersionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPersonalizationCookieEntriesVersionsPageResponses, unknown, ThrowOnError, "fields">; export declare const getPersonalizationCookieEntryPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<GetPersonalizationCookieEntryPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPersonalizationCookieEntryPermissionsPageResponses, unknown, ThrowOnError, "fields">; export declare const putPersonalizationCookieEntryPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<PutPersonalizationCookieEntryPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutPersonalizationCookieEntryPermissionsPageResponses, unknown, ThrowOnError, "fields">; export declare const postPersonalizationCookieEntryByVersionCopy: <ThrowOnError extends boolean = false>(options: Options<PostPersonalizationCookieEntryByVersionCopyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPersonalizationCookieEntryByVersionCopyResponses, unknown, ThrowOnError, "fields">; export declare const postPersonalizationCookieEntryByVersionExpire: <ThrowOnError extends boolean = false>(options: Options<PostPersonalizationCookieEntryByVersionExpireData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPersonalizationCookieEntryByVersionExpireResponses, unknown, ThrowOnError, "fields">; export declare const postPersonalizationCookieEntryExpire: <ThrowOnError extends boolean = false>(options: Options<PostPersonalizationCookieEntryExpireData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPersonalizationCookieEntryExpireResponses, unknown, ThrowOnError, "fields">; export declare const putPersonalizationCookieEntryByVersionRestore: <ThrowOnError extends boolean = false>(options: Options<PutPersonalizationCookieEntryByVersionRestoreData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutPersonalizationCookieEntryByVersionRestoreResponses, unknown, ThrowOnError, "fields">;