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