UNPKG

95.6 kBTypeScriptView Raw
1import type { RawAxiosRequestConfig, RawAxiosRequestHeaders } from 'axios';
2import type { OpPatch } from 'json-patch';
3import type { Stream } from 'stream';
4import type { AccessTokenProps, CreatePersonalAccessTokenProps as CreatePATProps } from './entities/access-token';
5import type { ApiKeyProps, CreateApiKeyProps } from './entities/api-key';
6import type { AppActionProps, CreateAppActionProps } from './entities/app-action';
7import type { AppActionCallProps, AppActionCallResponse, CreateAppActionCallProps } from './entities/app-action-call';
8import type { AppBundleProps, CreateAppBundleProps } from './entities/app-bundle';
9import type { AppDefinitionProps, AppInstallationsForOrganizationProps, CreateAppDefinitionProps } from './entities/app-definition';
10import type { AppDetailsProps, CreateAppDetailsProps } from './entities/app-details';
11import type { AppInstallationProps, CreateAppInstallationProps } from './entities/app-installation';
12import type { AppSignedRequestProps, CreateAppSignedRequestProps } from './entities/app-signed-request';
13import type { AppSigningSecretProps, CreateAppSigningSecretProps } from './entities/app-signing-secret';
14import type { AppUploadProps } from './entities/app-upload';
15import type { AssetFileProp, AssetProcessingForLocale, AssetProps, CreateAssetProps } from './entities/asset';
16import type { AssetKeyProps, CreateAssetKeyProps } from './entities/asset-key';
17import type { BulkActionProps, BulkActionPublishPayload, BulkActionUnpublishPayload, BulkActionValidatePayload } from './entities/bulk-action';
18import type { CommentProps, CreateCommentParams, CreateCommentProps, DeleteCommentParams, GetCommentParentEntityParams, GetManyCommentsParams, PlainTextBodyFormat, RichTextBodyFormat, RichTextCommentBodyPayload, RichTextCommentProps, UpdateCommentParams, UpdateCommentProps } from './entities/comment';
19import type { ContentTypeProps, CreateContentTypeProps } from './entities/content-type';
20import type { EditorInterfaceProps } from './entities/editor-interface';
21import type { CreateEntryProps, EntryProps, EntryReferenceProps } from './entities/entry';
22import type { CreateEnvironmentProps, EnvironmentProps } from './entities/environment';
23import type { CreateEnvironmentAliasProps, EnvironmentAliasProps } from './entities/environment-alias';
24import type { CreateExtensionProps, ExtensionProps } from './entities/extension';
25import type { CreateLocaleProps, LocaleProps } from './entities/locale';
26import type { OrganizationProps } from './entities/organization';
27import type { CreateOrganizationInvitationProps, OrganizationInvitationProps } from './entities/organization-invitation';
28import type { OrganizationMembershipProps } from './entities/organization-membership';
29import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProps } from './entities/personal-access-token';
30import type { PreviewApiKeyProps } from './entities/preview-api-key';
31import type { ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from './entities/release';
32import type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions } from './entities/release-action';
33import type { CreateRoleProps, RoleProps } from './entities/role';
34import type { ScheduledActionProps } from './entities/scheduled-action';
35import type { SnapshotProps } from './entities/snapshot';
36import type { SpaceProps } from './entities/space';
37import type { SpaceMemberProps } from './entities/space-member';
38import type { CreateSpaceMembershipProps, SpaceMembershipProps } from './entities/space-membership';
39import type { CreateTagProps, DeleteTagParams, TagProps, UpdateTagProps } from './entities/tag';
40import type { CreateTeamProps, TeamProps } from './entities/team';
41import type { CreateTeamMembershipProps, TeamMembershipProps } from './entities/team-membership';
42import type { CreateTeamSpaceMembershipProps, TeamSpaceMembershipProps } from './entities/team-space-membership';
43import type { UsageProps } from './entities/usage';
44import type { UserProps } from './entities/user';
45import type { CreateWebhooksProps, UpsertWebhookSigningSecretPayload, WebhookCallDetailsProps, WebhookCallOverviewProps, WebhookHealthProps, WebhookProps, WebhookRetryPolicyPayload, WebhookRetryPolicyProps, WebhookSigningSecretProps } from './entities/webhook';
46import type { CreateTaskParams, CreateTaskProps, DeleteTaskParams, TaskProps, UpdateTaskParams, UpdateTaskProps } from './entities/task';
47import type { AppAccessTokenProps, CreateAppAccessTokenProps } from './entities/app-access-token';
48import type { AppEventSubscriptionProps, CreateAppEventSubscriptionProps } from './entities/app-event-subscription';
49import type { AppKeyProps, CreateAppKeyProps } from './entities/app-key';
50import type { ConceptProps, CreateConceptProps } from './entities/concept';
51import type { ConceptSchemeProps, CreateConceptSchemeProps } from './entities/concept-scheme';
52import type { CreateEnvironmentTemplateProps, EnvironmentTemplateProps } from './entities/environment-template';
53import type { CreateEnvironmentTemplateInstallationProps, EnvironmentTemplateInstallationProps, EnvironmentTemplateValidationProps, ValidateEnvironmentTemplateInstallationProps } from './entities/environment-template-installation';
54import type { FunctionProps } from './entities/function';
55import type { ResourceProps, ResourceQueryOptions } from './entities/resource';
56import type { ResourceProviderProps, UpsertResourceProviderProps } from './entities/resource-provider';
57import type { ResourceTypeProps, SpaceEnvResourceTypeProps, UpsertResourceTypeProps } from './entities/resource-type';
58import type { UIConfigProps } from './entities/ui-config';
59import type { UserUIConfigProps } from './entities/user-ui-config';
60import type { CompleteWorkflowParams, CreateWorkflowParams, CreateWorkflowProps, DeleteWorkflowParams, WorkflowProps, WorkflowQueryOptions } from './entities/workflow';
61import type { CreateWorkflowDefinitionParams, CreateWorkflowDefinitionProps, DeleteWorkflowDefinitionParams, WorkflowDefinitionProps, WorkflowDefinitionQueryOptions } from './entities/workflow-definition';
62import type { WorkflowsChangelogEntryProps, WorkflowsChangelogQueryOptions } from './entities/workflows-changelog-entry';
63export interface DefaultElements<TPlainObject extends object = object> {
64 toPlainObject(): TPlainObject;
65}
66/**
67 * Link is a reference object to another entity that can be resolved using tools such as contentful-resolve
68 */
69export interface Link<T extends string> {
70 sys: {
71 type: 'Link';
72 linkType: T;
73 id: string;
74 };
75}
76/**
77 * ResourceLink is a reference object to another entity outside of the current space/environment
78 */
79export interface ResourceLink<T extends string> {
80 sys: {
81 type: 'ResourceLink';
82 linkType: T;
83 urn: string;
84 };
85}
86export interface VersionedLink<T extends string> {
87 sys: {
88 type: 'Link';
89 linkType: T;
90 id: string;
91 version: number;
92 };
93}
94export interface BaseCollection<T> {
95 sys: {
96 type: 'Array';
97 };
98 items: T[];
99}
100/** String will be in ISO8601 datetime format e.g. 2013-06-26T13:57:24Z */
101export type ISO8601Timestamp = string;
102export interface PaginationQueryOptions {
103 skip?: number;
104 limit?: number;
105 order?: string;
106}
107export interface QueryOptions extends PaginationQueryOptions {
108 content_type?: string;
109 include?: number;
110 select?: string;
111 links_to_entry?: string;
112 [key: string]: any;
113}
114export interface SpaceQueryOptions extends PaginationQueryOptions {
115 spaceId?: string;
116}
117export interface BasicMetaSysProps {
118 type: string;
119 id: string;
120 version: number;
121 createdBy?: SysLink;
122 createdAt: string;
123 updatedBy?: SysLink;
124 updatedAt: string;
125}
126export interface MetaSysProps extends BasicMetaSysProps {
127 space?: SysLink;
128 /**
129 * @deprecated `status` only exists on entities. Please refactor to use a
130 * type guard to get the correct `EntityMetaSysProps` type with this property.
131 */
132 status?: SysLink;
133 publishedVersion?: number;
134 archivedVersion?: number;
135 archivedBy?: SysLink;
136 archivedAt?: string;
137 deletedVersion?: number;
138 deletedBy?: SysLink;
139 deletedAt?: string;
140}
141export interface EntityMetaSysProps extends MetaSysProps {
142 /**
143 * @deprecated `contentType` only exists on entries. Please refactor to use a
144 * type guard to get the correct `EntryMetaSysProps` type with this property.
145 */
146 contentType: SysLink;
147 space: SysLink;
148 status?: SysLink;
149 environment: SysLink;
150 publishedBy?: Link<'User'> | Link<'AppDefinition'>;
151 publishedAt?: string;
152 firstPublishedAt?: string;
153 publishedCounter?: number;
154 locale?: string;
155 fieldStatus?: {
156 '*': Record<string, 'draft' | 'changed' | 'published'>;
157 };
158}
159export interface EntryMetaSysProps extends EntityMetaSysProps {
160 contentType: SysLink;
161 automationTags: Link<'Tag'>[];
162}
163export interface MetaLinkProps {
164 type: string;
165 linkType: string;
166 id: string;
167}
168export interface MetadataProps {
169 tags: Link<'Tag'>[];
170 concepts?: Link<'TaxonomyConcept'>[];
171}
172export interface SysLink {
173 sys: MetaLinkProps;
174}
175export interface CollectionProp<TObj> {
176 sys: {
177 type: 'Array';
178 };
179 total: number;
180 skip: number;
181 limit: number;
182 items: TObj[];
183}
184export interface CursorPaginatedCollectionProp<TObj> extends Omit<CollectionProp<TObj>, 'total' | 'skip'> {
185 pages?: {
186 next?: string;
187 prev?: string;
188 };
189}
190export interface Collection<T, TPlain> extends CollectionProp<T>, DefaultElements<CollectionProp<TPlain>> {
191}
192export interface CursorPaginatedCollection<T, TPlain> extends CursorPaginatedCollectionProp<T>, DefaultElements<CursorPaginatedCollectionProp<TPlain>> {
193}
194export interface QueryOptions extends BasicQueryOptions {
195 content_type?: string;
196 include?: number;
197 select?: string;
198}
199export interface BasicQueryOptions {
200 skip?: number;
201 limit?: number;
202 [key: string]: any;
203}
204export interface BasicCursorPaginationOptions extends Omit<BasicQueryOptions, 'skip'> {
205 pageNext?: string;
206 pagePrev?: string;
207}
208export type KeyValueMap = Record<string, any>;
209/**
210 * @private
211 */
212type MRInternal<UA extends boolean> = {
213 (opts: MROpts<'Http', 'get', UA>): MRReturn<'Http', 'get'>;
214 (opts: MROpts<'Http', 'patch', UA>): MRReturn<'Http', 'patch'>;
215 (opts: MROpts<'Http', 'post', UA>): MRReturn<'Http', 'post'>;
216 (opts: MROpts<'Http', 'put', UA>): MRReturn<'Http', 'put'>;
217 (opts: MROpts<'Http', 'delete', UA>): MRReturn<'Http', 'delete'>;
218 (opts: MROpts<'Http', 'request', UA>): MRReturn<'Http', 'request'>;
219 (opts: MROpts<'AppAction', 'get', UA>): MRReturn<'AppAction', 'get'>;
220 (opts: MROpts<'AppAction', 'getMany', UA>): MRReturn<'AppAction', 'getMany'>;
221 (opts: MROpts<'AppAction', 'delete', UA>): MRReturn<'AppAction', 'delete'>;
222 (opts: MROpts<'AppAction', 'create', UA>): MRReturn<'AppAction', 'create'>;
223 (opts: MROpts<'AppAction', 'update', UA>): MRReturn<'AppAction', 'update'>;
224 (opts: MROpts<'AppActionCall', 'create', UA>): MRReturn<'AppActionCall', 'create'>;
225 (opts: MROpts<'AppActionCall', 'createWithResponse', UA>): MRReturn<'AppActionCall', 'createWithResponse'>;
226 (opts: MROpts<'AppActionCall', 'getCallDetails', UA>): MRReturn<'AppActionCall', 'getCallDetails'>;
227 (opts: MROpts<'AppBundle', 'get', UA>): MRReturn<'AppBundle', 'get'>;
228 (opts: MROpts<'AppBundle', 'getMany', UA>): MRReturn<'AppBundle', 'getMany'>;
229 (opts: MROpts<'AppBundle', 'delete', UA>): MRReturn<'AppBundle', 'delete'>;
230 (opts: MROpts<'AppBundle', 'create', UA>): MRReturn<'AppBundle', 'create'>;
231 (opts: MROpts<'ApiKey', 'get', UA>): MRReturn<'ApiKey', 'get'>;
232 (opts: MROpts<'ApiKey', 'getMany', UA>): MRReturn<'ApiKey', 'getMany'>;
233 (opts: MROpts<'ApiKey', 'create', UA>): MRReturn<'ApiKey', 'create'>;
234 (opts: MROpts<'ApiKey', 'createWithId', UA>): MRReturn<'ApiKey', 'createWithId'>;
235 (opts: MROpts<'ApiKey', 'update', UA>): MRReturn<'ApiKey', 'update'>;
236 (opts: MROpts<'ApiKey', 'delete', UA>): MRReturn<'ApiKey', 'delete'>;
237 (opts: MROpts<'AppDefinition', 'get', UA>): MRReturn<'AppDefinition', 'get'>;
238 (opts: MROpts<'AppDefinition', 'getMany', UA>): MRReturn<'AppDefinition', 'getMany'>;
239 (opts: MROpts<'AppDefinition', 'create', UA>): MRReturn<'AppDefinition', 'create'>;
240 (opts: MROpts<'AppDefinition', 'update', UA>): MRReturn<'AppDefinition', 'update'>;
241 (opts: MROpts<'AppDefinition', 'delete', UA>): MRReturn<'AppDefinition', 'delete'>;
242 (opts: MROpts<'AppDefinition', 'getInstallationsForOrg', UA>): MRReturn<'AppDefinition', 'getInstallationsForOrg'>;
243 (opts: MROpts<'AppInstallation', 'get', UA>): MRReturn<'AppInstallation', 'get'>;
244 (opts: MROpts<'AppInstallation', 'getMany', UA>): MRReturn<'AppInstallation', 'getMany'>;
245 (opts: MROpts<'AppInstallation', 'upsert', UA>): MRReturn<'AppInstallation', 'upsert'>;
246 (opts: MROpts<'AppInstallation', 'delete', UA>): MRReturn<'AppInstallation', 'delete'>;
247 (opts: MROpts<'AppInstallation', 'getForOrganization', UA>): MRReturn<'AppInstallation', 'getForOrganization'>;
248 (opts: MROpts<'Asset', 'getMany', UA>): MRReturn<'Asset', 'getMany'>;
249 (opts: MROpts<'Asset', 'getPublished', UA>): MRReturn<'Asset', 'getPublished'>;
250 (opts: MROpts<'Asset', 'get', UA>): MRReturn<'Asset', 'get'>;
251 (opts: MROpts<'Asset', 'update', UA>): MRReturn<'Asset', 'update'>;
252 (opts: MROpts<'Asset', 'delete', UA>): MRReturn<'Asset', 'delete'>;
253 (opts: MROpts<'Asset', 'publish', UA>): MRReturn<'Asset', 'publish'>;
254 (opts: MROpts<'Asset', 'unpublish', UA>): MRReturn<'Asset', 'unpublish'>;
255 (opts: MROpts<'Asset', 'archive', UA>): MRReturn<'Asset', 'archive'>;
256 (opts: MROpts<'Asset', 'unarchive', UA>): MRReturn<'Asset', 'unarchive'>;
257 (opts: MROpts<'Asset', 'create', UA>): MRReturn<'Asset', 'create'>;
258 (opts: MROpts<'Asset', 'createWithId', UA>): MRReturn<'Asset', 'createWithId'>;
259 (opts: MROpts<'Asset', 'createFromFiles', UA>): MRReturn<'Asset', 'createFromFiles'>;
260 (opts: MROpts<'Asset', 'processForAllLocales', UA>): MRReturn<'Asset', 'processForAllLocales'>;
261 (opts: MROpts<'Asset', 'processForLocale', UA>): MRReturn<'Asset', 'processForLocale'>;
262 (opts: MROpts<'AppUpload', 'get', UA>): MRReturn<'AppUpload', 'get'>;
263 (opts: MROpts<'AppUpload', 'delete', UA>): MRReturn<'AppUpload', 'delete'>;
264 (opts: MROpts<'AppUpload', 'create', UA>): MRReturn<'AppUpload', 'create'>;
265 (opts: MROpts<'AppDetails', 'upsert', UA>): MRReturn<'AppDetails', 'upsert'>;
266 (opts: MROpts<'AppDetails', 'get', UA>): MRReturn<'AppDetails', 'get'>;
267 (opts: MROpts<'AppDetails', 'delete', UA>): MRReturn<'AppDetails', 'delete'>;
268 (opts: MROpts<'AppSignedRequest', 'create', UA>): MRReturn<'AppSignedRequest', 'create'>;
269 (opts: MROpts<'AppSigningSecret', 'upsert', UA>): MRReturn<'AppSigningSecret', 'upsert'>;
270 (opts: MROpts<'AppSigningSecret', 'get', UA>): MRReturn<'AppSigningSecret', 'get'>;
271 (opts: MROpts<'AppSigningSecret', 'delete', UA>): MRReturn<'AppSigningSecret', 'delete'>;
272 (opts: MROpts<'AppEventSubscription', 'upsert', UA>): MRReturn<'AppEventSubscription', 'upsert'>;
273 (opts: MROpts<'AppEventSubscription', 'get', UA>): MRReturn<'AppEventSubscription', 'get'>;
274 (opts: MROpts<'AppEventSubscription', 'delete', UA>): MRReturn<'AppEventSubscription', 'delete'>;
275 (opts: MROpts<'AppKey', 'get', UA>): MRReturn<'AppKey', 'get'>;
276 (opts: MROpts<'AppKey', 'getMany', UA>): MRReturn<'AppKey', 'getMany'>;
277 (opts: MROpts<'AppKey', 'create', UA>): MRReturn<'AppKey', 'create'>;
278 (opts: MROpts<'AppKey', 'delete', UA>): MRReturn<'AppKey', 'delete'>;
279 (opts: MROpts<'AppAccessToken', 'create', UA>): MRReturn<'AppAccessToken', 'create'>;
280 (opts: MROpts<'AssetKey', 'create', UA>): MRReturn<'AssetKey', 'create'>;
281 (opts: MROpts<'BulkAction', 'get', UA>): MRReturn<'BulkAction', 'get'>;
282 (opts: MROpts<'BulkAction', 'publish', UA>): MRReturn<'BulkAction', 'publish'>;
283 (opts: MROpts<'BulkAction', 'unpublish', UA>): MRReturn<'BulkAction', 'unpublish'>;
284 (opts: MROpts<'BulkAction', 'validate', UA>): MRReturn<'BulkAction', 'validate'>;
285 (opts: MROpts<'Comment', 'get', UA>): MRReturn<'Comment', 'get'>;
286 (opts: MROpts<'Comment', 'getMany', UA>): MRReturn<'Comment', 'getMany'>;
287 (opts: MROpts<'Comment', 'getAll', UA>): MRReturn<'Comment', 'getAll'>;
288 (opts: MROpts<'Comment', 'create', UA>): MRReturn<'Comment', 'create'>;
289 (opts: MROpts<'Comment', 'update', UA>): MRReturn<'Comment', 'update'>;
290 (opts: MROpts<'Comment', 'delete', UA>): MRReturn<'Comment', 'delete'>;
291 (opts: MROpts<'Concept', 'get', UA>): MRReturn<'Concept', 'get'>;
292 (opts: MROpts<'Concept', 'getMany', UA>): MRReturn<'Concept', 'getMany'>;
293 (opts: MROpts<'Concept', 'getTotal', UA>): MRReturn<'Concept', 'getTotal'>;
294 (opts: MROpts<'Concept', 'getDescendants', UA>): MRReturn<'Concept', 'getDescendants'>;
295 (opts: MROpts<'Concept', 'create', UA>): MRReturn<'Concept', 'create'>;
296 (opts: MROpts<'Concept', 'createWithId', UA>): MRReturn<'Concept', 'createWithId'>;
297 (opts: MROpts<'Concept', 'patch', UA>): MRReturn<'Concept', 'patch'>;
298 (opts: MROpts<'Concept', 'update', UA>): MRReturn<'Concept', 'update'>;
299 (opts: MROpts<'Concept', 'updatePut', UA>): MRReturn<'Concept', 'updatePut'>;
300 (opts: MROpts<'Concept', 'delete', UA>): MRReturn<'Concept', 'delete'>;
301 (opts: MROpts<'ConceptScheme', 'get', UA>): MRReturn<'ConceptScheme', 'get'>;
302 (opts: MROpts<'ConceptScheme', 'getMany', UA>): MRReturn<'ConceptScheme', 'getMany'>;
303 (opts: MROpts<'ConceptScheme', 'getTotal', UA>): MRReturn<'ConceptScheme', 'getTotal'>;
304 (opts: MROpts<'ConceptScheme', 'create', UA>): MRReturn<'ConceptScheme', 'create'>;
305 (opts: MROpts<'ConceptScheme', 'createWithId', UA>): MRReturn<'ConceptScheme', 'createWithId'>;
306 (opts: MROpts<'ConceptScheme', 'patch', UA>): MRReturn<'ConceptScheme', 'patch'>;
307 (opts: MROpts<'ConceptScheme', 'update', UA>): MRReturn<'ConceptScheme', 'update'>;
308 (opts: MROpts<'ConceptScheme', 'updatePut', UA>): MRReturn<'ConceptScheme', 'updatePut'>;
309 (opts: MROpts<'ConceptScheme', 'delete', UA>): MRReturn<'ConceptScheme', 'delete'>;
310 (opts: MROpts<'ContentType', 'get', UA>): MRReturn<'ContentType', 'get'>;
311 (opts: MROpts<'ContentType', 'getMany', UA>): MRReturn<'ContentType', 'getMany'>;
312 (opts: MROpts<'ContentType', 'update', UA>): MRReturn<'ContentType', 'update'>;
313 (opts: MROpts<'ContentType', 'create', UA>): MRReturn<'ContentType', 'create'>;
314 (opts: MROpts<'ContentType', 'createWithId', UA>): MRReturn<'ContentType', 'createWithId'>;
315 (opts: MROpts<'ContentType', 'delete', UA>): MRReturn<'ContentType', 'delete'>;
316 (opts: MROpts<'ContentType', 'publish', UA>): MRReturn<'ContentType', 'publish'>;
317 (opts: MROpts<'ContentType', 'unpublish', UA>): MRReturn<'ContentType', 'unpublish'>;
318 (opts: MROpts<'EditorInterface', 'get', UA>): MRReturn<'EditorInterface', 'get'>;
319 (opts: MROpts<'EditorInterface', 'getMany', UA>): MRReturn<'EditorInterface', 'getMany'>;
320 (opts: MROpts<'EditorInterface', 'update', UA>): MRReturn<'EditorInterface', 'update'>;
321 (opts: MROpts<'Environment', 'get', UA>): MRReturn<'Environment', 'get'>;
322 (opts: MROpts<'Environment', 'getMany', UA>): MRReturn<'Environment', 'getMany'>;
323 (opts: MROpts<'Environment', 'create', UA>): MRReturn<'Environment', 'create'>;
324 (opts: MROpts<'Environment', 'createWithId', UA>): MRReturn<'Environment', 'createWithId'>;
325 (opts: MROpts<'Environment', 'update', UA>): MRReturn<'Environment', 'update'>;
326 (opts: MROpts<'Environment', 'delete', UA>): MRReturn<'Environment', 'delete'>;
327 (opts: MROpts<'EnvironmentAlias', 'get', UA>): MRReturn<'EnvironmentAlias', 'get'>;
328 (opts: MROpts<'EnvironmentAlias', 'getMany', UA>): MRReturn<'EnvironmentAlias', 'getMany'>;
329 (opts: MROpts<'EnvironmentAlias', 'createWithId', UA>): MRReturn<'EnvironmentAlias', 'createWithId'>;
330 (opts: MROpts<'EnvironmentAlias', 'update', UA>): MRReturn<'EnvironmentAlias', 'update'>;
331 (opts: MROpts<'EnvironmentAlias', 'delete', UA>): MRReturn<'EnvironmentAlias', 'delete'>;
332 (opts: MROpts<'EnvironmentTemplate', 'get', UA>): MRReturn<'EnvironmentTemplate', 'get'>;
333 (opts: MROpts<'EnvironmentTemplate', 'getMany', UA>): MRReturn<'EnvironmentTemplate', 'getMany'>;
334 (opts: MROpts<'EnvironmentTemplate', 'create', UA>): MRReturn<'EnvironmentTemplate', 'create'>;
335 (opts: MROpts<'EnvironmentTemplate', 'update', UA>): MRReturn<'EnvironmentTemplate', 'update'>;
336 (opts: MROpts<'EnvironmentTemplate', 'delete', UA>): MRReturn<'EnvironmentTemplate', 'delete'>;
337 (opts: MROpts<'EnvironmentTemplate', 'versions', UA>): MRReturn<'EnvironmentTemplate', 'versions'>;
338 (opts: MROpts<'EnvironmentTemplate', 'versionUpdate', UA>): MRReturn<'EnvironmentTemplate', 'versionUpdate'>;
339 (opts: MROpts<'EnvironmentTemplate', 'validate', UA>): MRReturn<'EnvironmentTemplate', 'validate'>;
340 (opts: MROpts<'EnvironmentTemplate', 'install', UA>): MRReturn<'EnvironmentTemplate', 'install'>;
341 (opts: MROpts<'EnvironmentTemplate', 'disconnect', UA>): MRReturn<'EnvironmentTemplate', 'disconnect'>;
342 (opts: MROpts<'EnvironmentTemplateInstallation', 'getMany', UA>): MRReturn<'EnvironmentTemplateInstallation', 'getMany'>;
343 (opts: MROpts<'EnvironmentTemplateInstallation', 'getForEnvironment', UA>): MRReturn<'EnvironmentTemplateInstallation', 'getForEnvironment'>;
344 (opts: MROpts<'Entry', 'getMany', UA>): MRReturn<'Entry', 'getMany'>;
345 (opts: MROpts<'Entry', 'getPublished', UA>): MRReturn<'Entry', 'getPublished'>;
346 (opts: MROpts<'Entry', 'get', UA>): MRReturn<'Entry', 'get'>;
347 (opts: MROpts<'Entry', 'patch', UA>): MRReturn<'Entry', 'patch'>;
348 (opts: MROpts<'Entry', 'update', UA>): MRReturn<'Entry', 'update'>;
349 (opts: MROpts<'Entry', 'delete', UA>): MRReturn<'Entry', 'delete'>;
350 (opts: MROpts<'Entry', 'publish', UA>): MRReturn<'Entry', 'publish'>;
351 (opts: MROpts<'Entry', 'unpublish', UA>): MRReturn<'Entry', 'unpublish'>;
352 (opts: MROpts<'Entry', 'archive', UA>): MRReturn<'Entry', 'archive'>;
353 (opts: MROpts<'Entry', 'unarchive', UA>): MRReturn<'Entry', 'unarchive'>;
354 (opts: MROpts<'Entry', 'create', UA>): MRReturn<'Entry', 'create'>;
355 (opts: MROpts<'Entry', 'createWithId', UA>): MRReturn<'Entry', 'createWithId'>;
356 (opts: MROpts<'Entry', 'references', UA>): MRReturn<'Entry', 'references'>;
357 (opts: MROpts<'Extension', 'get', UA>): MRReturn<'Extension', 'get'>;
358 (opts: MROpts<'Extension', 'getMany', UA>): MRReturn<'Extension', 'getMany'>;
359 (opts: MROpts<'Extension', 'create', UA>): MRReturn<'Extension', 'create'>;
360 (opts: MROpts<'Extension', 'createWithId', UA>): MRReturn<'Extension', 'createWithId'>;
361 (opts: MROpts<'Extension', 'update', UA>): MRReturn<'Extension', 'update'>;
362 (opts: MROpts<'Extension', 'delete', UA>): MRReturn<'Extension', 'delete'>;
363 (opts: MROpts<'Function', 'get', UA>): MRReturn<'Function', 'get'>;
364 (opts: MROpts<'Function', 'getMany', UA>): MRReturn<'Function', 'getMany'>;
365 (opts: MROpts<'Function', 'getManyForEnvironment', UA>): MRReturn<'Function', 'getManyForEnvironment'>;
366 (opts: MROpts<'Locale', 'get', UA>): MRReturn<'Locale', 'get'>;
367 (opts: MROpts<'Locale', 'getMany', UA>): MRReturn<'Locale', 'getMany'>;
368 (opts: MROpts<'Locale', 'delete', UA>): MRReturn<'Locale', 'delete'>;
369 (opts: MROpts<'Locale', 'update', UA>): MRReturn<'Locale', 'update'>;
370 (opts: MROpts<'Locale', 'create', UA>): MRReturn<'Locale', 'create'>;
371 (opts: MROpts<'Organization', 'getMany', UA>): MRReturn<'Organization', 'getMany'>;
372 (opts: MROpts<'Organization', 'get', UA>): MRReturn<'Organization', 'get'>;
373 (opts: MROpts<'OrganizationInvitation', 'get', UA>): MRReturn<'OrganizationInvitation', 'get'>;
374 (opts: MROpts<'OrganizationInvitation', 'create', UA>): MRReturn<'OrganizationInvitation', 'create'>;
375 (opts: MROpts<'OrganizationMembership', 'get', UA>): MRReturn<'OrganizationMembership', 'get'>;
376 (opts: MROpts<'OrganizationMembership', 'getMany', UA>): MRReturn<'OrganizationMembership', 'getMany'>;
377 (opts: MROpts<'OrganizationMembership', 'update', UA>): MRReturn<'OrganizationMembership', 'update'>;
378 (opts: MROpts<'OrganizationMembership', 'delete', UA>): MRReturn<'OrganizationMembership', 'delete'>;
379 (opts: MROpts<'PersonalAccessToken', 'get', UA>): MRReturn<'PersonalAccessToken', 'get'>;
380 (opts: MROpts<'PersonalAccessToken', 'getMany', UA>): MRReturn<'PersonalAccessToken', 'getMany'>;
381 (opts: MROpts<'PersonalAccessToken', 'create', UA>): MRReturn<'PersonalAccessToken', 'create'>;
382 (opts: MROpts<'PersonalAccessToken', 'revoke', UA>): MRReturn<'PersonalAccessToken', 'revoke'>;
383 (opts: MROpts<'AccessToken', 'get', UA>): MRReturn<'AccessToken', 'get'>;
384 (opts: MROpts<'AccessToken', 'getMany', UA>): MRReturn<'AccessToken', 'getMany'>;
385 (opts: MROpts<'AccessToken', 'createPersonalAccessToken', UA>): MRReturn<'AccessToken', 'createPersonalAccessToken'>;
386 (opts: MROpts<'AccessToken', 'revoke', UA>): MRReturn<'AccessToken', 'revoke'>;
387 (opts: MROpts<'AccessToken', 'getManyForOrganization', UA>): MRReturn<'AccessToken', 'getManyForOrganization'>;
388 (opts: MROpts<'PreviewApiKey', 'get', UA>): MRReturn<'PreviewApiKey', 'get'>;
389 (opts: MROpts<'PreviewApiKey', 'getMany', UA>): MRReturn<'PreviewApiKey', 'getMany'>;
390 (opts: MROpts<'Release', 'archive', UA>): MRReturn<'Release', 'archive'>;
391 (opts: MROpts<'Release', 'get', UA>): MRReturn<'Release', 'get'>;
392 (opts: MROpts<'Release', 'query', UA>): MRReturn<'Release', 'query'>;
393 (opts: MROpts<'Release', 'create', UA>): MRReturn<'Release', 'create'>;
394 (opts: MROpts<'Release', 'update', UA>): MRReturn<'Release', 'update'>;
395 (opts: MROpts<'Release', 'delete', UA>): MRReturn<'Release', 'delete'>;
396 (opts: MROpts<'Release', 'publish', UA>): MRReturn<'Release', 'publish'>;
397 (opts: MROpts<'Release', 'unpublish', UA>): MRReturn<'Release', 'unpublish'>;
398 (opts: MROpts<'Release', 'unarchive', UA>): MRReturn<'Release', 'unarchive'>;
399 (opts: MROpts<'Release', 'validate', UA>): MRReturn<'Release', 'validate'>;
400 (opts: MROpts<'ReleaseAction', 'get', UA>): MRReturn<'ReleaseAction', 'get'>;
401 (opts: MROpts<'ReleaseAction', 'getMany', UA>): MRReturn<'ReleaseAction', 'getMany'>;
402 (opts: MROpts<'ReleaseAction', 'queryForRelease', UA>): MRReturn<'ReleaseAction', 'queryForRelease'>;
403 (opts: MROpts<'Resource', 'getMany', UA>): MRReturn<'Resource', 'getMany'>;
404 (opts: MROpts<'ResourceProvider', 'get', UA>): MRReturn<'ResourceProvider', 'get'>;
405 (opts: MROpts<'ResourceProvider', 'upsert', UA>): MRReturn<'ResourceProvider', 'upsert'>;
406 (opts: MROpts<'ResourceProvider', 'delete', UA>): MRReturn<'ResourceProvider', 'delete'>;
407 (opts: MROpts<'ResourceType', 'get', UA>): MRReturn<'ResourceType', 'get'>;
408 (opts: MROpts<'ResourceType', 'upsert', UA>): MRReturn<'ResourceType', 'upsert'>;
409 (opts: MROpts<'ResourceType', 'delete', UA>): MRReturn<'ResourceType', 'delete'>;
410 (opts: MROpts<'ResourceType', 'getForEnvironment', UA>): MRReturn<'ResourceType', 'getForEnvironment'>;
411 (opts: MROpts<'ResourceType', 'getMany', UA>): MRReturn<'ResourceType', 'getMany'>;
412 (opts: MROpts<'Role', 'get', UA>): MRReturn<'Role', 'get'>;
413 (opts: MROpts<'Role', 'getMany', UA>): MRReturn<'Role', 'getMany'>;
414 (opts: MROpts<'Role', 'getManyForOrganization', UA>): MRReturn<'Role', 'getManyForOrganization'>;
415 (opts: MROpts<'Role', 'create', UA>): MRReturn<'Role', 'create'>;
416 (opts: MROpts<'Role', 'createWithId', UA>): MRReturn<'Role', 'createWithId'>;
417 (opts: MROpts<'Role', 'update', UA>): MRReturn<'Role', 'update'>;
418 (opts: MROpts<'Role', 'delete', UA>): MRReturn<'Role', 'delete'>;
419 (opts: MROpts<'ScheduledAction', 'get', UA>): MRReturn<'ScheduledAction', 'get'>;
420 (opts: MROpts<'ScheduledAction', 'getMany', UA>): MRReturn<'ScheduledAction', 'getMany'>;
421 (opts: MROpts<'ScheduledAction', 'create', UA>): MRReturn<'ScheduledAction', 'create'>;
422 (opts: MROpts<'ScheduledAction', 'update', UA>): MRReturn<'ScheduledAction', 'update'>;
423 (opts: MROpts<'ScheduledAction', 'delete', UA>): MRReturn<'ScheduledAction', 'delete'>;
424 (opts: MROpts<'Snapshot', 'getManyForEntry', UA>): MRReturn<'Snapshot', 'getManyForEntry'>;
425 (opts: MROpts<'Snapshot', 'getForEntry', UA>): MRReturn<'Snapshot', 'getForEntry'>;
426 (opts: MROpts<'Snapshot', 'getManyForContentType', UA>): MRReturn<'Snapshot', 'getManyForContentType'>;
427 (opts: MROpts<'Snapshot', 'getForContentType', UA>): MRReturn<'Snapshot', 'getForContentType'>;
428 (opts: MROpts<'Space', 'get', UA>): MRReturn<'Space', 'get'>;
429 (opts: MROpts<'Space', 'getMany', UA>): MRReturn<'Space', 'getMany'>;
430 (opts: MROpts<'Space', 'getManyForOrganization', UA>): MRReturn<'Space', 'getManyForOrganization'>;
431 (opts: MROpts<'Space', 'create', UA>): MRReturn<'Space', 'create'>;
432 (opts: MROpts<'Space', 'update', UA>): MRReturn<'Space', 'update'>;
433 (opts: MROpts<'Space', 'delete', UA>): MRReturn<'Space', 'delete'>;
434 (opts: MROpts<'SpaceMember', 'get', UA>): MRReturn<'SpaceMember', 'get'>;
435 (opts: MROpts<'SpaceMember', 'getMany', UA>): MRReturn<'SpaceMember', 'getMany'>;
436 (opts: MROpts<'SpaceMembership', 'get', UA>): MRReturn<'SpaceMembership', 'get'>;
437 (opts: MROpts<'SpaceMembership', 'getMany', UA>): MRReturn<'SpaceMembership', 'getMany'>;
438 (opts: MROpts<'SpaceMembership', 'getForOrganization', UA>): MRReturn<'SpaceMembership', 'getForOrganization'>;
439 (opts: MROpts<'SpaceMembership', 'getManyForOrganization', UA>): MRReturn<'SpaceMembership', 'getManyForOrganization'>;
440 (opts: MROpts<'SpaceMembership', 'create', UA>): MRReturn<'SpaceMembership', 'create'>;
441 (opts: MROpts<'SpaceMembership', 'createWithId', UA>): MRReturn<'SpaceMembership', 'createWithId'>;
442 (opts: MROpts<'SpaceMembership', 'update', UA>): MRReturn<'SpaceMembership', 'update'>;
443 (opts: MROpts<'SpaceMembership', 'delete', UA>): MRReturn<'SpaceMembership', 'delete'>;
444 (opts: MROpts<'Tag', 'get', UA>): MRReturn<'Tag', 'get'>;
445 (opts: MROpts<'Tag', 'getMany', UA>): MRReturn<'Tag', 'getMany'>;
446 (opts: MROpts<'Tag', 'createWithId', UA>): MRReturn<'Tag', 'createWithId'>;
447 (opts: MROpts<'Tag', 'update', UA>): MRReturn<'Tag', 'update'>;
448 (opts: MROpts<'Tag', 'delete', UA>): MRReturn<'Tag', 'delete'>;
449 (opts: MROpts<'Task', 'get', UA>): MRReturn<'Task', 'get'>;
450 (opts: MROpts<'Task', 'getMany', UA>): MRReturn<'Task', 'getMany'>;
451 (opts: MROpts<'Task', 'getAll', UA>): MRReturn<'Task', 'getAll'>;
452 (opts: MROpts<'Task', 'create', UA>): MRReturn<'Task', 'create'>;
453 (opts: MROpts<'Task', 'update', UA>): MRReturn<'Task', 'update'>;
454 (opts: MROpts<'Task', 'delete', UA>): MRReturn<'Task', 'delete'>;
455 (opts: MROpts<'Team', 'get', UA>): MRReturn<'Team', 'get'>;
456 (opts: MROpts<'Team', 'getMany', UA>): MRReturn<'Team', 'getMany'>;
457 (opts: MROpts<'Team', 'getManyForSpace', UA>): MRReturn<'Team', 'getManyForSpace'>;
458 (opts: MROpts<'Team', 'create', UA>): MRReturn<'Team', 'create'>;
459 (opts: MROpts<'Team', 'update', UA>): MRReturn<'Team', 'update'>;
460 (opts: MROpts<'Team', 'delete', UA>): MRReturn<'Team', 'delete'>;
461 (opts: MROpts<'TeamMembership', 'get', UA>): MRReturn<'TeamMembership', 'get'>;
462 (opts: MROpts<'TeamMembership', 'getManyForOrganization', UA>): MRReturn<'TeamMembership', 'getManyForOrganization'>;
463 (opts: MROpts<'TeamMembership', 'getManyForTeam', UA>): MRReturn<'TeamMembership', 'getManyForTeam'>;
464 (opts: MROpts<'TeamMembership', 'create', UA>): MRReturn<'TeamMembership', 'create'>;
465 (opts: MROpts<'TeamMembership', 'update', UA>): MRReturn<'TeamMembership', 'update'>;
466 (opts: MROpts<'TeamMembership', 'delete', UA>): MRReturn<'TeamMembership', 'delete'>;
467 (opts: MROpts<'TeamSpaceMembership', 'get', UA>): MRReturn<'TeamSpaceMembership', 'get'>;
468 (opts: MROpts<'TeamSpaceMembership', 'getMany', UA>): MRReturn<'TeamSpaceMembership', 'getMany'>;
469 (opts: MROpts<'TeamSpaceMembership', 'getForOrganization', UA>): MRReturn<'TeamSpaceMembership', 'getForOrganization'>;
470 (opts: MROpts<'TeamSpaceMembership', 'getManyForOrganization', UA>): MRReturn<'TeamSpaceMembership', 'getManyForOrganization'>;
471 (opts: MROpts<'TeamSpaceMembership', 'create', UA>): MRReturn<'TeamSpaceMembership', 'create'>;
472 (opts: MROpts<'TeamSpaceMembership', 'update', UA>): MRReturn<'TeamSpaceMembership', 'update'>;
473 (opts: MROpts<'TeamSpaceMembership', 'delete', UA>): MRReturn<'TeamSpaceMembership', 'delete'>;
474 (opts: MROpts<'UIConfig', 'get', UA>): MRReturn<'UIConfig', 'get'>;
475 (opts: MROpts<'UIConfig', 'update', UA>): MRReturn<'UIConfig', 'update'>;
476 (opts: MROpts<'Upload', 'get', UA>): MRReturn<'Entry', 'get'>;
477 (opts: MROpts<'Upload', 'create', UA>): MRReturn<'Entry', 'create'>;
478 (opts: MROpts<'Upload', 'delete', UA>): MRReturn<'Entry', 'delete'>;
479 (opts: MROpts<'UploadCredential', 'create', UA>): MRReturn<'UploadCredential', 'create'>;
480 (opts: MROpts<'Usage', 'getManyForSpace', UA>): MRReturn<'Usage', 'getManyForSpace'>;
481 (opts: MROpts<'Usage', 'getManyForOrganization', UA>): MRReturn<'Usage', 'getManyForOrganization'>;
482 (opts: MROpts<'User', 'getManyForSpace', UA>): MRReturn<'User', 'getManyForSpace'>;
483 (opts: MROpts<'User', 'getForSpace', UA>): MRReturn<'User', 'getForSpace'>;
484 (opts: MROpts<'User', 'getCurrent', UA>): MRReturn<'User', 'getCurrent'>;
485 (opts: MROpts<'User', 'getForOrganization', UA>): MRReturn<'User', 'getForOrganization'>;
486 (opts: MROpts<'User', 'getManyForOrganization', UA>): MRReturn<'User', 'getManyForOrganization'>;
487 (opts: MROpts<'UserUIConfig', 'get', UA>): MRReturn<'UserUIConfig', 'update'>;
488 (opts: MROpts<'UserUIConfig', 'update', UA>): MRReturn<'UserUIConfig', 'update'>;
489 (opts: MROpts<'Webhook', 'get', UA>): MRReturn<'Webhook', 'get'>;
490 (opts: MROpts<'Webhook', 'getMany', UA>): MRReturn<'Webhook', 'getMany'>;
491 (opts: MROpts<'Webhook', 'getCallDetails', UA>): MRReturn<'Webhook', 'getCallDetails'>;
492 (opts: MROpts<'Webhook', 'getHealthStatus', UA>): MRReturn<'Webhook', 'getHealthStatus'>;
493 (opts: MROpts<'Webhook', 'getManyCallDetails', UA>): MRReturn<'Webhook', 'getManyCallDetails'>;
494 (opts: MROpts<'Webhook', 'getSigningSecret', UA>): MRReturn<'Webhook', 'getSigningSecret'>;
495 (opts: MROpts<'Webhook', 'getRetryPolicy', UA>): MRReturn<'Webhook', 'getRetryPolicy'>;
496 (opts: MROpts<'Webhook', 'create', UA>): MRReturn<'Webhook', 'create'>;
497 (opts: MROpts<'Webhook', 'createWithId', UA>): MRReturn<'Webhook', 'createWithId'>;
498 (opts: MROpts<'Webhook', 'update', UA>): MRReturn<'Webhook', 'update'>;
499 (opts: MROpts<'Webhook', 'upsertSigningSecret', UA>): MRReturn<'Webhook', 'upsertSigningSecret'>;
500 (opts: MROpts<'Webhook', 'upsertRetryPolicy', UA>): MRReturn<'Webhook', 'upsertRetryPolicy'>;
501 (opts: MROpts<'Webhook', 'delete', UA>): MRReturn<'Webhook', 'delete'>;
502 (opts: MROpts<'Webhook', 'deleteSigningSecret', UA>): MRReturn<'Webhook', 'deleteSigningSecret'>;
503 (opts: MROpts<'Webhook', 'deleteRetryPolicy', UA>): MRReturn<'Webhook', 'deleteRetryPolicy'>;
504 (opts: MROpts<'WorkflowDefinition', 'get', UA>): MRReturn<'WorkflowDefinition', 'get'>;
505 (opts: MROpts<'WorkflowDefinition', 'getMany', UA>): MRReturn<'WorkflowDefinition', 'getMany'>;
506 (opts: MROpts<'WorkflowDefinition', 'create', UA>): MRReturn<'WorkflowDefinition', 'create'>;
507 (opts: MROpts<'WorkflowDefinition', 'update', UA>): MRReturn<'WorkflowDefinition', 'update'>;
508 (opts: MROpts<'WorkflowDefinition', 'delete', UA>): MRReturn<'WorkflowDefinition', 'delete'>;
509 (opts: MROpts<'Workflow', 'get', UA>): MRReturn<'Workflow', 'get'>;
510 (opts: MROpts<'Workflow', 'getMany', UA>): MRReturn<'Workflow', 'getMany'>;
511 (opts: MROpts<'Workflow', 'create', UA>): MRReturn<'Workflow', 'create'>;
512 (opts: MROpts<'Workflow', 'update', UA>): MRReturn<'Workflow', 'update'>;
513 (opts: MROpts<'Workflow', 'delete', UA>): MRReturn<'Workflow', 'delete'>;
514 (opts: MROpts<'Workflow', 'complete', UA>): MRReturn<'Workflow', 'complete'>;
515 (opts: MROpts<'WorkflowsChangelog', 'getMany', UA>): MRReturn<'WorkflowsChangelog', 'getMany'>;
516};
517/**
518 * @private
519 */
520export type MakeRequestWithUserAgent = MRInternal<true>;
521/**
522 * @private
523 */
524export type MakeRequest = MRInternal<false>;
525/**
526 * @private
527 */
528type Without<T, U> = {
529 [P in Exclude<keyof T, keyof U>]?: never;
530};
531/**
532 * @private
533 */
534export type XOR<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
535export interface Adapter {
536 makeRequest: MakeRequestWithUserAgent;
537}
538/**
539 * @private
540 */
541export type MRActions = {
542 Resource: {
543 getMany: {
544 params: GetResourceParams & {
545 query?: ResourceQueryOptions;
546 };
547 headers?: RawAxiosRequestHeaders;
548 return: CursorPaginatedCollectionProp<ResourceProps>;
549 };
550 };
551 ResourceProvider: {
552 get: {
553 params: GetResourceProviderParams;
554 return: ResourceProviderProps;
555 };
556 upsert: {
557 params: GetResourceProviderParams;
558 payload: UpsertResourceProviderProps;
559 headers?: RawAxiosRequestHeaders;
560 return: ResourceProviderProps;
561 };
562 delete: {
563 params: GetResourceProviderParams;
564 return: any;
565 };
566 };
567 ResourceType: {
568 get: {
569 params: GetResourceTypeParams;
570 return: ResourceTypeProps;
571 };
572 getMany: {
573 params: Omit<GetResourceTypeParams, 'resourceTypeId'>;
574 return: CollectionProp<ResourceTypeProps>;
575 };
576 upsert: {
577 params: GetResourceTypeParams;
578 payload: UpsertResourceTypeProps;
579 headers?: RawAxiosRequestHeaders;
580 return: ResourceTypeProps;
581 };
582 delete: {
583 params: GetResourceTypeParams;
584 return: any;
585 };
586 getForEnvironment: {
587 params: GetSpaceEnvironmentParams & {
588 query?: BasicCursorPaginationOptions;
589 };
590 return: CursorPaginatedCollectionProp<SpaceEnvResourceTypeProps>;
591 };
592 };
593 Http: {
594 get: {
595 params: {
596 url: string;
597 config?: RawAxiosRequestConfig;
598 };
599 return: any;
600 };
601 patch: {
602 params: {
603 url: string;
604 config?: RawAxiosRequestConfig;
605 };
606 payload: any;
607 return: any;
608 };
609 post: {
610 params: {
611 url: string;
612 config?: RawAxiosRequestConfig;
613 };
614 payload: any;
615 return: any;
616 };
617 put: {
618 params: {
619 url: string;
620 config?: RawAxiosRequestConfig;
621 };
622 payload: any;
623 return: any;
624 };
625 delete: {
626 params: {
627 url: string;
628 config?: RawAxiosRequestConfig;
629 };
630 return: any;
631 };
632 request: {
633 params: {
634 url: string;
635 config?: RawAxiosRequestConfig;
636 };
637 return: any;
638 };
639 };
640 AppAction: {
641 get: {
642 params: GetAppActionParams;
643 return: AppActionProps;
644 };
645 getMany: {
646 params: GetAppDefinitionParams & QueryParams;
647 return: CollectionProp<AppActionProps>;
648 };
649 getManyForEnvironment: {
650 params: GetAppActionsForEnvParams & QueryParams;
651 return: CollectionProp<AppActionProps>;
652 };
653 delete: {
654 params: GetAppActionParams;
655 return: void;
656 };
657 create: {
658 params: GetAppDefinitionParams;
659 payload: CreateAppActionProps;
660 return: AppActionProps;
661 };
662 update: {
663 params: GetAppActionParams;
664 payload: CreateAppActionProps;
665 return: AppActionProps;
666 };
667 };
668 AppActionCall: {
669 create: {
670 params: GetAppActionCallParams;
671 payload: CreateAppActionCallProps;
672 return: AppActionCallProps;
673 };
674 getCallDetails: {
675 params: GetAppActionCallDetailsParams;
676 return: AppActionCallResponse;
677 };
678 createWithResponse: {
679 params: GetAppActionCallParams;
680 payload: CreateAppActionCallProps;
681 return: AppActionCallResponse;
682 };
683 };
684 AppBundle: {
685 get: {
686 params: GetAppBundleParams;
687 return: AppBundleProps;
688 };
689 getMany: {
690 params: GetAppDefinitionParams & QueryParams;
691 return: CollectionProp<AppBundleProps>;
692 };
693 delete: {
694 params: GetAppBundleParams;
695 return: void;
696 };
697 create: {
698 params: GetAppDefinitionParams;
699 payload: CreateAppBundleProps;
700 return: AppBundleProps;
701 };
702 };
703 ApiKey: {
704 get: {
705 params: GetSpaceParams & {
706 apiKeyId: string;
707 };
708 return: ApiKeyProps;
709 };
710 getMany: {
711 params: GetSpaceParams & QueryParams;
712 return: CollectionProp<ApiKeyProps>;
713 };
714 create: {
715 params: GetSpaceParams;
716 payload: CreateApiKeyProps;
717 headers?: RawAxiosRequestHeaders;
718 return: ApiKeyProps;
719 };
720 createWithId: {
721 params: GetSpaceParams & {
722 apiKeyId: string;
723 };
724 payload: CreateApiKeyProps;
725 headers?: RawAxiosRequestHeaders;
726 return: ApiKeyProps;
727 };
728 update: {
729 params: GetSpaceParams & {
730 apiKeyId: string;
731 };
732 payload: ApiKeyProps;
733 headers?: RawAxiosRequestHeaders;
734 return: ApiKeyProps;
735 };
736 delete: {
737 params: GetSpaceParams & {
738 apiKeyId: string;
739 };
740 return: any;
741 };
742 };
743 AppDefinition: {
744 get: {
745 params: GetOrganizationParams & {
746 appDefinitionId: string;
747 };
748 return: AppDefinitionProps;
749 };
750 getMany: {
751 params: GetOrganizationParams & QueryParams;
752 return: CollectionProp<AppDefinitionProps>;
753 };
754 create: {
755 params: GetOrganizationParams;
756 payload: CreateAppDefinitionProps;
757 return: AppDefinitionProps;
758 };
759 update: {
760 params: GetAppDefinitionParams;
761 payload: AppDefinitionProps;
762 headers?: RawAxiosRequestHeaders;
763 return: AppDefinitionProps;
764 };
765 delete: {
766 params: GetAppDefinitionParams;
767 return: any;
768 };
769 getInstallationsForOrg: {
770 params: GetOrganizationParams & {
771 appDefinitionId: string;
772 } & SpaceQueryParams;
773 return: AppInstallationsForOrganizationProps;
774 };
775 };
776 AppInstallation: {
777 get: {
778 params: GetAppInstallationParams;
779 return: AppInstallationProps;
780 };
781 getMany: {
782 params: GetSpaceEnvironmentParams & PaginationQueryParams;
783 return: CollectionProp<AppInstallationProps>;
784 };
785 upsert: {
786 params: GetAppInstallationParams & {
787 acceptAllTerms?: boolean;
788 };
789 payload: CreateAppInstallationProps;
790 headers?: RawAxiosRequestHeaders;
791 return: AppInstallationProps;
792 };
793 delete: {
794 params: GetAppInstallationParams;
795 return: any;
796 };
797 getForOrganization: {
798 params: GetOrganizationParams & {
799 appDefinitionId: string;
800 spaceId?: string;
801 };
802 return: AppInstallationsForOrganizationProps;
803 };
804 };
805 AppUpload: {
806 get: {
807 params: GetAppUploadParams;
808 return: AppUploadProps;
809 };
810 delete: {
811 params: GetAppUploadParams;
812 return: void;
813 };
814 create: {
815 params: GetOrganizationParams;
816 payload: {
817 file: string | ArrayBuffer | Stream;
818 };
819 return: AppUploadProps;
820 };
821 };
822 AppDetails: {
823 upsert: {
824 params: GetAppDefinitionParams;
825 payload: CreateAppDetailsProps;
826 return: AppDetailsProps;
827 };
828 get: {
829 params: GetAppDefinitionParams;
830 return: AppDetailsProps;
831 };
832 delete: {
833 params: GetAppDefinitionParams;
834 return: void;
835 };
836 };
837 AppSignedRequest: {
838 create: {
839 params: GetAppInstallationParams;
840 payload: CreateAppSignedRequestProps;
841 return: AppSignedRequestProps;
842 };
843 };
844 AppSigningSecret: {
845 upsert: {
846 params: GetAppDefinitionParams;
847 payload: CreateAppSigningSecretProps;
848 return: AppSigningSecretProps;
849 };
850 get: {
851 params: GetAppDefinitionParams;
852 return: AppSigningSecretProps;
853 };
854 delete: {
855 params: GetAppDefinitionParams;
856 return: void;
857 };
858 };
859 AppEventSubscription: {
860 upsert: {
861 params: GetAppDefinitionParams;
862 payload: CreateAppEventSubscriptionProps;
863 return: AppEventSubscriptionProps;
864 };
865 get: {
866 params: GetAppDefinitionParams;
867 return: AppEventSubscriptionProps;
868 };
869 delete: {
870 params: GetAppDefinitionParams;
871 return: void;
872 };
873 };
874 AppKey: {
875 create: {
876 params: GetAppDefinitionParams;
877 payload: CreateAppKeyProps;
878 return: AppKeyProps;
879 };
880 get: {
881 params: GetAppDefinitionParams & {
882 fingerprint: string;
883 };
884 return: AppKeyProps;
885 };
886 getMany: {
887 params: GetAppDefinitionParams & QueryParams;
888 return: CollectionProp<AppKeyProps>;
889 };
890 delete: {
891 params: GetAppDefinitionParams & {
892 fingerprint: string;
893 };
894 return: void;
895 };
896 };
897 AppAccessToken: {
898 create: {
899 params: GetAppInstallationParams;
900 payload: CreateAppAccessTokenProps;
901 return: AppAccessTokenProps;
902 };
903 };
904 Asset: {
905 getPublished: {
906 params: GetSpaceEnvironmentParams & QueryParams;
907 headers?: RawAxiosRequestHeaders;
908 return: CollectionProp<AssetProps>;
909 };
910 getMany: {
911 params: GetSpaceEnvironmentParams & QueryParams;
912 headers?: RawAxiosRequestHeaders;
913 return: CollectionProp<AssetProps>;
914 };
915 get: {
916 params: GetSpaceEnvironmentParams & {
917 assetId: string;
918 } & QueryParams;
919 headers?: RawAxiosRequestHeaders;
920 return: AssetProps;
921 };
922 update: {
923 params: GetSpaceEnvironmentParams & {
924 assetId: string;
925 };
926 payload: AssetProps;
927 headers?: RawAxiosRequestHeaders;
928 return: AssetProps;
929 };
930 delete: {
931 params: GetSpaceEnvironmentParams & {
932 assetId: string;
933 };
934 return: any;
935 };
936 publish: {
937 params: GetSpaceEnvironmentParams & {
938 assetId: string;
939 };
940 payload: AssetProps;
941 return: AssetProps;
942 };
943 unpublish: {
944 params: GetSpaceEnvironmentParams & {
945 assetId: string;
946 };
947 return: AssetProps;
948 };
949 archive: {
950 params: GetSpaceEnvironmentParams & {
951 assetId: string;
952 };
953 return: AssetProps;
954 };
955 unarchive: {
956 params: GetSpaceEnvironmentParams & {
957 assetId: string;
958 };
959 return: AssetProps;
960 };
961 create: {
962 params: GetSpaceEnvironmentParams;
963 payload: CreateAssetProps;
964 return: AssetProps;
965 };
966 createWithId: {
967 params: GetSpaceEnvironmentParams & {
968 assetId: string;
969 };
970 payload: CreateAssetProps;
971 return: AssetProps;
972 };
973 createFromFiles: {
974 params: GetSpaceEnvironmentParams & {
975 uploadTimeout?: number;
976 };
977 payload: Omit<AssetFileProp, 'sys'>;
978 return: AssetProps;
979 };
980 processForAllLocales: {
981 params: GetSpaceEnvironmentParams & {
982 asset: AssetProps;
983 options?: AssetProcessingForLocale;
984 };
985 return: AssetProps;
986 };
987 processForLocale: {
988 params: GetSpaceEnvironmentParams & {
989 asset: AssetProps;
990 locale: string;
991 options?: AssetProcessingForLocale;
992 };
993 return: AssetProps;
994 };
995 };
996 AssetKey: {
997 create: {
998 params: GetSpaceEnvironmentParams;
999 payload: CreateAssetKeyProps;
1000 return: AssetKeyProps;
1001 };
1002 };
1003 BulkAction: {
1004 get: {
1005 params: GetBulkActionParams;
1006 return: BulkActionProps;
1007 };
1008 publish: {
1009 params: GetSpaceEnvironmentParams;
1010 payload: BulkActionPublishPayload;
1011 return: BulkActionProps<BulkActionPublishPayload>;
1012 };
1013 unpublish: {
1014 params: GetSpaceEnvironmentParams;
1015 payload: BulkActionUnpublishPayload;
1016 return: BulkActionProps<BulkActionUnpublishPayload>;
1017 };
1018 validate: {
1019 params: GetSpaceEnvironmentParams;
1020 payload: BulkActionValidatePayload;
1021 return: BulkActionProps<BulkActionValidatePayload>;
1022 };
1023 };
1024 Comment: {
1025 get: {
1026 params: GetCommentParams & PlainTextBodyFormat;
1027 return: CommentProps;
1028 } | {
1029 params: GetCommentParams & RichTextBodyFormat;
1030 return: RichTextCommentProps;
1031 };
1032 getMany: {
1033 params: GetManyCommentsParams & PlainTextBodyFormat & QueryParams;
1034 return: CollectionProp<CommentProps>;
1035 } | {
1036 params: GetManyCommentsParams & QueryParams & RichTextBodyFormat;
1037 return: CollectionProp<RichTextCommentProps>;
1038 };
1039 getAll: {
1040 params: GetManyCommentsParams & QueryParams & PlainTextBodyFormat;
1041 return: CollectionProp<CommentProps>;
1042 } | {
1043 params: GetManyCommentsParams & QueryParams & RichTextBodyFormat;
1044 return: CollectionProp<RichTextCommentProps>;
1045 };
1046 create: {
1047 params: CreateCommentParams & PlainTextBodyFormat;
1048 payload: CreateCommentProps;
1049 return: CommentProps;
1050 } | {
1051 params: CreateCommentParams & RichTextBodyFormat;
1052 payload: RichTextCommentBodyPayload;
1053 return: RichTextCommentProps;
1054 };
1055 update: {
1056 params: UpdateCommentParams;
1057 payload: UpdateCommentProps;
1058 headers?: RawAxiosRequestHeaders;
1059 return: CommentProps;
1060 } | {
1061 params: UpdateCommentParams;
1062 payload: Omit<UpdateCommentProps, 'body'> & RichTextCommentBodyPayload;
1063 headers?: RawAxiosRequestHeaders;
1064 return: RichTextCommentProps;
1065 };
1066 delete: {
1067 params: DeleteCommentParams;
1068 return: void;
1069 };
1070 };
1071 Concept: {
1072 create: {
1073 params: GetOrganizationParams;
1074 payload: CreateConceptProps;
1075 return: ConceptProps;
1076 };
1077 createWithId: {
1078 params: GetConceptParams;
1079 payload: CreateConceptProps;
1080 return: ConceptProps;
1081 };
1082 patch: {
1083 params: UpdateConceptParams;
1084 payload: OpPatch[];
1085 return: ConceptProps;
1086 };
1087 update: {
1088 params: UpdateConceptParams;
1089 payload: OpPatch[];
1090 return: ConceptProps;
1091 };
1092 updatePut: {
1093 params: UpdateConceptParams;
1094 payload: CreateConceptProps;
1095 return: ConceptProps;
1096 };
1097 delete: {
1098 params: DeleteConceptParams;
1099 return: void;
1100 };
1101 get: {
1102 params: GetConceptParams;
1103 return: ConceptProps;
1104 };
1105 getMany: {
1106 params: GetManyConceptParams;
1107 return: CursorPaginatedCollectionProp<ConceptProps>;
1108 };
1109 getTotal: {
1110 params: GetOrganizationParams;
1111 return: {
1112 total: number;
1113 };
1114 };
1115 getDescendants: {
1116 params: GetConceptDescendantsParams;
1117 return: CursorPaginatedCollectionProp<ConceptProps>;
1118 };
1119 getAncestors: {
1120 params: GetConceptDescendantsParams;
1121 return: CursorPaginatedCollectionProp<ConceptProps>;
1122 };
1123 };
1124 ConceptScheme: {
1125 create: {
1126 params: GetOrganizationParams;
1127 payload: CreateConceptSchemeProps;
1128 return: ConceptSchemeProps;
1129 };
1130 createWithId: {
1131 params: GetConceptSchemeParams;
1132 payload: CreateConceptSchemeProps;
1133 return: ConceptSchemeProps;
1134 };
1135 patch: {
1136 params: UpdateConceptSchemeParams;
1137 payload: OpPatch[];
1138 return: ConceptSchemeProps;
1139 };
1140 update: {
1141 params: UpdateConceptSchemeParams;
1142 payload: OpPatch[];
1143 return: ConceptSchemeProps;
1144 };
1145 updatePut: {
1146 params: UpdateConceptSchemeParams;
1147 payload: CreateConceptSchemeProps;
1148 return: ConceptSchemeProps;
1149 };
1150 get: {
1151 params: GetConceptSchemeParams;
1152 return: ConceptSchemeProps;
1153 };
1154 getMany: {
1155 params: GetManyConceptSchemeParams;
1156 return: CursorPaginatedCollectionProp<ConceptSchemeProps>;
1157 };
1158 getTotal: {
1159 params: GetOrganizationParams;
1160 return: {
1161 total: number;
1162 };
1163 };
1164 delete: {
1165 params: DeleteConceptSchemeParams;
1166 return: void;
1167 };
1168 };
1169 ContentType: {
1170 get: {
1171 params: GetContentTypeParams & QueryParams;
1172 return: ContentTypeProps;
1173 };
1174 getMany: {
1175 params: GetSpaceEnvironmentParams & QueryParams;
1176 return: CollectionProp<ContentTypeProps>;
1177 };
1178 create: {
1179 params: GetSpaceEnvironmentParams;
1180 payload: CreateContentTypeProps;
1181 return: ContentTypeProps;
1182 };
1183 createWithId: {
1184 params: GetContentTypeParams;
1185 payload: CreateContentTypeProps;
1186 return: ContentTypeProps;
1187 };
1188 update: {
1189 params: GetContentTypeParams;
1190 payload: ContentTypeProps;
1191 headers?: RawAxiosRequestHeaders;
1192 return: ContentTypeProps;
1193 };
1194 delete: {
1195 params: GetContentTypeParams;
1196 return: any;
1197 };
1198 publish: {
1199 params: GetContentTypeParams;
1200 payload: ContentTypeProps;
1201 return: ContentTypeProps;
1202 };
1203 unpublish: {
1204 params: GetContentTypeParams;
1205 return: ContentTypeProps;
1206 };
1207 };
1208 EditorInterface: {
1209 get: {
1210 params: GetEditorInterfaceParams;
1211 return: EditorInterfaceProps;
1212 };
1213 getMany: {
1214 params: GetSpaceEnvironmentParams & QueryParams;
1215 return: CollectionProp<EditorInterfaceProps>;
1216 };
1217 update: {
1218 params: GetEditorInterfaceParams;
1219 payload: EditorInterfaceProps;
1220 headers?: RawAxiosRequestHeaders;
1221 return: EditorInterfaceProps;
1222 };
1223 };
1224 Environment: {
1225 get: {
1226 params: GetSpaceEnvironmentParams;
1227 return: EnvironmentProps;
1228 };
1229 getMany: {
1230 params: GetSpaceParams & PaginationQueryParams;
1231 return: CollectionProp<EnvironmentProps>;
1232 };
1233 create: {
1234 params: GetSpaceParams;
1235 payload: Partial<Pick<EnvironmentProps, 'name'>>;
1236 headers?: RawAxiosRequestHeaders;
1237 return: EnvironmentProps;
1238 };
1239 createWithId: {
1240 params: GetSpaceEnvironmentParams & {
1241 sourceEnvironmentId?: string;
1242 };
1243 payload: CreateEnvironmentProps;
1244 headers?: RawAxiosRequestHeaders;
1245 return: EnvironmentProps;
1246 };
1247 update: {
1248 params: GetSpaceEnvironmentParams;
1249 payload: EnvironmentProps;
1250 headers?: RawAxiosRequestHeaders;
1251 return: EnvironmentProps;
1252 };
1253 delete: {
1254 params: GetSpaceEnvironmentParams;
1255 return: any;
1256 };
1257 };
1258 EnvironmentAlias: {
1259 get: {
1260 params: GetSpaceEnvAliasParams;
1261 return: EnvironmentAliasProps;
1262 };
1263 getMany: {
1264 params: GetSpaceParams & PaginationQueryParams;
1265 return: CollectionProp<EnvironmentAliasProps>;
1266 };
1267 createWithId: {
1268 params: GetSpaceEnvAliasParams;
1269 payload: CreateEnvironmentAliasProps;
1270 headers?: RawAxiosRequestHeaders;
1271 return: EnvironmentAliasProps;
1272 };
1273 update: {
1274 params: GetSpaceEnvAliasParams;
1275 payload: EnvironmentAliasProps;
1276 headers?: RawAxiosRequestHeaders;
1277 return: EnvironmentAliasProps;
1278 };
1279 delete: {
1280 params: GetSpaceEnvAliasParams;
1281 return: any;
1282 };
1283 };
1284 EnvironmentTemplate: {
1285 get: {
1286 params: GetEnvironmentTemplateParams & {
1287 version?: number;
1288 query?: {
1289 select?: string;
1290 };
1291 };
1292 return: EnvironmentTemplateProps;
1293 };
1294 getMany: {
1295 params: GetOrganizationParams & {
1296 query?: BasicCursorPaginationOptions & {
1297 select?: string;
1298 };
1299 };
1300 return: CursorPaginatedCollectionProp<EnvironmentTemplateProps>;
1301 };
1302 create: {
1303 payload: CreateEnvironmentTemplateProps;
1304 params: GetOrganizationParams;
1305 return: EnvironmentTemplateProps;
1306 };
1307 versionUpdate: {
1308 params: GetEnvironmentTemplateParams & {
1309 version: number;
1310 };
1311 payload: {
1312 versionName: string;
1313 versionDescription: string;
1314 };
1315 return: EnvironmentTemplateProps;
1316 };
1317 update: {
1318 params: GetEnvironmentTemplateParams;
1319 payload: EnvironmentTemplateProps;
1320 return: EnvironmentTemplateProps;
1321 };
1322 delete: {
1323 params: GetEnvironmentTemplateParams;
1324 return: void;
1325 };
1326 versions: {
1327 params: GetEnvironmentTemplateParams & {
1328 query?: BasicCursorPaginationOptions & {
1329 select?: string;
1330 };
1331 };
1332 return: CursorPaginatedCollectionProp<EnvironmentTemplateProps>;
1333 };
1334 validate: {
1335 params: EnvironmentTemplateParams & {
1336 version?: number;
1337 };
1338 payload: ValidateEnvironmentTemplateInstallationProps;
1339 return: EnvironmentTemplateValidationProps;
1340 };
1341 install: {
1342 params: EnvironmentTemplateParams;
1343 payload: CreateEnvironmentTemplateInstallationProps;
1344 return: EnvironmentTemplateInstallationProps;
1345 };
1346 disconnect: {
1347 params: EnvironmentTemplateParams;
1348 return: void;
1349 };
1350 };
1351 EnvironmentTemplateInstallation: {
1352 getMany: {
1353 params: BasicCursorPaginationOptions & {
1354 environmentId?: string;
1355 environmentTemplateId: string;
1356 organizationId: string;
1357 spaceId?: string;
1358 };
1359 return: CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>;
1360 };
1361 getForEnvironment: {
1362 params: BasicCursorPaginationOptions & EnvironmentTemplateParams & {
1363 installationId?: string;
1364 };
1365 return: CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>;
1366 };
1367 };
1368 Entry: {
1369 getPublished: {
1370 params: GetSpaceEnvironmentParams & QueryParams;
1371 return: CollectionProp<EntryProps<any>>;
1372 };
1373 getMany: {
1374 params: GetSpaceEnvironmentParams & QueryParams;
1375 return: CollectionProp<EntryProps<any>>;
1376 };
1377 get: {
1378 params: GetSpaceEnvironmentParams & {
1379 entryId: string;
1380 } & QueryParams;
1381 return: EntryProps<any>;
1382 };
1383 patch: {
1384 params: GetSpaceEnvironmentParams & {
1385 entryId: string;
1386 version: number;
1387 };
1388 payload: OpPatch[];
1389 headers?: RawAxiosRequestHeaders;
1390 return: EntryProps<any>;
1391 };
1392 update: {
1393 params: GetSpaceEnvironmentParams & {
1394 entryId: string;
1395 };
1396 payload: EntryProps<any>;
1397 headers?: RawAxiosRequestHeaders;
1398 return: EntryProps<any>;
1399 };
1400 delete: {
1401 params: GetSpaceEnvironmentParams & {
1402 entryId: string;
1403 };
1404 return: any;
1405 };
1406 publish: {
1407 params: GetSpaceEnvironmentParams & {
1408 entryId: string;
1409 };
1410 payload: EntryProps<any>;
1411 return: EntryProps<any>;
1412 };
1413 unpublish: {
1414 params: GetSpaceEnvironmentParams & {
1415 entryId: string;
1416 };
1417 return: EntryProps<any>;
1418 };
1419 archive: {
1420 params: GetSpaceEnvironmentParams & {
1421 entryId: string;
1422 };
1423 return: EntryProps<any>;
1424 };
1425 unarchive: {
1426 params: GetSpaceEnvironmentParams & {
1427 entryId: string;
1428 };
1429 return: EntryProps<any>;
1430 };
1431 create: {
1432 params: GetSpaceEnvironmentParams & {
1433 contentTypeId: string;
1434 };
1435 payload: CreateEntryProps<any>;
1436 return: EntryProps<any>;
1437 };
1438 createWithId: {
1439 params: GetSpaceEnvironmentParams & {
1440 entryId: string;
1441 contentTypeId: string;
1442 };
1443 payload: CreateEntryProps<any>;
1444 return: EntryProps<any>;
1445 };
1446 references: {
1447 params: GetSpaceEnvironmentParams & {
1448 entryId: string;
1449 include?: number;
1450 };
1451 return: EntryReferenceProps;
1452 };
1453 };
1454 Extension: {
1455 get: {
1456 params: GetExtensionParams & QueryParams;
1457 return: ExtensionProps;
1458 };
1459 getMany: {
1460 params: GetSpaceEnvironmentParams & QueryParams;
1461 return: CollectionProp<ExtensionProps>;
1462 };
1463 create: {
1464 params: GetSpaceEnvironmentParams;
1465 payload: CreateExtensionProps;
1466 headers?: RawAxiosRequestHeaders;
1467 return: ExtensionProps;
1468 };
1469 createWithId: {
1470 params: GetExtensionParams;
1471 payload: CreateExtensionProps;
1472 headers?: RawAxiosRequestHeaders;
1473 return: ExtensionProps;
1474 };
1475 update: {
1476 params: GetExtensionParams;
1477 payload: ExtensionProps;
1478 headers?: RawAxiosRequestHeaders;
1479 return: ExtensionProps;
1480 };
1481 delete: {
1482 params: GetExtensionParams;
1483 return: any;
1484 };
1485 };
1486 Function: {
1487 get: {
1488 params: GetFunctionParams;
1489 return: FunctionProps;
1490 };
1491 getMany: {
1492 params: GetManyFunctionParams;
1493 return: CollectionProp<FunctionProps>;
1494 };
1495 getManyForEnvironment: {
1496 params: GetFunctionForEnvParams;
1497 return: CollectionProp<FunctionProps>;
1498 };
1499 };
1500 Locale: {
1501 get: {
1502 params: GetSpaceEnvironmentParams & {
1503 localeId: string;
1504 };
1505 return: LocaleProps;
1506 };
1507 getMany: {
1508 params: GetSpaceEnvironmentParams & QueryParams;
1509 return: CollectionProp<LocaleProps>;
1510 };
1511 delete: {
1512 params: GetSpaceEnvironmentParams & {
1513 localeId: string;
1514 };
1515 return: any;
1516 };
1517 update: {
1518 params: GetSpaceEnvironmentParams & {
1519 localeId: string;
1520 };
1521 payload: LocaleProps;
1522 headers?: RawAxiosRequestHeaders;
1523 return: LocaleProps;
1524 };
1525 create: {
1526 params: GetSpaceEnvironmentParams;
1527 payload: CreateLocaleProps;
1528 headers?: RawAxiosRequestHeaders;
1529 return: LocaleProps;
1530 };
1531 };
1532 Organization: {
1533 getMany: {
1534 params: PaginationQueryParams;
1535 return: CollectionProp<OrganizationProps>;
1536 };
1537 get: {
1538 params: GetOrganizationParams;
1539 return: OrganizationProps;
1540 };
1541 };
1542 OrganizationInvitation: {
1543 get: {
1544 params: {
1545 organizationId: string;
1546 invitationId: string;
1547 };
1548 headers?: RawAxiosRequestHeaders;
1549 return: OrganizationInvitationProps;
1550 };
1551 create: {
1552 params: {
1553 organizationId: string;
1554 };
1555 payload: CreateOrganizationInvitationProps;
1556 headers?: RawAxiosRequestHeaders;
1557 return: OrganizationInvitationProps;
1558 };
1559 };
1560 OrganizationMembership: {
1561 get: {
1562 params: GetOrganizationMembershipParams;
1563 return: OrganizationMembershipProps;
1564 };
1565 getMany: {
1566 params: GetOrganizationParams & QueryParams;
1567 return: CollectionProp<OrganizationMembershipProps>;
1568 };
1569 update: {
1570 params: GetOrganizationMembershipParams;
1571 payload: OrganizationMembershipProps;
1572 headers?: RawAxiosRequestHeaders;
1573 return: OrganizationMembershipProps;
1574 };
1575 delete: {
1576 params: GetOrganizationMembershipParams;
1577 return: any;
1578 };
1579 };
1580 PersonalAccessToken: {
1581 get: {
1582 params: {
1583 tokenId: string;
1584 };
1585 return: PersonalAccessTokenProps;
1586 };
1587 getMany: {
1588 params: QueryParams;
1589 return: CollectionProp<PersonalAccessTokenProps>;
1590 };
1591 create: {
1592 params: {};
1593 payload: CreatePersonalAccessTokenProps;
1594 headers?: RawAxiosRequestHeaders;
1595 return: PersonalAccessTokenProps;
1596 };
1597 revoke: {
1598 params: {
1599 tokenId: string;
1600 };
1601 return: PersonalAccessTokenProps;
1602 };
1603 };
1604 AccessToken: {
1605 get: {
1606 params: {
1607 tokenId: string;
1608 };
1609 return: AccessTokenProps;
1610 };
1611 getMany: {
1612 params: QueryParams;
1613 return: CollectionProp<AccessTokenProps>;
1614 };
1615 createPersonalAccessToken: {
1616 params: {};
1617 payload: CreatePATProps;
1618 headers?: RawAxiosRequestHeaders;
1619 return: AccessTokenProps;
1620 };
1621 revoke: {
1622 params: {
1623 tokenId: string;
1624 };
1625 return: AccessTokenProps;
1626 };
1627 getManyForOrganization: {
1628 params: GetOrganizationParams & QueryParams;
1629 return: CollectionProp<AccessTokenProps>;
1630 };
1631 };
1632 PreviewApiKey: {
1633 get: {
1634 params: GetSpaceParams & {
1635 previewApiKeyId: string;
1636 };
1637 return: PreviewApiKeyProps;
1638 };
1639 getMany: {
1640 params: GetSpaceParams & QueryParams;
1641 return: CollectionProp<PreviewApiKeyProps>;
1642 };
1643 };
1644 Release: {
1645 archive: {
1646 params: GetReleaseParams & {
1647 version: number;
1648 };
1649 return: ReleaseProps;
1650 };
1651 get: {
1652 params: GetReleaseParams;
1653 return: ReleaseProps;
1654 };
1655 query: {
1656 params: GetSpaceEnvironmentParams & {
1657 query?: ReleaseQueryOptions;
1658 };
1659 return: CollectionProp<ReleaseProps>;
1660 };
1661 create: {
1662 params: GetSpaceEnvironmentParams;
1663 payload: ReleasePayload;
1664 return: ReleaseProps;
1665 };
1666 update: {
1667 params: GetReleaseParams & {
1668 version: number;
1669 };
1670 payload: ReleasePayload;
1671 return: ReleaseProps;
1672 };
1673 delete: {
1674 params: GetReleaseParams;
1675 return: void;
1676 };
1677 publish: {
1678 params: GetReleaseParams & {
1679 version: number;
1680 };
1681 return: ReleaseActionProps<'publish'>;
1682 };
1683 unarchive: {
1684 params: GetReleaseParams & {
1685 version: number;
1686 };
1687 return: ReleaseProps;
1688 };
1689 unpublish: {
1690 params: GetReleaseParams & {
1691 version: number;
1692 };
1693 return: ReleaseActionProps<'unpublish'>;
1694 };
1695 validate: {
1696 params: GetReleaseParams;
1697 payload?: ReleaseValidatePayload;
1698 return: ReleaseActionProps<'validate'>;
1699 };
1700 };
1701 ReleaseAction: {
1702 get: {
1703 params: GetReleaseParams & {
1704 actionId: string;
1705 };
1706 return: ReleaseAction;
1707 };
1708 getMany: {
1709 params: GetSpaceEnvironmentParams & {
1710 query?: ReleaseActionQueryOptions;
1711 };
1712 return: Collection<ReleaseAction, ReleaseActionProps>;
1713 };
1714 queryForRelease: {
1715 params: GetReleaseParams & {
1716 query?: ReleaseActionQueryOptions;
1717 };
1718 return: Collection<ReleaseAction, ReleaseActionProps>;
1719 };
1720 };
1721 Role: {
1722 get: {
1723 params: GetSpaceParams & {
1724 roleId: string;
1725 };
1726 return: RoleProps;
1727 };
1728 getMany: {
1729 params: GetSpaceParams & QueryParams;
1730 return: CollectionProp<RoleProps>;
1731 };
1732 getManyForOrganization: {
1733 params: GetOrganizationParams & QueryParams;
1734 return: CollectionProp<RoleProps>;
1735 };
1736 create: {
1737 params: GetSpaceParams;
1738 payload: CreateRoleProps;
1739 headers?: RawAxiosRequestHeaders;
1740 return: RoleProps;
1741 };
1742 createWithId: {
1743 params: GetSpaceParams & {
1744 roleId: string;
1745 };
1746 payload: CreateRoleProps;
1747 headers?: RawAxiosRequestHeaders;
1748 return: RoleProps;
1749 };
1750 update: {
1751 params: GetSpaceParams & {
1752 roleId: string;
1753 };
1754 payload: RoleProps;
1755 headers?: RawAxiosRequestHeaders;
1756 return: RoleProps;
1757 };
1758 delete: {
1759 params: GetSpaceParams & {
1760 roleId: string;
1761 };
1762 return: any;
1763 };
1764 };
1765 ScheduledAction: {
1766 get: {
1767 params: GetSpaceParams & {
1768 scheduledActionId: string;
1769 environmentId: string;
1770 };
1771 return: ScheduledActionProps;
1772 };
1773 getMany: {
1774 params: GetSpaceParams & QueryParams;
1775 return: CollectionProp<ScheduledActionProps>;
1776 };
1777 create: {
1778 params: GetSpaceParams;
1779 payload: Omit<ScheduledActionProps, 'sys'>;
1780 return: ScheduledActionProps;
1781 };
1782 update: {
1783 params: GetSpaceParams & {
1784 scheduledActionId: string;
1785 version: number;
1786 };
1787 payload: Omit<ScheduledActionProps, 'sys'>;
1788 return: ScheduledActionProps;
1789 };
1790 delete: {
1791 params: GetSpaceEnvironmentParams & {
1792 scheduledActionId: string;
1793 };
1794 return: any;
1795 };
1796 };
1797 Snapshot: {
1798 getManyForEntry: {
1799 params: GetSnapshotForEntryParams & QueryParams;
1800 return: CollectionProp<SnapshotProps<Omit<EntryProps<any>, 'metadata'>>>;
1801 };
1802 getForEntry: {
1803 params: GetSnapshotForEntryParams & {
1804 snapshotId: string;
1805 };
1806 return: SnapshotProps<Omit<EntryProps<any>, 'metadata'>>;
1807 };
1808 getManyForContentType: {
1809 params: GetSnapshotForContentTypeParams & QueryParams;
1810 return: CollectionProp<SnapshotProps<ContentTypeProps>>;
1811 };
1812 getForContentType: {
1813 params: GetSnapshotForContentTypeParams & {
1814 snapshotId: string;
1815 };
1816 return: SnapshotProps<ContentTypeProps>;
1817 };
1818 };
1819 Space: {
1820 get: {
1821 params: GetSpaceParams;
1822 return: SpaceProps;
1823 };
1824 getMany: {
1825 params: QueryParams;
1826 return: CollectionProp<SpaceProps>;
1827 };
1828 getManyForOrganization: {
1829 params: GetOrganizationParams & QueryParams;
1830 return: CollectionProp<SpaceProps>;
1831 };
1832 create: {
1833 params: {
1834 organizationId?: string;
1835 };
1836 payload: Omit<SpaceProps, 'sys'>;
1837 headers?: RawAxiosRequestHeaders;
1838 return: any;
1839 };
1840 update: {
1841 params: GetSpaceParams;
1842 payload: SpaceProps;
1843 headers?: RawAxiosRequestHeaders;
1844 return: SpaceProps;
1845 };
1846 delete: {
1847 params: GetSpaceParams;
1848 return: void;
1849 };
1850 };
1851 SpaceMember: {
1852 get: {
1853 params: GetSpaceParams & {
1854 spaceMemberId: string;
1855 };
1856 return: SpaceMemberProps;
1857 };
1858 getMany: {
1859 params: GetSpaceParams & QueryParams;
1860 return: CollectionProp<SpaceMemberProps>;
1861 };
1862 };
1863 SpaceMembership: {
1864 get: {
1865 params: GetSpaceMembershipProps;
1866 return: SpaceMembershipProps;
1867 };
1868 getMany: {
1869 params: GetSpaceParams & QueryParams;
1870 return: CollectionProp<SpaceMembershipProps>;
1871 };
1872 getForOrganization: {
1873 params: GetOrganizationParams & {
1874 spaceMembershipId: string;
1875 };
1876 return: SpaceMembershipProps;
1877 };
1878 getManyForOrganization: {
1879 params: GetOrganizationParams & QueryParams;
1880 return: CollectionProp<SpaceMembershipProps>;
1881 };
1882 create: {
1883 params: GetSpaceParams;
1884 payload: CreateSpaceMembershipProps;
1885 headers?: RawAxiosRequestHeaders;
1886 return: SpaceMembershipProps;
1887 };
1888 createWithId: {
1889 params: GetSpaceMembershipProps;
1890 payload: CreateSpaceMembershipProps;
1891 headers?: RawAxiosRequestHeaders;
1892 return: SpaceMembershipProps;
1893 };
1894 update: {
1895 params: GetSpaceMembershipProps;
1896 payload: SpaceMembershipProps;
1897 headers?: RawAxiosRequestHeaders;
1898 return: SpaceMembershipProps;
1899 };
1900 delete: {
1901 params: GetSpaceMembershipProps;
1902 return: any;
1903 };
1904 };
1905 Tag: {
1906 get: {
1907 params: GetTagParams;
1908 return: TagProps;
1909 };
1910 getMany: {
1911 params: GetSpaceEnvironmentParams & QueryParams;
1912 return: CollectionProp<TagProps>;
1913 };
1914 createWithId: {
1915 params: GetTagParams;
1916 payload: CreateTagProps;
1917 return: TagProps;
1918 };
1919 update: {
1920 params: GetTagParams;
1921 payload: UpdateTagProps;
1922 headers?: RawAxiosRequestHeaders;
1923 return: TagProps;
1924 };
1925 delete: {
1926 params: DeleteTagParams;
1927 return: any;
1928 };
1929 };
1930 Task: {
1931 get: {
1932 params: GetTaskParams;
1933 return: TaskProps;
1934 };
1935 getMany: {
1936 params: GetEntryParams & QueryParams;
1937 return: CollectionProp<TaskProps>;
1938 };
1939 getAll: {
1940 params: GetEntryParams & QueryParams;
1941 return: CollectionProp<TaskProps>;
1942 };
1943 create: {
1944 params: CreateTaskParams;
1945 payload: CreateTaskProps;
1946 return: TaskProps;
1947 };
1948 update: {
1949 params: UpdateTaskParams;
1950 payload: UpdateTaskProps;
1951 headers?: RawAxiosRequestHeaders;
1952 return: TaskProps;
1953 };
1954 delete: {
1955 params: DeleteTaskParams;
1956 return: void;
1957 };
1958 };
1959 Team: {
1960 get: {
1961 params: GetTeamParams;
1962 return: TeamProps;
1963 };
1964 getMany: {
1965 params: GetOrganizationParams & QueryParams;
1966 return: CollectionProp<TeamProps>;
1967 };
1968 getManyForSpace: {
1969 params: GetSpaceParams & QueryParams;
1970 return: CollectionProp<TeamProps>;
1971 };
1972 create: {
1973 params: GetOrganizationParams;
1974 payload: CreateTeamProps;
1975 headers?: RawAxiosRequestHeaders;
1976 return: any;
1977 };
1978 update: {
1979 params: GetTeamParams;
1980 payload: TeamProps;
1981 headers?: RawAxiosRequestHeaders;
1982 return: TeamProps;
1983 };
1984 delete: {
1985 params: GetTeamParams;
1986 return: any;
1987 };
1988 };
1989 TeamMembership: {
1990 get: {
1991 params: GetTeamMembershipParams;
1992 return: TeamMembershipProps;
1993 };
1994 getManyForOrganization: {
1995 params: GetOrganizationParams & QueryParams;
1996 return: CollectionProp<TeamMembershipProps>;
1997 };
1998 getManyForTeam: {
1999 params: GetTeamParams & QueryParams;
2000 return: CollectionProp<TeamMembershipProps>;
2001 };
2002 create: {
2003 params: GetTeamParams;
2004 payload: CreateTeamMembershipProps;
2005 headers?: RawAxiosRequestHeaders;
2006 return: TeamMembershipProps;
2007 };
2008 update: {
2009 params: GetTeamMembershipParams;
2010 payload: TeamMembershipProps;
2011 headers?: RawAxiosRequestHeaders;
2012 return: TeamMembershipProps;
2013 };
2014 delete: {
2015 params: GetTeamMembershipParams;
2016 return: any;
2017 };
2018 };
2019 TeamSpaceMembership: {
2020 get: {
2021 params: GetTeamSpaceMembershipParams;
2022 return: TeamSpaceMembershipProps;
2023 };
2024 getMany: {
2025 params: GetSpaceParams & QueryParams;
2026 return: CollectionProp<TeamSpaceMembershipProps>;
2027 };
2028 getForOrganization: {
2029 params: GetOrganizationParams & {
2030 teamSpaceMembershipId: string;
2031 };
2032 return: TeamSpaceMembershipProps;
2033 };
2034 getManyForOrganization: {
2035 params: GetOrganizationParams & QueryParams & {
2036 teamId?: string;
2037 };
2038 return: CollectionProp<TeamSpaceMembershipProps>;
2039 };
2040 create: {
2041 params: GetSpaceParams & {
2042 teamId: string;
2043 };
2044 payload: CreateTeamSpaceMembershipProps;
2045 headers?: RawAxiosRequestHeaders;
2046 return: TeamSpaceMembershipProps;
2047 };
2048 update: {
2049 params: GetTeamSpaceMembershipParams;
2050 payload: TeamSpaceMembershipProps;
2051 headers?: RawAxiosRequestHeaders;
2052 return: TeamSpaceMembershipProps;
2053 };
2054 delete: {
2055 params: GetTeamSpaceMembershipParams;
2056 return: any;
2057 };
2058 };
2059 UIConfig: {
2060 get: {
2061 params: GetUIConfigParams;
2062 return: UIConfigProps;
2063 };
2064 update: {
2065 params: GetUIConfigParams;
2066 payload: UIConfigProps;
2067 return: UIConfigProps;
2068 };
2069 };
2070 Upload: {
2071 get: {
2072 params: GetSpaceEnvironmentUploadParams;
2073 return: any;
2074 };
2075 create: {
2076 params: GetSpaceEnvironmentParams;
2077 payload: {
2078 file: string | ArrayBuffer | Stream;
2079 };
2080 return: any;
2081 };
2082 delete: {
2083 params: GetSpaceEnvironmentUploadParams;
2084 return: any;
2085 };
2086 };
2087 UploadCredential: {
2088 create: {
2089 params: GetSpaceEnvironmentParams;
2090 return: any;
2091 };
2092 };
2093 Usage: {
2094 getManyForSpace: {
2095 params: {
2096 organizationId: string;
2097 } & QueryParams;
2098 return: CollectionProp<UsageProps>;
2099 };
2100 getManyForOrganization: {
2101 params: {
2102 organizationId: string;
2103 } & QueryParams;
2104 return: CollectionProp<UsageProps>;
2105 };
2106 };
2107 User: {
2108 getManyForSpace: {
2109 params: GetSpaceParams & QueryParams;
2110 return: CollectionProp<UserProps>;
2111 };
2112 getForSpace: {
2113 params: GetSpaceParams & {
2114 userId: string;
2115 };
2116 return: UserProps;
2117 };
2118 getCurrent: {
2119 params?: QueryParams;
2120 return: any;
2121 };
2122 getForOrganization: {
2123 params: GetOrganizationParams & {
2124 userId: string;
2125 };
2126 return: UserProps;
2127 };
2128 getManyForOrganization: {
2129 params: GetOrganizationParams & QueryParams;
2130 return: CollectionProp<UserProps>;
2131 };
2132 };
2133 UserUIConfig: {
2134 get: {
2135 params: GetUserUIConfigParams;
2136 return: UserUIConfigProps;
2137 };
2138 update: {
2139 params: GetUserUIConfigParams;
2140 payload: UserUIConfigProps;
2141 return: UserUIConfigProps;
2142 };
2143 };
2144 Webhook: {
2145 get: {
2146 params: GetWebhookParams;
2147 return: WebhookProps;
2148 };
2149 getMany: {
2150 params: GetSpaceParams & QueryParams;
2151 return: CollectionProp<WebhookProps>;
2152 };
2153 getCallDetails: {
2154 params: GetWebhookCallDetailsUrl;
2155 return: WebhookCallDetailsProps;
2156 };
2157 getHealthStatus: {
2158 params: GetWebhookParams;
2159 return: WebhookHealthProps;
2160 };
2161 getManyCallDetails: {
2162 params: GetWebhookParams & QueryParams;
2163 return: CollectionProp<WebhookCallOverviewProps>;
2164 };
2165 getSigningSecret: {
2166 params: GetSpaceParams;
2167 return: WebhookSigningSecretProps;
2168 };
2169 getRetryPolicy: {
2170 params: GetSpaceParams;
2171 return: WebhookRetryPolicyProps;
2172 };
2173 create: {
2174 params: GetSpaceParams;
2175 payload: CreateWebhooksProps;
2176 headers?: RawAxiosRequestHeaders;
2177 return: WebhookProps;
2178 };
2179 createWithId: {
2180 params: GetWebhookParams;
2181 payload: CreateWebhooksProps;
2182 headers?: RawAxiosRequestHeaders;
2183 return: WebhookProps;
2184 };
2185 update: {
2186 params: GetWebhookParams;
2187 payload: WebhookProps;
2188 return: WebhookProps;
2189 };
2190 upsertSigningSecret: {
2191 params: GetSpaceParams;
2192 payload: UpsertWebhookSigningSecretPayload;
2193 return: WebhookSigningSecretProps;
2194 };
2195 upsertRetryPolicy: {
2196 params: GetSpaceParams;
2197 payload: WebhookRetryPolicyPayload;
2198 return: WebhookRetryPolicyProps;
2199 };
2200 delete: {
2201 params: GetWebhookParams;
2202 return: void;
2203 };
2204 deleteSigningSecret: {
2205 params: GetSpaceParams;
2206 return: void;
2207 };
2208 deleteRetryPolicy: {
2209 params: GetSpaceParams;
2210 return: void;
2211 };
2212 };
2213 WorkflowDefinition: {
2214 get: {
2215 params: GetWorkflowDefinitionParams;
2216 headers?: RawAxiosRequestHeaders;
2217 return: WorkflowDefinitionProps;
2218 };
2219 getMany: {
2220 params: GetSpaceEnvironmentParams & {
2221 query?: WorkflowDefinitionQueryOptions;
2222 };
2223 headers?: RawAxiosRequestHeaders;
2224 return: CollectionProp<WorkflowDefinitionProps>;
2225 };
2226 create: {
2227 params: CreateWorkflowDefinitionParams;
2228 payload: CreateWorkflowDefinitionProps;
2229 headers?: RawAxiosRequestHeaders;
2230 return: WorkflowDefinitionProps;
2231 };
2232 update: {
2233 params: GetWorkflowDefinitionParams;
2234 payload: WorkflowDefinitionProps;
2235 headers?: RawAxiosRequestHeaders;
2236 return: WorkflowDefinitionProps;
2237 };
2238 delete: {
2239 params: DeleteWorkflowDefinitionParams;
2240 headers?: RawAxiosRequestHeaders;
2241 return: void;
2242 };
2243 };
2244 Workflow: {
2245 get: {
2246 params: GetWorkflowParams;
2247 headers?: RawAxiosRequestHeaders;
2248 return: WorkflowProps;
2249 };
2250 getMany: {
2251 params: GetSpaceEnvironmentParams & {
2252 query?: WorkflowQueryOptions;
2253 };
2254 headers?: RawAxiosRequestHeaders;
2255 return: CollectionProp<WorkflowProps>;
2256 };
2257 create: {
2258 params: CreateWorkflowParams;
2259 payload: CreateWorkflowProps;
2260 headers?: RawAxiosRequestHeaders;
2261 return: WorkflowProps;
2262 };
2263 update: {
2264 params: GetWorkflowParams;
2265 payload: WorkflowProps;
2266 headers?: RawAxiosRequestHeaders;
2267 return: WorkflowProps;
2268 };
2269 delete: {
2270 params: DeleteWorkflowParams;
2271 headers?: RawAxiosRequestHeaders;
2272 return: void;
2273 };
2274 complete: {
2275 params: CompleteWorkflowParams;
2276 headers?: RawAxiosRequestHeaders;
2277 return: void;
2278 };
2279 };
2280 WorkflowsChangelog: {
2281 getMany: {
2282 params: GetSpaceEnvironmentParams & {
2283 query: WorkflowsChangelogQueryOptions;
2284 };
2285 headers?: RawAxiosRequestHeaders;
2286 return: CollectionProp<WorkflowsChangelogEntryProps>;
2287 };
2288 };
2289};
2290/**
2291 * @private
2292 */
2293export type MROpts<ET extends keyof MRActions, Action extends keyof MRActions[ET], UA extends boolean = false> = {
2294 entityType: ET;
2295 action: Action;
2296} & (UA extends true ? {
2297 userAgent: string;
2298} : {}) & ('params' extends keyof MRActions[ET][Action] ? undefined extends MRActions[ET][Action]['params'] ? {
2299 params?: MRActions[ET][Action]['params'];
2300} : {
2301 params: MRActions[ET][Action]['params'];
2302} : {}) & ('payload' extends keyof MRActions[ET][Action] ? undefined extends MRActions[ET][Action]['payload'] ? {
2303 payload?: MRActions[ET][Action]['payload'];
2304} : {
2305 payload: MRActions[ET][Action]['payload'];
2306} : {}) & ('headers' extends keyof MRActions[ET][Action] ? undefined extends MRActions[ET][Action]['headers'] ? {
2307 headers?: MRActions[ET][Action]['headers'];
2308} : {
2309 headers: MRActions[ET][Action]['headers'];
2310} : {});
2311/**
2312 * @private
2313 */
2314export type MRReturn<ET extends keyof MRActions, Action extends keyof MRActions[ET]> = 'return' extends keyof MRActions[ET][Action] ? Promise<MRActions[ET][Action]['return']> : never;
2315/** Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions. */
2316export interface MakeRequestPayload {
2317}
2318export interface MakeRequestOptions {
2319 entityType: keyof MRActions;
2320 action: string;
2321 params?: Record<string, unknown>;
2322 payload?: Record<string, unknown> | OpPatch[] | MakeRequestPayload;
2323 headers?: RawAxiosRequestHeaders;
2324 userAgent: string;
2325}
2326export type EnvironmentTemplateParams = {
2327 spaceId: string;
2328 environmentId: string;
2329 environmentTemplateId: string;
2330};
2331export type GetAppActionParams = GetAppDefinitionParams & {
2332 appActionId: string;
2333};
2334export type GetAppActionsForEnvParams = GetSpaceParams & {
2335 environmentId?: string;
2336};
2337export type GetAppActionCallParams = GetAppInstallationParams & {
2338 appActionId: string;
2339};
2340export type CreateWithResponseParams = GetAppActionCallParams & {
2341 retries?: number;
2342 retryInterval?: number;
2343};
2344export type GetAppActionCallDetailsParams = GetSpaceEnvironmentParams & {
2345 appActionId: string;
2346 callId: string;
2347};
2348export type GetAppBundleParams = GetAppDefinitionParams & {
2349 appBundleId: string;
2350};
2351export type GetAppDefinitionParams = GetOrganizationParams & {
2352 appDefinitionId: string;
2353};
2354export type GetAppInstallationsForOrgParams = GetOrganizationParams & {
2355 appDefinitionId: string;
2356};
2357export type GetAppInstallationParams = GetSpaceEnvironmentParams & {
2358 appDefinitionId: string;
2359};
2360export type GetBulkActionParams = GetSpaceEnvironmentParams & {
2361 bulkActionId: string;
2362};
2363export type GetCommentParams = (GetEntryParams | GetCommentParentEntityParams) & {
2364 commentId: string;
2365};
2366export type GetContentTypeParams = GetSpaceEnvironmentParams & {
2367 contentTypeId: string;
2368};
2369export type GetEditorInterfaceParams = GetSpaceEnvironmentParams & {
2370 contentTypeId: string;
2371};
2372export type GetEntryParams = GetSpaceEnvironmentParams & {
2373 entryId: string;
2374};
2375export type GetExtensionParams = GetSpaceEnvironmentParams & {
2376 extensionId: string;
2377};
2378export type GetEnvironmentTemplateParams = GetOrganizationParams & {
2379 environmentTemplateId: string;
2380};
2381export type GetFunctionParams = GetAppDefinitionParams & {
2382 functionId: string;
2383};
2384export type GetManyFunctionParams = GetAppDefinitionParams;
2385export type GetFunctionForEnvParams = GetSpaceEnvironmentParams & {
2386 appInstallationId: string;
2387};
2388export type GetOrganizationParams = {
2389 organizationId: string;
2390};
2391export type GetReleaseParams = GetSpaceEnvironmentParams & {
2392 releaseId: string;
2393};
2394export type GetSnapshotForContentTypeParams = GetSpaceEnvironmentParams & {
2395 contentTypeId: string;
2396};
2397export type GetSnapshotForEntryParams = GetSpaceEnvironmentParams & {
2398 entryId: string;
2399};
2400export type GetSpaceEnvAliasParams = GetSpaceParams & {
2401 environmentAliasId: string;
2402};
2403export type GetSpaceEnvironmentParams = {
2404 spaceId: string;
2405 environmentId: string;
2406};
2407export type GetSpaceEnvironmentUploadParams = GetSpaceEnvironmentParams & {
2408 uploadId: string;
2409};
2410export type GetSpaceMembershipProps = GetSpaceParams & {
2411 spaceMembershipId: string;
2412};
2413export type GetSpaceParams = {
2414 spaceId: string;
2415};
2416export type GetTagParams = GetSpaceEnvironmentParams & {
2417 tagId: string;
2418};
2419export type GetTaskParams = GetEntryParams & {
2420 taskId: string;
2421};
2422export type GetTeamMembershipParams = GetTeamParams & {
2423 teamMembershipId: string;
2424};
2425export type GetTeamParams = {
2426 organizationId: string;
2427 teamId: string;
2428};
2429export type GetTeamSpaceMembershipParams = GetSpaceParams & {
2430 teamSpaceMembershipId: string;
2431};
2432export type GetWebhookCallDetailsUrl = GetWebhookParams & {
2433 callId: string;
2434};
2435export type GetWebhookParams = GetSpaceParams & {
2436 webhookDefinitionId: string;
2437};
2438export type GetOrganizationMembershipParams = GetOrganizationParams & {
2439 organizationMembershipId: string;
2440};
2441export type GetConceptParams = GetOrganizationParams & {
2442 conceptId: string;
2443};
2444export type UpdateConceptParams = GetOrganizationParams & {
2445 conceptId: string;
2446 version: number;
2447};
2448export type DeleteConceptParams = GetOrganizationParams & {
2449 conceptId: string;
2450 version: number;
2451};
2452export type GetConceptDescendantsParams = GetOrganizationParams & {
2453 conceptId: string;
2454} & {
2455 query?: {
2456 depth?: number;
2457 pageUrl?: string;
2458 };
2459};
2460export type GetManyConceptParams = GetOrganizationParams & {
2461 query?: {
2462 pageUrl?: string;
2463 } | ({
2464 conceptScheme?: string;
2465 query?: string;
2466 } & BasicCursorPaginationOptions & Omit<PaginationQueryOptions, 'skip'>);
2467};
2468export type GetConceptSchemeParams = GetOrganizationParams & {
2469 conceptSchemeId: string;
2470};
2471export type GetManyConceptSchemeParams = GetOrganizationParams & {
2472 query?: {
2473 pageUrl?: string;
2474 } | ({
2475 query?: string;
2476 } & BasicCursorPaginationOptions & Omit<PaginationQueryOptions, 'skip'>);
2477};
2478export type DeleteConceptSchemeParams = GetOrganizationParams & {
2479 conceptSchemeId: string;
2480 version: number;
2481};
2482export type UpdateConceptSchemeParams = GetOrganizationParams & {
2483 conceptSchemeId: string;
2484 version: number;
2485};
2486export type GetAppKeyParams = GetAppDefinitionParams & {
2487 fingerprint: string;
2488};
2489export type GetAppUploadParams = GetOrganizationParams & {
2490 appUploadId: string;
2491};
2492export type GetWorkflowDefinitionParams = GetSpaceEnvironmentParams & {
2493 workflowDefinitionId: string;
2494};
2495export type GetWorkflowParams = GetSpaceEnvironmentParams & {
2496 workflowId: string;
2497};
2498export type GetUIConfigParams = GetSpaceEnvironmentParams;
2499export type GetUserUIConfigParams = GetUIConfigParams;
2500export type GetResourceProviderParams = GetOrganizationParams & {
2501 appDefinitionId: string;
2502};
2503export type GetResourceTypeParams = GetResourceProviderParams & {
2504 resourceTypeId: string;
2505};
2506export type GetResourceParams = GetSpaceEnvironmentParams & {
2507 resourceTypeId: string;
2508};
2509export type QueryParams = {
2510 query?: QueryOptions;
2511};
2512export type SpaceQueryParams = {
2513 query?: SpaceQueryOptions;
2514};
2515export type PaginationQueryParams = {
2516 query?: PaginationQueryOptions;
2517};
2518export declare enum ScheduledActionReferenceFilters {
2519 contentTypeAnnotationNotIn = "sys.contentType.metadata.annotations.ContentType[nin]"
2520}
2521export {};