@mittwald/api-client 3.0.2 → 3.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1916 @@
1
+ import MittwaldAPIV2Client from "./client.js";
2
+ export * from "@mittwald/react-use-promise/types";
3
+ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
4
+ /** get a specific `App` */
5
+ getApp: (conf: {
6
+ appId: string;
7
+ headers?: {
8
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
9
+ "x-access-token"?: string | undefined;
10
+ } | undefined;
11
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
12
+ actionCapabilities?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppActionCapabilities | undefined;
13
+ id: string;
14
+ name: string;
15
+ tags: string[];
16
+ }>;
17
+ /** get a specific `AppInstallation` */
18
+ getAppinstallation: (conf: {
19
+ appInstallationId: string;
20
+ headers?: {
21
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
22
+ "x-access-token"?: string | undefined;
23
+ } | undefined;
24
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
25
+ appId: string;
26
+ appVersion: import("./types.js").MittwaldAPIV2.Components.Schemas.AppVersionStatus;
27
+ customDocumentRoot?: string | undefined;
28
+ description: string;
29
+ disabled: boolean;
30
+ id: string;
31
+ installationPath: string;
32
+ linkedDatabases?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppLinkedDatabase[] | undefined;
33
+ processes?: string[] | undefined;
34
+ projectId?: string | undefined;
35
+ screenshotId?: string | undefined;
36
+ screenshotRef?: string | undefined;
37
+ systemSoftware?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppInstalledSystemSoftware[] | undefined;
38
+ updatePolicy?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppUpdatePolicy | undefined;
39
+ userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSavedUserInput[] | undefined;
40
+ }>;
41
+ /** get a specific `AppVersion` */
42
+ getAppversion: (conf: {
43
+ appId: string;
44
+ appVersionId: string;
45
+ headers?: {
46
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
47
+ "x-access-token"?: string | undefined;
48
+ } | undefined;
49
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
50
+ breakingNote?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppBreakingNote | undefined;
51
+ databases?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppDatabaseDependency[] | undefined;
52
+ docRoot: string;
53
+ docRootUserEditable: boolean;
54
+ externalVersion: string;
55
+ id: string;
56
+ internalVersion: string;
57
+ recommended?: boolean | undefined;
58
+ requestHandler?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppRequestHandlerRequirement | undefined;
59
+ systemSoftwareDependencies?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[] | undefined;
60
+ userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppUserInput[] | undefined;
61
+ }>;
62
+ /** get the missing requirements of an appInstallation for a specific target AppVersion */
63
+ getMissingDependenciesForAppinstallation: (conf: {
64
+ queryParameters: {
65
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
66
+ };
67
+ appInstallationId: string;
68
+ headers?: {
69
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
70
+ "x-access-token"?: string | undefined;
71
+ } | undefined;
72
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
73
+ missingSystemSoftwareDependencies?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[] | undefined;
74
+ missingUserInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppUserInput[] | undefined;
75
+ }>;
76
+ /** get a specific `SystemSoftware` */
77
+ getSystemsoftware: (conf: {
78
+ systemSoftwareId: string;
79
+ headers?: {
80
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
81
+ "x-access-token"?: string | undefined;
82
+ } | undefined;
83
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
84
+ id: string;
85
+ name: string;
86
+ tags: string[];
87
+ }>;
88
+ /** get a specific `SystemSoftwareVersion` */
89
+ getSystemsoftwareversion: (conf: {
90
+ systemSoftwareId: string;
91
+ systemSoftwareVersionId: string;
92
+ headers?: {
93
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
94
+ "x-access-token"?: string | undefined;
95
+ } | undefined;
96
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
97
+ externalVersion: string;
98
+ id: string;
99
+ internalVersion: string;
100
+ recommended?: boolean | undefined;
101
+ systemSoftwareDependencies?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[] | undefined;
102
+ userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppUserInput[] | undefined;
103
+ }>;
104
+ /** get all `AppInstallations` inside a specific `Project` */
105
+ listAppinstallations: (conf: {
106
+ projectId: string;
107
+ headers?: {
108
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
109
+ "x-access-token"?: string | undefined;
110
+ } | undefined;
111
+ queryParameters?: {
112
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
113
+ limit?: number | undefined;
114
+ page?: number | undefined;
115
+ skip?: number | undefined;
116
+ } | undefined;
117
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppInstallation[]>;
118
+ /** get all available `Apps` */
119
+ listApps: (conf?: {
120
+ headers?: {
121
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
122
+ "x-access-token"?: string | undefined;
123
+ } | undefined;
124
+ queryParameters?: {
125
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
126
+ limit?: number | undefined;
127
+ page?: number | undefined;
128
+ skip?: number | undefined;
129
+ } | undefined;
130
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppApp[]>;
131
+ /** get all `AppVersions` of a specific `App` */
132
+ listAppversions: (conf: {
133
+ appId: string;
134
+ headers?: {
135
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
136
+ "x-access-token"?: string | undefined;
137
+ } | undefined;
138
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppVersion[]>;
139
+ /** get all available `SystemSoftware` */
140
+ listSystemsoftwares: (conf?: {
141
+ headers?: {
142
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
143
+ "x-access-token"?: string | undefined;
144
+ } | undefined;
145
+ queryParameters?: {
146
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
147
+ limit?: number | undefined;
148
+ page?: number | undefined;
149
+ skip?: number | undefined;
150
+ } | undefined;
151
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftware[]>;
152
+ /** get all available `SystemSoftwareVersions` of a specific `SystemSoftware` */
153
+ listSystemsoftwareversions: (conf: {
154
+ systemSoftwareId: string;
155
+ headers?: {
156
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
157
+ "x-access-token"?: string | undefined;
158
+ } | undefined;
159
+ queryParameters?: {
160
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
161
+ versionRange?: string | undefined;
162
+ } | undefined;
163
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareVersion[]>;
164
+ /** get all update candidates for a specific `AppVersion` */
165
+ listUpdateCandidatesForAppversion: (conf: {
166
+ appId: string;
167
+ baseAppVersionId: string;
168
+ headers?: {
169
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
170
+ "x-access-token"?: string | undefined;
171
+ } | undefined;
172
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppVersion[]>;
173
+ /** get runtime status of a specific `AppInstallation` */
174
+ retrieveStatus: (conf: {
175
+ appInstallationId: string;
176
+ headers?: {
177
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
178
+ } | undefined;
179
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
180
+ lastExitCode?: number | undefined;
181
+ logFileLocation: string;
182
+ state: "running" | "stopped" | "exited";
183
+ uptimeSeconds?: number | undefined;
184
+ }>;
185
+ };
186
+ declare const buildArticleApi: (baseClient: MittwaldAPIV2Client) => {
187
+ /** Get an Article. */
188
+ getArticle: (conf: {
189
+ articleId: string;
190
+ headers?: {
191
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
192
+ } | undefined;
193
+ queryParameters?: {
194
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
195
+ customerId?: string | undefined;
196
+ } | undefined;
197
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
198
+ additionalArticles?: import("./types.js").MittwaldAPIV2.Components.Schemas.ArticleReadableBookableArticleOptions[] | undefined;
199
+ addons?: import("./types.js").MittwaldAPIV2.Components.Schemas.ArticleArticleAddons[] | undefined;
200
+ articleId: string;
201
+ attributes?: import("./types.js").MittwaldAPIV2.Components.Schemas.ArticleArticleAttributes[] | undefined;
202
+ balanceAddonKey?: string | undefined;
203
+ contractDurationInMonth: number;
204
+ description: string;
205
+ forcedInvoicingPeriodInMonth?: number | undefined;
206
+ hasIndependentContractPeriod?: boolean | undefined;
207
+ hideOnInvoice?: boolean | undefined;
208
+ machineType?: {
209
+ cpu: string;
210
+ memory: string;
211
+ name: string;
212
+ } | undefined;
213
+ modifierArticles?: import("./types.js").MittwaldAPIV2.Components.Schemas.ArticleReadableModifierArticleOptions[] | undefined;
214
+ name: string;
215
+ orderable: "forbidden" | "internal" | "beta_testing" | "full" | "deprecated";
216
+ picture?: string | undefined;
217
+ possibleArticleChanges?: import("./types.js").MittwaldAPIV2.Components.Schemas.ArticleReadableChangeArticleOptions[] | undefined;
218
+ price?: number | undefined;
219
+ tags?: import("./types.js").MittwaldAPIV2.Components.Schemas.ArticleArticleTag[] | undefined;
220
+ template: import("./types.js").MittwaldAPIV2.Components.Schemas.ArticleArticleTemplate;
221
+ }>;
222
+ /** List Articles. */
223
+ listArticles: (conf?: {
224
+ headers?: {
225
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
226
+ } | undefined;
227
+ queryParameters?: {
228
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
229
+ customerId?: string | undefined;
230
+ limit?: number | undefined;
231
+ skip?: number | undefined;
232
+ page?: number | undefined;
233
+ tags?: string[] | undefined;
234
+ templateNames?: string[] | undefined;
235
+ articleIds?: string[] | undefined;
236
+ orderable?: ("forbidden" | "internal" | "beta_testing" | "full" | "deprecated")[] | undefined;
237
+ name?: string | undefined;
238
+ } | undefined;
239
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ArticleReadableArticle[]>;
240
+ };
241
+ declare const buildBackupApi: (baseClient: MittwaldAPIV2Client) => {
242
+ /** List BackupSchedules belonging to a Project. */
243
+ listProjectBackupSchedules: (conf: {
244
+ projectId: string;
245
+ headers?: {
246
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
247
+ "x-access-token"?: string | undefined;
248
+ } | undefined;
249
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.BackupProjectBackupSchedule[]>;
250
+ /** List Backups belonging to a Project. */
251
+ listProjectBackups: (conf: {
252
+ projectId: string;
253
+ headers?: {
254
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
255
+ "x-access-token"?: string | undefined;
256
+ } | undefined;
257
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.BackupProjectBackup[]>;
258
+ /** Get a ProjectBackupSchedule. */
259
+ getProjectBackupSchedule: (conf: {
260
+ projectBackupScheduleId: string;
261
+ headers?: {
262
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
263
+ "x-access-token"?: string | undefined;
264
+ } | undefined;
265
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
266
+ createdAt?: string | undefined;
267
+ description?: string | undefined;
268
+ id: string;
269
+ isSystemBackup: boolean;
270
+ projectId: string;
271
+ schedule: string;
272
+ ttl?: string | undefined;
273
+ updatedAt?: string | undefined;
274
+ }>;
275
+ /** Get a ProjectBackup. */
276
+ getProjectBackup: (conf: {
277
+ projectBackupId: string;
278
+ headers?: {
279
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
280
+ "x-access-token"?: string | undefined;
281
+ } | undefined;
282
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
283
+ createdAt?: string | undefined;
284
+ deletable: boolean;
285
+ description?: string | undefined;
286
+ expiresAt?: string | undefined;
287
+ export?: import("./types.js").MittwaldAPIV2.Components.Schemas.BackupProjectBackupExport | undefined;
288
+ id: string;
289
+ parentId?: string | undefined;
290
+ projectId: string;
291
+ status: string;
292
+ }>;
293
+ };
294
+ declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
295
+ /** Return the BaseItem of the Contract with the given ID. */
296
+ getBaseItemOfContract: (conf: {
297
+ contractId: string;
298
+ headers?: {
299
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
300
+ "x-access-token"?: string | undefined;
301
+ } | undefined;
302
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
303
+ activationDate?: string | undefined;
304
+ aggregateReference?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractAggregateReference | undefined;
305
+ articles: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractArticle[];
306
+ contractPeriod: number;
307
+ description: string;
308
+ groupByProjectId?: string | undefined;
309
+ invoicingPeriod: number;
310
+ isActivated: boolean;
311
+ isBaseItem: boolean;
312
+ isInFreeTrial?: boolean | undefined;
313
+ isInclusive?: boolean | undefined;
314
+ itemId: string;
315
+ nextPossibleDowngradeDate?: string | undefined;
316
+ nextPossibleTerminationDate?: string | undefined;
317
+ nextPossibleUpgradeDate?: string | undefined;
318
+ orderDate: string;
319
+ orderId?: string | undefined;
320
+ replacedByItem?: string | undefined;
321
+ tariffChange?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTariffChange | undefined;
322
+ termination?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
323
+ totalPrice: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractPrice;
324
+ }>;
325
+ /** Return the Contract for the given Domain. */
326
+ getDetailOfContractByDomain: (conf: {
327
+ domainId: string;
328
+ headers?: {
329
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
330
+ "x-access-token"?: string | undefined;
331
+ } | undefined;
332
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
333
+ additionalItems?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContractItem[] | undefined;
334
+ baseItem: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContractItem;
335
+ contractId: string;
336
+ contractNumber: string;
337
+ customerId: string;
338
+ isInvoicingDeactivated?: boolean | undefined;
339
+ isInvoicingPaused?: boolean | undefined;
340
+ owner: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContact;
341
+ termination?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
342
+ }>;
343
+ /** Return the Contract for the given Project. */
344
+ getDetailOfContractByProject: (conf: {
345
+ projectId: string;
346
+ headers?: {
347
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
348
+ "x-access-token"?: string | undefined;
349
+ } | undefined;
350
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
351
+ additionalItems?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContractItem[] | undefined;
352
+ baseItem: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContractItem;
353
+ contractId: string;
354
+ contractNumber: string;
355
+ customerId: string;
356
+ isInvoicingDeactivated?: boolean | undefined;
357
+ isInvoicingPaused?: boolean | undefined;
358
+ owner: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContact;
359
+ termination?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
360
+ }>;
361
+ /** Return the Contract for the given Server. */
362
+ getDetailOfContractByServer: (conf: {
363
+ serverId: string;
364
+ headers?: {
365
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
366
+ "x-access-token"?: string | undefined;
367
+ } | undefined;
368
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
369
+ additionalItems?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContractItem[] | undefined;
370
+ baseItem: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContractItem;
371
+ contractId: string;
372
+ contractNumber: string;
373
+ customerId: string;
374
+ isInvoicingDeactivated?: boolean | undefined;
375
+ isInvoicingPaused?: boolean | undefined;
376
+ owner: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContact;
377
+ termination?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
378
+ }>;
379
+ /** Get the ContractItem with the given ID. */
380
+ getDetailOfContractItem: (conf: {
381
+ contractId: string;
382
+ contractItemId: string;
383
+ headers?: {
384
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
385
+ "x-access-token"?: string | undefined;
386
+ } | undefined;
387
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
388
+ activationDate?: string | undefined;
389
+ aggregateReference?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractAggregateReference | undefined;
390
+ articles: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractArticle[];
391
+ contractPeriod: number;
392
+ description: string;
393
+ groupByProjectId?: string | undefined;
394
+ invoicingPeriod: number;
395
+ isActivated: boolean;
396
+ isBaseItem: boolean;
397
+ isInFreeTrial?: boolean | undefined;
398
+ isInclusive?: boolean | undefined;
399
+ itemId: string;
400
+ nextPossibleDowngradeDate?: string | undefined;
401
+ nextPossibleTerminationDate?: string | undefined;
402
+ nextPossibleUpgradeDate?: string | undefined;
403
+ orderDate: string;
404
+ orderId?: string | undefined;
405
+ replacedByItem?: string | undefined;
406
+ tariffChange?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTariffChange | undefined;
407
+ termination?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
408
+ totalPrice: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractPrice;
409
+ }>;
410
+ /** Returns the Contract with the given ID. */
411
+ getDetailOfContract: (conf: {
412
+ contractId: string;
413
+ headers?: {
414
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
415
+ "x-access-token"?: string | undefined;
416
+ } | undefined;
417
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
418
+ additionalItems?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContractItem[] | undefined;
419
+ baseItem: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContractItem;
420
+ contractId: string;
421
+ contractNumber: string;
422
+ customerId: string;
423
+ isInvoicingDeactivated?: boolean | undefined;
424
+ isInvoicingPaused?: boolean | undefined;
425
+ owner: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContact;
426
+ termination?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
427
+ }>;
428
+ /** Return the next TerminationDate for the ContractItem with the given ID. */
429
+ getNextTerminationDateForItem: (conf: {
430
+ contractId: string;
431
+ contractItemId: string;
432
+ headers?: {
433
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
434
+ "x-access-token"?: string | undefined;
435
+ } | undefined;
436
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
437
+ contractItemId: string;
438
+ nextTerminationDate: string;
439
+ }>;
440
+ /** Return a list of Contracts for the given Customer. */
441
+ listContracts: (conf: {
442
+ customerId: string;
443
+ headers?: {
444
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
445
+ "x-access-token"?: string | undefined;
446
+ } | undefined;
447
+ queryParameters?: {
448
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
449
+ limit?: number | undefined;
450
+ skip?: number | undefined;
451
+ page?: number | undefined;
452
+ } | undefined;
453
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContract[]>;
454
+ /** Get details of an Invoice. */
455
+ invoiceDetailOfInvoice: (conf: {
456
+ customerId: string;
457
+ invoiceId: string;
458
+ headers?: {
459
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
460
+ "x-access-token"?: string | undefined;
461
+ } | undefined;
462
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
463
+ amountPaid: number;
464
+ cancellation?: import("./types.js").MittwaldAPIV2.Components.Schemas.InvoiceCancellation | undefined;
465
+ cancellationOf?: string | undefined;
466
+ currency: string;
467
+ customerId: string;
468
+ date: string;
469
+ groups: {
470
+ contractId?: string | undefined;
471
+ description: string;
472
+ items: import("./types.js").MittwaldAPIV2.Components.Schemas.InvoiceInvoiceItem[];
473
+ }[];
474
+ id: string;
475
+ invoiceNumber: string;
476
+ invoiceType: "REGULAR" | "REISSUE" | "CORRECTION" | "CANCELLATION";
477
+ paymentSettings?: import("./types.js").MittwaldAPIV2.Components.Schemas.InvoicePaymentSettings | undefined;
478
+ pdfId: string;
479
+ recipient: import("./types.js").MittwaldAPIV2.Components.Schemas.InvoiceRecipient;
480
+ status: "NEW" | "CONFIRMED" | "DENIED" | "PAID" | "PARTIALLY_PAID" | "OVERPAID";
481
+ totalGross: number;
482
+ totalNet: number;
483
+ vatId?: string | undefined;
484
+ }>;
485
+ /** Get InvoiceSettings of a Customer. */
486
+ invoiceGetDetailOfInvoiceSettings: (conf: {
487
+ customerId: string;
488
+ headers?: {
489
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
490
+ "x-access-token"?: string | undefined;
491
+ } | undefined;
492
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
493
+ additionalEmailRecipients?: string[] | undefined;
494
+ id: string;
495
+ invoicePeriod?: number | undefined;
496
+ lastBankingInformation?: import("./types.js").MittwaldAPIV2.Components.Schemas.InvoiceBankingInformation | undefined;
497
+ paymentSettings?: import("./types.js").MittwaldAPIV2.Components.Schemas.InvoicePaymentSettings | undefined;
498
+ printedInvoices?: boolean | undefined;
499
+ recipient?: import("./types.js").MittwaldAPIV2.Components.Schemas.InvoiceRecipient | undefined;
500
+ recipientSameAsOwner?: boolean | undefined;
501
+ targetDay?: number | undefined;
502
+ }>;
503
+ /** List Invoices of a Customer. */
504
+ invoiceListCustomerInvoices: (conf: {
505
+ customerId: string;
506
+ headers?: {
507
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
508
+ "x-access-token"?: string | undefined;
509
+ } | undefined;
510
+ queryParameters?: {
511
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
512
+ invoiceTypes?: ("REGULAR" | "REISSUE" | "CORRECTION" | "CANCELLATION")[] | undefined;
513
+ limit?: number | undefined;
514
+ skip?: number | undefined;
515
+ page?: number | undefined;
516
+ } | undefined;
517
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.InvoiceInvoice[]>;
518
+ /** Get Order for Customer. */
519
+ orderGetOrder: (conf: {
520
+ orderId: string;
521
+ headers?: {
522
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
523
+ "x-access-token"?: string | undefined;
524
+ } | undefined;
525
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
526
+ contractChangeContractId?: string | undefined;
527
+ customerId: string;
528
+ dueDate?: string | undefined;
529
+ invoicingPeriod: number;
530
+ items: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderOrderItem[];
531
+ orderDate: string;
532
+ orderId: string;
533
+ orderNumber: string;
534
+ profile?: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderProfile | undefined;
535
+ status: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderOrderStatus;
536
+ summary: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderOrderSummary;
537
+ type: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderOrderType;
538
+ }>;
539
+ /** Get list of Orders of a Customer. */
540
+ orderListCustomerOrders: (conf: {
541
+ customerId: string;
542
+ headers?: {
543
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
544
+ "x-access-token"?: string | undefined;
545
+ } | undefined;
546
+ queryParameters?: {
547
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
548
+ limit?: number | undefined;
549
+ skip?: number | undefined;
550
+ page?: number | undefined;
551
+ includesStatus?: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderOrderStatus[] | undefined;
552
+ excludesStatus?: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderOrderStatus[] | undefined;
553
+ templateNames?: string[] | undefined;
554
+ } | undefined;
555
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.OrderCustomerOrder[]>;
556
+ /** Get list of Orders of a Project. */
557
+ orderListProjectOrders: (conf: {
558
+ projectId: string;
559
+ headers?: {
560
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
561
+ "x-access-token"?: string | undefined;
562
+ } | undefined;
563
+ queryParameters?: {
564
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
565
+ limit?: number | undefined;
566
+ skip?: number | undefined;
567
+ page?: number | undefined;
568
+ includesStatus?: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderOrderStatus[] | undefined;
569
+ excludesStatus?: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderOrderStatus[] | undefined;
570
+ templateNames?: string[] | undefined;
571
+ } | undefined;
572
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.OrderCustomerOrder[]>;
573
+ };
574
+ declare const buildConversationApi: (baseClient: MittwaldAPIV2Client) => {
575
+ /** Get all conversation the authenticated user has created or has access to. */
576
+ listConversations: (conf?: {
577
+ headers?: {
578
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
579
+ } | undefined;
580
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationConversation[]>;
581
+ /** Get all message of the conversation. */
582
+ listMessagesByConversation: (conf: {
583
+ conversationId: string;
584
+ headers?: {
585
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
586
+ } | undefined;
587
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<(import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationMessage | import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationStatusUpdate)[]>;
588
+ /** Get a specific conversation category. */
589
+ getCategory: (conf: {
590
+ categoryId: string;
591
+ headers?: {
592
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
593
+ } | undefined;
594
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
595
+ categoryId: string;
596
+ name: string;
597
+ referenceType: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationCategoryReferenceType;
598
+ }>;
599
+ /** Get a support conversation. */
600
+ getConversation: (conf: {
601
+ conversationId: string;
602
+ headers?: {
603
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
604
+ } | undefined;
605
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
606
+ category?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationCategory | undefined;
607
+ conversationId: string;
608
+ createdAt: string;
609
+ createdBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser | undefined;
610
+ lastMessageAt?: string | undefined;
611
+ lastMessageBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser | undefined;
612
+ relatedTo?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
613
+ relations?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference[] | undefined;
614
+ sharedWith?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
615
+ shortId: string;
616
+ status: "open" | "closed" | "answered";
617
+ title: string;
618
+ }>;
619
+ /** Get all conversation categories. */
620
+ listCategories: (conf?: {
621
+ headers?: {
622
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
623
+ } | undefined;
624
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationCategory[]>;
625
+ };
626
+ declare const buildCronjobApi: (baseClient: MittwaldAPIV2Client) => {
627
+ /** List Cronjobs belonging to a Project. */
628
+ listCronjobs: (conf: {
629
+ projectId: string;
630
+ headers?: {
631
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
632
+ "x-access-token"?: string | undefined;
633
+ } | undefined;
634
+ queryParameters?: {
635
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
636
+ limit?: number | undefined;
637
+ skip?: number | undefined;
638
+ page?: number | undefined;
639
+ } | undefined;
640
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.CronjobCronjob[]>;
641
+ /** List CronjobExecutions belonging to a Cronjob. */
642
+ listExecutions: (conf: {
643
+ cronjobId: string;
644
+ headers?: {
645
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
646
+ "x-access-token"?: string | undefined;
647
+ } | undefined;
648
+ queryParameters?: {
649
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
650
+ limit?: number | undefined;
651
+ skip?: number | undefined;
652
+ page?: number | undefined;
653
+ since?: string | undefined;
654
+ until?: string | undefined;
655
+ status?: string | undefined;
656
+ } | undefined;
657
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.CronjobCronjobExecution[]>;
658
+ /** Get a Cronjob. */
659
+ getCronjob: (conf: {
660
+ cronjobId: string;
661
+ headers?: {
662
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
663
+ "x-access-token"?: string | undefined;
664
+ } | undefined;
665
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
666
+ active: boolean;
667
+ appId: string;
668
+ createdAt: string;
669
+ description: string;
670
+ destination: import("./types.js").MittwaldAPIV2.Components.Schemas.CronjobCronjobCommand | import("./types.js").MittwaldAPIV2.Components.Schemas.CronjobCronjobUrl;
671
+ email?: string | undefined;
672
+ id: string;
673
+ interval: string;
674
+ latestExecution?: import("./types.js").MittwaldAPIV2.Components.Schemas.CronjobCronjobExecution | undefined;
675
+ nextExecutionTime?: string | undefined;
676
+ projectId?: string | undefined;
677
+ shortId: string;
678
+ updatedAt: string;
679
+ }>;
680
+ /** Get a CronjobExecution. */
681
+ getExecution: (conf: {
682
+ executionId: string;
683
+ cronjobId: string;
684
+ headers?: {
685
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
686
+ "x-access-token"?: string | undefined;
687
+ } | undefined;
688
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
689
+ abortedBy?: {
690
+ id?: string | undefined;
691
+ } | undefined;
692
+ durationInMilliseconds: number;
693
+ end?: string | undefined;
694
+ executionEnd?: string | undefined;
695
+ executionStart?: string | undefined;
696
+ id: string;
697
+ logPath: string;
698
+ start?: string | undefined;
699
+ status: "Pending" | "Failed" | "Complete" | "AbortedBySystem" | "Running" | "AbortedByUser";
700
+ successful: boolean;
701
+ triggeredBy?: {
702
+ id?: string | undefined;
703
+ } | undefined;
704
+ }>;
705
+ };
706
+ declare const buildCustomerApi: (baseClient: MittwaldAPIV2Client) => {
707
+ /** Get all customer categories. */
708
+ listOfCustomerCategories: (conf?: {
709
+ headers?: {
710
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
711
+ "x-access-token"?: string | undefined;
712
+ } | undefined;
713
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<{
714
+ categories?: import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerCategory[] | undefined;
715
+ }>;
716
+ /** Get all customer profiles the authenticated user has access to. */
717
+ listCustomers: (conf?: {
718
+ headers?: {
719
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
720
+ "x-access-token"?: string | undefined;
721
+ } | undefined;
722
+ queryParameters?: {
723
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
724
+ role?: string | undefined;
725
+ limit?: number | undefined;
726
+ skip?: number | undefined;
727
+ page?: number | undefined;
728
+ } | undefined;
729
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerCustomer[]>;
730
+ /** Get a customer category. */
731
+ getCustomerCategory: (conf: {
732
+ categoryId: string;
733
+ headers?: {
734
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
735
+ "x-access-token"?: string | undefined;
736
+ } | undefined;
737
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
738
+ id: string;
739
+ isPublic: boolean;
740
+ name: string;
741
+ useAgencyDomainPrices: boolean;
742
+ useAgencySslPrices: boolean;
743
+ }>;
744
+ /** Get a CustomerInvite. */
745
+ getCustomerInvite: (conf: {
746
+ inviteId: string;
747
+ headers?: {
748
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
749
+ "x-access-token"?: string | undefined;
750
+ } | undefined;
751
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
752
+ avatarRefId: string;
753
+ customerId: string;
754
+ customerName: string;
755
+ id: string;
756
+ information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
757
+ mailAddress: string;
758
+ membershipExpiresAt?: string | undefined;
759
+ message?: string | undefined;
760
+ role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerRoles;
761
+ }>;
762
+ /** Get a CustomerMembership. */
763
+ getCustomerMembership: (conf: {
764
+ membershipId: string;
765
+ headers?: {
766
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
767
+ "x-access-token"?: string | undefined;
768
+ } | undefined;
769
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
770
+ customerId: string;
771
+ expiresAt?: string | undefined;
772
+ id: string;
773
+ inviteId: string;
774
+ memberSince?: string | undefined;
775
+ role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerRoles;
776
+ userId: string;
777
+ }>;
778
+ /** Get a customer profile. */
779
+ getCustomer: (conf: {
780
+ customerId: string;
781
+ headers?: {
782
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
783
+ "x-access-token"?: string | undefined;
784
+ } | undefined;
785
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
786
+ activeSuspension?: {
787
+ createdAt: string;
788
+ } | undefined;
789
+ avatarRefId?: string | undefined;
790
+ categoryId?: string | undefined;
791
+ creationDate: string;
792
+ customerId: string;
793
+ customerNumber: string;
794
+ executingUserRoles?: import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerRole[] | undefined;
795
+ isBanned?: boolean | undefined;
796
+ isInDefaultOfPayment?: boolean | undefined;
797
+ memberCount: number;
798
+ name: string;
799
+ owner?: import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerContact | undefined;
800
+ projectCount: number;
801
+ vatId?: string | undefined;
802
+ vatIdValidationState?: "unspecified" | "valid" | "invalid" | "pending" | undefined;
803
+ }>;
804
+ /** Get a CustomerInvite by token. */
805
+ getCustomerTokenInvite: (conf: {
806
+ headers: {
807
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
808
+ "x-access-token"?: string | undefined;
809
+ };
810
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
811
+ avatarRefId: string;
812
+ customerId: string;
813
+ customerName: string;
814
+ id: string;
815
+ information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
816
+ mailAddress: string;
817
+ membershipExpiresAt?: string | undefined;
818
+ message?: string | undefined;
819
+ role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerRoles;
820
+ }>;
821
+ /** Check if the customer profile has a valid contract partner configured. */
822
+ isCustomerLegallyCompetent: (conf: {
823
+ customerId: string;
824
+ headers?: {
825
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
826
+ "x-access-token"?: string | undefined;
827
+ } | undefined;
828
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
829
+ isLegallyCompetent?: boolean | undefined;
830
+ }>;
831
+ /** List CustomerInvites belonging to the executing user. */
832
+ listCustomerInvites: (conf?: {
833
+ headers?: {
834
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
835
+ "x-access-token"?: string | undefined;
836
+ } | undefined;
837
+ queryParameters?: {
838
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
839
+ limit?: number | undefined;
840
+ skip?: number | undefined;
841
+ } | undefined;
842
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerInvite[]>;
843
+ /** List CustomerMemberships belonging to the executing user. */
844
+ listCustomerMemberships: (conf?: {
845
+ headers?: {
846
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
847
+ "x-access-token"?: string | undefined;
848
+ } | undefined;
849
+ queryParameters?: {
850
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
851
+ limit?: number | undefined;
852
+ skip?: number | undefined;
853
+ } | undefined;
854
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerMembership[]>;
855
+ /** List Invites belonging to a Customer. */
856
+ listInvitesForCustomer: (conf: {
857
+ customerId: string;
858
+ headers?: {
859
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
860
+ "x-access-token"?: string | undefined;
861
+ } | undefined;
862
+ queryParameters?: {
863
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
864
+ limit?: number | undefined;
865
+ skip?: number | undefined;
866
+ } | undefined;
867
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerInvite[]>;
868
+ /** List Memberships belonging to a Customer. */
869
+ listMembershipsForCustomer: (conf: {
870
+ customerId: string;
871
+ headers?: {
872
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
873
+ "x-access-token"?: string | undefined;
874
+ } | undefined;
875
+ queryParameters?: {
876
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
877
+ limit?: number | undefined;
878
+ skip?: number | undefined;
879
+ } | undefined;
880
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerMembership[]>;
881
+ };
882
+ declare const buildDatabaseApi: (baseClient: MittwaldAPIV2Client) => {
883
+ /** List MySQLDatabases belonging to a Project. */
884
+ listMysqlDatabases: (conf: {
885
+ projectId: string;
886
+ headers?: {
887
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
888
+ "x-access-token"?: string | undefined;
889
+ } | undefined;
890
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DatabaseMySqlDatabase[]>;
891
+ /** List MySQLUsers belonging to a Database. */
892
+ listMysqlUsers: (conf: {
893
+ databaseId: string;
894
+ headers?: {
895
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
896
+ "x-access-token"?: string | undefined;
897
+ } | undefined;
898
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DatabaseMySqlUser[]>;
899
+ /** List RedisDatabases belonging to a Project. */
900
+ listRedisDatabases: (conf: {
901
+ projectId: string;
902
+ headers?: {
903
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
904
+ "x-access-token"?: string | undefined;
905
+ } | undefined;
906
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DatabaseRedisDatabase[]>;
907
+ /** Get a MySQLDatabase. */
908
+ getMysqlDatabase: (conf: {
909
+ id: string;
910
+ headers?: {
911
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
912
+ "x-access-token"?: string | undefined;
913
+ } | undefined;
914
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
915
+ characterSettings: import("./types.js").MittwaldAPIV2.Components.Schemas.DatabaseCharacterSettings;
916
+ createdAt: string;
917
+ description: string;
918
+ finalizers?: string[] | undefined;
919
+ hostname: string;
920
+ id: string;
921
+ isReady: boolean;
922
+ isShared: boolean;
923
+ name: string;
924
+ projectId: string;
925
+ size: number;
926
+ updatedAt: string;
927
+ version: string;
928
+ }>;
929
+ /** Get a MySQLUser. */
930
+ getMysqlUser: (conf: {
931
+ id: string;
932
+ headers?: {
933
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
934
+ "x-access-token"?: string | undefined;
935
+ } | undefined;
936
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
937
+ accessIpMask?: string | undefined;
938
+ accessLevel: "full" | "readonly";
939
+ createdAt: string;
940
+ databaseId: string;
941
+ description?: string | undefined;
942
+ disabled: boolean;
943
+ externalAccess: boolean;
944
+ id: string;
945
+ mainUser: boolean;
946
+ name: string;
947
+ passwordUpdatedAt: string;
948
+ updatedAt: string;
949
+ }>;
950
+ /** Get a RedisDatabase. */
951
+ getRedisDatabase: (conf: {
952
+ id: string;
953
+ headers?: {
954
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
955
+ "x-access-token"?: string | undefined;
956
+ } | undefined;
957
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
958
+ configuration?: import("./types.js").MittwaldAPIV2.Components.Schemas.DatabaseRedisDatabaseConfiguration | undefined;
959
+ createdAt: string;
960
+ description: string;
961
+ finalizers: string[];
962
+ hostname: string;
963
+ id: string;
964
+ name: string;
965
+ port: number;
966
+ projectId: string;
967
+ updatedAt: string;
968
+ version: string;
969
+ }>;
970
+ /** Get a MySQLUser's PhpMyAdmin-URL. */
971
+ getMysqlUserPhpMyAdminUrl: (conf: {
972
+ id: string;
973
+ headers?: {
974
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
975
+ "x-access-token"?: string | undefined;
976
+ } | undefined;
977
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
978
+ url: string;
979
+ }>;
980
+ /** List available MySQL character sets and collations, optionally filtered by a MySQLVersion. */
981
+ listMysqlCharsets: (conf?: {
982
+ headers?: {
983
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
984
+ "x-access-token"?: string | undefined;
985
+ } | undefined;
986
+ queryParameters?: {
987
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
988
+ version?: string | undefined;
989
+ } | undefined;
990
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DatabaseMySqlCharacterSettings[]>;
991
+ /** List MySQLVersions. */
992
+ listMysqlVersions: (conf?: {
993
+ headers?: {
994
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
995
+ "x-access-token"?: string | undefined;
996
+ } | undefined;
997
+ queryParameters?: {
998
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
999
+ projectId?: string | undefined;
1000
+ } | undefined;
1001
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DatabaseMySqlVersion[]>;
1002
+ /** List RedisVersions. */
1003
+ listRedisVersions: (conf?: {
1004
+ headers?: {
1005
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1006
+ "x-access-token"?: string | undefined;
1007
+ } | undefined;
1008
+ queryParameters?: {
1009
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1010
+ projectId?: string | undefined;
1011
+ } | undefined;
1012
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DatabaseRedisVersion[]>;
1013
+ };
1014
+ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
1015
+ /** gets a specific zone */
1016
+ dnsZoneGetSpecific: (conf: {
1017
+ zoneId: string;
1018
+ headers?: {
1019
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1020
+ "x-access-token"?: string | undefined;
1021
+ } | undefined;
1022
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1023
+ domain: string;
1024
+ id: string;
1025
+ recordSet: {
1026
+ cname: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordCNAME;
1027
+ combinedARecords: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordCombinedA;
1028
+ mx: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordMX;
1029
+ srv: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordSRV;
1030
+ txt: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordTXT;
1031
+ };
1032
+ }>;
1033
+ /** gets all dns zones by project id */
1034
+ dnsZonesForProject: (conf: {
1035
+ projectId: string;
1036
+ headers?: {
1037
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1038
+ "x-access-token"?: string | undefined;
1039
+ } | undefined;
1040
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DnsZone[]>;
1041
+ /** Get a Domain. */
1042
+ getDomain: (conf: {
1043
+ domainId: string;
1044
+ headers?: {
1045
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1046
+ "x-access-token"?: string | undefined;
1047
+ } | undefined;
1048
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1049
+ authCode?: import("./types.js").MittwaldAPIV2.Components.Schemas.DomainAuthCode | undefined;
1050
+ authCode2?: import("./types.js").MittwaldAPIV2.Components.Schemas.DomainAuthCode2 | undefined;
1051
+ connected: boolean;
1052
+ deleted: boolean;
1053
+ domain: string;
1054
+ domainId: string;
1055
+ handles: {
1056
+ adminC?: import("./types.js").MittwaldAPIV2.Components.Schemas.DomainHandleReadable | undefined;
1057
+ ownerC: import("./types.js").MittwaldAPIV2.Components.Schemas.DomainHandleReadable;
1058
+ };
1059
+ hasAuthCode: boolean;
1060
+ nameservers: [string, string, ...string[]];
1061
+ processes?: import("./types.js").MittwaldAPIV2.Components.Schemas.DomainProcess[] | undefined;
1062
+ projectId: string;
1063
+ transferInAuthCode?: string | undefined;
1064
+ usesDefaultNameserver: boolean;
1065
+ }>;
1066
+ /** Get a HandleSchema. */
1067
+ getHandleFields: (conf: {
1068
+ domainName: string;
1069
+ headers?: {
1070
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1071
+ } | undefined;
1072
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1073
+ jsonSchemaAdminC?: {} | undefined;
1074
+ jsonSchemaOwnerC: {};
1075
+ }>;
1076
+ /** Get File Service Reference for a Screenshot of a domain. */
1077
+ getScreenshotForDomain: (conf: {
1078
+ data: {
1079
+ domainName: string;
1080
+ path: string;
1081
+ };
1082
+ domainId: string;
1083
+ headers?: {
1084
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1085
+ "x-access-token"?: string | undefined;
1086
+ } | undefined;
1087
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1088
+ references?: string[] | undefined;
1089
+ }>;
1090
+ /** Get a domain ownership. */
1091
+ getSpecificDomainOwnership: (conf: {
1092
+ domainOwnershipId: string;
1093
+ headers?: {
1094
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1095
+ "x-access-token"?: string | undefined;
1096
+ } | undefined;
1097
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1098
+ domain: string;
1099
+ id: string;
1100
+ projectId: string;
1101
+ txtRecord: string;
1102
+ }>;
1103
+ /** List all domain ownerships of a project. */
1104
+ listDomainOwnerships: (conf: {
1105
+ projectId: string;
1106
+ headers?: {
1107
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1108
+ "x-access-token"?: string | undefined;
1109
+ } | undefined;
1110
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DomainDomainOwnership[]>;
1111
+ /** List Domains belonging to a Project. */
1112
+ listDomains: (conf: {
1113
+ projectId: string;
1114
+ headers?: {
1115
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1116
+ "x-access-token"?: string | undefined;
1117
+ } | undefined;
1118
+ queryParameters?: {
1119
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1120
+ page?: number | undefined;
1121
+ limit?: number | undefined;
1122
+ domainSearchName?: string | undefined;
1123
+ } | undefined;
1124
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DomainDomain[]>;
1125
+ /** Get an Ingress. */
1126
+ ingressGetSpecific: (conf: {
1127
+ ingressId: string;
1128
+ headers?: {
1129
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1130
+ "x-access-token"?: string | undefined;
1131
+ } | undefined;
1132
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1133
+ dnsValidationErrors: ("ERROR_UNSPECIFIED" | "ERROR_QUAD_A" | "ERROR_NO_A_RECORD" | "ERROR_ACME_CERTIFICATE_REQUEST_DEADLINE_EXCEEDED")[];
1134
+ hostname: string;
1135
+ id: string;
1136
+ ips: {
1137
+ v4: string[];
1138
+ };
1139
+ isDefault: boolean;
1140
+ isEnabled: boolean;
1141
+ paths: import("./types.js").MittwaldAPIV2.Components.Schemas.IngressPath[];
1142
+ projectId: string;
1143
+ tls: import("./types.js").MittwaldAPIV2.Components.Schemas.IngressTlsAcme | import("./types.js").MittwaldAPIV2.Components.Schemas.IngressTlsCertificate;
1144
+ }>;
1145
+ /** List Ingresses the user has access to. */
1146
+ ingressListAccessible: (conf?: {
1147
+ headers?: {
1148
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1149
+ "x-access-token"?: string | undefined;
1150
+ } | undefined;
1151
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.IngressIngress[]>;
1152
+ /** List Ingresses belonging to a project. */
1153
+ ingressListForProject: (conf: {
1154
+ projectId: string;
1155
+ headers?: {
1156
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1157
+ "x-access-token"?: string | undefined;
1158
+ } | undefined;
1159
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.IngressIngress[]>;
1160
+ };
1161
+ declare const buildFileApi: (baseClient: MittwaldAPIV2Client) => {
1162
+ /** Get a File's meta. */
1163
+ getFileMeta: (conf: {
1164
+ id: string;
1165
+ headers?: {
1166
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1167
+ } | undefined;
1168
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1169
+ friendlyURL: string;
1170
+ id: string;
1171
+ name: string;
1172
+ sizeInBytes: number;
1173
+ type: string;
1174
+ }>;
1175
+ /** Get a Token's upload rules. */
1176
+ getFileTokenRules: (conf: {
1177
+ token: string;
1178
+ headers?: {
1179
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1180
+ } | undefined;
1181
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1182
+ maxSizeInKB: number;
1183
+ mimeTypes: string[];
1184
+ properties?: {
1185
+ imageDimensions?: {
1186
+ max?: {
1187
+ height?: number | undefined;
1188
+ width?: number | undefined;
1189
+ } | undefined;
1190
+ min?: {
1191
+ height?: number | undefined;
1192
+ width?: number | undefined;
1193
+ } | undefined;
1194
+ } | undefined;
1195
+ } | undefined;
1196
+ }>;
1197
+ /** Get a Type's upload rules. */
1198
+ getFileTypeRules: (conf: {
1199
+ name: "avatar" | "conversation";
1200
+ headers?: {
1201
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1202
+ } | undefined;
1203
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1204
+ maxSizeInKB: number;
1205
+ mimeTypes: string[];
1206
+ properties?: {
1207
+ imageDimensions?: {
1208
+ max?: {
1209
+ height?: number | undefined;
1210
+ width?: number | undefined;
1211
+ } | undefined;
1212
+ min?: {
1213
+ height?: number | undefined;
1214
+ width?: number | undefined;
1215
+ } | undefined;
1216
+ } | undefined;
1217
+ } | undefined;
1218
+ }>;
1219
+ /** Get a File. */
1220
+ getFile: (conf: {
1221
+ id: string;
1222
+ headers?: {
1223
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1224
+ Accept?: "binary" | "base64" | "ocr" | undefined;
1225
+ Download?: boolean | undefined;
1226
+ } | undefined;
1227
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<string>;
1228
+ };
1229
+ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
1230
+ /** Get all deliveryboxes by project ID */
1231
+ deliveryboxList: (conf: {
1232
+ projectId: string;
1233
+ headers?: {
1234
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1235
+ "x-access-token"?: string | undefined;
1236
+ } | undefined;
1237
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MailDeliverybox[]>;
1238
+ /** Get a specific deliverybox */
1239
+ deliveryboxGetSpecific: (conf: {
1240
+ id: string;
1241
+ headers?: {
1242
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1243
+ "x-access-token"?: string | undefined;
1244
+ } | undefined;
1245
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1246
+ authenticationEnabled: boolean;
1247
+ description: string;
1248
+ id: string;
1249
+ name: string;
1250
+ passwordUpdatedAt: string;
1251
+ projectId: string;
1252
+ sendingEnabled: boolean;
1253
+ updatedAt: string;
1254
+ }>;
1255
+ /** Get all mail addresses for a project ID */
1256
+ mailaddressList: (conf: {
1257
+ projectId: string;
1258
+ headers?: {
1259
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1260
+ "x-access-token"?: string | undefined;
1261
+ } | undefined;
1262
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MailMailAddress[]>;
1263
+ /** Get a specific mail address */
1264
+ mailaddressGetSpecific: (conf: {
1265
+ id: string;
1266
+ headers?: {
1267
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1268
+ "x-access-token"?: string | undefined;
1269
+ } | undefined;
1270
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1271
+ address: string;
1272
+ autoResponder: {
1273
+ active: boolean;
1274
+ expiresAt?: string | undefined;
1275
+ message: string;
1276
+ startsAt?: string | undefined;
1277
+ };
1278
+ forwardAddresses: string[];
1279
+ id: string;
1280
+ isArchived: boolean;
1281
+ isCatchAll: boolean;
1282
+ mailbox?: {
1283
+ passwordUpdatedAt: string;
1284
+ sendingEnabled: boolean;
1285
+ spamProtection: {
1286
+ active: boolean;
1287
+ autoDeleteSpam: boolean;
1288
+ folder: "spam" | "inbox";
1289
+ relocationMinSpamScore: number;
1290
+ };
1291
+ storageInBytes: {
1292
+ current: {
1293
+ updatedAt: string;
1294
+ value: number;
1295
+ };
1296
+ limit: number;
1297
+ };
1298
+ } | undefined;
1299
+ projectId: string;
1300
+ receivingDisabled: boolean;
1301
+ updatedAt: string;
1302
+ }>;
1303
+ /** Get settings for a given project ID */
1304
+ projectsettingGetSpecific: (conf: {
1305
+ projectId: string;
1306
+ headers?: {
1307
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1308
+ "x-access-token"?: string | undefined;
1309
+ } | undefined;
1310
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1311
+ blacklist: string[];
1312
+ projectId: string;
1313
+ whitelist: string[];
1314
+ }>;
1315
+ };
1316
+ declare const buildNotificationApi: (baseClient: MittwaldAPIV2Client) => {
1317
+ /** Getting the subscription status of the subscription. */
1318
+ newsletterGetInfo: (conf?: {
1319
+ headers?: {
1320
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1321
+ "x-access-token"?: string | undefined;
1322
+ } | undefined;
1323
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<{
1324
+ active: boolean;
1325
+ email: string;
1326
+ registered: boolean;
1327
+ }>;
1328
+ /** Get the counts for unread notifications of the user. */
1329
+ scountUnreadNotifications: (conf?: {
1330
+ headers?: {
1331
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1332
+ "x-access-token"?: string | undefined;
1333
+ } | undefined;
1334
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<{
1335
+ error: number;
1336
+ info: number;
1337
+ success: number;
1338
+ total: number;
1339
+ warning: number;
1340
+ }>;
1341
+ /** List all unread notifications */
1342
+ slistNotifications: (conf?: {
1343
+ headers?: {
1344
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1345
+ "x-access-token"?: string | undefined;
1346
+ } | undefined;
1347
+ queryParameters?: {
1348
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1349
+ status?: "read" | "unread" | undefined;
1350
+ } | undefined;
1351
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MessagingNotification[]>;
1352
+ };
1353
+ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
1354
+ /** Get a ProjectInvite. */
1355
+ getProjectInvite: (conf: {
1356
+ inviteId: string;
1357
+ headers?: {
1358
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1359
+ "x-access-token"?: string | undefined;
1360
+ } | undefined;
1361
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1362
+ id: string;
1363
+ information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
1364
+ mailAddress: string;
1365
+ membershipExpiresAt?: string | undefined;
1366
+ message?: string | undefined;
1367
+ projectDescription: string;
1368
+ projectId: string;
1369
+ role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
1370
+ }>;
1371
+ /** Get a ProjectMembership */
1372
+ getProjectMembership: (conf: {
1373
+ membershipId: string;
1374
+ headers?: {
1375
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1376
+ "x-access-token"?: string | undefined;
1377
+ } | undefined;
1378
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1379
+ expiresAt?: string | undefined;
1380
+ id: string;
1381
+ inherited: boolean;
1382
+ inviteId: string;
1383
+ memberSince?: string | undefined;
1384
+ projectId: string;
1385
+ role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
1386
+ userId: string;
1387
+ }>;
1388
+ /** Get a ProjectInvite by token. */
1389
+ getProjectTokenInvite: (conf: {
1390
+ headers: {
1391
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1392
+ "x-access-token"?: string | undefined;
1393
+ };
1394
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1395
+ id: string;
1396
+ information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
1397
+ mailAddress: string;
1398
+ membershipExpiresAt?: string | undefined;
1399
+ message?: string | undefined;
1400
+ projectDescription: string;
1401
+ projectId: string;
1402
+ role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
1403
+ }>;
1404
+ /** Get a Project. */
1405
+ getProject: (conf: {
1406
+ id: string;
1407
+ headers?: {
1408
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1409
+ "x-access-token"?: string | undefined;
1410
+ } | undefined;
1411
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1412
+ clusterDomain?: string | undefined;
1413
+ clusterID?: string | undefined;
1414
+ createdAt: string;
1415
+ customerId: string;
1416
+ description: string;
1417
+ directories: {
1418
+ [k: string]: string;
1419
+ };
1420
+ disableReason?: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectDisableReason | undefined;
1421
+ enabled: boolean;
1422
+ id: string;
1423
+ imageRefId?: string | undefined;
1424
+ isReady: boolean;
1425
+ projectHostingId?: string | undefined;
1426
+ readiness: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectProjectReadinessStatus;
1427
+ serverId?: string | undefined;
1428
+ serverShortId?: string | undefined;
1429
+ shortId: string;
1430
+ spec?: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectHardwareSpec | import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectVisitorSpec | undefined;
1431
+ }>;
1432
+ /** Get the executing user's membership in a Project. */
1433
+ getSelfMembershipForProject: (conf: {
1434
+ projectId: string;
1435
+ headers?: {
1436
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1437
+ "x-access-token"?: string | undefined;
1438
+ } | undefined;
1439
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1440
+ expiresAt?: string | undefined;
1441
+ id: string;
1442
+ inherited: boolean;
1443
+ inviteId: string;
1444
+ memberSince?: string | undefined;
1445
+ projectId: string;
1446
+ role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
1447
+ userId: string;
1448
+ }>;
1449
+ /** Get a Server. */
1450
+ getServer: (conf: {
1451
+ serverId: string;
1452
+ headers?: {
1453
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1454
+ "x-access-token"?: string | undefined;
1455
+ } | undefined;
1456
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1457
+ clusterName: string;
1458
+ createdAt: string;
1459
+ customerId: string;
1460
+ description: string;
1461
+ disabledReason?: "suspended" | undefined;
1462
+ id: string;
1463
+ imageRefId?: string | undefined;
1464
+ isReady: boolean;
1465
+ machineType: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectMachineType;
1466
+ readiness: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectProjectReadinessStatus;
1467
+ shortId: string;
1468
+ storage: string;
1469
+ }>;
1470
+ /** List Invites belonging to a Project. */
1471
+ listInvitesForProject: (conf: {
1472
+ projectId: string;
1473
+ headers?: {
1474
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1475
+ "x-access-token"?: string | undefined;
1476
+ } | undefined;
1477
+ queryParameters?: {
1478
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1479
+ limit?: number | undefined;
1480
+ skip?: number | undefined;
1481
+ } | undefined;
1482
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectInvite[]>;
1483
+ /** List Memberships belonging to a Project. */
1484
+ listMembershipsForProject: (conf: {
1485
+ projectId: string;
1486
+ headers?: {
1487
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1488
+ "x-access-token"?: string | undefined;
1489
+ } | undefined;
1490
+ queryParameters?: {
1491
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1492
+ limit?: number | undefined;
1493
+ skip?: number | undefined;
1494
+ } | undefined;
1495
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectMembership[]>;
1496
+ /** List ProjectInvites belonging to the executing user. */
1497
+ listProjectInvites: (conf?: {
1498
+ headers?: {
1499
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1500
+ "x-access-token"?: string | undefined;
1501
+ } | undefined;
1502
+ queryParameters?: {
1503
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1504
+ limit?: number | undefined;
1505
+ skip?: number | undefined;
1506
+ } | undefined;
1507
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectInvite[]>;
1508
+ /** List ProjectMemberships belonging to the executing user. */
1509
+ listProjectMemberships: (conf?: {
1510
+ headers?: {
1511
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1512
+ "x-access-token"?: string | undefined;
1513
+ } | undefined;
1514
+ queryParameters?: {
1515
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1516
+ limit?: number | undefined;
1517
+ skip?: number | undefined;
1518
+ } | undefined;
1519
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectMembership[]>;
1520
+ /** List Projects belonging to the executing user. */
1521
+ listProjects: (conf?: {
1522
+ headers?: {
1523
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1524
+ "x-access-token"?: string | undefined;
1525
+ } | undefined;
1526
+ queryParameters?: {
1527
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1528
+ customerId?: string | undefined;
1529
+ serverId?: string | undefined;
1530
+ } | undefined;
1531
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<{
1532
+ createdAt: string;
1533
+ customerId: string;
1534
+ customerMeta: {
1535
+ id: string;
1536
+ };
1537
+ description: string;
1538
+ disableReason?: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectDisableReason | undefined;
1539
+ enabled: boolean;
1540
+ id: string;
1541
+ imageRefId?: string | undefined;
1542
+ isReady: boolean;
1543
+ projectHostingId?: string | undefined;
1544
+ readiness: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectProjectReadinessStatus;
1545
+ serverId?: string | undefined;
1546
+ shortId: string;
1547
+ }[]>;
1548
+ /** List Servers belonging to the executing user. */
1549
+ listServers: (conf?: {
1550
+ headers?: {
1551
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1552
+ "x-access-token"?: string | undefined;
1553
+ } | undefined;
1554
+ queryParameters?: {
1555
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1556
+ customerId?: string | undefined;
1557
+ limit?: number | undefined;
1558
+ page?: number | undefined;
1559
+ skip?: number | undefined;
1560
+ } | undefined;
1561
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectServer[]>;
1562
+ };
1563
+ declare const buildProjectFileSystemApi: (baseClient: MittwaldAPIV2Client) => {
1564
+ /** List directories belonging to a Project. */
1565
+ getDirectories: (conf: {
1566
+ projectId: string;
1567
+ headers?: {
1568
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1569
+ "x-access-token"?: string | undefined;
1570
+ } | undefined;
1571
+ queryParameters?: {
1572
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1573
+ directory?: string | undefined;
1574
+ name?: string | undefined;
1575
+ max_depth?: number | undefined;
1576
+ type?: string[] | undefined;
1577
+ executable?: boolean | undefined;
1578
+ hidden?: boolean | undefined;
1579
+ } | undefined;
1580
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1581
+ absolutePath: string;
1582
+ isDirectory?: boolean | undefined;
1583
+ isExecutable?: boolean | undefined;
1584
+ isFile?: boolean | undefined;
1585
+ isSymlink?: boolean | undefined;
1586
+ items?: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectFilesystemDirectoryListing[] | undefined;
1587
+ name: string;
1588
+ size: number;
1589
+ target?: string | undefined;
1590
+ }>;
1591
+ /** Get a Project directory filesystem usage. */
1592
+ getDiskUsage: (conf: {
1593
+ projectId: string;
1594
+ headers?: {
1595
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1596
+ "x-access-token"?: string | undefined;
1597
+ } | undefined;
1598
+ queryParameters?: {
1599
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1600
+ directory?: string | undefined;
1601
+ } | undefined;
1602
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1603
+ path?: string | undefined;
1604
+ totalBytes?: number | undefined;
1605
+ usedBytes?: number | undefined;
1606
+ }>;
1607
+ /** Get a Project file's content. */
1608
+ getFileContent: (conf: {
1609
+ projectId: string;
1610
+ headers?: {
1611
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1612
+ "x-access-token"?: string | undefined;
1613
+ } | undefined;
1614
+ queryParameters?: {
1615
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1616
+ file?: string | undefined;
1617
+ inline?: boolean | undefined;
1618
+ } | undefined;
1619
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<string>;
1620
+ /** Get a Project's file/filesystem authorization token. */
1621
+ getJwt: (conf: {
1622
+ projectId: string;
1623
+ headers?: {
1624
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1625
+ "x-access-token"?: string | undefined;
1626
+ } | undefined;
1627
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1628
+ jwt: string;
1629
+ }>;
1630
+ /** Get a Project file's information. */
1631
+ listFiles: (conf: {
1632
+ projectId: string;
1633
+ headers?: {
1634
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1635
+ "x-access-token"?: string | undefined;
1636
+ } | undefined;
1637
+ queryParameters?: {
1638
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1639
+ file?: string | undefined;
1640
+ } | undefined;
1641
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1642
+ absolutePath: string;
1643
+ isDirectory?: boolean | undefined;
1644
+ isExecutable?: boolean | undefined;
1645
+ isFile?: boolean | undefined;
1646
+ isSymlink?: boolean | undefined;
1647
+ items?: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectFilesystemDirectoryListing[] | undefined;
1648
+ name: string;
1649
+ size: number;
1650
+ target?: string | undefined;
1651
+ }>;
1652
+ };
1653
+ declare const buildSshsftpUserApi: (baseClient: MittwaldAPIV2Client) => {
1654
+ /** Get all SFTPUsers for a Project. */
1655
+ sftpUserListSftpUsers: (conf: {
1656
+ projectId: string;
1657
+ headers?: {
1658
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1659
+ "x-access-token"?: string | undefined;
1660
+ } | undefined;
1661
+ queryParameters?: {
1662
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1663
+ limit?: number | undefined;
1664
+ skip?: number | undefined;
1665
+ } | undefined;
1666
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.SshuserSftpUser[]>;
1667
+ /** Get an SFTPUser. */
1668
+ sftpUserGetSftpUser: (conf: {
1669
+ sftpUserId: string;
1670
+ headers?: {
1671
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1672
+ "x-access-token"?: string | undefined;
1673
+ } | undefined;
1674
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1675
+ accessLevel: import("./types.js").MittwaldAPIV2.Components.Schemas.SshuserAccessLevel;
1676
+ active?: boolean | undefined;
1677
+ authUpdatedAt: string;
1678
+ createdAt: string;
1679
+ description: string;
1680
+ directories?: string[] | undefined;
1681
+ expiresAt?: string | undefined;
1682
+ hasPassword: boolean;
1683
+ id: string;
1684
+ projectId: string;
1685
+ publicKeys?: import("./types.js").MittwaldAPIV2.Components.Schemas.SshuserPublicKey[] | undefined;
1686
+ updatedAt?: string | undefined;
1687
+ userName: string;
1688
+ }>;
1689
+ /** Get all SSHUsers for a Project. */
1690
+ sshUserListSshUsers: (conf: {
1691
+ projectId: string;
1692
+ headers?: {
1693
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1694
+ "x-access-token"?: string | undefined;
1695
+ } | undefined;
1696
+ queryParameters?: {
1697
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1698
+ limit?: number | undefined;
1699
+ skip?: number | undefined;
1700
+ } | undefined;
1701
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.SshuserSshUser[]>;
1702
+ /** Get an SSHUser. */
1703
+ sshUserGetSshUser: (conf: {
1704
+ sshUserId: string;
1705
+ headers?: {
1706
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1707
+ "x-access-token"?: string | undefined;
1708
+ } | undefined;
1709
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1710
+ active?: boolean | undefined;
1711
+ authUpdatedAt: string;
1712
+ createdAt: string;
1713
+ description: string;
1714
+ expiresAt?: string | undefined;
1715
+ hasPassword: boolean;
1716
+ id: string;
1717
+ projectId: string;
1718
+ publicKeys?: import("./types.js").MittwaldAPIV2.Components.Schemas.SshuserPublicKey[] | undefined;
1719
+ updatedAt?: string | undefined;
1720
+ userName: string;
1721
+ }>;
1722
+ };
1723
+ declare const buildUserApi: (baseClient: MittwaldAPIV2Client) => {
1724
+ /** Get your verified Email-Address. */
1725
+ getOwnEmail: (conf?: {
1726
+ headers?: {
1727
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1728
+ "x-access-token"?: string | undefined;
1729
+ } | undefined;
1730
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<{
1731
+ email: string;
1732
+ }>;
1733
+ /** Get your current multi factor auth status. */
1734
+ getMfaStatus: (conf?: {
1735
+ headers?: {
1736
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1737
+ "x-access-token"?: string | undefined;
1738
+ } | undefined;
1739
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<{
1740
+ confirmed: boolean;
1741
+ initialized: boolean;
1742
+ }>;
1743
+ /** List all of your ApiTokens. */
1744
+ listApiTokens: (conf?: {
1745
+ headers?: {
1746
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1747
+ "x-access-token"?: string | undefined;
1748
+ } | undefined;
1749
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.SignupApiToken[]>;
1750
+ /** Get your stored ssh-keys. */
1751
+ listSshKeys: (conf?: {
1752
+ headers?: {
1753
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1754
+ "x-access-token"?: string | undefined;
1755
+ } | undefined;
1756
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<{
1757
+ sshKeys?: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupSshKey[] | undefined;
1758
+ }>;
1759
+ /** Get a specific ApiToken. */
1760
+ getApiToken: (conf: {
1761
+ apiTokenId: string;
1762
+ headers?: {
1763
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1764
+ "x-access-token"?: string | undefined;
1765
+ } | undefined;
1766
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1767
+ apiTokenId: string;
1768
+ createdAt: string;
1769
+ description: string;
1770
+ expiresAt?: string | undefined;
1771
+ roles: ("api_read" | "api_write")[];
1772
+ }>;
1773
+ /** Get a specific stored ssh-key. */
1774
+ getSshKey: (conf: {
1775
+ sshKeyId: string;
1776
+ headers?: {
1777
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1778
+ "x-access-token"?: string | undefined;
1779
+ } | undefined;
1780
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1781
+ sshKey: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupSshKey;
1782
+ }>;
1783
+ /** Get your account information. */
1784
+ getOwnAccount: (conf?: {
1785
+ headers?: {
1786
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1787
+ "x-access-token"?: string | undefined;
1788
+ } | undefined;
1789
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<{
1790
+ email?: string | undefined;
1791
+ mfaDetails?: {
1792
+ mfaConfirmed?: boolean | undefined;
1793
+ mfaInitialized?: boolean | undefined;
1794
+ } | undefined;
1795
+ passwordUpdatedAt?: string | undefined;
1796
+ person?: import("./types.js").MittwaldAPIV2.Components.Schemas.CommonsPerson | undefined;
1797
+ userId?: string | undefined;
1798
+ }>;
1799
+ /** The timestamp of your latest password change. */
1800
+ getPasswordUpdatedAt: (conf?: {
1801
+ headers?: {
1802
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1803
+ "x-access-token"?: string | undefined;
1804
+ } | undefined;
1805
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<{
1806
+ passwordUpdatedAt: string;
1807
+ }>;
1808
+ /** Get personalized settings. */
1809
+ getPersonalizedSettings: (conf: {
1810
+ userId: string;
1811
+ headers?: {
1812
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1813
+ "x-access-token"?: string | undefined;
1814
+ } | undefined;
1815
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1816
+ settingsString?: string | undefined;
1817
+ }>;
1818
+ /** Get a specific session. */
1819
+ getSession: (conf: {
1820
+ tokenId: string;
1821
+ headers?: {
1822
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1823
+ "x-access-token"?: string | undefined;
1824
+ } | undefined;
1825
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1826
+ created: string;
1827
+ device: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupDeviceInfo;
1828
+ lastAccess?: string | undefined;
1829
+ location?: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupLocation | undefined;
1830
+ tokenId: string;
1831
+ }>;
1832
+ /** Get profile information for a user. */
1833
+ getUser: (conf: {
1834
+ userId: string;
1835
+ headers?: {
1836
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1837
+ "x-access-token"?: string | undefined;
1838
+ } | undefined;
1839
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1840
+ avatarRef?: string | undefined;
1841
+ email?: string | undefined;
1842
+ person: import("./types.js").MittwaldAPIV2.Components.Schemas.CommonsPerson;
1843
+ phoneNumber?: string | undefined;
1844
+ registeredAt?: string | undefined;
1845
+ userId: string;
1846
+ }>;
1847
+ /** Submitted feedback of the given user. */
1848
+ listFeedback: (conf: {
1849
+ userId: string;
1850
+ headers?: {
1851
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1852
+ "x-access-token"?: string | undefined;
1853
+ } | undefined;
1854
+ queryParameters?: {
1855
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1856
+ subject?: string | undefined;
1857
+ } | undefined;
1858
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.UserUserFeedback[]>;
1859
+ /** List all sessions. */
1860
+ listSessions: (conf?: {
1861
+ headers?: {
1862
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1863
+ "x-access-token"?: string | undefined;
1864
+ } | undefined;
1865
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.SignupUserSession[]>;
1866
+ /** Request a support code. */
1867
+ supportCodeRequest: (conf?: {
1868
+ headers?: {
1869
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1870
+ "x-access-token"?: string | undefined;
1871
+ } | undefined;
1872
+ queryParameters?: {
1873
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1874
+ forceRecreate?: boolean | undefined;
1875
+ } | undefined;
1876
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<{
1877
+ expiresAt?: string | undefined;
1878
+ supportCode?: string | undefined;
1879
+ }>;
1880
+ };
1881
+ export declare class MittwaldAPIV2ClientReact {
1882
+ /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
1883
+ readonly app: ReturnType<typeof buildAppApi>;
1884
+ /** The article API allows you to read article information. */
1885
+ readonly article: ReturnType<typeof buildArticleApi>;
1886
+ /** The backup API allows you to manage your project backups. */
1887
+ readonly backup: ReturnType<typeof buildBackupApi>;
1888
+ /** The contract API allows you to manage your contracts and orders */
1889
+ readonly contract: ReturnType<typeof buildContractApi>;
1890
+ /** The conversation API allows you to manage your support conversations. */
1891
+ readonly conversation: ReturnType<typeof buildConversationApi>;
1892
+ /** The cronjob API allows you to manage cronjobs within a project. */
1893
+ readonly cronjob: ReturnType<typeof buildCronjobApi>;
1894
+ /** The customer API allows you to manage your own organizations and users. */
1895
+ readonly customer: ReturnType<typeof buildCustomerApi>;
1896
+ /** The database API allows you to manage your databases, like MySQL and Redis databases. */
1897
+ readonly database: ReturnType<typeof buildDatabaseApi>;
1898
+ /** The domain API allows you to manage your domains, DNS records and ingress resources. */
1899
+ readonly domain: ReturnType<typeof buildDomainApi>;
1900
+ /** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
1901
+ readonly file: ReturnType<typeof buildFileApi>;
1902
+ /** The mail API allows you to manage your mail accounts. */
1903
+ readonly mail: ReturnType<typeof buildMailApi>;
1904
+ /** The notification API allows you to manage your notifications. */
1905
+ readonly notification: ReturnType<typeof buildNotificationApi>;
1906
+ /** The project API allows you to manage your projects, and also any kinds of user memberships concerning these projects. */
1907
+ readonly project: ReturnType<typeof buildProjectApi>;
1908
+ /** The filesystem API allows you to directly access the filesystem of your project. */
1909
+ readonly projectFileSystem: ReturnType<typeof buildProjectFileSystemApi>;
1910
+ /** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
1911
+ readonly sshsftpUser: ReturnType<typeof buildSshsftpUserApi>;
1912
+ /** The user API allows you to manage your own user and access information of other users that might be visible to you. */
1913
+ readonly user: ReturnType<typeof buildUserApi>;
1914
+ private constructor();
1915
+ static fromBaseClient(baseClient: MittwaldAPIV2Client): MittwaldAPIV2ClientReact;
1916
+ }