@mittwald/api-client 3.1.55 → 3.1.57

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