@mittwald/api-client 3.1.57 → 3.1.59

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