UNPKG

65.5 kBTypeScriptView Raw
1/// <reference types="node" />
2import { AxiosRequestConfig } from 'axios';
3import { OpPatch } from 'json-patch';
4import { Stream } from 'stream';
5import { AppBundleProps, CreateAppBundleProps } from './entities/app-bundle';
6import { ApiKeyProps, CreateApiKeyProps } from './entities/api-key';
7import { AppDefinitionProps, CreateAppDefinitionProps } from './entities/app-definition';
8import { AppInstallationProps, CreateAppInstallationProps } from './entities/app-installation';
9import { AssetFileProp, AssetProcessingForLocale, AssetProps, CreateAssetProps } from './entities/asset';
10import { ContentTypeProps, CreateContentTypeProps } from './entities/content-type';
11import { CreateCommentParams, CreateCommentProps, DeleteCommentParams, CommentProps, UpdateCommentParams, UpdateCommentProps } from './entities/comment';
12import { EditorInterfaceProps } from './entities/editor-interface';
13import { CreateEntryProps, EntryProps, EntryReferenceProps } from './entities/entry';
14import { CreateEnvironmentProps, EnvironmentProps } from './entities/environment';
15import { CreateEnvironmentAliasProps, EnvironmentAliasProps } from './entities/environment-alias';
16import { CreateLocaleProps, LocaleProps } from './entities/locale';
17import { OrganizationProp } from './entities/organization';
18import { CreateOrganizationInvitationProps, OrganizationInvitationProps } from './entities/organization-invitation';
19import { OrganizationMembershipProps } from './entities/organization-membership';
20import { CreatePersonalAccessTokenProps, PersonalAccessTokenProp } from './entities/personal-access-token';
21import { PreviewApiKeyProps } from './entities/preview-api-key';
22import { CreateRoleProps, RoleProps } from './entities/role';
23import { ScheduledActionProps } from './entities/scheduled-action';
24import { SnapshotProps } from './entities/snapshot';
25import { SpaceProps } from './entities/space';
26import { SpaceMemberProps } from './entities/space-member';
27import { CreateSpaceMembershipProps, SpaceMembershipProps } from './entities/space-membership';
28import { CreateTagProps, DeleteTagParams, TagProps, UpdateTagProps } from './entities/tag';
29import { CreateTeamProps, TeamProps } from './entities/team';
30import { CreateTeamMembershipProps, TeamMembershipProps } from './entities/team-membership';
31import { CreateTeamSpaceMembershipProps, TeamSpaceMembershipProps } from './entities/team-space-membership';
32import { CreateExtensionProps, ExtensionProps } from './entities/extension';
33import { UsageProps } from './entities/usage';
34import { UserProps } from './entities/user';
35import { CreateWebhooksProps, WebhookCallDetailsProps, WebhookCallOverviewProps, WebhookHealthProps, WebhookProps } from './entities/webhook';
36import { AssetKeyProps, CreateAssetKeyProps } from './entities/asset-key';
37import { AppUploadProps } from './entities/app-upload';
38import { AppDetailsProps, CreateAppDetailsProps } from './entities/app-details';
39import { AppSignedRequestProps, CreateAppSignedRequestProps } from './entities/app-signed-request';
40import { AppSigningSecretProps, CreateAppSigningSecretProps } from './entities/app-signing-secret';
41import { BulkActionProps, BulkActionPublishPayload, BulkActionUnpublishPayload, BulkActionValidatePayload } from './entities/bulk-action';
42import { ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from './entities/release';
43import { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions } from './entities/release-action';
44import { CreateTaskParams, CreateTaskProps, DeleteTaskParams, TaskProps, UpdateTaskParams, UpdateTaskProps } from './entities/task';
45import { CreateWorkflowDefinitionParams, CreateWorkflowDefinitionProps, DeleteWorkflowDefinitionParams, WorkflowDefinitionProps, WorkflowDefinitionQueryOptions } from './entities/workflow-definition';
46import { CompleteWorkflowParams, CreateWorkflowParams, CreateWorkflowProps, DeleteWorkflowParams, WorkflowProps, WorkflowQueryOptions } from './entities/workflow';
47export interface DefaultElements<TPlainObject extends object = object> {
48 toPlainObject(): TPlainObject;
49}
50/**
51 * Link is a reference object to another entity that can be resolved using tools such as contentful-resolve
52 */
53export interface Link<T extends string> {
54 sys: {
55 type: 'Link';
56 linkType: T;
57 id: string;
58 };
59}
60export interface VersionedLink<T extends string> {
61 sys: {
62 type: 'Link';
63 linkType: T;
64 id: string;
65 version: number;
66 };
67}
68export interface BaseCollection<T> {
69 sys: {
70 type: 'Array';
71 };
72 items: T[];
73}
74/** String will be in ISO8601 datetime format e.g. 2013-06-26T13:57:24Z */
75export declare type ISO8601Timestamp = string;
76export interface PaginationQueryOptions {
77 skip?: number;
78 limit?: number;
79 order?: string;
80}
81export interface QueryOptions extends PaginationQueryOptions {
82 content_type?: string;
83 include?: number;
84 select?: string;
85 links_to_entry?: string;
86 [key: string]: any;
87}
88export interface BasicMetaSysProps {
89 type: string;
90 id: string;
91 version: number;
92 createdBy?: SysLink;
93 createdAt: string;
94 updatedBy?: SysLink;
95 updatedAt: string;
96}
97export interface MetaSysProps extends BasicMetaSysProps {
98 space?: SysLink;
99 status?: SysLink;
100 publishedVersion?: number;
101 archivedVersion?: number;
102 archivedBy?: SysLink;
103 archivedAt?: string;
104 deletedVersion?: number;
105 deletedBy?: SysLink;
106 deletedAt?: string;
107}
108export interface EntityMetaSysProps extends MetaSysProps {
109 space: SysLink;
110 contentType: SysLink;
111 environment: SysLink;
112 publishedBy?: Link<'User'> | Link<'AppDefinition'>;
113 publishedAt?: string;
114 firstPublishedAt?: string;
115 publishedCounter?: number;
116 locale?: string;
117}
118export interface MetaLinkProps {
119 type: string;
120 linkType: string;
121 id: string;
122}
123export interface MetadataProps {
124 tags: Link<'Tag'>[];
125}
126export interface SysLink {
127 sys: MetaLinkProps;
128}
129export interface CollectionProp<TObj> {
130 sys: {
131 type: 'Array';
132 };
133 total: number;
134 skip: number;
135 limit: number;
136 items: TObj[];
137}
138export interface CursorPaginatedCollectionProp<TObj> extends Omit<CollectionProp<TObj>, 'total' | 'skip'> {
139 pages?: BasicCursorPaginationOptions;
140}
141export interface Collection<T, TPlain> extends CollectionProp<T>, DefaultElements<CollectionProp<TPlain>> {
142}
143export interface CursorPaginatedCollection<T, TPlain> extends CursorPaginatedCollectionProp<T>, DefaultElements<CursorPaginatedCollectionProp<TPlain>> {
144}
145export interface QueryOptions extends BasicQueryOptions {
146 content_type?: string;
147 include?: number;
148 select?: string;
149}
150export interface BasicQueryOptions {
151 skip?: number;
152 limit?: number;
153 [key: string]: any;
154}
155export interface BasicCursorPaginationOptions {
156 prev?: string;
157 next?: string;
158}
159export declare type KeyValueMap = Record<string, any>;
160/**
161 * @private
162 */
163declare type MRInternal<UA extends boolean> = {
164 (opts: MROpts<'Http', 'get', UA>): MRReturn<'Http', 'get'>;
165 (opts: MROpts<'Http', 'patch', UA>): MRReturn<'Http', 'patch'>;
166 (opts: MROpts<'Http', 'post', UA>): MRReturn<'Http', 'post'>;
167 (opts: MROpts<'Http', 'put', UA>): MRReturn<'Http', 'put'>;
168 (opts: MROpts<'Http', 'delete', UA>): MRReturn<'Http', 'delete'>;
169 (opts: MROpts<'Http', 'request', UA>): MRReturn<'Http', 'request'>;
170 (opts: MROpts<'AppBundle', 'get', UA>): MRReturn<'AppBundle', 'get'>;
171 (opts: MROpts<'AppBundle', 'getMany', UA>): MRReturn<'AppBundle', 'getMany'>;
172 (opts: MROpts<'AppBundle', 'delete', UA>): MRReturn<'AppBundle', 'delete'>;
173 (opts: MROpts<'AppBundle', 'create', UA>): MRReturn<'AppBundle', 'create'>;
174 (opts: MROpts<'ApiKey', 'get', UA>): MRReturn<'ApiKey', 'get'>;
175 (opts: MROpts<'ApiKey', 'getMany', UA>): MRReturn<'ApiKey', 'getMany'>;
176 (opts: MROpts<'ApiKey', 'create', UA>): MRReturn<'ApiKey', 'create'>;
177 (opts: MROpts<'ApiKey', 'createWithId', UA>): MRReturn<'ApiKey', 'createWithId'>;
178 (opts: MROpts<'ApiKey', 'update', UA>): MRReturn<'ApiKey', 'update'>;
179 (opts: MROpts<'ApiKey', 'delete', UA>): MRReturn<'ApiKey', 'delete'>;
180 (opts: MROpts<'AppDefinition', 'get', UA>): MRReturn<'AppDefinition', 'get'>;
181 (opts: MROpts<'AppDefinition', 'getMany', UA>): MRReturn<'AppDefinition', 'getMany'>;
182 (opts: MROpts<'AppDefinition', 'create', UA>): MRReturn<'AppDefinition', 'create'>;
183 (opts: MROpts<'AppDefinition', 'update', UA>): MRReturn<'AppDefinition', 'update'>;
184 (opts: MROpts<'AppDefinition', 'delete', UA>): MRReturn<'AppDefinition', 'delete'>;
185 (opts: MROpts<'AppInstallation', 'get', UA>): MRReturn<'AppInstallation', 'get'>;
186 (opts: MROpts<'AppInstallation', 'getMany', UA>): MRReturn<'AppInstallation', 'getMany'>;
187 (opts: MROpts<'AppInstallation', 'upsert', UA>): MRReturn<'AppInstallation', 'upsert'>;
188 (opts: MROpts<'AppInstallation', 'delete', UA>): MRReturn<'AppInstallation', 'delete'>;
189 (opts: MROpts<'Asset', 'getMany', UA>): MRReturn<'Asset', 'getMany'>;
190 (opts: MROpts<'Asset', 'get', UA>): MRReturn<'Asset', 'get'>;
191 (opts: MROpts<'Asset', 'update', UA>): MRReturn<'Asset', 'update'>;
192 (opts: MROpts<'Asset', 'delete', UA>): MRReturn<'Asset', 'delete'>;
193 (opts: MROpts<'Asset', 'publish', UA>): MRReturn<'Asset', 'publish'>;
194 (opts: MROpts<'Asset', 'unpublish', UA>): MRReturn<'Asset', 'unpublish'>;
195 (opts: MROpts<'Asset', 'archive', UA>): MRReturn<'Asset', 'archive'>;
196 (opts: MROpts<'Asset', 'unarchive', UA>): MRReturn<'Asset', 'unarchive'>;
197 (opts: MROpts<'Asset', 'create', UA>): MRReturn<'Asset', 'create'>;
198 (opts: MROpts<'Asset', 'createWithId', UA>): MRReturn<'Asset', 'createWithId'>;
199 (opts: MROpts<'Asset', 'createFromFiles', UA>): MRReturn<'Asset', 'createFromFiles'>;
200 (opts: MROpts<'Asset', 'processForAllLocales', UA>): MRReturn<'Asset', 'processForAllLocales'>;
201 (opts: MROpts<'Asset', 'processForLocale', UA>): MRReturn<'Asset', 'processForLocale'>;
202 (opts: MROpts<'AppUpload', 'get', UA>): MRReturn<'AppUpload', 'get'>;
203 (opts: MROpts<'AppUpload', 'delete', UA>): MRReturn<'AppUpload', 'delete'>;
204 (opts: MROpts<'AppUpload', 'create', UA>): MRReturn<'AppUpload', 'create'>;
205 (opts: MROpts<'AppDetails', 'upsert', UA>): MRReturn<'AppDetails', 'upsert'>;
206 (opts: MROpts<'AppDetails', 'get', UA>): MRReturn<'AppDetails', 'get'>;
207 (opts: MROpts<'AppDetails', 'delete', UA>): MRReturn<'AppDetails', 'delete'>;
208 (opts: MROpts<'AppSignedRequest', 'create', UA>): MRReturn<'AppSignedRequest', 'create'>;
209 (opts: MROpts<'AppSigningSecret', 'upsert', UA>): MRReturn<'AppSigningSecret', 'upsert'>;
210 (opts: MROpts<'AppSigningSecret', 'get', UA>): MRReturn<'AppSigningSecret', 'get'>;
211 (opts: MROpts<'AppSigningSecret', 'delete', UA>): MRReturn<'AppSigningSecret', 'delete'>;
212 (opts: MROpts<'AssetKey', 'create', UA>): MRReturn<'AssetKey', 'create'>;
213 (opts: MROpts<'BulkAction', 'get', UA>): MRReturn<'BulkAction', 'get'>;
214 (opts: MROpts<'BulkAction', 'publish', UA>): MRReturn<'BulkAction', 'publish'>;
215 (opts: MROpts<'BulkAction', 'unpublish', UA>): MRReturn<'BulkAction', 'unpublish'>;
216 (opts: MROpts<'BulkAction', 'validate', UA>): MRReturn<'BulkAction', 'validate'>;
217 (opts: MROpts<'Comment', 'get', UA>): MRReturn<'Comment', 'get'>;
218 (opts: MROpts<'Comment', 'getAll', UA>): MRReturn<'Comment', 'getAll'>;
219 (opts: MROpts<'Comment', 'create', UA>): MRReturn<'Comment', 'create'>;
220 (opts: MROpts<'Comment', 'update', UA>): MRReturn<'Comment', 'update'>;
221 (opts: MROpts<'Comment', 'delete', UA>): MRReturn<'Comment', 'delete'>;
222 (opts: MROpts<'ContentType', 'get', UA>): MRReturn<'ContentType', 'get'>;
223 (opts: MROpts<'ContentType', 'getMany', UA>): MRReturn<'ContentType', 'getMany'>;
224 (opts: MROpts<'ContentType', 'update', UA>): MRReturn<'ContentType', 'update'>;
225 (opts: MROpts<'ContentType', 'create', UA>): MRReturn<'ContentType', 'create'>;
226 (opts: MROpts<'ContentType', 'createWithId', UA>): MRReturn<'ContentType', 'createWithId'>;
227 (opts: MROpts<'ContentType', 'delete', UA>): MRReturn<'ContentType', 'delete'>;
228 (opts: MROpts<'ContentType', 'publish', UA>): MRReturn<'ContentType', 'publish'>;
229 (opts: MROpts<'ContentType', 'unpublish', UA>): MRReturn<'ContentType', 'unpublish'>;
230 (opts: MROpts<'EditorInterface', 'get', UA>): MRReturn<'EditorInterface', 'get'>;
231 (opts: MROpts<'EditorInterface', 'getMany', UA>): MRReturn<'EditorInterface', 'getMany'>;
232 (opts: MROpts<'EditorInterface', 'update', UA>): MRReturn<'EditorInterface', 'update'>;
233 (opts: MROpts<'Environment', 'get', UA>): MRReturn<'Environment', 'get'>;
234 (opts: MROpts<'Environment', 'getMany', UA>): MRReturn<'Environment', 'getMany'>;
235 (opts: MROpts<'Environment', 'create', UA>): MRReturn<'Environment', 'create'>;
236 (opts: MROpts<'Environment', 'createWithId', UA>): MRReturn<'Environment', 'createWithId'>;
237 (opts: MROpts<'Environment', 'update', UA>): MRReturn<'Environment', 'update'>;
238 (opts: MROpts<'Environment', 'delete', UA>): MRReturn<'Environment', 'delete'>;
239 (opts: MROpts<'EnvironmentAlias', 'get', UA>): MRReturn<'EnvironmentAlias', 'get'>;
240 (opts: MROpts<'EnvironmentAlias', 'getMany', UA>): MRReturn<'EnvironmentAlias', 'getMany'>;
241 (opts: MROpts<'EnvironmentAlias', 'createWithId', UA>): MRReturn<'EnvironmentAlias', 'createWithId'>;
242 (opts: MROpts<'EnvironmentAlias', 'update', UA>): MRReturn<'EnvironmentAlias', 'update'>;
243 (opts: MROpts<'EnvironmentAlias', 'delete', UA>): MRReturn<'EnvironmentAlias', 'delete'>;
244 (opts: MROpts<'Entry', 'getMany', UA>): MRReturn<'Entry', 'getMany'>;
245 (opts: MROpts<'Entry', 'get', UA>): MRReturn<'Entry', 'get'>;
246 (opts: MROpts<'Entry', 'patch', UA>): MRReturn<'Entry', 'patch'>;
247 (opts: MROpts<'Entry', 'update', UA>): MRReturn<'Entry', 'update'>;
248 (opts: MROpts<'Entry', 'delete', UA>): MRReturn<'Entry', 'delete'>;
249 (opts: MROpts<'Entry', 'publish', UA>): MRReturn<'Entry', 'publish'>;
250 (opts: MROpts<'Entry', 'unpublish', UA>): MRReturn<'Entry', 'unpublish'>;
251 (opts: MROpts<'Entry', 'archive', UA>): MRReturn<'Entry', 'archive'>;
252 (opts: MROpts<'Entry', 'unarchive', UA>): MRReturn<'Entry', 'unarchive'>;
253 (opts: MROpts<'Entry', 'create', UA>): MRReturn<'Entry', 'create'>;
254 (opts: MROpts<'Entry', 'createWithId', UA>): MRReturn<'Entry', 'createWithId'>;
255 (opts: MROpts<'Entry', 'references', UA>): MRReturn<'Entry', 'references'>;
256 (opts: MROpts<'Extension', 'get', UA>): MRReturn<'Extension', 'get'>;
257 (opts: MROpts<'Extension', 'getMany', UA>): MRReturn<'Extension', 'getMany'>;
258 (opts: MROpts<'Extension', 'create', UA>): MRReturn<'Extension', 'create'>;
259 (opts: MROpts<'Extension', 'createWithId', UA>): MRReturn<'Extension', 'createWithId'>;
260 (opts: MROpts<'Extension', 'update', UA>): MRReturn<'Extension', 'update'>;
261 (opts: MROpts<'Extension', 'delete', UA>): MRReturn<'Extension', 'delete'>;
262 (opts: MROpts<'Locale', 'get', UA>): MRReturn<'Locale', 'get'>;
263 (opts: MROpts<'Locale', 'getMany', UA>): MRReturn<'Locale', 'getMany'>;
264 (opts: MROpts<'Locale', 'delete', UA>): MRReturn<'Locale', 'delete'>;
265 (opts: MROpts<'Locale', 'update', UA>): MRReturn<'Locale', 'update'>;
266 (opts: MROpts<'Locale', 'create', UA>): MRReturn<'Locale', 'create'>;
267 (opts: MROpts<'Organization', 'getMany', UA>): MRReturn<'Organization', 'getMany'>;
268 (opts: MROpts<'Organization', 'get', UA>): MRReturn<'Organization', 'get'>;
269 (opts: MROpts<'OrganizationInvitation', 'get', UA>): MRReturn<'OrganizationInvitation', 'get'>;
270 (opts: MROpts<'OrganizationInvitation', 'create', UA>): MRReturn<'OrganizationInvitation', 'create'>;
271 (opts: MROpts<'OrganizationMembership', 'get', UA>): MRReturn<'OrganizationMembership', 'get'>;
272 (opts: MROpts<'OrganizationMembership', 'getMany', UA>): MRReturn<'OrganizationMembership', 'getMany'>;
273 (opts: MROpts<'OrganizationMembership', 'update', UA>): MRReturn<'OrganizationMembership', 'update'>;
274 (opts: MROpts<'OrganizationMembership', 'delete', UA>): MRReturn<'OrganizationMembership', 'delete'>;
275 (opts: MROpts<'PersonalAccessToken', 'get', UA>): MRReturn<'PersonalAccessToken', 'get'>;
276 (opts: MROpts<'PersonalAccessToken', 'getMany', UA>): MRReturn<'PersonalAccessToken', 'getMany'>;
277 (opts: MROpts<'PersonalAccessToken', 'create', UA>): MRReturn<'PersonalAccessToken', 'create'>;
278 (opts: MROpts<'PersonalAccessToken', 'revoke', UA>): MRReturn<'PersonalAccessToken', 'revoke'>;
279 (opts: MROpts<'PreviewApiKey', 'get', UA>): MRReturn<'PreviewApiKey', 'get'>;
280 (opts: MROpts<'PreviewApiKey', 'getMany', UA>): MRReturn<'PreviewApiKey', 'getMany'>;
281 (opts: MROpts<'Release', 'get', UA>): MRReturn<'Release', 'get'>;
282 (opts: MROpts<'Release', 'query', UA>): MRReturn<'Release', 'query'>;
283 (opts: MROpts<'Release', 'create', UA>): MRReturn<'Release', 'create'>;
284 (opts: MROpts<'Release', 'update', UA>): MRReturn<'Release', 'update'>;
285 (opts: MROpts<'Release', 'delete', UA>): MRReturn<'Release', 'delete'>;
286 (opts: MROpts<'Release', 'publish', UA>): MRReturn<'Release', 'publish'>;
287 (opts: MROpts<'Release', 'unpublish', UA>): MRReturn<'Release', 'unpublish'>;
288 (opts: MROpts<'Release', 'validate', UA>): MRReturn<'Release', 'validate'>;
289 (opts: MROpts<'ReleaseAction', 'get', UA>): MRReturn<'ReleaseAction', 'get'>;
290 (opts: MROpts<'ReleaseAction', 'queryForRelease', UA>): MRReturn<'ReleaseAction', 'queryForRelease'>;
291 (opts: MROpts<'Role', 'get', UA>): MRReturn<'Role', 'get'>;
292 (opts: MROpts<'Role', 'getMany', UA>): MRReturn<'Role', 'getMany'>;
293 (opts: MROpts<'Role', 'create', UA>): MRReturn<'Role', 'create'>;
294 (opts: MROpts<'Role', 'createWithId', UA>): MRReturn<'Role', 'createWithId'>;
295 (opts: MROpts<'Role', 'update', UA>): MRReturn<'Role', 'update'>;
296 (opts: MROpts<'Role', 'delete', UA>): MRReturn<'Role', 'delete'>;
297 (opts: MROpts<'ScheduledAction', 'get', UA>): MRReturn<'ScheduledAction', 'get'>;
298 (opts: MROpts<'ScheduledAction', 'getMany', UA>): MRReturn<'ScheduledAction', 'getMany'>;
299 (opts: MROpts<'ScheduledAction', 'create', UA>): MRReturn<'ScheduledAction', 'create'>;
300 (opts: MROpts<'ScheduledAction', 'update', UA>): MRReturn<'ScheduledAction', 'update'>;
301 (opts: MROpts<'ScheduledAction', 'delete', UA>): MRReturn<'ScheduledAction', 'delete'>;
302 (opts: MROpts<'Snapshot', 'getManyForEntry', UA>): MRReturn<'Snapshot', 'getManyForEntry'>;
303 (opts: MROpts<'Snapshot', 'getForEntry', UA>): MRReturn<'Snapshot', 'getForEntry'>;
304 (opts: MROpts<'Snapshot', 'getManyForContentType', UA>): MRReturn<'Snapshot', 'getManyForContentType'>;
305 (opts: MROpts<'Snapshot', 'getForContentType', UA>): MRReturn<'Snapshot', 'getForContentType'>;
306 (opts: MROpts<'Space', 'get', UA>): MRReturn<'Space', 'get'>;
307 (opts: MROpts<'Space', 'getMany', UA>): MRReturn<'Space', 'getMany'>;
308 (opts: MROpts<'Space', 'create', UA>): MRReturn<'Space', 'create'>;
309 (opts: MROpts<'Space', 'update', UA>): MRReturn<'Space', 'update'>;
310 (opts: MROpts<'Space', 'delete', UA>): MRReturn<'Space', 'delete'>;
311 (opts: MROpts<'SpaceMember', 'get', UA>): MRReturn<'SpaceMember', 'get'>;
312 (opts: MROpts<'SpaceMember', 'getMany', UA>): MRReturn<'SpaceMember', 'getMany'>;
313 (opts: MROpts<'SpaceMembership', 'get', UA>): MRReturn<'SpaceMembership', 'get'>;
314 (opts: MROpts<'SpaceMembership', 'getMany', UA>): MRReturn<'SpaceMembership', 'getMany'>;
315 (opts: MROpts<'SpaceMembership', 'getForOrganization', UA>): MRReturn<'SpaceMembership', 'getForOrganization'>;
316 (opts: MROpts<'SpaceMembership', 'getManyForOrganization', UA>): MRReturn<'SpaceMembership', 'getManyForOrganization'>;
317 (opts: MROpts<'SpaceMembership', 'create', UA>): MRReturn<'SpaceMembership', 'create'>;
318 (opts: MROpts<'SpaceMembership', 'createWithId', UA>): MRReturn<'SpaceMembership', 'createWithId'>;
319 (opts: MROpts<'SpaceMembership', 'update', UA>): MRReturn<'SpaceMembership', 'update'>;
320 (opts: MROpts<'SpaceMembership', 'delete', UA>): MRReturn<'SpaceMembership', 'delete'>;
321 (opts: MROpts<'Tag', 'get', UA>): MRReturn<'Tag', 'get'>;
322 (opts: MROpts<'Tag', 'getMany', UA>): MRReturn<'Tag', 'getMany'>;
323 (opts: MROpts<'Tag', 'createWithId', UA>): MRReturn<'Tag', 'createWithId'>;
324 (opts: MROpts<'Tag', 'update', UA>): MRReturn<'Tag', 'update'>;
325 (opts: MROpts<'Tag', 'delete', UA>): MRReturn<'Tag', 'delete'>;
326 (opts: MROpts<'Task', 'get', UA>): MRReturn<'Task', 'get'>;
327 (opts: MROpts<'Task', 'getAll', UA>): MRReturn<'Task', 'getAll'>;
328 (opts: MROpts<'Task', 'create', UA>): MRReturn<'Task', 'create'>;
329 (opts: MROpts<'Task', 'update', UA>): MRReturn<'Task', 'update'>;
330 (opts: MROpts<'Task', 'delete', UA>): MRReturn<'Task', 'delete'>;
331 (opts: MROpts<'Team', 'get', UA>): MRReturn<'Team', 'get'>;
332 (opts: MROpts<'Team', 'getMany', UA>): MRReturn<'Team', 'getMany'>;
333 (opts: MROpts<'Team', 'getManyForSpace', UA>): MRReturn<'Team', 'getManyForSpace'>;
334 (opts: MROpts<'Team', 'create', UA>): MRReturn<'Team', 'create'>;
335 (opts: MROpts<'Team', 'update', UA>): MRReturn<'Team', 'update'>;
336 (opts: MROpts<'Team', 'delete', UA>): MRReturn<'Team', 'delete'>;
337 (opts: MROpts<'TeamMembership', 'get', UA>): MRReturn<'TeamMembership', 'get'>;
338 (opts: MROpts<'TeamMembership', 'getManyForOrganization', UA>): MRReturn<'TeamMembership', 'getManyForOrganization'>;
339 (opts: MROpts<'TeamMembership', 'getManyForTeam', UA>): MRReturn<'TeamMembership', 'getManyForTeam'>;
340 (opts: MROpts<'TeamMembership', 'create', UA>): MRReturn<'TeamMembership', 'create'>;
341 (opts: MROpts<'TeamMembership', 'update', UA>): MRReturn<'TeamMembership', 'update'>;
342 (opts: MROpts<'TeamMembership', 'delete', UA>): MRReturn<'TeamMembership', 'delete'>;
343 (opts: MROpts<'TeamSpaceMembership', 'get', UA>): MRReturn<'TeamSpaceMembership', 'get'>;
344 (opts: MROpts<'TeamSpaceMembership', 'getMany', UA>): MRReturn<'TeamSpaceMembership', 'getMany'>;
345 (opts: MROpts<'TeamSpaceMembership', 'getForOrganization', UA>): MRReturn<'TeamSpaceMembership', 'getForOrganization'>;
346 (opts: MROpts<'TeamSpaceMembership', 'getManyForOrganization', UA>): MRReturn<'TeamSpaceMembership', 'getManyForOrganization'>;
347 (opts: MROpts<'TeamSpaceMembership', 'create', UA>): MRReturn<'TeamSpaceMembership', 'create'>;
348 (opts: MROpts<'TeamSpaceMembership', 'update', UA>): MRReturn<'TeamSpaceMembership', 'update'>;
349 (opts: MROpts<'TeamSpaceMembership', 'delete', UA>): MRReturn<'TeamSpaceMembership', 'delete'>;
350 (opts: MROpts<'Upload', 'get', UA>): MRReturn<'Entry', 'get'>;
351 (opts: MROpts<'Upload', 'create', UA>): MRReturn<'Entry', 'create'>;
352 (opts: MROpts<'Upload', 'delete', UA>): MRReturn<'Entry', 'delete'>;
353 (opts: MROpts<'Usage', 'getManyForSpace', UA>): MRReturn<'Usage', 'getManyForSpace'>;
354 (opts: MROpts<'Usage', 'getManyForOrganization', UA>): MRReturn<'Usage', 'getManyForOrganization'>;
355 (opts: MROpts<'User', 'getManyForSpace', UA>): MRReturn<'User', 'getManyForSpace'>;
356 (opts: MROpts<'User', 'getForSpace', UA>): MRReturn<'User', 'getForSpace'>;
357 (opts: MROpts<'User', 'getCurrent', UA>): MRReturn<'User', 'getCurrent'>;
358 (opts: MROpts<'User', 'getForOrganization', UA>): MRReturn<'User', 'getForOrganization'>;
359 (opts: MROpts<'User', 'getManyForOrganization', UA>): MRReturn<'User', 'getManyForOrganization'>;
360 (opts: MROpts<'Webhook', 'get', UA>): MRReturn<'Webhook', 'get'>;
361 (opts: MROpts<'Webhook', 'getMany', UA>): MRReturn<'Webhook', 'getMany'>;
362 (opts: MROpts<'Webhook', 'getCallDetails', UA>): MRReturn<'Webhook', 'getCallDetails'>;
363 (opts: MROpts<'Webhook', 'getHealthStatus', UA>): MRReturn<'Webhook', 'getHealthStatus'>;
364 (opts: MROpts<'Webhook', 'getManyCallDetails', UA>): MRReturn<'Webhook', 'getManyCallDetails'>;
365 (opts: MROpts<'Webhook', 'create', UA>): MRReturn<'Webhook', 'create'>;
366 (opts: MROpts<'Webhook', 'createWithId', UA>): MRReturn<'Webhook', 'createWithId'>;
367 (opts: MROpts<'Webhook', 'update', UA>): MRReturn<'Webhook', 'update'>;
368 (opts: MROpts<'Webhook', 'delete', UA>): MRReturn<'Webhook', 'delete'>;
369 (opts: MROpts<'WorkflowDefinition', 'get', UA>): MRReturn<'WorkflowDefinition', 'get'>;
370 (opts: MROpts<'WorkflowDefinition', 'getMany', UA>): MRReturn<'WorkflowDefinition', 'getMany'>;
371 (opts: MROpts<'WorkflowDefinition', 'create', UA>): MRReturn<'WorkflowDefinition', 'create'>;
372 (opts: MROpts<'WorkflowDefinition', 'update', UA>): MRReturn<'WorkflowDefinition', 'update'>;
373 (opts: MROpts<'WorkflowDefinition', 'delete', UA>): MRReturn<'WorkflowDefinition', 'delete'>;
374 (opts: MROpts<'Workflow', 'getMany', UA>): MRReturn<'Workflow', 'getMany'>;
375 (opts: MROpts<'Workflow', 'create', UA>): MRReturn<'Workflow', 'create'>;
376 (opts: MROpts<'Workflow', 'update', UA>): MRReturn<'Workflow', 'update'>;
377 (opts: MROpts<'Workflow', 'delete', UA>): MRReturn<'Workflow', 'delete'>;
378 (opts: MROpts<'Workflow', 'complete', UA>): MRReturn<'Workflow', 'complete'>;
379};
380/**
381 * @private
382 */
383export declare type MakeRequestWithUserAgent = MRInternal<true>;
384/**
385 * @private
386 */
387export declare type MakeRequest = MRInternal<false>;
388export interface Adapter {
389 makeRequest: MakeRequestWithUserAgent;
390}
391/**
392 * @private
393 */
394export declare type MRActions = {
395 Http: {
396 get: {
397 params: {
398 url: string;
399 config?: AxiosRequestConfig;
400 };
401 return: any;
402 };
403 patch: {
404 params: {
405 url: string;
406 config?: AxiosRequestConfig;
407 };
408 payload: any;
409 return: any;
410 };
411 post: {
412 params: {
413 url: string;
414 config?: AxiosRequestConfig;
415 };
416 payload: any;
417 return: any;
418 };
419 put: {
420 params: {
421 url: string;
422 config?: AxiosRequestConfig;
423 };
424 payload: any;
425 return: any;
426 };
427 delete: {
428 params: {
429 url: string;
430 config?: AxiosRequestConfig;
431 };
432 return: any;
433 };
434 request: {
435 params: {
436 url: string;
437 config?: AxiosRequestConfig;
438 };
439 return: any;
440 };
441 };
442 AppBundle: {
443 get: {
444 params: GetAppBundleParams;
445 return: AppBundleProps;
446 };
447 getMany: {
448 params: GetAppDefinitionParams & QueryParams;
449 return: CollectionProp<AppBundleProps>;
450 };
451 delete: {
452 params: GetAppBundleParams;
453 return: void;
454 };
455 create: {
456 params: GetAppDefinitionParams;
457 payload: CreateAppBundleProps;
458 return: AppBundleProps;
459 };
460 };
461 ApiKey: {
462 get: {
463 params: GetSpaceParams & {
464 apiKeyId: string;
465 };
466 return: ApiKeyProps;
467 };
468 getMany: {
469 params: GetSpaceParams & QueryParams;
470 return: CollectionProp<ApiKeyProps>;
471 };
472 create: {
473 params: GetSpaceParams;
474 payload: CreateApiKeyProps;
475 headers?: Record<string, unknown>;
476 return: ApiKeyProps;
477 };
478 createWithId: {
479 params: GetSpaceParams & {
480 apiKeyId: string;
481 };
482 payload: CreateApiKeyProps;
483 headers?: Record<string, unknown>;
484 return: ApiKeyProps;
485 };
486 update: {
487 params: GetSpaceParams & {
488 apiKeyId: string;
489 };
490 payload: ApiKeyProps;
491 headers?: Record<string, unknown>;
492 return: ApiKeyProps;
493 };
494 delete: {
495 params: GetSpaceParams & {
496 apiKeyId: string;
497 };
498 return: any;
499 };
500 };
501 AppDefinition: {
502 get: {
503 params: GetOrganizationParams & {
504 appDefinitionId: string;
505 };
506 return: AppDefinitionProps;
507 };
508 getMany: {
509 params: GetOrganizationParams & QueryParams;
510 return: CollectionProp<AppDefinitionProps>;
511 };
512 create: {
513 params: GetOrganizationParams;
514 payload: CreateAppDefinitionProps;
515 return: AppDefinitionProps;
516 };
517 update: {
518 params: GetAppDefinitionParams;
519 payload: AppDefinitionProps;
520 headers?: Record<string, unknown>;
521 return: AppDefinitionProps;
522 };
523 delete: {
524 params: GetAppDefinitionParams;
525 return: any;
526 };
527 };
528 AppInstallation: {
529 get: {
530 params: GetAppInstallationParams;
531 return: AppInstallationProps;
532 };
533 getMany: {
534 params: GetSpaceEnvironmentParams & PaginationQueryParams;
535 return: CollectionProp<AppInstallationProps>;
536 };
537 upsert: {
538 params: GetAppInstallationParams;
539 payload: CreateAppInstallationProps;
540 headers?: Record<string, unknown>;
541 return: AppInstallationProps;
542 };
543 delete: {
544 params: GetAppInstallationParams;
545 return: any;
546 };
547 };
548 AppUpload: {
549 get: {
550 params: GetAppUploadParams;
551 return: AppUploadProps;
552 };
553 delete: {
554 params: GetAppUploadParams;
555 return: void;
556 };
557 create: {
558 params: GetOrganizationParams;
559 payload: {
560 file: string | ArrayBuffer | Stream;
561 };
562 return: AppUploadProps;
563 };
564 };
565 AppDetails: {
566 upsert: {
567 params: GetAppDefinitionParams;
568 payload: CreateAppDetailsProps;
569 return: AppDetailsProps;
570 };
571 get: {
572 params: GetAppDefinitionParams;
573 return: AppDetailsProps;
574 };
575 delete: {
576 params: GetAppDefinitionParams;
577 return: void;
578 };
579 };
580 AppSignedRequest: {
581 create: {
582 params: GetAppInstallationParams;
583 payload: CreateAppSignedRequestProps;
584 return: AppSignedRequestProps;
585 };
586 };
587 AppSigningSecret: {
588 upsert: {
589 params: GetAppDefinitionParams;
590 payload: CreateAppSigningSecretProps;
591 return: AppSigningSecretProps;
592 };
593 get: {
594 params: GetAppDefinitionParams;
595 return: AppSigningSecretProps;
596 };
597 delete: {
598 params: GetAppDefinitionParams;
599 return: void;
600 };
601 };
602 Asset: {
603 getMany: {
604 params: GetSpaceEnvironmentParams & QueryParams;
605 return: CollectionProp<AssetProps>;
606 };
607 get: {
608 params: GetSpaceEnvironmentParams & {
609 assetId: string;
610 } & QueryParams;
611 return: AssetProps;
612 };
613 update: {
614 params: GetSpaceEnvironmentParams & {
615 assetId: string;
616 };
617 payload: AssetProps;
618 headers?: Record<string, unknown>;
619 return: AssetProps;
620 };
621 delete: {
622 params: GetSpaceEnvironmentParams & {
623 assetId: string;
624 };
625 return: any;
626 };
627 publish: {
628 params: GetSpaceEnvironmentParams & {
629 assetId: string;
630 };
631 payload: AssetProps;
632 return: AssetProps;
633 };
634 unpublish: {
635 params: GetSpaceEnvironmentParams & {
636 assetId: string;
637 };
638 return: AssetProps;
639 };
640 archive: {
641 params: GetSpaceEnvironmentParams & {
642 assetId: string;
643 };
644 return: AssetProps;
645 };
646 unarchive: {
647 params: GetSpaceEnvironmentParams & {
648 assetId: string;
649 };
650 return: AssetProps;
651 };
652 create: {
653 params: GetSpaceEnvironmentParams;
654 payload: CreateAssetProps;
655 return: AssetProps;
656 };
657 createWithId: {
658 params: GetSpaceEnvironmentParams & {
659 assetId: string;
660 };
661 payload: CreateAssetProps;
662 return: AssetProps;
663 };
664 createFromFiles: {
665 params: GetSpaceEnvironmentParams;
666 payload: Omit<AssetFileProp, 'sys'>;
667 return: AssetProps;
668 };
669 processForAllLocales: {
670 params: GetSpaceEnvironmentParams & {
671 asset: AssetProps;
672 options?: AssetProcessingForLocale;
673 };
674 return: AssetProps;
675 };
676 processForLocale: {
677 params: GetSpaceEnvironmentParams & {
678 asset: AssetProps;
679 locale: string;
680 options?: AssetProcessingForLocale;
681 };
682 return: AssetProps;
683 };
684 };
685 AssetKey: {
686 create: {
687 params: GetSpaceEnvironmentParams;
688 payload: CreateAssetKeyProps;
689 return: AssetKeyProps;
690 };
691 };
692 BulkAction: {
693 get: {
694 params: GetBulkActionParams;
695 return: BulkActionProps;
696 };
697 publish: {
698 params: GetSpaceEnvironmentParams;
699 payload: BulkActionPublishPayload;
700 return: BulkActionProps<BulkActionPublishPayload>;
701 };
702 unpublish: {
703 params: GetSpaceEnvironmentParams;
704 payload: BulkActionUnpublishPayload;
705 return: BulkActionProps<BulkActionUnpublishPayload>;
706 };
707 validate: {
708 params: GetSpaceEnvironmentParams;
709 payload: BulkActionValidatePayload;
710 return: BulkActionProps<BulkActionValidatePayload>;
711 };
712 };
713 Comment: {
714 get: {
715 params: GetCommentParams;
716 return: CommentProps;
717 };
718 getAll: {
719 params: GetEntryParams;
720 return: CollectionProp<CommentProps>;
721 };
722 create: {
723 params: CreateCommentParams;
724 payload: CreateCommentProps;
725 return: CommentProps;
726 };
727 update: {
728 params: UpdateCommentParams;
729 payload: UpdateCommentProps;
730 headers?: Record<string, unknown>;
731 return: CommentProps;
732 };
733 delete: {
734 params: DeleteCommentParams;
735 return: void;
736 };
737 };
738 ContentType: {
739 get: {
740 params: GetContentTypeParams & QueryParams;
741 return: ContentTypeProps;
742 };
743 getMany: {
744 params: GetSpaceEnvironmentParams & QueryParams;
745 return: CollectionProp<ContentTypeProps>;
746 };
747 create: {
748 params: GetSpaceEnvironmentParams;
749 payload: CreateContentTypeProps;
750 return: ContentTypeProps;
751 };
752 createWithId: {
753 params: GetContentTypeParams;
754 payload: CreateContentTypeProps;
755 return: ContentTypeProps;
756 };
757 update: {
758 params: GetContentTypeParams;
759 payload: ContentTypeProps;
760 headers?: Record<string, unknown>;
761 return: ContentTypeProps;
762 };
763 delete: {
764 params: GetContentTypeParams;
765 return: any;
766 };
767 publish: {
768 params: GetContentTypeParams;
769 payload: ContentTypeProps;
770 return: ContentTypeProps;
771 };
772 unpublish: {
773 params: GetContentTypeParams;
774 return: ContentTypeProps;
775 };
776 };
777 EditorInterface: {
778 get: {
779 params: GetEditorInterfaceParams;
780 return: EditorInterfaceProps;
781 };
782 getMany: {
783 params: GetSpaceEnvironmentParams & QueryParams;
784 return: CollectionProp<EditorInterfaceProps>;
785 };
786 update: {
787 params: GetEditorInterfaceParams;
788 payload: EditorInterfaceProps;
789 headers?: Record<string, unknown>;
790 return: EditorInterfaceProps;
791 };
792 };
793 Environment: {
794 get: {
795 params: GetSpaceEnvironmentParams;
796 return: EnvironmentProps;
797 };
798 getMany: {
799 params: GetSpaceParams & PaginationQueryParams;
800 return: CollectionProp<EnvironmentProps>;
801 };
802 create: {
803 params: GetSpaceParams;
804 payload: Partial<Pick<EnvironmentProps, 'name'>>;
805 headers?: Record<string, unknown>;
806 return: EnvironmentProps;
807 };
808 createWithId: {
809 params: GetSpaceEnvironmentParams & {
810 sourceEnvironmentId?: string;
811 };
812 payload: CreateEnvironmentProps;
813 headers?: Record<string, unknown>;
814 return: EnvironmentProps;
815 };
816 update: {
817 params: GetSpaceEnvironmentParams;
818 payload: EnvironmentProps;
819 headers?: Record<string, unknown>;
820 return: EnvironmentProps;
821 };
822 delete: {
823 params: GetSpaceEnvironmentParams;
824 return: any;
825 };
826 };
827 EnvironmentAlias: {
828 get: {
829 params: GetSpaceEnvAliasParams;
830 return: EnvironmentAliasProps;
831 };
832 getMany: {
833 params: GetSpaceParams & PaginationQueryParams;
834 return: CollectionProp<EnvironmentAliasProps>;
835 };
836 createWithId: {
837 params: GetSpaceEnvAliasParams;
838 payload: CreateEnvironmentAliasProps;
839 headers?: Record<string, unknown>;
840 return: EnvironmentAliasProps;
841 };
842 update: {
843 params: GetSpaceEnvAliasParams;
844 payload: EnvironmentAliasProps;
845 headers?: Record<string, unknown>;
846 return: EnvironmentAliasProps;
847 };
848 delete: {
849 params: GetSpaceEnvAliasParams;
850 return: any;
851 };
852 };
853 Entry: {
854 getMany: {
855 params: GetSpaceEnvironmentParams & QueryParams;
856 return: CollectionProp<EntryProps<any>>;
857 };
858 get: {
859 params: GetSpaceEnvironmentParams & {
860 entryId: string;
861 } & QueryParams;
862 return: EntryProps<any>;
863 };
864 patch: {
865 params: GetSpaceEnvironmentParams & {
866 entryId: string;
867 version: number;
868 };
869 payload: OpPatch[];
870 headers?: Record<string, unknown>;
871 return: EntryProps<any>;
872 };
873 update: {
874 params: GetSpaceEnvironmentParams & {
875 entryId: string;
876 };
877 payload: EntryProps<any>;
878 headers?: Record<string, unknown>;
879 return: EntryProps<any>;
880 };
881 delete: {
882 params: GetSpaceEnvironmentParams & {
883 entryId: string;
884 };
885 return: any;
886 };
887 publish: {
888 params: GetSpaceEnvironmentParams & {
889 entryId: string;
890 };
891 payload: EntryProps<any>;
892 return: EntryProps<any>;
893 };
894 unpublish: {
895 params: GetSpaceEnvironmentParams & {
896 entryId: string;
897 };
898 return: EntryProps<any>;
899 };
900 archive: {
901 params: GetSpaceEnvironmentParams & {
902 entryId: string;
903 };
904 return: EntryProps<any>;
905 };
906 unarchive: {
907 params: GetSpaceEnvironmentParams & {
908 entryId: string;
909 };
910 return: EntryProps<any>;
911 };
912 create: {
913 params: GetSpaceEnvironmentParams & {
914 contentTypeId: string;
915 };
916 payload: CreateEntryProps<any>;
917 return: EntryProps<any>;
918 };
919 createWithId: {
920 params: GetSpaceEnvironmentParams & {
921 entryId: string;
922 contentTypeId: string;
923 };
924 payload: CreateEntryProps<any>;
925 return: EntryProps<any>;
926 };
927 references: {
928 params: GetSpaceEnvironmentParams & {
929 entryId: string;
930 /**
931 * @deprecated use `include` param instead
932 */
933 maxDepth?: number;
934 include?: number;
935 };
936 return: EntryReferenceProps;
937 };
938 };
939 Extension: {
940 get: {
941 params: GetExtensionParams & QueryParams;
942 return: ExtensionProps;
943 };
944 getMany: {
945 params: GetSpaceEnvironmentParams & QueryParams;
946 return: CollectionProp<ExtensionProps>;
947 };
948 create: {
949 params: GetSpaceEnvironmentParams;
950 payload: CreateExtensionProps;
951 headers?: Record<string, unknown>;
952 return: ExtensionProps;
953 };
954 createWithId: {
955 params: GetExtensionParams;
956 payload: CreateExtensionProps;
957 headers?: Record<string, unknown>;
958 return: ExtensionProps;
959 };
960 update: {
961 params: GetExtensionParams;
962 payload: ExtensionProps;
963 headers?: Record<string, unknown>;
964 return: ExtensionProps;
965 };
966 delete: {
967 params: GetExtensionParams;
968 return: any;
969 };
970 };
971 Locale: {
972 get: {
973 params: GetSpaceEnvironmentParams & {
974 localeId: string;
975 };
976 return: LocaleProps;
977 };
978 getMany: {
979 params: GetSpaceEnvironmentParams & QueryParams;
980 return: CollectionProp<LocaleProps>;
981 };
982 delete: {
983 params: GetSpaceEnvironmentParams & {
984 localeId: string;
985 };
986 return: any;
987 };
988 update: {
989 params: GetSpaceEnvironmentParams & {
990 localeId: string;
991 };
992 payload: LocaleProps;
993 headers?: Record<string, unknown>;
994 return: LocaleProps;
995 };
996 create: {
997 params: GetSpaceEnvironmentParams;
998 payload: CreateLocaleProps;
999 headers?: Record<string, unknown>;
1000 return: LocaleProps;
1001 };
1002 };
1003 Organization: {
1004 getMany: {
1005 params: PaginationQueryParams;
1006 return: CollectionProp<OrganizationProp>;
1007 };
1008 get: {
1009 params: GetOrganizationParams;
1010 return: OrganizationProp;
1011 };
1012 };
1013 OrganizationInvitation: {
1014 get: {
1015 params: {
1016 organizationId: string;
1017 invitationId: string;
1018 };
1019 headers?: Record<string, unknown>;
1020 return: OrganizationInvitationProps;
1021 };
1022 create: {
1023 params: {
1024 organizationId: string;
1025 };
1026 payload: CreateOrganizationInvitationProps;
1027 headers?: Record<string, unknown>;
1028 return: OrganizationInvitationProps;
1029 };
1030 };
1031 OrganizationMembership: {
1032 get: {
1033 params: GetOrganizationMembershipProps;
1034 return: OrganizationMembershipProps;
1035 };
1036 getMany: {
1037 params: GetOrganizationParams & QueryParams;
1038 return: CollectionProp<OrganizationMembershipProps>;
1039 };
1040 update: {
1041 params: GetOrganizationMembershipProps;
1042 payload: OrganizationMembershipProps;
1043 headers?: Record<string, unknown>;
1044 return: OrganizationMembershipProps;
1045 };
1046 delete: {
1047 params: GetOrganizationMembershipProps;
1048 return: any;
1049 };
1050 };
1051 PersonalAccessToken: {
1052 get: {
1053 params: {
1054 tokenId: string;
1055 };
1056 return: PersonalAccessTokenProp;
1057 };
1058 getMany: {
1059 params: QueryParams;
1060 return: CollectionProp<PersonalAccessTokenProp>;
1061 };
1062 create: {
1063 params: {};
1064 payload: CreatePersonalAccessTokenProps;
1065 headers?: Record<string, unknown>;
1066 return: PersonalAccessTokenProp;
1067 };
1068 revoke: {
1069 params: {
1070 tokenId: string;
1071 };
1072 return: PersonalAccessTokenProp;
1073 };
1074 };
1075 PreviewApiKey: {
1076 get: {
1077 params: GetSpaceParams & {
1078 previewApiKeyId: string;
1079 };
1080 return: PreviewApiKeyProps;
1081 };
1082 getMany: {
1083 params: GetSpaceParams & QueryParams;
1084 return: CollectionProp<PreviewApiKeyProps>;
1085 };
1086 };
1087 Release: {
1088 get: {
1089 params: GetReleaseParams;
1090 return: ReleaseProps;
1091 };
1092 query: {
1093 params: GetSpaceEnvironmentParams & {
1094 query?: ReleaseQueryOptions;
1095 };
1096 return: CollectionProp<ReleaseProps>;
1097 };
1098 create: {
1099 params: GetSpaceEnvironmentParams;
1100 payload: ReleasePayload;
1101 return: ReleaseProps;
1102 };
1103 update: {
1104 params: GetReleaseParams & {
1105 version: number;
1106 };
1107 payload: ReleasePayload;
1108 return: ReleaseProps;
1109 };
1110 delete: {
1111 params: GetReleaseParams;
1112 return: void;
1113 };
1114 publish: {
1115 params: GetReleaseParams & {
1116 version: number;
1117 };
1118 return: ReleaseActionProps<'publish'>;
1119 };
1120 unpublish: {
1121 params: GetReleaseParams & {
1122 version: number;
1123 };
1124 return: ReleaseActionProps<'unpublish'>;
1125 };
1126 validate: {
1127 params: GetReleaseParams;
1128 payload?: ReleaseValidatePayload;
1129 return: ReleaseActionProps<'validate'>;
1130 };
1131 };
1132 ReleaseAction: {
1133 get: {
1134 params: GetReleaseParams & {
1135 actionId: string;
1136 };
1137 return: ReleaseAction;
1138 };
1139 queryForRelease: {
1140 params: GetReleaseParams & {
1141 query?: ReleaseActionQueryOptions;
1142 };
1143 return: Collection<ReleaseAction, ReleaseActionProps>;
1144 };
1145 };
1146 Role: {
1147 get: {
1148 params: GetSpaceParams & {
1149 roleId: string;
1150 };
1151 return: RoleProps;
1152 };
1153 getMany: {
1154 params: GetSpaceParams & QueryParams;
1155 return: CollectionProp<RoleProps>;
1156 };
1157 create: {
1158 params: GetSpaceParams;
1159 payload: CreateRoleProps;
1160 headers?: Record<string, unknown>;
1161 return: RoleProps;
1162 };
1163 createWithId: {
1164 params: GetSpaceParams & {
1165 roleId: string;
1166 };
1167 payload: CreateRoleProps;
1168 headers?: Record<string, unknown>;
1169 return: RoleProps;
1170 };
1171 update: {
1172 params: GetSpaceParams & {
1173 roleId: string;
1174 };
1175 payload: RoleProps;
1176 headers?: Record<string, unknown>;
1177 return: RoleProps;
1178 };
1179 delete: {
1180 params: GetSpaceParams & {
1181 roleId: string;
1182 };
1183 return: any;
1184 };
1185 };
1186 ScheduledAction: {
1187 get: {
1188 params: GetSpaceParams & {
1189 scheduledActionId: string;
1190 environmentId: string;
1191 };
1192 return: ScheduledActionProps;
1193 };
1194 getMany: {
1195 params: GetSpaceParams & QueryParams;
1196 return: CollectionProp<ScheduledActionProps>;
1197 };
1198 create: {
1199 params: GetSpaceParams;
1200 payload: Omit<ScheduledActionProps, 'sys'>;
1201 return: ScheduledActionProps;
1202 };
1203 update: {
1204 params: GetSpaceParams & {
1205 scheduledActionId: string;
1206 version: number;
1207 };
1208 payload: Omit<ScheduledActionProps, 'sys'>;
1209 return: ScheduledActionProps;
1210 };
1211 delete: {
1212 params: GetSpaceEnvironmentParams & {
1213 scheduledActionId: string;
1214 };
1215 return: any;
1216 };
1217 };
1218 Snapshot: {
1219 getManyForEntry: {
1220 params: GetSnapshotForEntryParams & QueryParams;
1221 return: CollectionProp<SnapshotProps<EntryProps<any>>>;
1222 };
1223 getForEntry: {
1224 params: GetSnapshotForEntryParams & {
1225 snapshotId: string;
1226 };
1227 return: SnapshotProps<EntryProps<any>>;
1228 };
1229 getManyForContentType: {
1230 params: GetSnapshotForContentTypeParams & QueryParams;
1231 return: CollectionProp<SnapshotProps<ContentTypeProps>>;
1232 };
1233 getForContentType: {
1234 params: GetSnapshotForContentTypeParams & {
1235 snapshotId: string;
1236 };
1237 return: SnapshotProps<ContentTypeProps>;
1238 };
1239 };
1240 Space: {
1241 get: {
1242 params: GetSpaceParams;
1243 return: SpaceProps;
1244 };
1245 getMany: {
1246 params: QueryParams;
1247 return: CollectionProp<SpaceProps>;
1248 };
1249 create: {
1250 params: {
1251 organizationId?: string;
1252 };
1253 payload: Omit<SpaceProps, 'sys'>;
1254 headers?: Record<string, unknown>;
1255 return: any;
1256 };
1257 update: {
1258 params: GetSpaceParams;
1259 payload: SpaceProps;
1260 headers?: Record<string, unknown>;
1261 return: SpaceProps;
1262 };
1263 delete: {
1264 params: GetSpaceParams;
1265 return: void;
1266 };
1267 };
1268 SpaceMember: {
1269 get: {
1270 params: GetSpaceParams & {
1271 spaceMemberId: string;
1272 };
1273 return: SpaceMemberProps;
1274 };
1275 getMany: {
1276 params: GetSpaceParams & QueryParams;
1277 return: CollectionProp<SpaceMemberProps>;
1278 };
1279 };
1280 SpaceMembership: {
1281 get: {
1282 params: GetSpaceMembershipProps;
1283 return: SpaceMembershipProps;
1284 };
1285 getMany: {
1286 params: GetSpaceParams & QueryParams;
1287 return: CollectionProp<SpaceMembershipProps>;
1288 };
1289 getForOrganization: {
1290 params: GetOrganizationParams & {
1291 spaceMembershipId: string;
1292 };
1293 return: SpaceMembershipProps;
1294 };
1295 getManyForOrganization: {
1296 params: GetOrganizationParams & QueryParams;
1297 return: CollectionProp<SpaceMembershipProps>;
1298 };
1299 create: {
1300 params: GetSpaceParams;
1301 payload: CreateSpaceMembershipProps;
1302 headers?: Record<string, unknown>;
1303 return: SpaceMembershipProps;
1304 };
1305 createWithId: {
1306 params: GetSpaceMembershipProps;
1307 payload: CreateSpaceMembershipProps;
1308 headers?: Record<string, unknown>;
1309 return: SpaceMembershipProps;
1310 };
1311 update: {
1312 params: GetSpaceMembershipProps;
1313 payload: SpaceMembershipProps;
1314 headers?: Record<string, unknown>;
1315 return: SpaceMembershipProps;
1316 };
1317 delete: {
1318 params: GetSpaceMembershipProps;
1319 return: any;
1320 };
1321 };
1322 Tag: {
1323 get: {
1324 params: GetTagParams;
1325 return: TagProps;
1326 };
1327 getMany: {
1328 params: GetSpaceEnvironmentParams & QueryParams;
1329 return: CollectionProp<TagProps>;
1330 };
1331 createWithId: {
1332 params: GetTagParams;
1333 payload: CreateTagProps;
1334 return: TagProps;
1335 };
1336 update: {
1337 params: GetTagParams;
1338 payload: UpdateTagProps;
1339 headers?: Record<string, unknown>;
1340 return: TagProps;
1341 };
1342 delete: {
1343 params: DeleteTagParams;
1344 return: any;
1345 };
1346 };
1347 Task: {
1348 get: {
1349 params: GetTaskParams;
1350 return: TaskProps;
1351 };
1352 getAll: {
1353 params: GetEntryParams;
1354 return: CollectionProp<TaskProps>;
1355 };
1356 create: {
1357 params: CreateTaskParams;
1358 payload: CreateTaskProps;
1359 return: TaskProps;
1360 };
1361 update: {
1362 params: UpdateTaskParams;
1363 payload: UpdateTaskProps;
1364 headers?: Record<string, unknown>;
1365 return: TaskProps;
1366 };
1367 delete: {
1368 params: DeleteTaskParams;
1369 return: void;
1370 };
1371 };
1372 Team: {
1373 get: {
1374 params: GetTeamParams;
1375 return: TeamProps;
1376 };
1377 getMany: {
1378 params: GetOrganizationParams & QueryParams;
1379 return: CollectionProp<TeamProps>;
1380 };
1381 getManyForSpace: {
1382 params: GetSpaceParams & QueryParams;
1383 return: CollectionProp<TeamProps>;
1384 };
1385 create: {
1386 params: GetOrganizationParams;
1387 payload: CreateTeamProps;
1388 headers?: Record<string, unknown>;
1389 return: any;
1390 };
1391 update: {
1392 params: GetTeamParams;
1393 payload: TeamProps;
1394 headers?: Record<string, unknown>;
1395 return: TeamProps;
1396 };
1397 delete: {
1398 params: GetTeamParams;
1399 return: any;
1400 };
1401 };
1402 TeamMembership: {
1403 get: {
1404 params: GetTeamMembershipParams;
1405 return: TeamMembershipProps;
1406 };
1407 getManyForOrganization: {
1408 params: GetOrganizationParams & QueryParams;
1409 return: CollectionProp<TeamMembershipProps>;
1410 };
1411 getManyForTeam: {
1412 params: GetTeamParams & QueryParams;
1413 return: CollectionProp<TeamMembershipProps>;
1414 };
1415 create: {
1416 params: GetTeamParams;
1417 payload: CreateTeamMembershipProps;
1418 headers?: Record<string, unknown>;
1419 return: TeamMembershipProps;
1420 };
1421 update: {
1422 params: GetTeamMembershipParams;
1423 payload: TeamMembershipProps;
1424 headers?: Record<string, unknown>;
1425 return: TeamMembershipProps;
1426 };
1427 delete: {
1428 params: GetTeamMembershipParams;
1429 return: any;
1430 };
1431 };
1432 TeamSpaceMembership: {
1433 get: {
1434 params: GetTeamSpaceMembershipParams;
1435 return: TeamSpaceMembershipProps;
1436 };
1437 getMany: {
1438 params: GetSpaceParams & QueryParams;
1439 return: CollectionProp<TeamSpaceMembershipProps>;
1440 };
1441 getForOrganization: {
1442 params: GetOrganizationParams & {
1443 teamSpaceMembershipId: string;
1444 };
1445 return: TeamSpaceMembershipProps;
1446 };
1447 getManyForOrganization: {
1448 params: GetOrganizationParams & QueryParams & {
1449 teamId?: string;
1450 };
1451 return: CollectionProp<TeamSpaceMembershipProps>;
1452 };
1453 create: {
1454 params: GetSpaceParams & {
1455 teamId: string;
1456 };
1457 payload: CreateTeamSpaceMembershipProps;
1458 headers?: Record<string, unknown>;
1459 return: TeamSpaceMembershipProps;
1460 };
1461 update: {
1462 params: GetTeamSpaceMembershipParams;
1463 payload: TeamSpaceMembershipProps;
1464 headers?: Record<string, unknown>;
1465 return: TeamSpaceMembershipProps;
1466 };
1467 delete: {
1468 params: GetTeamSpaceMembershipParams;
1469 return: any;
1470 };
1471 };
1472 Upload: {
1473 get: {
1474 params: GetSpaceParams & {
1475 uploadId: string;
1476 };
1477 return: any;
1478 };
1479 create: {
1480 params: GetSpaceParams;
1481 payload: {
1482 file: string | ArrayBuffer | Stream;
1483 };
1484 return: any;
1485 };
1486 delete: {
1487 params: GetSpaceParams & {
1488 uploadId: string;
1489 };
1490 return: any;
1491 };
1492 };
1493 Usage: {
1494 getManyForSpace: {
1495 params: {
1496 organizationId: string;
1497 } & QueryParams;
1498 return: CollectionProp<UsageProps>;
1499 };
1500 getManyForOrganization: {
1501 params: {
1502 organizationId: string;
1503 } & QueryParams;
1504 return: CollectionProp<UsageProps>;
1505 };
1506 };
1507 User: {
1508 getManyForSpace: {
1509 params: GetSpaceParams & QueryParams;
1510 return: CollectionProp<UserProps>;
1511 };
1512 getForSpace: {
1513 params: GetSpaceParams & {
1514 userId: string;
1515 };
1516 return: UserProps;
1517 };
1518 getCurrent: {
1519 params?: QueryParams;
1520 return: any;
1521 };
1522 getForOrganization: {
1523 params: GetOrganizationParams & {
1524 userId: string;
1525 };
1526 return: UserProps;
1527 };
1528 getManyForOrganization: {
1529 params: GetOrganizationParams & QueryParams;
1530 return: CollectionProp<UserProps>;
1531 };
1532 };
1533 Webhook: {
1534 get: {
1535 params: GetWebhookParams;
1536 return: WebhookProps;
1537 };
1538 getMany: {
1539 params: GetSpaceParams & QueryParams;
1540 return: CollectionProp<WebhookProps>;
1541 };
1542 getCallDetails: {
1543 params: GetWebhookCallDetailsUrl;
1544 return: WebhookCallDetailsProps;
1545 };
1546 getHealthStatus: {
1547 params: GetWebhookParams;
1548 return: WebhookHealthProps;
1549 };
1550 getManyCallDetails: {
1551 params: GetWebhookParams & QueryParams;
1552 return: CollectionProp<WebhookCallOverviewProps>;
1553 };
1554 create: {
1555 params: GetSpaceParams;
1556 payload: CreateWebhooksProps;
1557 headers?: Record<string, unknown>;
1558 return: WebhookProps;
1559 };
1560 createWithId: {
1561 params: GetWebhookParams;
1562 payload: CreateWebhooksProps;
1563 headers?: Record<string, unknown>;
1564 return: WebhookProps;
1565 };
1566 update: {
1567 params: GetWebhookParams;
1568 payload: WebhookProps;
1569 return: WebhookProps;
1570 };
1571 delete: {
1572 params: GetWebhookParams;
1573 return: void;
1574 };
1575 };
1576 WorkflowDefinition: {
1577 get: {
1578 params: GetWorkflowDefinitionParams;
1579 headers?: Record<string, unknown>;
1580 return: WorkflowDefinitionProps;
1581 };
1582 getMany: {
1583 params: GetSpaceEnvironmentParams & {
1584 query?: WorkflowDefinitionQueryOptions;
1585 };
1586 headers?: Record<string, unknown>;
1587 return: CollectionProp<WorkflowDefinitionProps>;
1588 };
1589 create: {
1590 params: CreateWorkflowDefinitionParams;
1591 payload: CreateWorkflowDefinitionProps;
1592 headers?: Record<string, unknown>;
1593 return: WorkflowDefinitionProps;
1594 };
1595 update: {
1596 params: GetWorkflowDefinitionParams;
1597 payload: WorkflowDefinitionProps;
1598 headers?: Record<string, unknown>;
1599 return: WorkflowDefinitionProps;
1600 };
1601 delete: {
1602 params: DeleteWorkflowDefinitionParams;
1603 headers?: Record<string, unknown>;
1604 return: void;
1605 };
1606 };
1607 Workflow: {
1608 getMany: {
1609 params: GetSpaceEnvironmentParams & {
1610 query?: WorkflowQueryOptions;
1611 };
1612 headers?: Record<string, unknown>;
1613 return: CollectionProp<WorkflowProps>;
1614 };
1615 create: {
1616 params: CreateWorkflowParams;
1617 payload: CreateWorkflowProps;
1618 headers?: Record<string, unknown>;
1619 return: WorkflowProps;
1620 };
1621 update: {
1622 params: GetWorkflowParams;
1623 payload: WorkflowProps;
1624 headers?: Record<string, unknown>;
1625 return: WorkflowProps;
1626 };
1627 delete: {
1628 params: DeleteWorkflowParams;
1629 headers?: Record<string, unknown>;
1630 return: void;
1631 };
1632 complete: {
1633 params: CompleteWorkflowParams;
1634 headers?: Record<string, unknown>;
1635 return: void;
1636 };
1637 };
1638};
1639/**
1640 * @private
1641 */
1642export declare type MROpts<ET extends keyof MRActions, Action extends keyof MRActions[ET], UA extends boolean = false> = {
1643 entityType: ET;
1644 action: Action;
1645} & (UA extends true ? {
1646 userAgent: string;
1647} : {}) & ('params' extends keyof MRActions[ET][Action] ? undefined extends MRActions[ET][Action]['params'] ? {
1648 params?: MRActions[ET][Action]['params'];
1649} : {
1650 params: MRActions[ET][Action]['params'];
1651} : {}) & ('payload' extends keyof MRActions[ET][Action] ? undefined extends MRActions[ET][Action]['payload'] ? {
1652 payload?: MRActions[ET][Action]['payload'];
1653} : {
1654 payload: MRActions[ET][Action]['payload'];
1655} : {}) & ('headers' extends keyof MRActions[ET][Action] ? undefined extends MRActions[ET][Action]['headers'] ? {
1656 headers?: MRActions[ET][Action]['headers'];
1657} : {
1658 headers: MRActions[ET][Action]['headers'];
1659} : {});
1660/**
1661 * @private
1662 */
1663export declare type MRReturn<ET extends keyof MRActions, Action extends keyof MRActions[ET]> = 'return' extends keyof MRActions[ET][Action] ? Promise<MRActions[ET][Action]['return']> : never;
1664/** Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions. */
1665export interface MakeRequestPayload {
1666}
1667export interface MakeRequestOptions {
1668 entityType: keyof MRActions;
1669 action: string;
1670 params?: Record<string, unknown>;
1671 payload?: Record<string, unknown> | OpPatch[] | MakeRequestPayload;
1672 headers?: Record<string, unknown>;
1673 userAgent: string;
1674}
1675export declare type GetAppBundleParams = GetAppDefinitionParams & {
1676 appBundleId: string;
1677};
1678export declare type GetAppDefinitionParams = GetOrganizationParams & {
1679 appDefinitionId: string;
1680};
1681export declare type GetAppInstallationParams = GetSpaceEnvironmentParams & {
1682 appDefinitionId: string;
1683};
1684export declare type GetBulkActionParams = GetSpaceEnvironmentParams & {
1685 bulkActionId: string;
1686};
1687export declare type GetCommentParams = GetEntryParams & {
1688 commentId: string;
1689};
1690export declare type GetContentTypeParams = GetSpaceEnvironmentParams & {
1691 contentTypeId: string;
1692};
1693export declare type GetEditorInterfaceParams = GetSpaceEnvironmentParams & {
1694 contentTypeId: string;
1695};
1696export declare type GetEntryParams = GetSpaceEnvironmentParams & {
1697 entryId: string;
1698};
1699export declare type GetExtensionParams = GetSpaceEnvironmentParams & {
1700 extensionId: string;
1701};
1702export declare type GetOrganizationParams = {
1703 organizationId: string;
1704};
1705export declare type GetReleaseParams = GetSpaceEnvironmentParams & {
1706 releaseId: string;
1707};
1708export declare type GetSnapshotForContentTypeParams = GetSpaceEnvironmentParams & {
1709 contentTypeId: string;
1710};
1711export declare type GetSnapshotForEntryParams = GetSpaceEnvironmentParams & {
1712 entryId: string;
1713};
1714export declare type GetSpaceEnvAliasParams = GetSpaceParams & {
1715 environmentAliasId: string;
1716};
1717export declare type GetSpaceEnvironmentParams = {
1718 spaceId: string;
1719 environmentId: string;
1720};
1721export declare type GetSpaceMembershipProps = GetSpaceParams & {
1722 spaceMembershipId: string;
1723};
1724export declare type GetSpaceParams = {
1725 spaceId: string;
1726};
1727export declare type GetTagParams = GetSpaceEnvironmentParams & {
1728 tagId: string;
1729};
1730export declare type GetTaskParams = GetEntryParams & {
1731 taskId: string;
1732};
1733export declare type GetTeamMembershipParams = GetTeamParams & {
1734 teamMembershipId: string;
1735};
1736export declare type GetTeamParams = {
1737 organizationId: string;
1738 teamId: string;
1739};
1740export declare type GetTeamSpaceMembershipParams = GetSpaceParams & {
1741 teamSpaceMembershipId: string;
1742};
1743export declare type GetWebhookCallDetailsUrl = GetWebhookParams & {
1744 callId: string;
1745};
1746export declare type GetWebhookParams = GetSpaceParams & {
1747 webhookDefinitionId: string;
1748};
1749export declare type GetOrganizationMembershipProps = GetOrganizationParams & {
1750 organizationMembershipId: string;
1751};
1752export declare type GetAppUploadParams = GetOrganizationParams & {
1753 appUploadId: string;
1754};
1755export declare type GetWorkflowDefinitionParams = GetSpaceEnvironmentParams & {
1756 workflowDefinitionId: string;
1757};
1758export declare type GetWorkflowParams = GetSpaceEnvironmentParams & {
1759 workflowId: string;
1760};
1761export declare type QueryParams = {
1762 query?: QueryOptions;
1763};
1764export declare type PaginationQueryParams = {
1765 query?: PaginationQueryOptions;
1766};
1767export {};