1 | import type { RawAxiosRequestConfig, RawAxiosRequestHeaders } from 'axios';
|
2 | import type { OpPatch } from 'json-patch';
|
3 | import type { BasicCursorPaginationOptions, CollectionProp, CursorPaginatedCollectionProp, EnvironmentTemplateParams, GetBulkActionParams, GetContentTypeParams, GetEnvironmentTemplateParams, GetOrganizationMembershipParams, GetOrganizationParams, GetReleaseParams, GetSnapshotForContentTypeParams, GetSnapshotForEntryParams, GetSpaceEnvironmentParams, GetSpaceParams, KeyValueMap, QueryParams } from '../common-types';
|
4 | import type { AccessTokenProps, CreatePersonalAccessTokenProps as CreatePATProps } from '../entities/access-token';
|
5 | import type { ApiKeyProps, CreateApiKeyProps } from '../entities/api-key';
|
6 | import type { AssetFileProp, AssetProcessingForLocale, AssetProps, CreateAssetProps } from '../entities/asset';
|
7 | import type { AssetKeyProps, CreateAssetKeyProps } from '../entities/asset-key';
|
8 | import type { BulkActionPayload, BulkActionProps, BulkActionPublishPayload, BulkActionUnpublishPayload, BulkActionValidatePayload } from '../entities/bulk-action';
|
9 | import type { ContentTypeProps, CreateContentTypeProps } from '../entities/content-type';
|
10 | import type { CreateEntryProps, EntryProps, EntryReferenceProps } from '../entities/entry';
|
11 | import type { CreateEnvironmentTemplateProps, EnvironmentTemplateProps } from '../entities/environment-template';
|
12 | import type { CreateEnvironmentTemplateInstallationProps, EnvironmentTemplateInstallationProps, EnvironmentTemplateValidationProps, ValidateEnvironmentTemplateInstallationProps } from '../entities/environment-template-installation';
|
13 | import type { CreateOrganizationInvitationProps, OrganizationInvitationProps } from '../entities/organization-invitation';
|
14 | import type { OrganizationMembershipProps } from '../entities/organization-membership';
|
15 | import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProps } from '../entities/personal-access-token';
|
16 | import type { PreviewApiKeyProps } from '../entities/preview-api-key';
|
17 | import type { ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from '../entities/release';
|
18 | import type { ReleaseActionProps, ReleaseActionQueryOptions } from '../entities/release-action';
|
19 | import type { CreateUpdateScheduledActionProps, ScheduledActionProps } from '../entities/scheduled-action';
|
20 | import type { SnapshotProps } from '../entities/snapshot';
|
21 | import type { AppAccessTokenPlainClientAPI } from './entities/app-access-token';
|
22 | import type { AppActionPlainClientAPI } from './entities/app-action';
|
23 | import type { AppActionCallPlainClientAPI } from './entities/app-action-call';
|
24 | import type { AppBundlePlainClientAPI } from './entities/app-bundle';
|
25 | import type { AppDefinitionPlainClientAPI } from './entities/app-definition';
|
26 | import type { AppDetailsPlainClientAPI } from './entities/app-details';
|
27 | import type { AppEventSubscriptionPlainClientAPI } from './entities/app-event-subscription';
|
28 | import type { AppInstallationPlainClientAPI } from './entities/app-installation';
|
29 | import type { AppKeyPlainClientAPI } from './entities/app-key';
|
30 | import type { AppSignedRequestPlainClientAPI } from './entities/app-signed-request';
|
31 | import type { AppSigningSecretPlainClientAPI } from './entities/app-signing-secret';
|
32 | import type { AppUploadPlainClientAPI } from './entities/app-upload';
|
33 | import type { CommentPlainClientAPI } from './entities/comment';
|
34 | import type { ConceptPlainClientAPI } from './entities/concept';
|
35 | import type { ConceptSchemePlainClientAPI } from './entities/concept-scheme';
|
36 | import type { EditorInterfacePlainClientAPI } from './entities/editor-interface';
|
37 | import type { EnvironmentPlainClientAPI } from './entities/environment';
|
38 | import type { EnvironmentAliasPlainClientAPI } from './entities/environment-alias';
|
39 | import type { ExtensionPlainClientAPI } from './entities/extension';
|
40 | import type { FunctionPlainClientAPI } from './entities/function';
|
41 | import type { LocalePlainClientAPI } from './entities/locale';
|
42 | import type { OrganizationPlainClientAPI } from './entities/organization';
|
43 | import type { ResourcePlainAPI } from './entities/resource';
|
44 | import type { ResourceProviderPlainClientAPI } from './entities/resource-provider';
|
45 | import type { ResourceTypePlainClientAPI } from './entities/resource-type';
|
46 | import type { RolePlainClientAPI } from './entities/role';
|
47 | import type { SpacePlainClientAPI } from './entities/space';
|
48 | import type { SpaceMemberPlainClientAPI } from './entities/space-member';
|
49 | import type { SpaceMembershipPlainClientAPI } from './entities/space-membership';
|
50 | import type { TagPlainClientAPI } from './entities/tag';
|
51 | import type { TaskPlainClientAPI } from './entities/task';
|
52 | import type { TeamPlainClientAPI } from './entities/team';
|
53 | import type { TeamMembershipPlainClientAPI } from './entities/team-membership';
|
54 | import type { TeamSpaceMembershipPlainClientAPI } from './entities/team-space-membership';
|
55 | import type { UIConfigPlainClientAPI } from './entities/ui-config';
|
56 | import type { UploadPlainClientAPI } from './entities/upload';
|
57 | import type { UploadCredentialAPI } from './entities/upload-credential';
|
58 | import type { UsagePlainClientAPI } from './entities/usage';
|
59 | import type { UserPlainClientAPI } from './entities/user';
|
60 | import type { UserUIConfigPlainClientAPI } from './entities/user-ui-config';
|
61 | import type { WebhookPlainClientAPI } from './entities/webhook';
|
62 | import type { WorkflowPlainClientAPI } from './entities/workflow';
|
63 | import type { WorkflowDefinitionPlainClientAPI } from './entities/workflow-definition';
|
64 | import type { WorkflowsChangelogPlainClientAPI } from './entities/workflows-changelog';
|
65 | import type { DefaultParams, OptionalDefaults } from './wrappers/wrap';
|
66 | export type PlainClientAPI = {
|
67 | raw: {
|
68 | getDefaultParams(): DefaultParams | undefined;
|
69 | get<T = unknown>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
|
70 | post<T = unknown>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
|
71 | patch<T = unknown>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
|
72 | put<T = unknown>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
|
73 | delete<T = unknown>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
|
74 | http<T = unknown>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
|
75 | };
|
76 | appAction: AppActionPlainClientAPI;
|
77 | appActionCall: AppActionCallPlainClientAPI;
|
78 | appBundle: AppBundlePlainClientAPI;
|
79 | appDetails: AppDetailsPlainClientAPI;
|
80 | appEventSubscription: AppEventSubscriptionPlainClientAPI;
|
81 | appKey: AppKeyPlainClientAPI;
|
82 | appSignedRequest: AppSignedRequestPlainClientAPI;
|
83 | appSigningSecret: AppSigningSecretPlainClientAPI;
|
84 | appAccessToken: AppAccessTokenPlainClientAPI;
|
85 | function: FunctionPlainClientAPI;
|
86 | editorInterface: EditorInterfacePlainClientAPI;
|
87 | space: SpacePlainClientAPI;
|
88 | environment: EnvironmentPlainClientAPI;
|
89 | environmentAlias: EnvironmentAliasPlainClientAPI;
|
90 | environmentTemplate: {
|
91 | get(params: GetEnvironmentTemplateParams & {
|
92 | version?: number;
|
93 | query?: {
|
94 | select?: string;
|
95 | };
|
96 | }, headers?: RawAxiosRequestHeaders): Promise<EnvironmentTemplateProps>;
|
97 | getMany(params: GetOrganizationParams & {
|
98 | query?: BasicCursorPaginationOptions & {
|
99 | select?: string;
|
100 | };
|
101 | }, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
|
102 | create(params: GetOrganizationParams, rawData: CreateEnvironmentTemplateProps, headers?: RawAxiosRequestHeaders): Promise<EnvironmentTemplateProps>;
|
103 | versionUpdate(params: GetEnvironmentTemplateParams & {
|
104 | version: number;
|
105 | }, rawData: {
|
106 | versionName?: string;
|
107 | versionDescription?: string;
|
108 | }, headers?: RawAxiosRequestHeaders): Promise<EnvironmentTemplateProps>;
|
109 | update(params: GetEnvironmentTemplateParams, rawData: EnvironmentTemplateProps, headers?: RawAxiosRequestHeaders): Promise<EnvironmentTemplateProps>;
|
110 | delete(params: GetEnvironmentTemplateParams, headers?: RawAxiosRequestHeaders): Promise<void>;
|
111 | versions(params: GetEnvironmentTemplateParams & {
|
112 | query?: BasicCursorPaginationOptions & {
|
113 | select?: string;
|
114 | };
|
115 | }, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
|
116 | validate(params: EnvironmentTemplateParams & {
|
117 | version?: number;
|
118 | }, rawData: ValidateEnvironmentTemplateInstallationProps, headers?: RawAxiosRequestHeaders): Promise<EnvironmentTemplateValidationProps>;
|
119 | install(params: EnvironmentTemplateParams, rawData: CreateEnvironmentTemplateInstallationProps, headers?: RawAxiosRequestHeaders): Promise<EnvironmentTemplateInstallationProps>;
|
120 | disconnect(params: EnvironmentTemplateParams, headers?: RawAxiosRequestHeaders): Promise<void>;
|
121 | };
|
122 | environmentTemplateInstallation: {
|
123 | getMany(params: BasicCursorPaginationOptions & {
|
124 | environmentId?: string;
|
125 | environmentTemplateId: string;
|
126 | organizationId: string;
|
127 | spaceId?: string;
|
128 | }, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
|
129 | getForEnvironment(params: BasicCursorPaginationOptions & EnvironmentTemplateParams & {
|
130 | installationId?: string;
|
131 | }, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
|
132 | };
|
133 | bulkAction: {
|
134 | get<T extends BulkActionPayload = any>(params: GetBulkActionParams): Promise<BulkActionProps<T>>;
|
135 | publish(params: GetSpaceEnvironmentParams, payload: BulkActionPublishPayload): Promise<BulkActionProps<BulkActionPublishPayload>>;
|
136 | unpublish(params: GetSpaceEnvironmentParams, payload: BulkActionUnpublishPayload): Promise<BulkActionProps<BulkActionUnpublishPayload>>;
|
137 | validate(params: GetSpaceEnvironmentParams, payload: BulkActionValidatePayload): Promise<BulkActionProps<BulkActionValidatePayload>>;
|
138 | };
|
139 | comment: CommentPlainClientAPI;
|
140 | concept: ConceptPlainClientAPI;
|
141 | conceptScheme: ConceptSchemePlainClientAPI;
|
142 | contentType: {
|
143 | get(params: OptionalDefaults<GetContentTypeParams & QueryParams>): Promise<ContentTypeProps>;
|
144 | getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>): Promise<CollectionProp<ContentTypeProps>>;
|
145 | update(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps, headers?: RawAxiosRequestHeaders): Promise<ContentTypeProps>;
|
146 | delete(params: OptionalDefaults<GetContentTypeParams>): Promise<any>;
|
147 | publish(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps): Promise<ContentTypeProps>;
|
148 | unpublish(params: OptionalDefaults<GetContentTypeParams>): Promise<ContentTypeProps>;
|
149 | create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: CreateContentTypeProps): Promise<ContentTypeProps>;
|
150 | createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
151 | contentTypeId: string;
|
152 | }>, rawData: CreateContentTypeProps): Promise<ContentTypeProps>;
|
153 | omitAndDeleteField(params: OptionalDefaults<GetContentTypeParams>, contentType: ContentTypeProps, fieldId: string): Promise<ContentTypeProps>;
|
154 | };
|
155 | user: UserPlainClientAPI;
|
156 | entry: {
|
157 | getPublished<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
|
158 | getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
|
159 | get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
160 | entryId: string;
|
161 | }>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
|
162 | update<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
163 | entryId: string;
|
164 | }>, rawData: EntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
|
165 | patch<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
166 | entryId: string;
|
167 | }>, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
|
168 | delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
169 | entryId: string;
|
170 | }>): Promise<any>;
|
171 | publish<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
172 | entryId: string;
|
173 | locales?: string[];
|
174 | }>, rawData: EntryProps<T>): Promise<EntryProps<T>>;
|
175 | unpublish<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
176 | entryId: string;
|
177 | locales?: string[];
|
178 | }>): Promise<EntryProps<T>>;
|
179 | archive<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
180 | entryId: string;
|
181 | }>): Promise<EntryProps<T>>;
|
182 | unarchive<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
183 | entryId: string;
|
184 | }>): Promise<EntryProps<T>>;
|
185 | create<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
186 | contentTypeId: string;
|
187 | }>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
|
188 | createWithId<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
189 | entryId: string;
|
190 | contentTypeId: string;
|
191 | }>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
|
192 | references(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
193 | entryId: string;
|
194 | include?: number;
|
195 | }>): Promise<EntryReferenceProps>;
|
196 | };
|
197 | asset: {
|
198 | getPublished(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps>>;
|
199 | getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps>>;
|
200 | get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
201 | assetId: string;
|
202 | } & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<AssetProps>;
|
203 | update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
204 | assetId: string;
|
205 | }>, rawData: AssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps>;
|
206 | delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
207 | assetId: string;
|
208 | }>): Promise<any>;
|
209 | publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
210 | assetId: string;
|
211 | locales?: string[];
|
212 | }>, rawData: AssetProps): Promise<AssetProps>;
|
213 | unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
214 | assetId: string;
|
215 | locales?: string[];
|
216 | }>): Promise<AssetProps>;
|
217 | archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
218 | assetId: string;
|
219 | }>): Promise<AssetProps>;
|
220 | unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
221 | assetId: string;
|
222 | }>): Promise<AssetProps>;
|
223 | create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: CreateAssetProps): Promise<AssetProps>;
|
224 | createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
225 | assetId: string;
|
226 | }>, rawData: CreateAssetProps): Promise<AssetProps>;
|
227 | createFromFiles(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: Omit<AssetFileProp, 'sys'>): Promise<AssetProps>;
|
228 | processForAllLocales(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
|
229 | processForLocale(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
|
230 | };
|
231 | appUpload: AppUploadPlainClientAPI;
|
232 | assetKey: {
|
233 | create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: CreateAssetKeyProps): Promise<AssetKeyProps>;
|
234 | };
|
235 | upload: UploadPlainClientAPI;
|
236 | uploadCredential: UploadCredentialAPI;
|
237 | locale: LocalePlainClientAPI;
|
238 | personalAccessToken: {
|
239 | get(params: OptionalDefaults<{
|
240 | tokenId: string;
|
241 | }>): Promise<PersonalAccessTokenProps>;
|
242 | getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<PersonalAccessTokenProps>>;
|
243 | create(rawData: CreatePersonalAccessTokenProps, headers?: RawAxiosRequestHeaders): Promise<PersonalAccessTokenProps>;
|
244 | revoke(params: OptionalDefaults<{
|
245 | tokenId: string;
|
246 | }>): Promise<PersonalAccessTokenProps>;
|
247 | };
|
248 | accessToken: {
|
249 | get(params: OptionalDefaults<{
|
250 | tokenId: string;
|
251 | }>): Promise<AccessTokenProps>;
|
252 | getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<AccessTokenProps>>;
|
253 | createPersonalAccessToken(rawData: CreatePATProps, headers?: RawAxiosRequestHeaders): Promise<AccessTokenProps>;
|
254 | revoke(params: OptionalDefaults<{
|
255 | tokenId: string;
|
256 | }>): Promise<AccessTokenProps>;
|
257 | getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<AccessTokenProps>>;
|
258 | };
|
259 | usage: UsagePlainClientAPI;
|
260 | release: {
|
261 | archive(params: OptionalDefaults<GetReleaseParams & {
|
262 | version: number;
|
263 | }>): Promise<ReleaseProps>;
|
264 | get(params: OptionalDefaults<GetReleaseParams>): Promise<ReleaseProps>;
|
265 | query(params: OptionalDefaults<GetSpaceEnvironmentParams> & {
|
266 | query?: ReleaseQueryOptions;
|
267 | }): Promise<CursorPaginatedCollectionProp<ReleaseProps>>;
|
268 | create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: ReleasePayload): Promise<ReleaseProps>;
|
269 | update(params: OptionalDefaults<GetReleaseParams & {
|
270 | version: number;
|
271 | }>, data: ReleasePayload): Promise<ReleaseProps>;
|
272 | delete(params: OptionalDefaults<GetReleaseParams>): Promise<void>;
|
273 | publish(params: OptionalDefaults<GetReleaseParams & {
|
274 | version: number;
|
275 | }>): Promise<ReleaseActionProps<'publish'>>;
|
276 | unarchive(params: OptionalDefaults<GetReleaseParams & {
|
277 | version: number;
|
278 | }>): Promise<ReleaseProps>;
|
279 | unpublish(params: OptionalDefaults<GetReleaseParams & {
|
280 | version: number;
|
281 | }>): Promise<ReleaseActionProps<'unpublish'>>;
|
282 | validate(params: OptionalDefaults<GetReleaseParams>, data?: ReleaseValidatePayload): Promise<ReleaseActionProps<'validate'>>;
|
283 | };
|
284 | releaseAction: {
|
285 | get(params: OptionalDefaults<GetReleaseParams> & {
|
286 | actionId: string;
|
287 | }): Promise<ReleaseActionProps>;
|
288 | getMany(params: OptionalDefaults<GetSpaceEnvironmentParams> & {
|
289 | query?: ReleaseActionQueryOptions;
|
290 | }): Promise<CollectionProp<ReleaseActionProps>>;
|
291 | queryForRelease(params: OptionalDefaults<GetReleaseParams> & {
|
292 | query?: ReleaseActionQueryOptions;
|
293 | }): Promise<CollectionProp<ReleaseActionProps>>;
|
294 | };
|
295 | resource: ResourcePlainAPI;
|
296 | resourceProvider: ResourceProviderPlainClientAPI;
|
297 | resourceType: ResourceTypePlainClientAPI;
|
298 | role: RolePlainClientAPI;
|
299 | scheduledActions: {
|
300 | get(params: OptionalDefaults<GetSpaceParams> & {
|
301 | scheduledActionId: string;
|
302 | environmentId: string;
|
303 | }): Promise<ScheduledActionProps>;
|
304 | getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CursorPaginatedCollectionProp<ScheduledActionProps>>;
|
305 | create(params: OptionalDefaults<GetSpaceParams>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
|
306 | delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
307 | scheduledActionId: string;
|
308 | }>): Promise<ScheduledActionProps>;
|
309 | update(params: OptionalDefaults<GetSpaceParams & {
|
310 | scheduledActionId: string;
|
311 | version: number;
|
312 | }>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
|
313 | };
|
314 | previewApiKey: {
|
315 | get(params: OptionalDefaults<GetSpaceParams & {
|
316 | previewApiKeyId: string;
|
317 | }>): Promise<PreviewApiKeyProps>;
|
318 | getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<PreviewApiKeyProps>>;
|
319 | };
|
320 | apiKey: {
|
321 | get(params: OptionalDefaults<GetSpaceParams & {
|
322 | apiKeyId: string;
|
323 | }>): Promise<ApiKeyProps>;
|
324 | getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<ApiKeyProps>>;
|
325 | create(params: OptionalDefaults<GetSpaceParams>, data: CreateApiKeyProps, headers?: RawAxiosRequestHeaders): Promise<ApiKeyProps>;
|
326 | createWithId(params: OptionalDefaults<GetSpaceParams & {
|
327 | apiKeyId: string;
|
328 | }>, data: CreateApiKeyProps, headers?: RawAxiosRequestHeaders): Promise<ApiKeyProps>;
|
329 | update(params: OptionalDefaults<GetSpaceParams & {
|
330 | apiKeyId: string;
|
331 | }>, rawData: ApiKeyProps, headers?: RawAxiosRequestHeaders): Promise<ApiKeyProps>;
|
332 | delete(params: OptionalDefaults<GetSpaceParams & {
|
333 | apiKeyId: string;
|
334 | }>): Promise<any>;
|
335 | };
|
336 | appDefinition: AppDefinitionPlainClientAPI;
|
337 | appInstallation: AppInstallationPlainClientAPI;
|
338 | extension: ExtensionPlainClientAPI;
|
339 | webhook: WebhookPlainClientAPI;
|
340 | snapshot: {
|
341 | getManyForEntry<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSnapshotForEntryParams & QueryParams>): Promise<CollectionProp<SnapshotProps<Omit<EntryProps<T>, 'metadata'>>>>;
|
342 | getForEntry<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSnapshotForEntryParams & {
|
343 | snapshotId: string;
|
344 | }>): Promise<SnapshotProps<Omit<EntryProps<T>, 'metadata'>>>;
|
345 | getManyForContentType(params: OptionalDefaults<GetSnapshotForContentTypeParams & QueryParams>): Promise<CollectionProp<SnapshotProps<ContentTypeProps>>>;
|
346 | getForContentType(params: OptionalDefaults<GetSnapshotForContentTypeParams & {
|
347 | snapshotId: string;
|
348 | }>): Promise<SnapshotProps<ContentTypeProps>>;
|
349 | };
|
350 | tag: TagPlainClientAPI;
|
351 | organization: OrganizationPlainClientAPI;
|
352 | organizationInvitation: {
|
353 | get(params: OptionalDefaults<{
|
354 | organizationId: string;
|
355 | invitationId: string;
|
356 | }>, headers?: RawAxiosRequestHeaders): Promise<OrganizationInvitationProps>;
|
357 | create(params: OptionalDefaults<{
|
358 | organizationId: string;
|
359 | }>, data: CreateOrganizationInvitationProps, headers?: RawAxiosRequestHeaders): Promise<OrganizationInvitationProps>;
|
360 | };
|
361 | organizationMembership: {
|
362 | get(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<OrganizationMembershipProps>;
|
363 | getMany(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<OrganizationMembershipProps>>;
|
364 | update(params: OptionalDefaults<GetOrganizationMembershipParams>, rawData: OrganizationMembershipProps, headers?: RawAxiosRequestHeaders): Promise<OrganizationMembershipProps>;
|
365 | delete(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<any>;
|
366 | };
|
367 | spaceMember: SpaceMemberPlainClientAPI;
|
368 | spaceMembership: SpaceMembershipPlainClientAPI;
|
369 | task: TaskPlainClientAPI;
|
370 | team: TeamPlainClientAPI;
|
371 | teamMembership: TeamMembershipPlainClientAPI;
|
372 | teamSpaceMembership: TeamSpaceMembershipPlainClientAPI;
|
373 | uiConfig: UIConfigPlainClientAPI;
|
374 | userUIConfig: UserUIConfigPlainClientAPI;
|
375 | workflowDefinition: WorkflowDefinitionPlainClientAPI;
|
376 | workflow: WorkflowPlainClientAPI;
|
377 | workflowsChangelog: WorkflowsChangelogPlainClientAPI;
|
378 | };
|