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