UNPKG

liferay-headless-rest-client

Version:

A collection of Headless Clients used in Liferay Portal

github.com/kevenleone/liferay-headless-rest-client

kevenleone/liferay-headless-rest-client

80 lines (79 loc) • 13.2 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch'; import type { DeleteObjectEntryFolderCollaboratorByTypeCollaboratorData, DeleteObjectEntryFolderCollaboratorByTypeCollaboratorResponses, GetObjectEntryFolderCollaboratorByTypeCollaboratorData, GetObjectEntryFolderCollaboratorByTypeCollaboratorResponses, PutObjectEntryFolderCollaboratorByTypeCollaboratorData, PutObjectEntryFolderCollaboratorByTypeCollaboratorResponses, DeleteScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorData, DeleteScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses, GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorData, GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses, PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorData, PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses, GetObjectEntryFolderCollaboratorsPageData, GetObjectEntryFolderCollaboratorsPageResponses, PostObjectEntryFolderCollaboratorsPageData, PostObjectEntryFolderCollaboratorsPageResponses, GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageData, GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageResponses, PostScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageData, PostScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageResponses, PostObjectEntryFolderCollaboratorsPageExportBatchData, PostObjectEntryFolderCollaboratorsPageExportBatchResponses, DeleteObjectEntryFolderData, DeleteObjectEntryFolderResponses, GetObjectEntryFolderData, GetObjectEntryFolderResponses, PatchObjectEntryFolderData, PatchObjectEntryFolderResponses, PutObjectEntryFolderData, PutObjectEntryFolderResponses, DeleteObjectEntryFolderBatchData, DeleteObjectEntryFolderBatchResponses, PutObjectEntryFolderBatchData, PutObjectEntryFolderBatchResponses, DeleteScopeScopeKeyObjectEntryFolderByExternalReferenceCodeData, DeleteScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses, GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeData, GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses, PatchScopeScopeKeyObjectEntryFolderByExternalReferenceCodeData, PatchScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses, PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeData, PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses, GetObjectEntryFolderPermissionsPageData, GetObjectEntryFolderPermissionsPageResponses, PutObjectEntryFolderPermissionsPageData, PutObjectEntryFolderPermissionsPageResponses, GetScopeScopeKeyObjectEntryFoldersPageData, GetScopeScopeKeyObjectEntryFoldersPageResponses, PostScopeScopeKeyObjectEntryFolderData, PostScopeScopeKeyObjectEntryFolderResponses } 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 folder and returns a 204 if the operation succeeds. */ export declare const deleteObjectEntryFolderCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<DeleteObjectEntryFolderCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteObjectEntryFolderCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">; /** * Retrieves the collaborator of an object entry. */ export declare const getObjectEntryFolderCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<GetObjectEntryFolderCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetObjectEntryFolderCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">; /** * Add or update a collaborator received in the request. */ export declare const putObjectEntryFolderCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<PutObjectEntryFolderCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutObjectEntryFolderCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">; /** * Deletes the collaborator for an object entry folder and returns a 204 if the operation succeeds. */ export declare const deleteScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<DeleteScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">; /** * Retrieves the collaborator for an object entry folder. */ export declare const getScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">; /** * Add or update a collaborator received in the request. */ export declare const putScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaborator: <ThrowOnError extends boolean = false>(options: Options<PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses, unknown, ThrowOnError, "fields">; /** * Retrieves the collaborators of an object entry folder. */ export declare const getObjectEntryFolderCollaboratorsPage: <ThrowOnError extends boolean = false>(options: Options<GetObjectEntryFolderCollaboratorsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetObjectEntryFolderCollaboratorsPageResponses, 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 postObjectEntryFolderCollaboratorsPage: <ThrowOnError extends boolean = false>(options: Options<PostObjectEntryFolderCollaboratorsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostObjectEntryFolderCollaboratorsPageResponses, unknown, ThrowOnError, "fields">; /** * Retrieves the collaborators of an object entry. */ export declare const getScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPage: <ThrowOnError extends boolean = false>(options: Options<GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageResponses, 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 postScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPage: <ThrowOnError extends boolean = false>(options: Options<PostScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageResponses, unknown, ThrowOnError, "fields">; export declare const postObjectEntryFolderCollaboratorsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostObjectEntryFolderCollaboratorsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostObjectEntryFolderCollaboratorsPageExportBatchResponses, unknown, ThrowOnError, "fields">; /** * Deletes the object entry folder and returns a 204 if the operation succeeds. */ export declare const deleteObjectEntryFolder: <ThrowOnError extends boolean = false>(options: Options<DeleteObjectEntryFolderData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteObjectEntryFolderResponses, unknown, ThrowOnError, "fields">; /** * Retrieves the object entry folder. */ export declare const getObjectEntryFolder: <ThrowOnError extends boolean = false>(options: Options<GetObjectEntryFolderData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetObjectEntryFolderResponses, unknown, ThrowOnError, "fields">; /** * Updates only the fields received in the request body, leaving any other fields untouched. */ export declare const patchObjectEntryFolder: <ThrowOnError extends boolean = false>(options: Options<PatchObjectEntryFolderData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchObjectEntryFolderResponses, unknown, ThrowOnError, "fields">; export declare const putObjectEntryFolder: <ThrowOnError extends boolean = false>(options: Options<PutObjectEntryFolderData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutObjectEntryFolderResponses, unknown, ThrowOnError, "fields">; export declare const deleteObjectEntryFolderBatch: <ThrowOnError extends boolean = false>(options?: Options<DeleteObjectEntryFolderBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteObjectEntryFolderBatchResponses, unknown, ThrowOnError, "fields">; export declare const putObjectEntryFolderBatch: <ThrowOnError extends boolean = false>(options?: Options<PutObjectEntryFolderBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutObjectEntryFolderBatchResponses, unknown, ThrowOnError, "fields">; export declare const deleteScopeScopeKeyObjectEntryFolderByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeleteScopeScopeKeyObjectEntryFolderByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">; export declare const getScopeScopeKeyObjectEntryFolderByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">; export declare const patchScopeScopeKeyObjectEntryFolderByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PatchScopeScopeKeyObjectEntryFolderByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">; export declare const putScopeScopeKeyObjectEntryFolderByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">; export declare const getObjectEntryFolderPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<GetObjectEntryFolderPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetObjectEntryFolderPermissionsPageResponses, unknown, ThrowOnError, "fields">; export declare const putObjectEntryFolderPermissionsPage: <ThrowOnError extends boolean = false>(options: Options<PutObjectEntryFolderPermissionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PutObjectEntryFolderPermissionsPageResponses, unknown, ThrowOnError, "fields">; export declare const getScopeScopeKeyObjectEntryFoldersPage: <ThrowOnError extends boolean = false>(options: Options<GetScopeScopeKeyObjectEntryFoldersPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetScopeScopeKeyObjectEntryFoldersPageResponses, unknown, ThrowOnError, "fields">; export declare const postScopeScopeKeyObjectEntryFolder: <ThrowOnError extends boolean = false>(options: Options<PostScopeScopeKeyObjectEntryFolderData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostScopeScopeKeyObjectEntryFolderResponses, unknown, ThrowOnError, "fields">;