@mittwald/api-client 4.404.0 → 4.405.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,3789 @@
1
+ import MittwaldAPIV3NextClient from "./client.js";
2
+ export * from "@mittwald/react-use-promise";
3
+ declare const buildAiHostingApi: (baseClient: MittwaldAPIV3NextClient) => {
4
+ /** Get a list of already created keys. */
5
+ customerGetKeys: (conf: {
6
+ customerId: string;
7
+ headers?: {
8
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
9
+ } | undefined;
10
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingKey[]>;
11
+ /** Get a key of a customer. */
12
+ customerGetKey: (conf: {
13
+ customerId: string;
14
+ keyId: string;
15
+ headers?: {
16
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
17
+ } | undefined;
18
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
19
+ containerMeta?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingContainerMeta | undefined;
20
+ customerId?: string | undefined;
21
+ isBlocked: boolean;
22
+ key: string;
23
+ keyId: string;
24
+ models: string[];
25
+ name: string;
26
+ projectId?: string | undefined;
27
+ rateLimit: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingRateLimit;
28
+ tokenUsage: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingTokenUsage;
29
+ }>;
30
+ /** Get a list of currently active models. */
31
+ customerGetDetailedModels: (conf: {
32
+ customerId: string;
33
+ headers?: {
34
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
35
+ } | undefined;
36
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingCustomerDetailedModel[]>;
37
+ /** Get ai hosting plan and usages of a customer. */
38
+ customerGetUsage: (conf: {
39
+ customerId: string;
40
+ headers?: {
41
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
42
+ } | undefined;
43
+ queryParameters?: {
44
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
45
+ topUsageCount?: number | undefined;
46
+ } | undefined;
47
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
48
+ customerId: string;
49
+ deletedAt?: string | undefined;
50
+ keys: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingPlanUsage;
51
+ modelTermsApprovalRequired: boolean;
52
+ nextTokenReset: string;
53
+ rateLimit: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingRateLimit;
54
+ tokens: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingPlanUsageBig;
55
+ topUsages?: {
56
+ keyId?: string;
57
+ name: string;
58
+ projectId?: string;
59
+ tokenUsed: number;
60
+ }[] | undefined;
61
+ }>;
62
+ /** Get a list of currently active models. */
63
+ getModels: (conf?: {
64
+ headers?: {
65
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
66
+ } | undefined;
67
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingModel[]>;
68
+ /** Get a list of keys of a project. */
69
+ projectGetKeys: (conf: {
70
+ projectId: string;
71
+ headers?: {
72
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
73
+ } | undefined;
74
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingKey[]>;
75
+ /** Get a key of a project. */
76
+ projectGetKey: (conf: {
77
+ projectId: string;
78
+ keyId: string;
79
+ headers?: {
80
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
81
+ } | undefined;
82
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
83
+ containerMeta?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingContainerMeta | undefined;
84
+ customerId?: string | undefined;
85
+ isBlocked: boolean;
86
+ key: string;
87
+ keyId: string;
88
+ models: string[];
89
+ name: string;
90
+ projectId?: string | undefined;
91
+ rateLimit: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingRateLimit;
92
+ tokenUsage: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingTokenUsage;
93
+ }>;
94
+ /** Get a list of currently active models. */
95
+ projectGetDetailedModels: (conf: {
96
+ projectId: string;
97
+ headers?: {
98
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
99
+ } | undefined;
100
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingProjectDetailedModel[]>;
101
+ /** Get ai hosting plan and usages of a project. Same as the customer route, but less details. */
102
+ projectGetUsage: (conf: {
103
+ projectId: string;
104
+ headers?: {
105
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
106
+ } | undefined;
107
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
108
+ keys: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AihostingPlanUsage;
109
+ modelTermsApprovalRequired: boolean;
110
+ nextTokenReset?: string | undefined;
111
+ projectId: string;
112
+ }>;
113
+ };
114
+ declare const buildAppApi: (baseClient: MittwaldAPIV3NextClient) => {
115
+ /** Get an App. */
116
+ getApp: (conf: {
117
+ appId: string;
118
+ headers?: {
119
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
120
+ "x-access-token"?: string | undefined;
121
+ } | undefined;
122
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
123
+ actionCapabilities?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppActionCapabilities | undefined;
124
+ id: string;
125
+ name: string;
126
+ tags: string[];
127
+ }>;
128
+ /** Get an AppInstallation. */
129
+ getAppinstallation: (conf: {
130
+ appInstallationId: string;
131
+ headers?: {
132
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
133
+ "x-access-token"?: string | undefined;
134
+ } | undefined;
135
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
136
+ appExternalVersion: string;
137
+ appId: string;
138
+ appName: string;
139
+ appVersion: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppVersionStatus;
140
+ createdAt: string;
141
+ customDocumentRoot?: string | undefined;
142
+ deletionRequested?: boolean | undefined;
143
+ description: string;
144
+ disabled: boolean;
145
+ hostname?: string | undefined;
146
+ id: string;
147
+ installationPath: string;
148
+ lastError?: string | undefined;
149
+ linkedDatabases: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppLinkedDatabase[];
150
+ lockedBy?: {
151
+ [k: string]: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppLockPurpose;
152
+ } | undefined;
153
+ phase: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppPhase;
154
+ ports?: {
155
+ name?: string;
156
+ port?: number;
157
+ }[] | undefined;
158
+ projectDescription: string;
159
+ projectId: string;
160
+ screenshotId?: string | undefined;
161
+ screenshotRef?: string | undefined;
162
+ shortId: string;
163
+ systemSoftware: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppInstalledSystemSoftware[];
164
+ updateAvailable: boolean;
165
+ updatePolicy: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppAppUpdatePolicy;
166
+ userInputs: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppSavedUserInput[];
167
+ }>;
168
+ /** Get an AppVersion. */
169
+ getAppversion: (conf: {
170
+ appId: string;
171
+ appVersionId: string;
172
+ headers?: {
173
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
174
+ "x-access-token"?: string | undefined;
175
+ } | undefined;
176
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
177
+ appId: string;
178
+ backendPathTemplate?: string | undefined;
179
+ breakingNote?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppBreakingNote | undefined;
180
+ databases?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppDatabaseDependency[] | undefined;
181
+ defaultCronjobs?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppDefaultCronjob[] | undefined;
182
+ docRoot: string;
183
+ docRootUserEditable: boolean;
184
+ externalVersion: string;
185
+ id: string;
186
+ internalVersion: string;
187
+ recommended?: boolean | undefined;
188
+ requestHandler?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppRequestHandlerRequirement | undefined;
189
+ systemSoftwareDependencies?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppSystemSoftwareDependency[] | undefined;
190
+ userInputs?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppUserInput[] | undefined;
191
+ }>;
192
+ /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
193
+ getInstalledSystemsoftwareForAppinstallation: (conf: {
194
+ appInstallationId: string;
195
+ headers?: {
196
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
197
+ "x-access-token"?: string | undefined;
198
+ } | undefined;
199
+ queryParameters?: {
200
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
201
+ tagFilter?: string | undefined;
202
+ } | undefined;
203
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppSystemSoftware[]>;
204
+ /** Get the missing requirements of an appInstallation for a specific target AppVersion. */
205
+ getMissingDependenciesForAppinstallation: (conf: {
206
+ queryParameters: {
207
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
208
+ targetAppVersionID: string;
209
+ };
210
+ appInstallationId: string;
211
+ headers?: {
212
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
213
+ "x-access-token"?: string | undefined;
214
+ } | undefined;
215
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
216
+ missingSystemSoftwareDependencies?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppSystemSoftwareDependency[] | undefined;
217
+ missingUserInputs?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppUserInput[] | undefined;
218
+ }>;
219
+ /** Get a SystemSoftware. */
220
+ getSystemsoftware: (conf: {
221
+ systemSoftwareId: string;
222
+ headers?: {
223
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
224
+ "x-access-token"?: string | undefined;
225
+ } | undefined;
226
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
227
+ id: string;
228
+ meta?: {
229
+ [k: string]: string;
230
+ } | undefined;
231
+ name: string;
232
+ tags: string[];
233
+ }>;
234
+ /** Get a SystemSoftwareVersion. */
235
+ getSystemsoftwareversion: (conf: {
236
+ systemSoftwareId: string;
237
+ systemSoftwareVersionId: string;
238
+ headers?: {
239
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
240
+ "x-access-token"?: string | undefined;
241
+ } | undefined;
242
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
243
+ expiryDate?: string | undefined;
244
+ externalVersion: string;
245
+ fee?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.FeeFeeStrategy | undefined;
246
+ id: string;
247
+ internalVersion: string;
248
+ recommended?: boolean | undefined;
249
+ systemSoftwareDependencies?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppSystemSoftwareDependency[] | undefined;
250
+ userInputs?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppUserInput[] | undefined;
251
+ }>;
252
+ /** List AppInstallations that a user has access to. */
253
+ listAppinstallationsForUser: (conf?: {
254
+ headers?: {
255
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
256
+ "x-access-token"?: string | undefined;
257
+ } | undefined;
258
+ queryParameters?: {
259
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
260
+ appIds?: string[] | undefined;
261
+ searchTerm?: string | undefined;
262
+ sortOrder?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppAppInstallationSortOrder | undefined;
263
+ limit?: number | undefined;
264
+ skip?: number | undefined;
265
+ page?: number | undefined;
266
+ } | undefined;
267
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppAppInstallation[]>;
268
+ /** List AppInstallations belonging to a Project. */
269
+ listAppinstallations: (conf: {
270
+ projectId: string;
271
+ headers?: {
272
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
273
+ "x-access-token"?: string | undefined;
274
+ } | undefined;
275
+ queryParameters?: {
276
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
277
+ appIds?: string[] | undefined;
278
+ searchTerm?: string | undefined;
279
+ sortOrder?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppAppInstallationSortOrder | undefined;
280
+ limit?: number | undefined;
281
+ skip?: number | undefined;
282
+ page?: number | undefined;
283
+ } | undefined;
284
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppAppInstallation[]>;
285
+ /** List Apps. */
286
+ listApps: (conf?: {
287
+ headers?: {
288
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
289
+ } | undefined;
290
+ queryParameters?: {
291
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
292
+ limit?: number | undefined;
293
+ skip?: number | undefined;
294
+ page?: number | undefined;
295
+ } | undefined;
296
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppApp[]>;
297
+ /** List AppVersions belonging to an App. */
298
+ listAppversions: (conf: {
299
+ appId: string;
300
+ headers?: {
301
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
302
+ "x-access-token"?: string | undefined;
303
+ } | undefined;
304
+ queryParameters?: {
305
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
306
+ versionRange?: string | undefined;
307
+ recommended?: boolean | undefined;
308
+ } | undefined;
309
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppAppVersion[]>;
310
+ /** List SystemSoftwares. */
311
+ listSystemsoftwares: (conf?: {
312
+ headers?: {
313
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
314
+ "x-access-token"?: string | undefined;
315
+ } | undefined;
316
+ queryParameters?: {
317
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
318
+ limit?: number | undefined;
319
+ skip?: number | undefined;
320
+ page?: number | undefined;
321
+ } | undefined;
322
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppSystemSoftware[]>;
323
+ /** List SystemSoftwareVersions belonging to a SystemSoftware. */
324
+ listSystemsoftwareversions: (conf: {
325
+ systemSoftwareId: string;
326
+ headers?: {
327
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
328
+ "x-access-token"?: string | undefined;
329
+ } | undefined;
330
+ queryParameters?: {
331
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
332
+ versionRange?: string | undefined;
333
+ recommended?: boolean | undefined;
334
+ } | undefined;
335
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppSystemSoftwareVersion[]>;
336
+ /** List update candidates belonging to an AppVersion. */
337
+ listUpdateCandidatesForAppversion: (conf: {
338
+ appId: string;
339
+ baseAppVersionId: string;
340
+ headers?: {
341
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
342
+ "x-access-token"?: string | undefined;
343
+ } | undefined;
344
+ queryParameters?: {
345
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
346
+ onlyRecommended?: boolean | undefined;
347
+ } | undefined;
348
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.AppAppVersion[]>;
349
+ /** Get runtime status belonging to an AppInstallation. */
350
+ retrieveStatus: (conf: {
351
+ appInstallationId: string;
352
+ headers?: {
353
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
354
+ } | undefined;
355
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
356
+ lastExitCode?: number | undefined;
357
+ logFileLocation: string;
358
+ state: "running" | "stopped" | "exited";
359
+ uptimeSeconds?: number | undefined;
360
+ }>;
361
+ };
362
+ declare const buildArticleApi: (baseClient: MittwaldAPIV3NextClient) => {
363
+ /** Get an Article. */
364
+ getArticle: (conf: {
365
+ articleId: string;
366
+ headers?: {
367
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
368
+ } | undefined;
369
+ queryParameters?: {
370
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
371
+ customerId?: string | undefined;
372
+ } | undefined;
373
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
374
+ addons?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ArticleArticleAddons[] | undefined;
375
+ articleId: string;
376
+ attributes?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ArticleArticleAttributes[] | undefined;
377
+ balanceAddonKey?: string | undefined;
378
+ contractDurationInMonth: number;
379
+ description?: string | undefined;
380
+ forcedInvoicingPeriodInMonth?: number | undefined;
381
+ hasIndependentContractPeriod?: boolean | undefined;
382
+ hideOnInvoice?: boolean | undefined;
383
+ machineType?: {
384
+ cpu: string;
385
+ memory: string;
386
+ name: string;
387
+ } | undefined;
388
+ modifierArticles?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ArticleReadableModifierArticleOptions[] | undefined;
389
+ name: string;
390
+ orderable: "full" | "forbidden" | "internal" | "beta_testing" | "deprecated";
391
+ possibleArticleChanges?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ArticleReadableChangeArticleOptions[] | undefined;
392
+ price?: number | undefined;
393
+ tags?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ArticleArticleTag[] | undefined;
394
+ template: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ArticleArticleTemplate;
395
+ }>;
396
+ /** List Articles. */
397
+ listArticles: (conf?: {
398
+ headers?: {
399
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
400
+ } | undefined;
401
+ queryParameters?: {
402
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
403
+ customerId?: string | undefined;
404
+ tags?: string[] | undefined;
405
+ templateNames?: string[] | undefined;
406
+ articleIds?: string[] | undefined;
407
+ orderable?: ("forbidden" | "internal" | "beta_testing" | "full" | "deprecated")[] | undefined;
408
+ name?: string | undefined;
409
+ limit?: number | undefined;
410
+ skip?: number | undefined;
411
+ page?: number | undefined;
412
+ } | undefined;
413
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ArticleReadableArticle[]>;
414
+ };
415
+ declare const buildBackupApi: (baseClient: MittwaldAPIV3NextClient) => {
416
+ /** List BackupSchedules belonging to a Project. */
417
+ listProjectBackupSchedules: (conf: {
418
+ projectId: string;
419
+ headers?: {
420
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
421
+ "x-access-token"?: string | undefined;
422
+ } | undefined;
423
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.BackupProjectBackupSchedule[]>;
424
+ /** List Backups belonging to a Project. */
425
+ listProjectBackups: (conf: {
426
+ projectId: string;
427
+ headers?: {
428
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
429
+ "x-access-token"?: string | undefined;
430
+ } | undefined;
431
+ queryParameters?: {
432
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
433
+ searchTerm?: string | undefined;
434
+ withExportsOnly?: boolean | undefined;
435
+ sortOrder?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.BackupBackupSortOrder | undefined;
436
+ runningRestoresOnly?: boolean | undefined;
437
+ runningBackupsOnly?: boolean | undefined;
438
+ limit?: number | undefined;
439
+ skip?: number | undefined;
440
+ page?: number | undefined;
441
+ } | undefined;
442
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.BackupProjectBackup[]>;
443
+ /** Get a ProjectBackupSchedule. */
444
+ getProjectBackupSchedule: (conf: {
445
+ projectBackupScheduleId: string;
446
+ headers?: {
447
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
448
+ "x-access-token"?: string | undefined;
449
+ } | undefined;
450
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
451
+ createdAt?: string | undefined;
452
+ description?: string | undefined;
453
+ id: string;
454
+ isSystemBackup: boolean;
455
+ projectId: string;
456
+ schedule: string;
457
+ ttl?: string | undefined;
458
+ updatedAt?: string | undefined;
459
+ }>;
460
+ /** Get a ProjectBackup. */
461
+ getProjectBackup: (conf: {
462
+ projectBackupId: string;
463
+ headers?: {
464
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
465
+ "x-access-token"?: string | undefined;
466
+ } | undefined;
467
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
468
+ createdAt?: string | undefined;
469
+ deletable: boolean;
470
+ description?: string | undefined;
471
+ expiresAt?: string | undefined;
472
+ export?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.BackupProjectBackupExport | undefined;
473
+ id: string;
474
+ parentId?: string | undefined;
475
+ projectId: string;
476
+ requestedAt: string;
477
+ restore?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.BackupProjectBackupRestore | undefined;
478
+ restorePath?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.BackupProjectBackupRestorePathDeprecated | undefined;
479
+ status: string;
480
+ }>;
481
+ /** List database dump's for a ProjectBackup. */
482
+ getProjectBackupDatabaseDumps: (conf: {
483
+ projectBackupId: string;
484
+ headers?: {
485
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
486
+ "x-access-token"?: string | undefined;
487
+ } | undefined;
488
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
489
+ databases: string[];
490
+ }>;
491
+ /** List paths for a ProjectBackup. */
492
+ getProjectBackupDirectories: (conf: {
493
+ projectBackupId: string;
494
+ headers?: {
495
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
496
+ "x-access-token"?: string | undefined;
497
+ } | undefined;
498
+ queryParameters?: {
499
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
500
+ directory?: string | undefined;
501
+ } | undefined;
502
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
503
+ absolutePath: string;
504
+ isDirectory?: boolean | undefined;
505
+ isExecutable?: boolean | undefined;
506
+ isFile?: boolean | undefined;
507
+ isSymlink?: boolean | undefined;
508
+ items?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.BackupProjectBackupPath[] | undefined;
509
+ name: string;
510
+ size: number;
511
+ target?: string | undefined;
512
+ }>;
513
+ };
514
+ declare const buildContainerApi: (baseClient: MittwaldAPIV3NextClient) => {
515
+ /** Call pull-image webhook */
516
+ callPullImageWebhookForService: (conf: {
517
+ queryParameters: {
518
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
519
+ token: string;
520
+ };
521
+ stackId: string;
522
+ headers?: {
523
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
524
+ } | undefined;
525
+ }) => import("@mittwald/react-use-promise").AsyncResource<never>;
526
+ /** List Registries belonging to a Project. */
527
+ listRegistries: (conf: {
528
+ projectId: string;
529
+ headers?: {
530
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
531
+ "x-access-token"?: string | undefined;
532
+ } | undefined;
533
+ queryParameters?: {
534
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
535
+ hasCredentials?: boolean | undefined;
536
+ limit?: number | undefined;
537
+ skip?: number | undefined;
538
+ page?: number | undefined;
539
+ } | undefined;
540
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerRegistry[]>;
541
+ /** List Stacks belonging to a Project. */
542
+ listStacks: (conf: {
543
+ projectId: string;
544
+ headers?: {
545
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
546
+ "x-access-token"?: string | undefined;
547
+ } | undefined;
548
+ queryParameters?: {
549
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
550
+ limit?: number | undefined;
551
+ skip?: number | undefined;
552
+ page?: number | undefined;
553
+ } | undefined;
554
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerStackResponse[]>;
555
+ /** Get a Stack. */
556
+ getStack: (conf: {
557
+ stackId: string;
558
+ headers?: {
559
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
560
+ "x-access-token"?: string | undefined;
561
+ } | undefined;
562
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
563
+ description: string;
564
+ disabled: boolean;
565
+ id: string;
566
+ prefix: string;
567
+ projectId: string;
568
+ services?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerServiceResponse[] | undefined;
569
+ templateId?: string | undefined;
570
+ updateSchedule?: {
571
+ cron: string;
572
+ timezone?: string;
573
+ } | null | undefined;
574
+ volumes?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerVolumeResponse[] | undefined;
575
+ }>;
576
+ /** Get a Registry. */
577
+ getRegistry: (conf: {
578
+ registryId: string;
579
+ headers?: {
580
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
581
+ "x-access-token"?: string | undefined;
582
+ } | undefined;
583
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
584
+ credentials?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerRegistryCredentials | undefined;
585
+ description: string;
586
+ id: string;
587
+ projectId: string;
588
+ uri: string;
589
+ }>;
590
+ /** Get a Volume belonging to a Stack. */
591
+ getVolume: (conf: {
592
+ stackId: string;
593
+ volumeId: string;
594
+ headers?: {
595
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
596
+ "x-access-token"?: string | undefined;
597
+ } | undefined;
598
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
599
+ id: string;
600
+ linkedServices?: string[] | undefined;
601
+ name: string;
602
+ orphaned: boolean;
603
+ stackId: string;
604
+ storageUsageInBytes: number;
605
+ storageUsageInBytesSetAt: string;
606
+ }>;
607
+ /** Get a ContainerImageConfig. */
608
+ getContainerImageConfig: (conf: {
609
+ queryParameters: {
610
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
611
+ imageReference: string;
612
+ useCredentialsForProjectId?: string | undefined;
613
+ useCredentialsForRegistryId?: string | undefined;
614
+ generateAiData?: boolean | undefined;
615
+ };
616
+ headers?: {
617
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
618
+ "x-access-token"?: string | undefined;
619
+ } | undefined;
620
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
621
+ command?: string[] | undefined;
622
+ digest: string;
623
+ entrypoint?: string[] | undefined;
624
+ env?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerContainerImageConfigEnv[] | undefined;
625
+ exposedPorts?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerContainerImageConfigExposedPort[] | undefined;
626
+ hasAiGeneratedData: boolean;
627
+ isAiAvailable: boolean;
628
+ isUserRoot: boolean;
629
+ overwritingUser?: number | undefined;
630
+ user: string;
631
+ userId: number;
632
+ volumes?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerContainerImageConfigVolume[] | undefined;
633
+ }>;
634
+ /** Get logs belonging to a Service. */
635
+ getServiceLogs: (conf: {
636
+ stackId: string;
637
+ serviceId: string;
638
+ headers?: {
639
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
640
+ "x-access-token"?: string | undefined;
641
+ } | undefined;
642
+ queryParameters?: {
643
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
644
+ tail?: number | undefined;
645
+ } | undefined;
646
+ }) => import("@mittwald/react-use-promise").AsyncResource<string>;
647
+ /** Get a Service belonging to a Stack. */
648
+ getService: (conf: {
649
+ stackId: string;
650
+ serviceId: string;
651
+ headers?: {
652
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
653
+ "x-access-token"?: string | undefined;
654
+ } | undefined;
655
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
656
+ deploy?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerDeploy | undefined;
657
+ deployedState: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerServiceState;
658
+ description: string;
659
+ id: string;
660
+ message?: string | undefined;
661
+ pendingState: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerServiceState;
662
+ projectId: string;
663
+ requiresRecreate: boolean;
664
+ restartPolicy?: "no" | "always" | "on-failure" | "unless-stopped" | undefined;
665
+ serviceName: string;
666
+ shortId: string;
667
+ stackId: string;
668
+ status: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerServiceStatus;
669
+ statusSetAt: string;
670
+ }>;
671
+ /** Get a Container Template icon. */
672
+ getTemplateIcon: (conf: {
673
+ templateId: string;
674
+ headers?: {
675
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
676
+ } | undefined;
677
+ }) => import("@mittwald/react-use-promise").AsyncResource<string>;
678
+ /** Get a Container Template by ID. */
679
+ getTemplate: (conf: {
680
+ templateId: string;
681
+ headers?: {
682
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
683
+ } | undefined;
684
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
685
+ categories: string[];
686
+ description: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerTemplateTranslatedString;
687
+ developer: string;
688
+ domains?: {
689
+ port: string;
690
+ purpose?: string;
691
+ service: string;
692
+ userInput: string;
693
+ }[] | undefined;
694
+ help?: {
695
+ alerts?: {
696
+ content: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerTemplateTranslatedString;
697
+ heading: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerTemplateTranslatedString;
698
+ link?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerTemplateTranslatedString;
699
+ linkText?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerTemplateTranslatedString;
700
+ status: string;
701
+ }[];
702
+ technicalDetails?: {
703
+ key: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerTemplateTranslatedString;
704
+ value: string;
705
+ }[];
706
+ } | undefined;
707
+ iconUrl: string;
708
+ id: string;
709
+ license?: {
710
+ link?: string;
711
+ name: string;
712
+ } | undefined;
713
+ manifestVersion: string;
714
+ name: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerTemplateTranslatedString;
715
+ repository?: string | undefined;
716
+ supportLink?: string | undefined;
717
+ tagline: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerTemplateTranslatedString;
718
+ userInputs?: {
719
+ dataSource?: string;
720
+ defaultValue?: string;
721
+ label?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerTemplateTranslatedString;
722
+ name: string;
723
+ required: boolean;
724
+ validationSchema?: string;
725
+ }[] | undefined;
726
+ version: string;
727
+ website?: string | undefined;
728
+ }>;
729
+ /** List Stacks belonging to the executing user. */
730
+ listSelfStacks: (conf?: {
731
+ headers?: {
732
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
733
+ "x-access-token"?: string | undefined;
734
+ } | undefined;
735
+ queryParameters?: {
736
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
737
+ searchTerm?: string | undefined;
738
+ limit?: number | undefined;
739
+ skip?: number | undefined;
740
+ page?: number | undefined;
741
+ } | undefined;
742
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerStackResponse[]>;
743
+ /** List Services belonging to a Project. */
744
+ listServices: (conf: {
745
+ projectId: string;
746
+ headers?: {
747
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
748
+ "x-access-token"?: string | undefined;
749
+ } | undefined;
750
+ queryParameters?: {
751
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
752
+ stackId?: string | undefined;
753
+ status?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerServiceStatus | undefined;
754
+ requiresRecreate?: boolean | undefined;
755
+ searchTerm?: string | undefined;
756
+ sortOrder?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerServiceSortOrder | undefined;
757
+ limit?: number | undefined;
758
+ skip?: number | undefined;
759
+ page?: number | undefined;
760
+ } | undefined;
761
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerServiceResponse[]>;
762
+ /** List Volumes belonging to a Stack. */
763
+ listStackVolumes: (conf: {
764
+ stackId: string;
765
+ headers?: {
766
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
767
+ "x-access-token"?: string | undefined;
768
+ } | undefined;
769
+ queryParameters?: {
770
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
771
+ searchTerm?: string | undefined;
772
+ sortOrder?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerVolumeSortOrder | undefined;
773
+ limit?: number | undefined;
774
+ skip?: number | undefined;
775
+ page?: number | undefined;
776
+ } | undefined;
777
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerVolumeResponse[]>;
778
+ /** List Container Templates. */
779
+ listTemplates: (conf?: {
780
+ headers?: {
781
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
782
+ } | undefined;
783
+ queryParameters?: {
784
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
785
+ category?: string | undefined;
786
+ searchTerm?: string | undefined;
787
+ type?: "component" | "standalone" | undefined;
788
+ limit?: number | undefined;
789
+ skip?: number | undefined;
790
+ page?: number | undefined;
791
+ } | undefined;
792
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerTemplate[]>;
793
+ /** List Volumes belonging to a Project. */
794
+ listVolumes: (conf: {
795
+ projectId: string;
796
+ headers?: {
797
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
798
+ "x-access-token"?: string | undefined;
799
+ } | undefined;
800
+ queryParameters?: {
801
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
802
+ stackId?: string | undefined;
803
+ searchTerm?: string | undefined;
804
+ sortOrder?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerVolumeSortOrder | undefined;
805
+ limit?: number | undefined;
806
+ skip?: number | undefined;
807
+ page?: number | undefined;
808
+ } | undefined;
809
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContainerVolumeResponse[]>;
810
+ };
811
+ declare const buildContractApi: (baseClient: MittwaldAPIV3NextClient) => {
812
+ /** Return the BaseItem of the Contract with the given ID. */
813
+ getBaseItemOfContract: (conf: {
814
+ contractId: string;
815
+ headers?: {
816
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
817
+ "x-access-token"?: string | undefined;
818
+ } | undefined;
819
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
820
+ activationDate?: string | undefined;
821
+ aggregateReference?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractAggregateReference | undefined;
822
+ articles: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractArticle[];
823
+ contractPeriod: number;
824
+ description: string;
825
+ freeTrialDays?: number | undefined;
826
+ groupByProjectId?: string | undefined;
827
+ invoiceStop?: string | undefined;
828
+ invoicingPeriod?: number | undefined;
829
+ isActivated: boolean;
830
+ isBaseItem: boolean;
831
+ isInFreeTrial?: boolean | undefined;
832
+ isInclusive?: boolean | undefined;
833
+ itemId: string;
834
+ nextPossibleDowngradeDate?: string | undefined;
835
+ nextPossibleTerminationDate?: string | undefined;
836
+ nextPossibleUpgradeDate?: string | undefined;
837
+ orderDate?: string | undefined;
838
+ orderId?: string | undefined;
839
+ replacedByItem?: string | undefined;
840
+ tariffChange?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractTariffChange | undefined;
841
+ termination?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractTermination | undefined;
842
+ totalPrice: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractPrice;
843
+ }>;
844
+ /** Return the AI Hosting Contract for the given Customer. */
845
+ getDetailOfContractByAiHosting: (conf: {
846
+ customerId: string;
847
+ headers?: {
848
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
849
+ "x-access-token"?: string | undefined;
850
+ } | undefined;
851
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
852
+ additionalItems?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem[] | undefined;
853
+ baseItem: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem;
854
+ contractId: string;
855
+ contractNumber: string;
856
+ customerId: string;
857
+ termination?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractTermination | undefined;
858
+ }>;
859
+ /** Return the Contract for the given Certificate. */
860
+ getDetailOfContractByCertificate: (conf: {
861
+ certificateId: string;
862
+ headers?: {
863
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
864
+ "x-access-token"?: string | undefined;
865
+ } | undefined;
866
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
867
+ additionalItems?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem[] | undefined;
868
+ baseItem: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem;
869
+ contractId: string;
870
+ contractNumber: string;
871
+ customerId: string;
872
+ termination?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractTermination | undefined;
873
+ }>;
874
+ /** Return the Contract for the given Domain. */
875
+ getDetailOfContractByDomain: (conf: {
876
+ domainId: string;
877
+ headers?: {
878
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
879
+ "x-access-token"?: string | undefined;
880
+ } | undefined;
881
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
882
+ additionalItems?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem[] | undefined;
883
+ baseItem: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem;
884
+ contractId: string;
885
+ contractNumber: string;
886
+ customerId: string;
887
+ termination?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractTermination | undefined;
888
+ }>;
889
+ /** Return the Contract for the given LeadFyndrProfile. */
890
+ getDetailOfContractByLeadFyndr: (conf: {
891
+ customerId: string;
892
+ headers?: {
893
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
894
+ "x-access-token"?: string | undefined;
895
+ } | undefined;
896
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
897
+ additionalItems?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem[] | undefined;
898
+ baseItem: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem;
899
+ contractId: string;
900
+ contractNumber: string;
901
+ customerId: string;
902
+ termination?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractTermination | undefined;
903
+ }>;
904
+ /** Return the Contract for the given License. */
905
+ getDetailOfContractByLicense: (conf: {
906
+ licenseId: string;
907
+ headers?: {
908
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
909
+ "x-access-token"?: string | undefined;
910
+ } | undefined;
911
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
912
+ additionalItems?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem[] | undefined;
913
+ baseItem: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem;
914
+ contractId: string;
915
+ contractNumber: string;
916
+ customerId: string;
917
+ termination?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractTermination | undefined;
918
+ }>;
919
+ /** Return the Contract for the given Mail Address. */
920
+ getDetailOfContractByMailAddress: (conf: {
921
+ mailAddressId: string;
922
+ headers?: {
923
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
924
+ "x-access-token"?: string | undefined;
925
+ } | undefined;
926
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
927
+ additionalItems?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem[] | undefined;
928
+ baseItem: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem;
929
+ contractId: string;
930
+ contractNumber: string;
931
+ customerId: string;
932
+ termination?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractTermination | undefined;
933
+ }>;
934
+ /** Return the Contract for the given Project. */
935
+ getDetailOfContractByProject: (conf: {
936
+ projectId: string;
937
+ headers?: {
938
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
939
+ "x-access-token"?: string | undefined;
940
+ } | undefined;
941
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
942
+ additionalItems?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem[] | undefined;
943
+ baseItem: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem;
944
+ contractId: string;
945
+ contractNumber: string;
946
+ customerId: string;
947
+ termination?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractTermination | undefined;
948
+ }>;
949
+ /** Return the Contract for the given Server. */
950
+ getDetailOfContractByServer: (conf: {
951
+ serverId: string;
952
+ headers?: {
953
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
954
+ "x-access-token"?: string | undefined;
955
+ } | undefined;
956
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
957
+ additionalItems?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem[] | undefined;
958
+ baseItem: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem;
959
+ contractId: string;
960
+ contractNumber: string;
961
+ customerId: string;
962
+ termination?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractTermination | undefined;
963
+ }>;
964
+ /** Get the ContractItem with the given ID. */
965
+ getDetailOfContractItem: (conf: {
966
+ contractId: string;
967
+ contractItemId: string;
968
+ headers?: {
969
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
970
+ "x-access-token"?: string | undefined;
971
+ } | undefined;
972
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
973
+ activationDate?: string | undefined;
974
+ aggregateReference?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractAggregateReference | undefined;
975
+ articles: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractArticle[];
976
+ contractPeriod: number;
977
+ description: string;
978
+ freeTrialDays?: number | undefined;
979
+ groupByProjectId?: string | undefined;
980
+ invoiceStop?: string | undefined;
981
+ invoicingPeriod?: number | undefined;
982
+ isActivated: boolean;
983
+ isBaseItem: boolean;
984
+ isInFreeTrial?: boolean | undefined;
985
+ isInclusive?: boolean | undefined;
986
+ itemId: string;
987
+ nextPossibleDowngradeDate?: string | undefined;
988
+ nextPossibleTerminationDate?: string | undefined;
989
+ nextPossibleUpgradeDate?: string | undefined;
990
+ orderDate?: string | undefined;
991
+ orderId?: string | undefined;
992
+ replacedByItem?: string | undefined;
993
+ tariffChange?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractTariffChange | undefined;
994
+ termination?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractTermination | undefined;
995
+ totalPrice: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractPrice;
996
+ }>;
997
+ /** Returns the Contract with the given ID. */
998
+ getDetailOfContract: (conf: {
999
+ contractId: 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
+ additionalItems?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem[] | undefined;
1006
+ baseItem: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContractItem;
1007
+ contractId: string;
1008
+ contractNumber: string;
1009
+ customerId: string;
1010
+ termination?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractTermination | undefined;
1011
+ }>;
1012
+ /** Return a list of Contracts for the given Customer. */
1013
+ listContracts: (conf: {
1014
+ customerId: string;
1015
+ headers?: {
1016
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1017
+ "x-access-token"?: string | undefined;
1018
+ } | undefined;
1019
+ queryParameters?: {
1020
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1021
+ limit?: number | undefined;
1022
+ skip?: number | undefined;
1023
+ page?: number | undefined;
1024
+ } | undefined;
1025
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ContractContract[]>;
1026
+ /** Get details of an Invoice. */
1027
+ invoiceDetail: (conf: {
1028
+ invoiceId: string;
1029
+ headers?: {
1030
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1031
+ "x-access-token"?: string | undefined;
1032
+ } | undefined;
1033
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1034
+ amountPaid: number;
1035
+ cancellation?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.InvoiceCancellation | undefined;
1036
+ cancellationOf?: string | undefined;
1037
+ currency: string;
1038
+ customerId: string;
1039
+ date: string;
1040
+ groups: {
1041
+ contractId?: string;
1042
+ description?: string;
1043
+ items: import("./types.js").MittwaldAPIV3Next.Components.Schemas.InvoiceInvoiceItem[];
1044
+ }[];
1045
+ id: string;
1046
+ invoiceNumber: string;
1047
+ invoiceType: "REGULAR" | "REISSUE" | "CORRECTION" | "CANCELLATION";
1048
+ paymentSettings?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.InvoicePaymentSettings | undefined;
1049
+ pdfId: string;
1050
+ recipient: import("./types.js").MittwaldAPIV3Next.Components.Schemas.InvoiceRecipient;
1051
+ reissuedBy?: string | undefined;
1052
+ status: "NEW" | "CONFIRMED" | "DENIED" | "PAID" | "PARTIALLY_PAID" | "OVERPAID";
1053
+ totalGross: number;
1054
+ totalNet: number;
1055
+ vatId?: string | undefined;
1056
+ }>;
1057
+ /** Get InvoiceSettings of a Customer. */
1058
+ invoiceGetDetailOfInvoiceSettings: (conf: {
1059
+ customerId: string;
1060
+ headers?: {
1061
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1062
+ "x-access-token"?: string | undefined;
1063
+ } | undefined;
1064
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1065
+ additionalEmailRecipients?: string[] | undefined;
1066
+ debitPaymentStopUntil?: string | undefined;
1067
+ id: string;
1068
+ invoicePeriod?: number | undefined;
1069
+ lastBankingInformation?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.InvoiceBankingInformation | undefined;
1070
+ paymentSettings?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.InvoicePaymentSettings | undefined;
1071
+ printedInvoices?: boolean | undefined;
1072
+ recipient?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.InvoiceRecipient | undefined;
1073
+ recipientSameAsOwner?: boolean | undefined;
1074
+ status?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.InvoiceInvoiceSettingsStatus[] | undefined;
1075
+ targetDay?: number | undefined;
1076
+ }>;
1077
+ /** Request an Access Token for the Invoice file. */
1078
+ invoiceGetFileAccessToken: (conf: {
1079
+ customerId: string;
1080
+ invoiceId: string;
1081
+ headers?: {
1082
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1083
+ "x-access-token"?: string | undefined;
1084
+ } | undefined;
1085
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1086
+ accessToken: string;
1087
+ expiresAt: string;
1088
+ }>;
1089
+ /** List Invoices of a Customer. */
1090
+ invoiceListCustomerInvoices: (conf: {
1091
+ customerId: string;
1092
+ headers?: {
1093
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1094
+ "x-access-token"?: string | undefined;
1095
+ } | undefined;
1096
+ queryParameters?: {
1097
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1098
+ invoiceTypes?: ("REGULAR" | "REISSUE" | "CORRECTION" | "CANCELLATION")[] | undefined;
1099
+ status?: ("CONFIRMED" | "PAID" | "PARTIALLY_PAID" | "OVERPAID")[] | undefined;
1100
+ search?: string | undefined;
1101
+ limit?: number | undefined;
1102
+ skip?: number | undefined;
1103
+ page?: number | undefined;
1104
+ sort?: "invoiceNumber"[] | undefined;
1105
+ order?: ("asc" | "desc")[] | undefined;
1106
+ } | undefined;
1107
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.InvoiceInvoice[]>;
1108
+ /** Get list of Orders. */
1109
+ orderListOrders: (conf?: {
1110
+ headers?: {
1111
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1112
+ "x-access-token"?: string | undefined;
1113
+ } | undefined;
1114
+ queryParameters?: {
1115
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1116
+ includesStatus?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderOrderStatus[] | undefined;
1117
+ excludesStatus?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderOrderStatus[] | undefined;
1118
+ templateNames?: string[] | undefined;
1119
+ types?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderOrderType[] | undefined;
1120
+ limit?: number | undefined;
1121
+ skip?: number | undefined;
1122
+ page?: number | undefined;
1123
+ } | undefined;
1124
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderCustomerOrder[]>;
1125
+ /** Get Order for Customer. */
1126
+ orderGetOrder: (conf: {
1127
+ orderId: string;
1128
+ headers?: {
1129
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1130
+ "x-access-token"?: string | undefined;
1131
+ } | undefined;
1132
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1133
+ contractChangeContractId?: string | undefined;
1134
+ customerId: string;
1135
+ dueDate?: string | undefined;
1136
+ invoicingPeriod: number;
1137
+ items: import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderOrderItem[];
1138
+ orderDate?: string | undefined;
1139
+ orderId: string;
1140
+ orderNumber: string;
1141
+ profile?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderProfile | undefined;
1142
+ status: import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderOrderStatus;
1143
+ summary: import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderOrderSummary;
1144
+ type: import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderOrderType;
1145
+ }>;
1146
+ /** Get list of Orders of a Customer. */
1147
+ orderListCustomerOrders: (conf: {
1148
+ customerId: string;
1149
+ headers?: {
1150
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1151
+ "x-access-token"?: string | undefined;
1152
+ } | undefined;
1153
+ queryParameters?: {
1154
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1155
+ limit?: number | undefined;
1156
+ skip?: number | undefined;
1157
+ page?: number | undefined;
1158
+ includesStatus?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderOrderStatus[] | undefined;
1159
+ excludesStatus?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderOrderStatus[] | undefined;
1160
+ templateNames?: string[] | undefined;
1161
+ } | undefined;
1162
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderCustomerOrder[]>;
1163
+ /** Get list of Orders of a Project. */
1164
+ orderListProjectOrders: (conf: {
1165
+ projectId: string;
1166
+ headers?: {
1167
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1168
+ "x-access-token"?: string | undefined;
1169
+ } | undefined;
1170
+ queryParameters?: {
1171
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1172
+ limit?: number | undefined;
1173
+ skip?: number | undefined;
1174
+ page?: number | undefined;
1175
+ includesStatus?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderOrderStatus[] | undefined;
1176
+ excludesStatus?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderOrderStatus[] | undefined;
1177
+ templateNames?: string[] | undefined;
1178
+ } | undefined;
1179
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.OrderCustomerOrder[]>;
1180
+ };
1181
+ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV3NextClient) => {
1182
+ /** Get a Contributor. */
1183
+ extensionGetContributor: (conf: {
1184
+ contributorId: string;
1185
+ headers?: {
1186
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1187
+ } | undefined;
1188
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("@mittwald/api-client-commons").Simplify<import("./types.js").MittwaldAPIV3Next.Paths.V2ContributorsContributorId.Get.Responses.$200.Content.ApplicationJson>>;
1189
+ /** Get Contributor Billing Information. */
1190
+ contributorGetBillingInformation: (conf: {
1191
+ contributorId: string;
1192
+ headers?: {
1193
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1194
+ "x-access-token"?: string | undefined;
1195
+ } | undefined;
1196
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1197
+ contributorId?: string | undefined;
1198
+ invoiceFooter?: string | undefined;
1199
+ onboardingStatus?: "NOT_STARTED" | "STARTED" | "SUCCESSFUL" | undefined;
1200
+ stripeAccountId?: string | undefined;
1201
+ }>;
1202
+ /** Get the Stripe Billing Portal Link for a Customer */
1203
+ contributorGetCustomerBillingPortalLink: (conf: {
1204
+ customerId: string;
1205
+ headers?: {
1206
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1207
+ "x-access-token"?: string | undefined;
1208
+ } | undefined;
1209
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1210
+ url?: string | undefined;
1211
+ }>;
1212
+ /** Get the Stripe Dashboard Link for a Contributor. */
1213
+ contributorGetLoginLink: (conf: {
1214
+ contributorId: string;
1215
+ headers?: {
1216
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1217
+ "x-access-token"?: string | undefined;
1218
+ } | undefined;
1219
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1220
+ url?: string | undefined;
1221
+ }>;
1222
+ /** List ContractPartners of the contributor. */
1223
+ contributorListContractPartnersOfContributor: (conf: {
1224
+ contributorId: string;
1225
+ headers?: {
1226
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1227
+ "x-access-token"?: string | undefined;
1228
+ } | undefined;
1229
+ queryParameters?: {
1230
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1231
+ extensionId?: string | undefined;
1232
+ extensionInstanceId?: string | undefined;
1233
+ } | undefined;
1234
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceContractPartner[]>;
1235
+ /** List incoming Invoices of a Contributor. */
1236
+ contributorListIncomingInvoices: (conf: {
1237
+ contributorId: string;
1238
+ headers?: {
1239
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1240
+ "x-access-token"?: string | undefined;
1241
+ } | undefined;
1242
+ queryParameters?: {
1243
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1244
+ search?: string | undefined;
1245
+ limit?: number | undefined;
1246
+ skip?: number | undefined;
1247
+ page?: number | undefined;
1248
+ sort?: "invoiceNumber"[] | undefined;
1249
+ order?: ("asc" | "desc")[] | undefined;
1250
+ } | undefined;
1251
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1252
+ currency: string;
1253
+ customerId: string;
1254
+ customerName: string;
1255
+ customerNumber: string;
1256
+ date: string;
1257
+ id: string;
1258
+ invoiceNumber: string;
1259
+ invoiceType?: "REGULAR" | "CORRECTION" | "REISSUE" | "CANCELLATION";
1260
+ pdfId: string;
1261
+ recipient: import("./types.js").MittwaldAPIV3Next.Components.Schemas.InvoiceRecipient;
1262
+ totalGross: number;
1263
+ totalNet: number;
1264
+ }[]>;
1265
+ /** List all invoices on behalf of a contributor. */
1266
+ contributorListOnbehalfInvoices: (conf: {
1267
+ contributorId: 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<{
1273
+ invoiceDate: string;
1274
+ invoiceId: string;
1275
+ invoiceNumber: string;
1276
+ invoiceType: "INVOICE" | "CREDIT_NOTE";
1277
+ pdfLink: string;
1278
+ totalGross: number;
1279
+ totalNet: number;
1280
+ webLink?: string;
1281
+ }[]>;
1282
+ /** Request an Access Token for the Incoming Invoice file. */
1283
+ contributorReceiptGetFileAccessToken: (conf: {
1284
+ contributorId: string;
1285
+ contributorReceiptId: string;
1286
+ headers?: {
1287
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1288
+ "x-access-token"?: string | undefined;
1289
+ } | undefined;
1290
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1291
+ accessToken: string;
1292
+ expiresAt: string;
1293
+ }>;
1294
+ /** Check if an Extension is unchargable for this specific context or if it must be charged. */
1295
+ extensionCheckExtensionIsChargable: (conf: {
1296
+ extensionId: string;
1297
+ contextId: string;
1298
+ headers?: {
1299
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1300
+ } | undefined;
1301
+ queryParameters?: {
1302
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1303
+ variantKey?: string | undefined;
1304
+ } | undefined;
1305
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1306
+ chargeability: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceExtensionInstanceChargeability;
1307
+ }>;
1308
+ /** List ExtensionInstances. */
1309
+ extensionListExtensionInstances: (conf?: {
1310
+ headers?: {
1311
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1312
+ "x-access-token"?: string | undefined;
1313
+ } | undefined;
1314
+ queryParameters?: {
1315
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1316
+ context?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceContext | undefined;
1317
+ contextId?: string | undefined;
1318
+ extensionId?: string | undefined;
1319
+ searchTerm?: string | undefined;
1320
+ anchor?: string | undefined;
1321
+ limit?: number | undefined;
1322
+ skip?: number | undefined;
1323
+ page?: number | undefined;
1324
+ sort?: ("createdAt" | "extensionId" | "extensionName")[] | undefined;
1325
+ order?: ("asc" | "desc")[] | undefined;
1326
+ } | undefined;
1327
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceExtensionInstance[]>;
1328
+ /** Get an ExtensionInstance. */
1329
+ extensionGetExtensionInstance: (conf: {
1330
+ extensionInstanceId: string;
1331
+ headers?: {
1332
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1333
+ "x-access-token"?: string | undefined;
1334
+ } | undefined;
1335
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1336
+ aggregateReference: {
1337
+ aggregate: string;
1338
+ domain: string;
1339
+ id: string;
1340
+ };
1341
+ chargeability: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceExtensionInstanceChargeability;
1342
+ consentedScopes: string[];
1343
+ contributorId: string;
1344
+ contributorName: string;
1345
+ createdAt?: string | undefined;
1346
+ disabled: boolean;
1347
+ extensionDeletionDeadline?: string | undefined;
1348
+ extensionId: string;
1349
+ extensionName: string;
1350
+ extensionSubTitle?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceSubTitle | undefined;
1351
+ frontendFragments?: {
1352
+ [k: string]: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceFrontendFragment;
1353
+ } | undefined;
1354
+ id: string;
1355
+ nextScheduledWebhookExecution?: string | undefined;
1356
+ pendingInstallation: boolean;
1357
+ pendingRemoval: boolean;
1358
+ variantKey?: string | undefined;
1359
+ webhookExecutionHalted: boolean;
1360
+ }>;
1361
+ /** Get Extension of own contributor. */
1362
+ extensionGetOwnExtension: (conf: {
1363
+ contributorId: string;
1364
+ extensionId: string;
1365
+ headers?: {
1366
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1367
+ "x-access-token"?: string | undefined;
1368
+ } | undefined;
1369
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1370
+ assets: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceExtensionAsset[];
1371
+ backendComponents?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceBackendComponents | undefined;
1372
+ blocked?: boolean | undefined;
1373
+ context?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceContext | undefined;
1374
+ contributorId: string;
1375
+ deletionDeadline?: string | undefined;
1376
+ deprecation?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceExtensionDeprecation | undefined;
1377
+ description?: string | undefined;
1378
+ detailedDescriptions?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceDetailedDescriptions | undefined;
1379
+ disabled?: boolean | undefined;
1380
+ externalFrontends?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceExternalComponent[] | undefined;
1381
+ frontendComponents?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceExternalComponent[] | undefined;
1382
+ frontendFragments?: {
1383
+ [k: string]: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceFrontendFragment;
1384
+ } | undefined;
1385
+ functional: boolean;
1386
+ id: string;
1387
+ isDeletionScheduled?: boolean | undefined;
1388
+ logoRefId?: string | undefined;
1389
+ name: string;
1390
+ pricing?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceMonthlyPricePlanStrategy | undefined;
1391
+ pricingDetails?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplacePricePlanDetails | undefined;
1392
+ published: boolean;
1393
+ requestedChanges?: {
1394
+ context?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceContext;
1395
+ scopes?: string[];
1396
+ webhookUrls?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceWebhookUrls | {};
1397
+ } | undefined;
1398
+ scopes?: string[] | undefined;
1399
+ secrets: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceExtensionSecret[];
1400
+ state?: "enabled" | "blocked" | "disabled" | undefined;
1401
+ statistics: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceExtensionStatistics;
1402
+ subTitle?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceSubTitle | undefined;
1403
+ support?: (import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceSupportMeta & {
1404
+ inherited: boolean;
1405
+ }) | undefined;
1406
+ tags?: string[] | undefined;
1407
+ verificationRequested: boolean;
1408
+ verified: boolean;
1409
+ webhookUrls?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceWebhookUrls | undefined;
1410
+ }>;
1411
+ /** Get all open extension orders for given customer */
1412
+ extensionGetCustomerExtensionInstanceOrders: (conf: {
1413
+ customerId: string;
1414
+ headers?: {
1415
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1416
+ "x-access-token"?: string | undefined;
1417
+ } | undefined;
1418
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1419
+ context?: "project" | "customer";
1420
+ extensionId?: string;
1421
+ referencedId?: string;
1422
+ }[]>;
1423
+ /** Get the Contract Strategy of an Extension Instance */
1424
+ extensionGetExtensionInstanceContract: (conf: {
1425
+ extensionInstanceId: string;
1426
+ headers?: {
1427
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1428
+ "x-access-token"?: string | undefined;
1429
+ } | undefined;
1430
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1431
+ contractPeriodEndDate?: string | undefined;
1432
+ currentPrice?: number | undefined;
1433
+ interactionDeadline?: string | undefined;
1434
+ interactionRequired: boolean;
1435
+ pendingVariantChange?: {
1436
+ effectiveDate: string;
1437
+ targetVariantKey: string;
1438
+ } | undefined;
1439
+ status: "notStarted" | "pending" | "active" | "terminationPending";
1440
+ terminationTargetDate?: string | undefined;
1441
+ variantDescription?: string | undefined;
1442
+ variantKey?: string | undefined;
1443
+ variantName?: string | undefined;
1444
+ }>;
1445
+ /** Get the ExtensionInstance of a specific customer and extension, if existing. */
1446
+ extensionGetExtensionInstanceForCustomer: (conf: {
1447
+ customerId: string;
1448
+ extensionId: string;
1449
+ headers?: {
1450
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1451
+ "x-access-token"?: string | undefined;
1452
+ } | undefined;
1453
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1454
+ aggregateReference: {
1455
+ aggregate: string;
1456
+ domain: string;
1457
+ id: string;
1458
+ };
1459
+ chargeability: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceExtensionInstanceChargeability;
1460
+ consentedScopes: string[];
1461
+ contributorId: string;
1462
+ contributorName: string;
1463
+ createdAt?: string | undefined;
1464
+ disabled: boolean;
1465
+ extensionDeletionDeadline?: string | undefined;
1466
+ extensionId: string;
1467
+ extensionName: string;
1468
+ extensionSubTitle?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceSubTitle | undefined;
1469
+ frontendFragments?: {
1470
+ [k: string]: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceFrontendFragment;
1471
+ } | undefined;
1472
+ id: string;
1473
+ nextScheduledWebhookExecution?: string | undefined;
1474
+ pendingInstallation: boolean;
1475
+ pendingRemoval: boolean;
1476
+ variantKey?: string | undefined;
1477
+ webhookExecutionHalted: boolean;
1478
+ }>;
1479
+ /** Get the ExtensionInstance of a specific project and extension, if existing. */
1480
+ extensionGetExtensionInstanceForProject: (conf: {
1481
+ projectId: string;
1482
+ extensionId: string;
1483
+ headers?: {
1484
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1485
+ "x-access-token"?: string | undefined;
1486
+ } | undefined;
1487
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1488
+ aggregateReference: {
1489
+ aggregate: string;
1490
+ domain: string;
1491
+ id: string;
1492
+ };
1493
+ chargeability: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceExtensionInstanceChargeability;
1494
+ consentedScopes: string[];
1495
+ contributorId: string;
1496
+ contributorName: string;
1497
+ createdAt?: string | undefined;
1498
+ disabled: boolean;
1499
+ extensionDeletionDeadline?: string | undefined;
1500
+ extensionId: string;
1501
+ extensionName: string;
1502
+ extensionSubTitle?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceSubTitle | undefined;
1503
+ frontendFragments?: {
1504
+ [k: string]: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceFrontendFragment;
1505
+ } | undefined;
1506
+ id: string;
1507
+ nextScheduledWebhookExecution?: string | undefined;
1508
+ pendingInstallation: boolean;
1509
+ pendingRemoval: boolean;
1510
+ variantKey?: string | undefined;
1511
+ webhookExecutionHalted: boolean;
1512
+ }>;
1513
+ /** Get an Extension. */
1514
+ extensionGetExtension: (conf: {
1515
+ extensionId: string;
1516
+ headers?: {
1517
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1518
+ } | undefined;
1519
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("@mittwald/api-client-commons").Simplify<import("./types.js").MittwaldAPIV3Next.Paths.V2ExtensionsExtensionId.Get.Responses.$200.Content.ApplicationJson>>;
1520
+ /** Get all open extension orders for given project */
1521
+ extensionGetProjectExtensionInstanceOrders: (conf: {
1522
+ projectId: string;
1523
+ headers?: {
1524
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1525
+ "x-access-token"?: string | undefined;
1526
+ } | undefined;
1527
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1528
+ context?: "project" | "customer";
1529
+ extensionId?: string;
1530
+ referencedId?: string;
1531
+ }[]>;
1532
+ /** Get the public key to verify the webhook signature. */
1533
+ extensionGetPublicKey: (conf: {
1534
+ serial: string;
1535
+ headers?: {
1536
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1537
+ } | undefined;
1538
+ queryParameters?: {
1539
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1540
+ purpose?: "webhook" | "session_token" | undefined;
1541
+ format?: "raw" | "spki" | undefined;
1542
+ } | undefined;
1543
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1544
+ algorithm: string;
1545
+ key: string;
1546
+ serial: string;
1547
+ }>;
1548
+ /** List all Webhook Executions. */
1549
+ extensionListAllExtensionInstanceWebhookExecutions: (conf: {
1550
+ contributorId: string;
1551
+ headers?: {
1552
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1553
+ "x-access-token"?: string | undefined;
1554
+ } | undefined;
1555
+ queryParameters?: {
1556
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1557
+ extensionId?: string | undefined;
1558
+ extensionInstanceId?: string | undefined;
1559
+ state?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceExtensionInstanceWebhookExecutionState[] | undefined;
1560
+ limit?: number | undefined;
1561
+ skip?: number | undefined;
1562
+ page?: number | undefined;
1563
+ sort?: ("attempts" | "nextScheduledExecution")[] | undefined;
1564
+ order?: ("asc" | "desc")[] | undefined;
1565
+ } | undefined;
1566
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceExtensionInstanceWebhookExecution[]>;
1567
+ /** List Contributors. */
1568
+ extensionListContributors: (conf?: {
1569
+ headers?: {
1570
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1571
+ } | undefined;
1572
+ queryParameters?: {
1573
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1574
+ limit?: number | undefined;
1575
+ skip?: number | undefined;
1576
+ page?: number | undefined;
1577
+ sort?: "name" | undefined;
1578
+ order?: "asc" | "desc" | undefined;
1579
+ } | undefined;
1580
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceContributor[]>;
1581
+ /** List Extensions. */
1582
+ extensionListExtensions: (conf?: {
1583
+ headers?: {
1584
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1585
+ } | undefined;
1586
+ queryParameters?: {
1587
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1588
+ context?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceContext | undefined;
1589
+ searchTerm?: string | undefined;
1590
+ includeDeprecated?: boolean | undefined;
1591
+ includeFree?: boolean | undefined;
1592
+ includeChargeable?: boolean | undefined;
1593
+ limit?: number | undefined;
1594
+ skip?: number | undefined;
1595
+ page?: number | undefined;
1596
+ sort?: "name" | "pricing.priceInCents" | undefined;
1597
+ order?: "asc" | "desc" | undefined;
1598
+ } | undefined;
1599
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceExtension[]>;
1600
+ /** List Extensions of own contributor. */
1601
+ extensionListOwnExtensions: (conf: {
1602
+ contributorId: string;
1603
+ headers?: {
1604
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1605
+ "x-access-token"?: string | undefined;
1606
+ } | undefined;
1607
+ queryParameters?: {
1608
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1609
+ limit?: number | undefined;
1610
+ skip?: number | undefined;
1611
+ page?: number | undefined;
1612
+ } | undefined;
1613
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MarketplaceOwnExtension[]>;
1614
+ /** List Scopes. */
1615
+ extensionListScopes: (conf?: {
1616
+ headers?: {
1617
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1618
+ } | undefined;
1619
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
1620
+ name: string;
1621
+ }[]>;
1622
+ /** Get payment method details */
1623
+ customerGetPaymentMethod: (conf: {
1624
+ customerId: string;
1625
+ headers?: {
1626
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1627
+ "x-access-token"?: string | undefined;
1628
+ } | undefined;
1629
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1630
+ cardDetails?: {
1631
+ brand: string;
1632
+ last4: string;
1633
+ } | undefined;
1634
+ }>;
1635
+ };
1636
+ declare const buildConversationApi: (baseClient: MittwaldAPIV3NextClient) => {
1637
+ /** Get all conversation the authenticated user has created or has access to. */
1638
+ listConversations: (conf?: {
1639
+ headers?: {
1640
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1641
+ } | undefined;
1642
+ queryParameters?: {
1643
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1644
+ fullTextSearch?: string | undefined;
1645
+ status?: ("open" | "closed")[] | undefined;
1646
+ limit?: number | undefined;
1647
+ skip?: number | undefined;
1648
+ page?: number | undefined;
1649
+ sort?: ("createdAt" | "lastMessage.createdAt" | "title" | "shortId" | "conversationId")[] | undefined;
1650
+ order?: ("asc" | "desc")[] | undefined;
1651
+ } | undefined;
1652
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationConversation[]>;
1653
+ /** Get all message of the conversation. */
1654
+ listMessagesByConversation: (conf: {
1655
+ conversationId: string;
1656
+ headers?: {
1657
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1658
+ } | undefined;
1659
+ }) => import("@mittwald/react-use-promise").AsyncResource<(import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationMessage | import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationStatusUpdate | import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationServiceRequest)[]>;
1660
+ /** Get a specific conversation category. */
1661
+ getCategory: (conf: {
1662
+ categoryId: string;
1663
+ headers?: {
1664
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1665
+ } | undefined;
1666
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1667
+ categoryId: string;
1668
+ name: string;
1669
+ referenceType: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationCategoryReferenceType;
1670
+ }>;
1671
+ /** Get members of a support conversation. */
1672
+ getConversationMembers: (conf: {
1673
+ conversationId: string;
1674
+ headers?: {
1675
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1676
+ } | undefined;
1677
+ }) => import("@mittwald/react-use-promise").AsyncResource<(import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationUser & {
1678
+ active: boolean;
1679
+ })[]>;
1680
+ /** Get preferences for customer conversations. */
1681
+ getConversationPreferencesOfCustomer: (conf: {
1682
+ customerId: string;
1683
+ headers?: {
1684
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1685
+ } | undefined;
1686
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1687
+ customerId: string;
1688
+ preferredUsers: {
1689
+ categoryUserPairs?: {
1690
+ [k: string]: string;
1691
+ };
1692
+ fallback?: string;
1693
+ };
1694
+ }>;
1695
+ /** Get a support conversation. */
1696
+ getConversation: (conf: {
1697
+ conversationId: string;
1698
+ headers?: {
1699
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1700
+ } | undefined;
1701
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1702
+ category?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationCategory | undefined;
1703
+ conversationId: string;
1704
+ createdAt: string;
1705
+ lastMessageAt?: string | undefined;
1706
+ mainUser: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationUser;
1707
+ notificationRoles?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationNotificationRole[] | undefined;
1708
+ relatedTo?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationRelatedAggregateReference | undefined;
1709
+ relations?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationAggregateReference[] | undefined;
1710
+ sharedWith?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationShareableAggregateReference | undefined;
1711
+ shortId: string;
1712
+ status: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationStatus;
1713
+ title: string;
1714
+ visibility: "shared" | "private";
1715
+ createdBy?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationUser | undefined;
1716
+ lastMessage?: {
1717
+ createdAt: string;
1718
+ createdBy?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationUser;
1719
+ } | undefined;
1720
+ lastMessageBy?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationUser | undefined;
1721
+ }>;
1722
+ /** Request an access token for the File belonging to the Conversation. */
1723
+ getFileAccessToken: (conf: {
1724
+ conversationId: string;
1725
+ fileId: string;
1726
+ headers?: {
1727
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1728
+ } | undefined;
1729
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1730
+ accessToken: string;
1731
+ expiresAt: string;
1732
+ }>;
1733
+ /** Get all conversation categories. */
1734
+ listCategories: (conf?: {
1735
+ headers?: {
1736
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1737
+ } | undefined;
1738
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ConversationCategory[]>;
1739
+ };
1740
+ declare const buildCronjobApi: (baseClient: MittwaldAPIV3NextClient) => {
1741
+ /** List Cronjobs belonging to a Project. */
1742
+ listCronjobs: (conf: {
1743
+ projectId: string;
1744
+ headers?: {
1745
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1746
+ "x-access-token"?: string | undefined;
1747
+ } | undefined;
1748
+ queryParameters?: {
1749
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1750
+ includeServiceCronjobs?: boolean | undefined;
1751
+ limit?: number | undefined;
1752
+ skip?: number | undefined;
1753
+ page?: number | undefined;
1754
+ } | undefined;
1755
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.CronjobCronjob[]>;
1756
+ /** List CronjobExecutions belonging to a Cronjob. */
1757
+ listExecutions: (conf: {
1758
+ cronjobId: string;
1759
+ headers?: {
1760
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1761
+ "x-access-token"?: string | undefined;
1762
+ } | undefined;
1763
+ queryParameters?: {
1764
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1765
+ limit?: number | undefined;
1766
+ skip?: number | undefined;
1767
+ page?: number | undefined;
1768
+ since?: string | undefined;
1769
+ until?: string | undefined;
1770
+ status?: string | undefined;
1771
+ triggeredByUser?: boolean | undefined;
1772
+ sortOrder?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.CronjobCronjobExecutionSortOrder | undefined;
1773
+ } | undefined;
1774
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.CronjobCronjobExecution[]>;
1775
+ /** Get a Cronjob. */
1776
+ getCronjob: (conf: {
1777
+ cronjobId: string;
1778
+ headers?: {
1779
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1780
+ "x-access-token"?: string | undefined;
1781
+ } | undefined;
1782
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1783
+ active: boolean;
1784
+ appId: string;
1785
+ appInstallationId?: string | undefined;
1786
+ concurrencyPolicy?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.CronjobConcurrencyPolicy | undefined;
1787
+ createdAt: string;
1788
+ description: string;
1789
+ destination?: (import("./types.js").MittwaldAPIV3Next.Components.Schemas.CronjobCronjobUrl | import("./types.js").MittwaldAPIV3Next.Components.Schemas.CronjobCronjobCommand) | undefined;
1790
+ email?: string | undefined;
1791
+ failedExecutionAlertThreshold: number;
1792
+ id: string;
1793
+ interval: string;
1794
+ latestExecution?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.CronjobCronjobExecution | undefined;
1795
+ nextExecutionTime?: string | undefined;
1796
+ projectId?: string | undefined;
1797
+ shortId: string;
1798
+ target?: (import("./types.js").MittwaldAPIV3Next.Components.Schemas.CronjobAppInstallationTarget | import("./types.js").MittwaldAPIV3Next.Components.Schemas.CronjobServiceTargetResponse) | undefined;
1799
+ timeZone?: string | undefined;
1800
+ timeout: number;
1801
+ updatedAt: string;
1802
+ }>;
1803
+ /** Get a CronjobExecution analysis for failed executions. */
1804
+ getExecutionAnalysis: (conf: {
1805
+ executionId: string;
1806
+ cronjobId: string;
1807
+ headers?: {
1808
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1809
+ "Accept-Language"?: "de" | "en" | undefined;
1810
+ "x-access-token"?: string | undefined;
1811
+ } | undefined;
1812
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1813
+ message: string;
1814
+ }>;
1815
+ /** Get a CronjobExecution. */
1816
+ getExecution: (conf: {
1817
+ executionId: string;
1818
+ cronjobId: string;
1819
+ headers?: {
1820
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1821
+ "x-access-token"?: string | undefined;
1822
+ } | undefined;
1823
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1824
+ abortedBy?: {
1825
+ id?: string;
1826
+ } | undefined;
1827
+ cronjobId: string;
1828
+ durationInMilliseconds?: number | undefined;
1829
+ end?: string | undefined;
1830
+ executionEnd?: string | undefined;
1831
+ executionStart?: string | undefined;
1832
+ exitCode?: number | undefined;
1833
+ id: string;
1834
+ logPath?: string | undefined;
1835
+ start?: string | undefined;
1836
+ status: "Complete" | "Failed" | "AbortedBySystem" | "Pending" | "Running" | "AbortedByUser" | "TimedOut";
1837
+ successful: boolean;
1838
+ triggeredBy?: {
1839
+ id?: string;
1840
+ } | undefined;
1841
+ }>;
1842
+ };
1843
+ declare const buildCustomerApi: (baseClient: MittwaldAPIV3NextClient) => {
1844
+ /** List Invites belonging to a Customer. */
1845
+ listInvitesForCustomer: (conf: {
1846
+ customerId: string;
1847
+ headers?: {
1848
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1849
+ "x-access-token"?: string | undefined;
1850
+ } | undefined;
1851
+ queryParameters?: {
1852
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1853
+ limit?: number | undefined;
1854
+ skip?: number | undefined;
1855
+ searchTerm?: string | undefined;
1856
+ } | undefined;
1857
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipCustomerInvite[]>;
1858
+ /** Get all customer profiles the authenticated user has access to. */
1859
+ listCustomers: (conf?: {
1860
+ headers?: {
1861
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1862
+ "x-access-token"?: string | undefined;
1863
+ } | undefined;
1864
+ queryParameters?: {
1865
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1866
+ role?: string | undefined;
1867
+ search?: string | undefined;
1868
+ limit?: number | undefined;
1869
+ skip?: number | undefined;
1870
+ page?: number | undefined;
1871
+ } | undefined;
1872
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.CustomerCustomer[]>;
1873
+ /** Gets the Wallet of the Customer. */
1874
+ getWallet: (conf: {
1875
+ customerId: string;
1876
+ headers?: {
1877
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1878
+ "x-access-token"?: string | undefined;
1879
+ } | undefined;
1880
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1881
+ customerId: string;
1882
+ points: number;
1883
+ recommendationCode?: string | undefined;
1884
+ walletId: string;
1885
+ }>;
1886
+ /** Get a CustomerInvite. */
1887
+ getCustomerInvite: (conf: {
1888
+ customerInviteId: string;
1889
+ headers?: {
1890
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1891
+ "x-access-token"?: string | undefined;
1892
+ } | undefined;
1893
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1894
+ avatarRefId?: string | undefined;
1895
+ customerId: string;
1896
+ customerName: string;
1897
+ id: string;
1898
+ information: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipInviteInformation;
1899
+ mailAddress: string;
1900
+ membershipExpiresAt?: string | undefined;
1901
+ message?: string | undefined;
1902
+ role: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipCustomerRoles;
1903
+ }>;
1904
+ /** Get a CustomerMembership. */
1905
+ getCustomerMembership: (conf: {
1906
+ customerMembershipId: string;
1907
+ headers?: {
1908
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1909
+ "x-access-token"?: string | undefined;
1910
+ } | undefined;
1911
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1912
+ avatarRef?: string | undefined;
1913
+ customerId: string;
1914
+ email: string;
1915
+ expiresAt?: string | undefined;
1916
+ firstName: string;
1917
+ id: string;
1918
+ inviteId?: string | undefined;
1919
+ lastName: string;
1920
+ memberSince?: string | undefined;
1921
+ mfa: boolean;
1922
+ role: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipCustomerRoles;
1923
+ userId: string;
1924
+ }>;
1925
+ /** Get a customer profile. */
1926
+ getCustomer: (conf: {
1927
+ customerId: string;
1928
+ headers?: {
1929
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1930
+ "x-access-token"?: string | undefined;
1931
+ } | undefined;
1932
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1933
+ activeSuspension?: {
1934
+ createdAt: string;
1935
+ } | undefined;
1936
+ avatarRefId?: string | undefined;
1937
+ categoryId?: string | undefined;
1938
+ creationDate: string;
1939
+ customerId: string;
1940
+ customerNumber: string;
1941
+ deletionProhibitedBy?: ("hasOpenInvoices" | "hasActiveContracts" | "hasActiveExtensionSubscriptions" | "isActiveContributor")[] | undefined;
1942
+ executingUserRoles?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.CustomerRole[] | undefined;
1943
+ flags?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.CustomerCustomerFlag[] | undefined;
1944
+ isAllowedToPlaceOrders?: boolean | undefined;
1945
+ isBanned?: boolean | undefined;
1946
+ isInDefaultOfPayment?: boolean | undefined;
1947
+ isMailAddressInvalid?: boolean | undefined;
1948
+ levelOfUndeliverableDunningNotice?: "first" | "second" | undefined;
1949
+ memberCount: number;
1950
+ name: string;
1951
+ owner?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.CustomerContact | undefined;
1952
+ projectCount: number;
1953
+ vatId?: string | undefined;
1954
+ vatIdValidationState?: "valid" | "invalid" | "pending" | "unspecified" | undefined;
1955
+ }>;
1956
+ /** Get a CustomerInvite by token. */
1957
+ getCustomerTokenInvite: (conf: {
1958
+ headers: {
1959
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1960
+ token: string;
1961
+ "x-access-token"?: string | undefined;
1962
+ };
1963
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1964
+ avatarRefId?: string | undefined;
1965
+ customerId: string;
1966
+ customerName: string;
1967
+ id: string;
1968
+ information: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipInviteInformation;
1969
+ mailAddress: string;
1970
+ membershipExpiresAt?: string | undefined;
1971
+ message?: string | undefined;
1972
+ role: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipCustomerRoles;
1973
+ }>;
1974
+ /** Check if the customer profile has a valid contract partner configured. */
1975
+ isCustomerLegallyCompetent: (conf: {
1976
+ customerId: string;
1977
+ headers?: {
1978
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1979
+ "x-access-token"?: string | undefined;
1980
+ } | undefined;
1981
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1982
+ isLegallyCompetent?: boolean | undefined;
1983
+ }>;
1984
+ /** List CustomerInvites belonging to the executing user. */
1985
+ listCustomerInvites: (conf?: {
1986
+ headers?: {
1987
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1988
+ "x-access-token"?: string | undefined;
1989
+ } | undefined;
1990
+ queryParameters?: {
1991
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1992
+ limit?: number | undefined;
1993
+ skip?: number | undefined;
1994
+ page?: number | undefined;
1995
+ } | undefined;
1996
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipCustomerInvite[]>;
1997
+ /** List CustomerMemberships belonging to the executing user. */
1998
+ listCustomerMemberships: (conf?: {
1999
+ headers?: {
2000
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2001
+ "x-access-token"?: string | undefined;
2002
+ } | undefined;
2003
+ queryParameters?: {
2004
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2005
+ limit?: number | undefined;
2006
+ skip?: number | undefined;
2007
+ page?: number | undefined;
2008
+ hasExpiry?: boolean | undefined;
2009
+ role?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipCustomerRoles | undefined;
2010
+ } | undefined;
2011
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipCustomerMembership[]>;
2012
+ /** List Memberships belonging to a Customer. */
2013
+ listMembershipsForCustomer: (conf: {
2014
+ customerId: string;
2015
+ headers?: {
2016
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2017
+ "x-access-token"?: string | undefined;
2018
+ } | undefined;
2019
+ queryParameters?: {
2020
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2021
+ limit?: number | undefined;
2022
+ skip?: number | undefined;
2023
+ hasExpiry?: boolean | undefined;
2024
+ role?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipCustomerRoles | undefined;
2025
+ searchTerm?: string | undefined;
2026
+ } | undefined;
2027
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipCustomerMembership[]>;
2028
+ };
2029
+ declare const buildDatabaseApi: (baseClient: MittwaldAPIV3NextClient) => {
2030
+ /** List MySQLDatabases belonging to a Project. */
2031
+ listMysqlDatabases: (conf: {
2032
+ projectId: string;
2033
+ headers?: {
2034
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2035
+ "x-access-token"?: string | undefined;
2036
+ } | undefined;
2037
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DatabaseMySqlDatabase[]>;
2038
+ /** List MySQLUsers belonging to a Database. */
2039
+ listMysqlUsers: (conf: {
2040
+ mysqlDatabaseId: string;
2041
+ headers?: {
2042
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2043
+ "x-access-token"?: string | undefined;
2044
+ } | undefined;
2045
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DatabaseMySqlUser[]>;
2046
+ /** List RedisDatabases belonging to a Project. */
2047
+ listRedisDatabases: (conf: {
2048
+ projectId: string;
2049
+ headers?: {
2050
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2051
+ "x-access-token"?: string | undefined;
2052
+ } | undefined;
2053
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DatabaseRedisDatabase[]>;
2054
+ /** Get a MySQLDatabase. */
2055
+ getMysqlDatabase: (conf: {
2056
+ mysqlDatabaseId: string;
2057
+ headers?: {
2058
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2059
+ "x-access-token"?: string | undefined;
2060
+ } | undefined;
2061
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2062
+ characterSettings: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DatabaseCharacterSettings;
2063
+ createdAt: string;
2064
+ description: string;
2065
+ externalHostname: string;
2066
+ finalizers?: string[] | undefined;
2067
+ hostname: string;
2068
+ id: string;
2069
+ isReady: boolean;
2070
+ isShared: boolean;
2071
+ mainUser?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DatabaseMySqlUser | undefined;
2072
+ name: string;
2073
+ projectId: string;
2074
+ status: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DatabaseDatabaseStatus;
2075
+ statusSetAt: string;
2076
+ storageUsageInBytes: number;
2077
+ storageUsageInBytesSetAt: string;
2078
+ updatedAt: string;
2079
+ version: string;
2080
+ }>;
2081
+ /** Get a MySQLUser. */
2082
+ getMysqlUser: (conf: {
2083
+ mysqlUserId: string;
2084
+ headers?: {
2085
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2086
+ "x-access-token"?: string | undefined;
2087
+ } | undefined;
2088
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2089
+ accessIpMask?: string | undefined;
2090
+ accessLevel: "full" | "readonly";
2091
+ createdAt: string;
2092
+ databaseId: string;
2093
+ description?: string | undefined;
2094
+ disabled: boolean;
2095
+ externalAccess: boolean;
2096
+ id: string;
2097
+ mainUser: boolean;
2098
+ name: string;
2099
+ passwordUpdatedAt: string;
2100
+ status: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DatabaseDatabaseUserStatus;
2101
+ statusSetAt: string;
2102
+ updatedAt: string;
2103
+ }>;
2104
+ /** Get a RedisDatabase. */
2105
+ getRedisDatabase: (conf: {
2106
+ redisDatabaseId: string;
2107
+ headers?: {
2108
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2109
+ "x-access-token"?: string | undefined;
2110
+ } | undefined;
2111
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2112
+ configuration?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DatabaseRedisDatabaseConfiguration | undefined;
2113
+ createdAt: string;
2114
+ description: string;
2115
+ finalizers?: string[] | undefined;
2116
+ hostname: string;
2117
+ id: string;
2118
+ name: string;
2119
+ port: number;
2120
+ projectId: string;
2121
+ status: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DatabaseDatabaseStatus;
2122
+ statusSetAt: string;
2123
+ storageUsageInBytes: number;
2124
+ storageUsageInBytesSetAt: string;
2125
+ updatedAt: string;
2126
+ version: string;
2127
+ }>;
2128
+ /** Get a MySQLUser's PhpMyAdmin-URL. */
2129
+ getMysqlUserPhpMyAdminUrl: (conf: {
2130
+ mysqlUserId: string;
2131
+ headers?: {
2132
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2133
+ "x-access-token"?: string | undefined;
2134
+ } | undefined;
2135
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2136
+ url: string;
2137
+ }>;
2138
+ /** List available MySQL character sets and collations, optionally filtered by a MySQLVersion. */
2139
+ listMysqlCharsets: (conf?: {
2140
+ headers?: {
2141
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2142
+ } | undefined;
2143
+ queryParameters?: {
2144
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2145
+ version?: string | undefined;
2146
+ } | undefined;
2147
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DatabaseMySqlCharacterSettings[]>;
2148
+ /** List MySQLVersions. */
2149
+ listMysqlVersions: (conf?: {
2150
+ headers?: {
2151
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2152
+ "x-access-token"?: string | undefined;
2153
+ } | undefined;
2154
+ queryParameters?: {
2155
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2156
+ projectId?: string | undefined;
2157
+ } | undefined;
2158
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DatabaseMySqlVersion[]>;
2159
+ /** List RedisVersions. */
2160
+ listRedisVersions: (conf?: {
2161
+ headers?: {
2162
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2163
+ "x-access-token"?: string | undefined;
2164
+ } | undefined;
2165
+ queryParameters?: {
2166
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2167
+ projectId?: string | undefined;
2168
+ } | undefined;
2169
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DatabaseRedisVersion[]>;
2170
+ };
2171
+ declare const buildDomainApi: (baseClient: MittwaldAPIV3NextClient) => {
2172
+ /** List Domains */
2173
+ listDomains: (conf?: {
2174
+ headers?: {
2175
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2176
+ "x-access-token"?: string | undefined;
2177
+ } | undefined;
2178
+ queryParameters?: {
2179
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2180
+ projectId?: string | undefined;
2181
+ domainSearchName?: string | undefined;
2182
+ contactHash?: string | undefined;
2183
+ limit?: number | undefined;
2184
+ skip?: number | undefined;
2185
+ page?: number | undefined;
2186
+ } | undefined;
2187
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DomainDomain[]>;
2188
+ /** Get a DNSZone. */
2189
+ dnsGetDnsZone: (conf: {
2190
+ dnsZoneId: string;
2191
+ headers?: {
2192
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2193
+ "x-access-token"?: string | undefined;
2194
+ } | undefined;
2195
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2196
+ domain: string;
2197
+ id: string;
2198
+ recordSet: {
2199
+ caa: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DnsRecordCAA;
2200
+ cname: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DnsRecordCNAME;
2201
+ combinedARecords: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DnsRecordCombinedA;
2202
+ mx: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DnsRecordMX;
2203
+ srv: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DnsRecordSRV;
2204
+ txt: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DnsRecordTXT;
2205
+ };
2206
+ }>;
2207
+ /** Get a zone file for a DNSZone. */
2208
+ dnsGetZoneFile: (conf: {
2209
+ dnsZoneId: string;
2210
+ headers?: {
2211
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2212
+ "x-access-token"?: string | undefined;
2213
+ } | undefined;
2214
+ }) => import("@mittwald/react-use-promise").AsyncResource<string>;
2215
+ /** List DNSZones belonging to a Project. */
2216
+ dnsListDnsZones: (conf: {
2217
+ projectId: string;
2218
+ headers?: {
2219
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2220
+ "x-access-token"?: string | undefined;
2221
+ } | undefined;
2222
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DnsZone[]>;
2223
+ /** Get a Domain. */
2224
+ getDomain: (conf: {
2225
+ domainId: string;
2226
+ headers?: {
2227
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2228
+ "x-access-token"?: string | undefined;
2229
+ } | undefined;
2230
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2231
+ authCode?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DomainAuthCode | undefined;
2232
+ authCode2?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DomainAuthCode2 | undefined;
2233
+ connected: boolean;
2234
+ contactHash?: string | undefined;
2235
+ deleted: boolean;
2236
+ domain: string;
2237
+ domainId: string;
2238
+ handles: {
2239
+ adminC?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DomainHandleReadable;
2240
+ ownerC: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DomainHandleReadable;
2241
+ };
2242
+ nameservers: string[];
2243
+ processes?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DomainProcess[] | undefined;
2244
+ projectId: string;
2245
+ scheduledDeletionDate?: string | undefined;
2246
+ transferInAuthCode?: string | undefined;
2247
+ usesDefaultNameserver: boolean;
2248
+ }>;
2249
+ /** Get a Contact-Verification. */
2250
+ getContactVerification: (conf: {
2251
+ contactVerificationId: string;
2252
+ headers?: {
2253
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2254
+ "x-access-token"?: string | undefined;
2255
+ } | undefined;
2256
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2257
+ id: string;
2258
+ status: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DomainContactVerificationStatus;
2259
+ typeData: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DomainContactVerificationAddressData | import("./types.js").MittwaldAPIV3Next.Components.Schemas.DomainContactVerificationEmailData | import("./types.js").MittwaldAPIV3Next.Components.Schemas.DomainContactVerificationNameData;
2260
+ }>;
2261
+ /** Get the latest screenshot's FileReference belonging to a Domain. */
2262
+ getLatestScreenshot: (conf: {
2263
+ queryParameters: {
2264
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2265
+ domainName: string;
2266
+ };
2267
+ headers?: {
2268
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2269
+ "x-access-token"?: string | undefined;
2270
+ } | undefined;
2271
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2272
+ reference?: string | undefined;
2273
+ }>;
2274
+ /** List Contact-Verifications belonging to the executing user. */
2275
+ listContactVerifications: (conf?: {
2276
+ headers?: {
2277
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2278
+ "x-access-token"?: string | undefined;
2279
+ } | undefined;
2280
+ queryParameters?: {
2281
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2282
+ value?: string | undefined;
2283
+ type?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DomainContactVerificationType | undefined;
2284
+ } | undefined;
2285
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DomainContactVerification[]>;
2286
+ /** List the contact schemas for a TLD. */
2287
+ listTldContactSchemas: (conf: {
2288
+ tld: string;
2289
+ headers?: {
2290
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2291
+ } | undefined;
2292
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2293
+ jsonSchemaAdminC?: {} | undefined;
2294
+ jsonSchemaOwnerC: {};
2295
+ }>;
2296
+ /** List TLDs. */
2297
+ listTlds: (conf?: {
2298
+ headers?: {
2299
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2300
+ } | undefined;
2301
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DomainTopLevel[]>;
2302
+ /** List Domain-Migrations belonging to a Project. */
2303
+ migrationListMigrationsByProjectId: (conf: {
2304
+ projectId: string;
2305
+ headers?: {
2306
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2307
+ "x-access-token"?: string | undefined;
2308
+ } | undefined;
2309
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DomainmigrationMigration[]>;
2310
+ /** Suggest a list of domains based on a prompt using AI. */
2311
+ suggest: (conf: {
2312
+ queryParameters: {
2313
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2314
+ prompt: string;
2315
+ domainCount?: number | undefined;
2316
+ tlds?: string[] | undefined;
2317
+ };
2318
+ headers?: {
2319
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2320
+ } | undefined;
2321
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2322
+ domains: string[];
2323
+ }>;
2324
+ /** List Ingresses. */
2325
+ ingressListIngresses: (conf?: {
2326
+ headers?: {
2327
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2328
+ "x-access-token"?: string | undefined;
2329
+ } | undefined;
2330
+ queryParameters?: {
2331
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2332
+ projectId?: string | undefined;
2333
+ certificateId?: string | undefined;
2334
+ hostnameSubstring?: string | undefined;
2335
+ appInstallationId?: string | undefined;
2336
+ limit?: number | undefined;
2337
+ skip?: number | undefined;
2338
+ page?: number | undefined;
2339
+ } | undefined;
2340
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.IngressIngress[]>;
2341
+ /** Get an Ingress. */
2342
+ ingressGetIngress: (conf: {
2343
+ ingressId: string;
2344
+ headers?: {
2345
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2346
+ "x-access-token"?: string | undefined;
2347
+ } | undefined;
2348
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2349
+ dnsValidationErrors: ("ERROR_UNSPECIFIED" | "ERROR_QUAD_A" | "ERROR_NO_A_RECORD" | "ERROR_ACME_CERTIFICATE_REQUEST_DEADLINE_EXCEEDED")[];
2350
+ hostname: string;
2351
+ id: string;
2352
+ ips: {
2353
+ v4: string[];
2354
+ v6: string[];
2355
+ };
2356
+ isDefault: boolean;
2357
+ isDomain?: boolean | undefined;
2358
+ isEnabled: boolean;
2359
+ ownership: import("./types.js").MittwaldAPIV3Next.Components.Schemas.IngressOwnership;
2360
+ paths: import("./types.js").MittwaldAPIV3Next.Components.Schemas.IngressPath[];
2361
+ projectId: string;
2362
+ tls: import("./types.js").MittwaldAPIV3Next.Components.Schemas.IngressTlsAcme | import("./types.js").MittwaldAPIV3Next.Components.Schemas.IngressTlsCertificate;
2363
+ }>;
2364
+ /** List CertificateRequests belonging to a Project or an Ingress. */
2365
+ sslListCertificateRequests: (conf?: {
2366
+ headers?: {
2367
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2368
+ "x-access-token"?: string | undefined;
2369
+ } | undefined;
2370
+ queryParameters?: {
2371
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2372
+ projectId?: string | undefined;
2373
+ ingressId?: string | undefined;
2374
+ } | undefined;
2375
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.SslCertificateRequest[]>;
2376
+ /** Get a CertificateRequest. */
2377
+ sslGetCertificateRequest: (conf: {
2378
+ certificateRequestId: string;
2379
+ headers?: {
2380
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2381
+ "x-access-token"?: string | undefined;
2382
+ } | undefined;
2383
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2384
+ certificateData: import("./types.js").MittwaldAPIV3Next.Components.Schemas.SslCertificateData;
2385
+ certificateType: import("./types.js").MittwaldAPIV3Next.Components.Schemas.SslCertificateType;
2386
+ commonName?: string | undefined;
2387
+ contact?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.SslContact | undefined;
2388
+ createdAt: string;
2389
+ dnsNames?: string[] | undefined;
2390
+ id: string;
2391
+ isCompleted: boolean;
2392
+ issuer?: string | undefined;
2393
+ projectId: string;
2394
+ validFrom?: string | undefined;
2395
+ validTo?: string | undefined;
2396
+ }>;
2397
+ /** Get a Certificate. */
2398
+ sslGetCertificate: (conf: {
2399
+ certificateId: string;
2400
+ headers?: {
2401
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2402
+ "x-access-token"?: string | undefined;
2403
+ } | undefined;
2404
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2405
+ caBundle?: string | undefined;
2406
+ certificate?: string | undefined;
2407
+ certificateOrderId?: string | undefined;
2408
+ certificateRequestId: string;
2409
+ certificateType: import("./types.js").MittwaldAPIV3Next.Components.Schemas.SslCertificateType;
2410
+ commonName?: string | undefined;
2411
+ contact?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.SslContact | undefined;
2412
+ dnsCertSpec?: {
2413
+ cnameTarget?: string;
2414
+ status?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.SslDNSCertStatus;
2415
+ } | undefined;
2416
+ dnsNames?: string[] | undefined;
2417
+ id: string;
2418
+ isExpired?: boolean | undefined;
2419
+ issuer?: string | undefined;
2420
+ lastExpirationThresholdHit?: number | undefined;
2421
+ projectId: string;
2422
+ validFrom?: string | undefined;
2423
+ validTo?: string | undefined;
2424
+ }>;
2425
+ /** List Certificates belonging to a Project or an Ingress. */
2426
+ sslListCertificates: (conf?: {
2427
+ headers?: {
2428
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2429
+ "x-access-token"?: string | undefined;
2430
+ } | undefined;
2431
+ queryParameters?: {
2432
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2433
+ projectId?: string | undefined;
2434
+ ingressId?: string | undefined;
2435
+ } | undefined;
2436
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.SslCertificate[]>;
2437
+ };
2438
+ declare const buildFileApi: (baseClient: MittwaldAPIV3NextClient) => {
2439
+ /** Get a File's meta. */
2440
+ getFileMeta: (conf: {
2441
+ fileId: string;
2442
+ headers?: {
2443
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2444
+ Token?: string | undefined;
2445
+ } | undefined;
2446
+ queryParameters?: {
2447
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2448
+ token?: string | undefined;
2449
+ } | undefined;
2450
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2451
+ friendlyURL: string;
2452
+ friendlyUrl: string;
2453
+ id: string;
2454
+ mimeType: string;
2455
+ name: string;
2456
+ sizeInBytes: number;
2457
+ type: string;
2458
+ }>;
2459
+ /** Get a FileUploadToken's rules. */
2460
+ getFileUploadTokenRules: (conf: {
2461
+ fileUploadToken: string;
2462
+ headers?: {
2463
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2464
+ } | undefined;
2465
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2466
+ extensions: string[];
2467
+ fileTypes: import("./types.js").MittwaldAPIV3Next.Components.Schemas.FileFileType[];
2468
+ maxNameLength: number;
2469
+ maxSizeInBytes: number;
2470
+ maxSizeInKB: number;
2471
+ maxSizeInKb: number;
2472
+ mimeTypes: string[];
2473
+ properties?: {
2474
+ imageDimensions?: {
2475
+ max?: {
2476
+ height?: number;
2477
+ width?: number;
2478
+ };
2479
+ min?: {
2480
+ height?: number;
2481
+ width?: number;
2482
+ };
2483
+ };
2484
+ } | undefined;
2485
+ }>;
2486
+ /** Get a FileUploadType's rules. */
2487
+ getFileUploadTypeRules: (conf: {
2488
+ fileUploadType: "avatar" | "extensionAssetImage" | "extensionAssetVideo" | "anchorIcon" | "conversation";
2489
+ headers?: {
2490
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2491
+ } | undefined;
2492
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2493
+ extensions: string[];
2494
+ fileTypes: import("./types.js").MittwaldAPIV3Next.Components.Schemas.FileFileType[];
2495
+ maxNameLength: number;
2496
+ maxSizeInBytes: number;
2497
+ maxSizeInKB: number;
2498
+ maxSizeInKb: number;
2499
+ mimeTypes: string[];
2500
+ properties?: {
2501
+ imageDimensions?: {
2502
+ max?: {
2503
+ height?: number;
2504
+ width?: number;
2505
+ };
2506
+ min?: {
2507
+ height?: number;
2508
+ width?: number;
2509
+ };
2510
+ };
2511
+ } | undefined;
2512
+ }>;
2513
+ /** Get a File. */
2514
+ getFile: (conf: {
2515
+ fileId: string;
2516
+ headers?: {
2517
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2518
+ Accept?: "application/octet-stream" | "text/plain;base64" | undefined;
2519
+ "Content-Disposition"?: "inline" | "attachment" | undefined;
2520
+ Token?: string | undefined;
2521
+ } | undefined;
2522
+ queryParameters?: {
2523
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2524
+ accept?: "application/octet-stream" | "text/plain;base64" | undefined;
2525
+ "content-disposition"?: "inline" | "attachment" | undefined;
2526
+ token?: string | undefined;
2527
+ } | undefined;
2528
+ }) => import("@mittwald/react-use-promise").AsyncResource<string>;
2529
+ /** Get a File with user-friendly url. */
2530
+ getFileWithName: (conf: {
2531
+ fileId: string;
2532
+ fileName: string;
2533
+ headers?: {
2534
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2535
+ Accept?: "application/octet-stream" | "text/plain;base64" | undefined;
2536
+ "Content-Disposition"?: "inline" | "attachment" | undefined;
2537
+ Token?: string | undefined;
2538
+ } | undefined;
2539
+ queryParameters?: {
2540
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2541
+ accept?: "application/octet-stream" | "text/plain;base64" | undefined;
2542
+ "content-disposition"?: "inline" | "attachment" | undefined;
2543
+ token?: string | undefined;
2544
+ } | undefined;
2545
+ }) => import("@mittwald/react-use-promise").AsyncResource<string>;
2546
+ };
2547
+ declare const buildLeadFyndrApi: (baseClient: MittwaldAPIV3NextClient) => {
2548
+ /** Get your LeadFyndr request. */
2549
+ leadfyndrGetLeadFyndrProfileRequest: (conf: {
2550
+ customerId: string;
2551
+ headers?: {
2552
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2553
+ } | undefined;
2554
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2555
+ createdOn: string;
2556
+ customerId: string;
2557
+ domain: string;
2558
+ profileId: string;
2559
+ requestedBy: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrUser;
2560
+ resultOn?: string | undefined;
2561
+ status: "AUTOTEST_INIT" | "MANUAL_VERIFICATION" | "REJECTED" | "APPROVED";
2562
+ }>;
2563
+ /** Get cities in DACH. */
2564
+ leadfyndrGetCities: (conf: {
2565
+ queryParameters: {
2566
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2567
+ input: string;
2568
+ };
2569
+ headers?: {
2570
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2571
+ } | undefined;
2572
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrCity[]>;
2573
+ /** Get lead tariff options. How many leads did you unlock this month? */
2574
+ leadfyndrGetLeadFyndrProfileTariffOptions: (conf: {
2575
+ customerId: string;
2576
+ headers?: {
2577
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2578
+ } | undefined;
2579
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2580
+ nextUnlockRenewalDate?: string | undefined;
2581
+ reservation: {
2582
+ available: number;
2583
+ tariffLimit: number;
2584
+ used: number;
2585
+ };
2586
+ unlocked: {
2587
+ available: number;
2588
+ tariffLimit: number;
2589
+ used: number;
2590
+ };
2591
+ }>;
2592
+ /** Get your LeadFyndr profile. */
2593
+ leadfyndrGetLeadFyndrProfile: (conf: {
2594
+ customerId: string;
2595
+ headers?: {
2596
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2597
+ } | undefined;
2598
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2599
+ approvedOn: string;
2600
+ customerId: string;
2601
+ disabledOn?: string | undefined;
2602
+ domain: string;
2603
+ tariff: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrTariffOptions;
2604
+ }>;
2605
+ /** Get a simple lead. Use the unlocked route for more detail leads. */
2606
+ leadfyndrGetLead: (conf: {
2607
+ leadId: string;
2608
+ customerId: string;
2609
+ headers?: {
2610
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2611
+ } | undefined;
2612
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2613
+ businessFields: string[];
2614
+ company: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrBasicCompany;
2615
+ description: string;
2616
+ hoster: {
2617
+ server: string[];
2618
+ };
2619
+ languages: string[];
2620
+ leadId: string;
2621
+ mainTechnology?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrTechnology | undefined;
2622
+ metrics: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrBasicMetrics;
2623
+ potential: number;
2624
+ scannedAt?: string | undefined;
2625
+ screenshot: string;
2626
+ technologies: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrTechnology[];
2627
+ }>;
2628
+ /** Get unlocked leads export history for the given customerId. */
2629
+ leadfyndrGetLeadsExportHistory: (conf: {
2630
+ customerId: string;
2631
+ headers?: {
2632
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2633
+ } | undefined;
2634
+ queryParameters?: {
2635
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2636
+ limit?: number | undefined;
2637
+ skip?: number | undefined;
2638
+ page?: number | undefined;
2639
+ sort?: "exportedAt" | undefined;
2640
+ order?: "asc" | "desc" | undefined;
2641
+ } | undefined;
2642
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrLeadsExport[]>;
2643
+ /** Get a detail of a unlocked lead. Organisation can unlock leads. */
2644
+ leadfyndrGetUnlockedLead: (conf: {
2645
+ leadId: string;
2646
+ customerId: string;
2647
+ headers?: {
2648
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2649
+ } | undefined;
2650
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2651
+ actualUrl: string;
2652
+ businessFields: string[];
2653
+ company: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrDetailCompany;
2654
+ contact: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrContact;
2655
+ description: string;
2656
+ domain: string;
2657
+ hoster: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrHoster;
2658
+ languages: string[];
2659
+ leadId: string;
2660
+ mainTechnology?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrTechnology | undefined;
2661
+ metrics: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrDetailMetrics;
2662
+ potential: number;
2663
+ reservationAllowed?: boolean | undefined;
2664
+ reservedAt?: string | undefined;
2665
+ scannedAt?: string | undefined;
2666
+ screenshot: string;
2667
+ socialMedia: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrSocialMedia[];
2668
+ technologies: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrTechnology[];
2669
+ unlockedAt: string;
2670
+ }>;
2671
+ /** Get all leads. Use the unlocked routes for more lead details. */
2672
+ leadfyndrListLeads: (conf: {
2673
+ customerId: string;
2674
+ headers?: {
2675
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2676
+ } | undefined;
2677
+ queryParameters?: {
2678
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2679
+ potentialRangeMin?: number | undefined;
2680
+ potentialRangeMax?: number | undefined;
2681
+ employeeCountMin?: number | undefined;
2682
+ employeeCountMax?: number | undefined;
2683
+ salesVolumeMin?: number | undefined;
2684
+ salesVolumeMax?: number | undefined;
2685
+ technologies?: (string | "none")[] | undefined;
2686
+ businessFields?: string[] | undefined;
2687
+ locationCity?: string | undefined;
2688
+ locationPostCode?: string | undefined;
2689
+ locationRadiusInKm?: number | undefined;
2690
+ "basic:timeToFirstByteMs:min"?: number | undefined;
2691
+ "basic:timeToFirstByteMs:max"?: number | undefined;
2692
+ "basic:desktop:performance:min"?: number | undefined;
2693
+ "basic:desktop:performance:max"?: number | undefined;
2694
+ "basic:mobile:performance:min"?: number | undefined;
2695
+ "basic:mobile:performance:max"?: number | undefined;
2696
+ limit?: number | undefined;
2697
+ skip?: number | undefined;
2698
+ page?: number | undefined;
2699
+ sort?: "potential" | "relevance" | undefined;
2700
+ order?: "asc" | "desc" | undefined;
2701
+ } | undefined;
2702
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2703
+ leads: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrLead[];
2704
+ limit: number;
2705
+ skip: number;
2706
+ totalCount: number;
2707
+ }>;
2708
+ /** Get all unlocked leads. Organisation can unlock leads. */
2709
+ leadfyndrListUnlockedLeads: (conf: {
2710
+ customerId: string;
2711
+ headers?: {
2712
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2713
+ } | undefined;
2714
+ queryParameters?: {
2715
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2716
+ potentialRangeMin?: number | undefined;
2717
+ potentialRangeMax?: number | undefined;
2718
+ employeeCountMin?: number | undefined;
2719
+ employeeCountMax?: number | undefined;
2720
+ salesVolumeMin?: number | undefined;
2721
+ salesVolumeMax?: number | undefined;
2722
+ technologies?: (string | "none")[] | undefined;
2723
+ businessFields?: string[] | undefined;
2724
+ locationCity?: string | undefined;
2725
+ locationPostCode?: string | undefined;
2726
+ locationRadiusInKm?: number | undefined;
2727
+ "basic:timeToFirstByteMs:min"?: number | undefined;
2728
+ "basic:timeToFirstByteMs:max"?: number | undefined;
2729
+ "basic:desktop:performance:min"?: number | undefined;
2730
+ "basic:desktop:performance:max"?: number | undefined;
2731
+ "basic:mobile:performance:min"?: number | undefined;
2732
+ "basic:mobile:performance:max"?: number | undefined;
2733
+ reserved?: boolean | undefined;
2734
+ limit?: number | undefined;
2735
+ skip?: number | undefined;
2736
+ page?: number | undefined;
2737
+ sort?: "potential" | "relevance" | "company" | undefined;
2738
+ order?: "asc" | "desc" | undefined;
2739
+ } | undefined;
2740
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2741
+ leads: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LeadfyndrUnlockedLead[];
2742
+ limit: number;
2743
+ skip: number;
2744
+ totalCount: number;
2745
+ }>;
2746
+ };
2747
+ declare const buildLicenseApi: (baseClient: MittwaldAPIV3NextClient) => {
2748
+ /** Get a license. */
2749
+ getLicense: (conf: {
2750
+ licenseId: string;
2751
+ headers?: {
2752
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2753
+ "x-access-token"?: string | undefined;
2754
+ } | undefined;
2755
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2756
+ description: string;
2757
+ expiryDate?: string | undefined;
2758
+ id: string;
2759
+ keyReference?: (import("./types.js").MittwaldAPIV3Next.Components.Schemas.LicenseKey | import("./types.js").MittwaldAPIV3Next.Components.Schemas.LicenseExternalKey) | undefined;
2760
+ kind: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LicenseKind;
2761
+ meta: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LicenseMeta;
2762
+ reference: import("./types.js").MittwaldAPIV3Next.Components.Schemas.LicenseReference;
2763
+ volume?: number | undefined;
2764
+ }>;
2765
+ /** List Licenses belonging to a Project. */
2766
+ listLicensesForProject: (conf: {
2767
+ projectId: string;
2768
+ headers?: {
2769
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2770
+ "x-access-token"?: string | undefined;
2771
+ } | undefined;
2772
+ queryParameters?: {
2773
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2774
+ limit?: number | undefined;
2775
+ skip?: number | undefined;
2776
+ page?: number | undefined;
2777
+ } | undefined;
2778
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.LicenseLicense[]>;
2779
+ };
2780
+ declare const buildMailApi: (baseClient: MittwaldAPIV3NextClient) => {
2781
+ /** List DeliveryBoxes belonging to a Project. */
2782
+ listDeliveryBoxes: (conf: {
2783
+ projectId: string;
2784
+ headers?: {
2785
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2786
+ "x-access-token"?: string | undefined;
2787
+ } | undefined;
2788
+ queryParameters?: {
2789
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2790
+ search?: string | undefined;
2791
+ limit?: number | undefined;
2792
+ skip?: number | undefined;
2793
+ page?: number | undefined;
2794
+ } | undefined;
2795
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MailDeliverybox[]>;
2796
+ /** List MailAddresses belonging to a Project. */
2797
+ listMailAddresses: (conf: {
2798
+ projectId: string;
2799
+ headers?: {
2800
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2801
+ "x-access-token"?: string | undefined;
2802
+ } | undefined;
2803
+ queryParameters?: {
2804
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2805
+ search?: string | undefined;
2806
+ forwardAddress?: boolean | undefined;
2807
+ catchAll?: boolean | undefined;
2808
+ autoResponder?: boolean | undefined;
2809
+ mailArchive?: boolean | undefined;
2810
+ limit?: number | undefined;
2811
+ skip?: number | undefined;
2812
+ page?: number | undefined;
2813
+ sort?: ("address.domain" | "address.local" | "updatedAt" | "projectId" | "mailbox.quota" | "mailbox.name" | "mailbox.storageInBytes.current" | "mailbox.storageInBytes.limit")[] | undefined;
2814
+ order?: ("asc" | "desc")[] | undefined;
2815
+ } | undefined;
2816
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MailMailAddress[]>;
2817
+ /** Get a DeliveryBox. */
2818
+ getDeliveryBox: (conf: {
2819
+ deliveryBoxId: string;
2820
+ headers?: {
2821
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2822
+ "x-access-token"?: string | undefined;
2823
+ } | undefined;
2824
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2825
+ authenticationEnabled: boolean;
2826
+ description: string;
2827
+ id: string;
2828
+ name: string;
2829
+ passwordUpdatedAt: string;
2830
+ projectId: string;
2831
+ sendingEnabled: boolean;
2832
+ updatedAt: string;
2833
+ }>;
2834
+ /** Get a MailAddress. */
2835
+ getMailAddress: (conf: {
2836
+ mailAddressId: string;
2837
+ headers?: {
2838
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2839
+ "x-access-token"?: string | undefined;
2840
+ } | undefined;
2841
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2842
+ address: string;
2843
+ archive: {
2844
+ active: boolean;
2845
+ quota: number;
2846
+ usedBytes: number;
2847
+ };
2848
+ autoResponder: {
2849
+ active: boolean;
2850
+ expiresAt?: string;
2851
+ message?: string;
2852
+ startsAt?: string;
2853
+ };
2854
+ forwardAddresses: string[];
2855
+ id: string;
2856
+ isArchived: boolean;
2857
+ isBackupInProgress: boolean;
2858
+ isCatchAll: boolean;
2859
+ mailbox?: {
2860
+ name: string;
2861
+ passwordUpdatedAt: string;
2862
+ sendingEnabled: boolean;
2863
+ spamProtection: {
2864
+ active: boolean;
2865
+ autoDeleteSpam: boolean;
2866
+ folder: "spam" | "inbox";
2867
+ relocationMinSpamScore: number;
2868
+ };
2869
+ storageInBytes: {
2870
+ current: {
2871
+ updatedAt: string;
2872
+ value: number;
2873
+ };
2874
+ limit: number;
2875
+ };
2876
+ } | undefined;
2877
+ projectId: string;
2878
+ receivingDisabled: boolean;
2879
+ updatedAt: string;
2880
+ }>;
2881
+ /** List backups belonging to a MailAddress. */
2882
+ listBackupsForMailAddress: (conf: {
2883
+ mailAddressId: string;
2884
+ headers?: {
2885
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2886
+ "x-access-token"?: string | undefined;
2887
+ } | undefined;
2888
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MailMailAddressBackup[]>;
2889
+ /** List MailAddresses. */
2890
+ listMailAddressesForUser: (conf?: {
2891
+ headers?: {
2892
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2893
+ "x-access-token"?: string | undefined;
2894
+ } | undefined;
2895
+ queryParameters?: {
2896
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2897
+ projectId?: string | undefined;
2898
+ search?: string | undefined;
2899
+ forwardAddress?: boolean | undefined;
2900
+ catchAll?: boolean | undefined;
2901
+ autoResponder?: boolean | undefined;
2902
+ mailArchive?: boolean | undefined;
2903
+ limit?: number | undefined;
2904
+ skip?: number | undefined;
2905
+ page?: number | undefined;
2906
+ sort?: ("address.domain" | "address.local" | "updatedAt" | "projectId" | "mailbox.quota" | "mailbox.name" | "mailbox.storageInBytes.current" | "mailbox.storageInBytes.limit")[] | undefined;
2907
+ order?: ("asc" | "desc")[] | undefined;
2908
+ } | undefined;
2909
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MailMailAddress[]>;
2910
+ /** List mail settings of a Project. */
2911
+ listProjectMailSettings: (conf: {
2912
+ projectId: string;
2913
+ headers?: {
2914
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2915
+ "x-access-token"?: string | undefined;
2916
+ } | undefined;
2917
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2918
+ blacklist: string[];
2919
+ projectId: string;
2920
+ whitelist: string[];
2921
+ }>;
2922
+ };
2923
+ declare const buildMiscApi: (baseClient: MittwaldAPIV3NextClient) => {
2924
+ /** List valid time zones. */
2925
+ ellaneousListTimeZones: (conf?: {
2926
+ headers?: {
2927
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2928
+ "x-access-token"?: string | undefined;
2929
+ } | undefined;
2930
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<string[]>;
2931
+ };
2932
+ declare const buildNotificationApi: (baseClient: MittwaldAPIV3NextClient) => {
2933
+ /** Getting the subscription status of the subscription. */
2934
+ newsletterGetInfo: (conf?: {
2935
+ headers?: {
2936
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2937
+ "x-access-token"?: string | undefined;
2938
+ } | undefined;
2939
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
2940
+ active: boolean;
2941
+ email: string;
2942
+ registered: boolean;
2943
+ }>;
2944
+ /** Get the counts for unread notifications of the user. */
2945
+ scountUnreadNotifications: (conf?: {
2946
+ headers?: {
2947
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2948
+ "x-access-token"?: string | undefined;
2949
+ } | undefined;
2950
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
2951
+ error: number;
2952
+ info: number;
2953
+ success: number;
2954
+ total: number;
2955
+ warning: number;
2956
+ }>;
2957
+ /** List all unread notifications. */
2958
+ slistNotifications: (conf?: {
2959
+ headers?: {
2960
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2961
+ "x-access-token"?: string | undefined;
2962
+ } | undefined;
2963
+ queryParameters?: {
2964
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2965
+ status?: "unread" | "read" | undefined;
2966
+ severity?: ("success" | "info" | "warning" | "error")[] | undefined;
2967
+ type?: string[] | undefined;
2968
+ "type-not"?: string[] | undefined;
2969
+ limit?: number | undefined;
2970
+ skip?: number | undefined;
2971
+ page?: number | undefined;
2972
+ } | undefined;
2973
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MessagingNotification[]>;
2974
+ };
2975
+ declare const buildPageInsightsApi: (baseClient: MittwaldAPIV3NextClient) => {
2976
+ /** Get detailed performance data for a given domain and path. */
2977
+ pageinsightsGetPerformanceData: (conf: {
2978
+ queryParameters: {
2979
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2980
+ domain: string;
2981
+ path: string;
2982
+ date?: string | undefined;
2983
+ };
2984
+ headers?: {
2985
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2986
+ "x-access-token"?: string | undefined;
2987
+ } | undefined;
2988
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2989
+ createdAt?: string | undefined;
2990
+ domain: string;
2991
+ metrics?: {
2992
+ createdAt: string;
2993
+ name: string;
2994
+ score?: number;
2995
+ value: number;
2996
+ }[] | undefined;
2997
+ moreDataAvailable?: string[] | undefined;
2998
+ path: string;
2999
+ performanceScore: number;
3000
+ screenshot?: {
3001
+ createdAt: string;
3002
+ fileRef: string;
3003
+ } | undefined;
3004
+ }>;
3005
+ /** Get all data for a given strace. */
3006
+ pageinsightsGetStraceData: (conf: {
3007
+ straceId: string;
3008
+ projectId: string;
3009
+ headers?: {
3010
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3011
+ "x-access-token"?: string | undefined;
3012
+ } | undefined;
3013
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3014
+ executedAt: string;
3015
+ id: string;
3016
+ result: import("./types.js").MittwaldAPIV3Next.Components.Schemas.StraceError | import("./types.js").MittwaldAPIV3Next.Components.Schemas.StraceData;
3017
+ }>;
3018
+ /** List websites (specified as domain and path) from a project where performance data is available. */
3019
+ pageinsightsListPerformanceDataForProject: (conf: {
3020
+ projectId: string;
3021
+ headers?: {
3022
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3023
+ "x-access-token"?: string | undefined;
3024
+ } | undefined;
3025
+ queryParameters?: {
3026
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3027
+ domain?: string | undefined;
3028
+ } | undefined;
3029
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3030
+ domain: string;
3031
+ paths: {
3032
+ createdAt: string;
3033
+ path: string;
3034
+ performanceScore: number;
3035
+ screenshotFileRef?: string;
3036
+ }[];
3037
+ }[]>;
3038
+ };
3039
+ declare const buildUserApi: (baseClient: MittwaldAPIV3NextClient) => {
3040
+ /** Get a PasswordPolicy. */
3041
+ passwordValidationGetPasswordPolicy: (conf: {
3042
+ passwordPolicy: string;
3043
+ headers?: {
3044
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3045
+ } | undefined;
3046
+ }) => import("@mittwald/react-use-promise").AsyncResource<string>;
3047
+ /** Get your verified Email-Address. */
3048
+ getOwnEmail: (conf?: {
3049
+ headers?: {
3050
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3051
+ "x-access-token"?: string | undefined;
3052
+ } | undefined;
3053
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
3054
+ email: string;
3055
+ }>;
3056
+ /** Get your current multi factor auth status. */
3057
+ getMfaStatus: (conf?: {
3058
+ headers?: {
3059
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3060
+ "x-access-token"?: string | undefined;
3061
+ } | undefined;
3062
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
3063
+ confirmed: boolean;
3064
+ initialized: boolean;
3065
+ }>;
3066
+ /** List all of your ApiTokens. */
3067
+ listApiTokens: (conf?: {
3068
+ headers?: {
3069
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3070
+ "x-access-token"?: string | undefined;
3071
+ } | undefined;
3072
+ queryParameters?: {
3073
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3074
+ limit?: number | undefined;
3075
+ skip?: number | undefined;
3076
+ page?: number | undefined;
3077
+ } | undefined;
3078
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.SignupApiToken[]>;
3079
+ /** Get your stored ssh-keys. */
3080
+ listSshKeys: (conf?: {
3081
+ headers?: {
3082
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3083
+ "x-access-token"?: string | undefined;
3084
+ } | undefined;
3085
+ queryParameters?: {
3086
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3087
+ limit?: number | undefined;
3088
+ skip?: number | undefined;
3089
+ page?: number | undefined;
3090
+ } | undefined;
3091
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
3092
+ sshKeys?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.SignupSshKey[] | undefined;
3093
+ }>;
3094
+ /** Get a specific ApiToken. */
3095
+ getApiToken: (conf: {
3096
+ apiTokenId: string;
3097
+ headers?: {
3098
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3099
+ "x-access-token"?: string | undefined;
3100
+ } | undefined;
3101
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3102
+ apiTokenId: string;
3103
+ createdAt: string;
3104
+ description: string;
3105
+ expiresAt?: string | undefined;
3106
+ roles: ("api_read" | "api_write")[];
3107
+ }>;
3108
+ /** Get a specific stored ssh-key. */
3109
+ getSshKey: (conf: {
3110
+ sshKeyId: string;
3111
+ headers?: {
3112
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3113
+ "x-access-token"?: string | undefined;
3114
+ } | undefined;
3115
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3116
+ sshKey: import("./types.js").MittwaldAPIV3Next.Components.Schemas.SignupSshKey;
3117
+ }>;
3118
+ /** Check status of the current session. */
3119
+ getCurrentSessionStatus: (conf?: {
3120
+ headers?: {
3121
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3122
+ "x-access-token"?: string | undefined;
3123
+ } | undefined;
3124
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
3125
+ isEmployee: boolean;
3126
+ isImpersonated: boolean;
3127
+ tokenId: string;
3128
+ userId: string;
3129
+ }>;
3130
+ /** The timestamp of your latest password change. */
3131
+ getPasswordUpdatedAt: (conf?: {
3132
+ headers?: {
3133
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3134
+ "x-access-token"?: string | undefined;
3135
+ } | undefined;
3136
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
3137
+ passwordUpdatedAt: string;
3138
+ }>;
3139
+ /** Get personalized settings. */
3140
+ getPersonalizedSettings: (conf: {
3141
+ userId: string;
3142
+ headers?: {
3143
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3144
+ "x-access-token"?: string | undefined;
3145
+ } | undefined;
3146
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3147
+ settingsString?: string | undefined;
3148
+ }>;
3149
+ /** Get poll settings for the specified user. */
3150
+ getPollStatus: (conf: {
3151
+ userId: string;
3152
+ headers?: {
3153
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3154
+ } | undefined;
3155
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3156
+ completedAt?: string | undefined;
3157
+ dontShowUntil?: string | undefined;
3158
+ ignoredAt?: string | undefined;
3159
+ shouldShow: boolean;
3160
+ status: "completed" | "muted" | "ignored" | "new";
3161
+ userId: string;
3162
+ }>;
3163
+ /** Get a specific session. */
3164
+ getSession: (conf: {
3165
+ tokenId: string;
3166
+ headers?: {
3167
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3168
+ "x-access-token"?: string | undefined;
3169
+ } | undefined;
3170
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3171
+ created: string;
3172
+ device: import("./types.js").MittwaldAPIV3Next.Components.Schemas.SignupDeviceInfo;
3173
+ lastAccess?: string | undefined;
3174
+ location?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.SignupLocation | undefined;
3175
+ tokenId: string;
3176
+ }>;
3177
+ /** Get profile information for a user. */
3178
+ getUser: (conf: {
3179
+ userId: string;
3180
+ headers?: {
3181
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3182
+ "x-access-token"?: string | undefined;
3183
+ } | undefined;
3184
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3185
+ avatarRef?: string | undefined;
3186
+ customerMemberships?: {
3187
+ [k: string]: import("./types.js").MittwaldAPIV3Next.Components.Schemas.UserCustomerMembership;
3188
+ } | undefined;
3189
+ email?: string | undefined;
3190
+ employeeInformation?: {
3191
+ department: string;
3192
+ } | undefined;
3193
+ isEmployee?: boolean | undefined;
3194
+ mfa?: {
3195
+ active: boolean;
3196
+ setup: boolean;
3197
+ } | undefined;
3198
+ passwordUpdatedAt?: string | undefined;
3199
+ person: import("./types.js").MittwaldAPIV3Next.Components.Schemas.CommonsPerson;
3200
+ phoneNumber?: string | undefined;
3201
+ projectMemberships?: {
3202
+ [k: string]: import("./types.js").MittwaldAPIV3Next.Components.Schemas.UserProjectMembership;
3203
+ } | undefined;
3204
+ registeredAt?: string | undefined;
3205
+ userId: string;
3206
+ }>;
3207
+ /** Submitted feedback of the given user. */
3208
+ listFeedback: (conf: {
3209
+ userId: string;
3210
+ headers?: {
3211
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3212
+ "x-access-token"?: string | undefined;
3213
+ } | undefined;
3214
+ queryParameters?: {
3215
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3216
+ subject?: string | undefined;
3217
+ } | undefined;
3218
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.UserUserFeedback[]>;
3219
+ /** List all sessions. */
3220
+ listSessions: (conf?: {
3221
+ headers?: {
3222
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3223
+ "x-access-token"?: string | undefined;
3224
+ } | undefined;
3225
+ queryParameters?: {
3226
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3227
+ limit?: number | undefined;
3228
+ skip?: number | undefined;
3229
+ page?: number | undefined;
3230
+ } | undefined;
3231
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.SignupUserSession[]>;
3232
+ /** Obtain authorization from the resource owner. */
3233
+ oauthGetAuthorization: (conf: {
3234
+ queryParameters: {
3235
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3236
+ response_type: "code";
3237
+ client_id: string;
3238
+ grant_consent?: boolean | undefined;
3239
+ grant_type?: "authorization_code" | undefined;
3240
+ redirect_uri?: string | undefined;
3241
+ scope?: string | undefined;
3242
+ state?: string | undefined;
3243
+ code_challenge?: string | undefined;
3244
+ code_challenge_method?: "S256" | undefined;
3245
+ };
3246
+ headers?: {
3247
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3248
+ } | undefined;
3249
+ }) => import("@mittwald/react-use-promise").AsyncResource<never>;
3250
+ /** Request a support code. */
3251
+ supportCodeRequest: (conf?: {
3252
+ headers?: {
3253
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3254
+ "x-access-token"?: string | undefined;
3255
+ } | undefined;
3256
+ queryParameters?: {
3257
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3258
+ forceRecreate?: boolean | undefined;
3259
+ } | undefined;
3260
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
3261
+ expiresAt: string;
3262
+ supportCode: string;
3263
+ }>;
3264
+ };
3265
+ declare const buildProjectApi: (baseClient: MittwaldAPIV3NextClient) => {
3266
+ /** List Invites belonging to a Project. */
3267
+ listInvitesForProject: (conf: {
3268
+ projectId: string;
3269
+ headers?: {
3270
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3271
+ "x-access-token"?: string | undefined;
3272
+ } | undefined;
3273
+ queryParameters?: {
3274
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3275
+ limit?: number | undefined;
3276
+ skip?: number | undefined;
3277
+ searchTerm?: string | undefined;
3278
+ } | undefined;
3279
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipProjectInvite[]>;
3280
+ /** Get a ProjectInvite. */
3281
+ getProjectInvite: (conf: {
3282
+ projectInviteId: string;
3283
+ headers?: {
3284
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3285
+ "x-access-token"?: string | undefined;
3286
+ } | undefined;
3287
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3288
+ avatarRefId?: string | undefined;
3289
+ id: string;
3290
+ information: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipInviteInformation;
3291
+ mailAddress: string;
3292
+ membershipExpiresAt?: string | undefined;
3293
+ message?: string | undefined;
3294
+ projectDescription: string;
3295
+ projectId: string;
3296
+ role: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipProjectRoles;
3297
+ }>;
3298
+ /** Get a ProjectMembership */
3299
+ getProjectMembership: (conf: {
3300
+ projectMembershipId: string;
3301
+ headers?: {
3302
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3303
+ "x-access-token"?: string | undefined;
3304
+ } | undefined;
3305
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3306
+ avatarRef?: string | undefined;
3307
+ email: string;
3308
+ expiresAt?: string | undefined;
3309
+ firstName: string;
3310
+ id: string;
3311
+ inherited: boolean;
3312
+ inviteId?: string | undefined;
3313
+ lastName: string;
3314
+ memberSince?: string | undefined;
3315
+ mfa: boolean;
3316
+ projectId: string;
3317
+ role: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipProjectRoles;
3318
+ userId: string;
3319
+ }>;
3320
+ /** Get a Project. */
3321
+ getProject: (conf: {
3322
+ projectId: string;
3323
+ headers?: {
3324
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3325
+ "x-access-token"?: string | undefined;
3326
+ } | undefined;
3327
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3328
+ backupStorageUsageInBytes: number;
3329
+ backupStorageUsageInBytesSetAt: string;
3330
+ clusterDomain?: string | undefined;
3331
+ clusterID?: string | undefined;
3332
+ clusterId?: string | undefined;
3333
+ createdAt: string;
3334
+ customerId: string;
3335
+ deletionRequested?: boolean | undefined;
3336
+ description: string;
3337
+ directories: {
3338
+ [k: string]: string;
3339
+ };
3340
+ disableReason?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectDisableReason | undefined;
3341
+ disabledAt?: string | undefined;
3342
+ enabled: boolean;
3343
+ features?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectProjectFeature[] | undefined;
3344
+ id: string;
3345
+ imageRefId?: string | undefined;
3346
+ isReady: boolean;
3347
+ projectHostingId?: string | undefined;
3348
+ readiness: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectDeprecatedProjectReadinessStatus;
3349
+ serverGroupId: string;
3350
+ serverId?: string | undefined;
3351
+ serverShortId?: string | undefined;
3352
+ shortId: string;
3353
+ spec?: (import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectVisitorSpec | import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectHardwareSpec) | undefined;
3354
+ statisticsBaseDomain?: string | undefined;
3355
+ status: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectProjectStatus;
3356
+ statusSetAt: string;
3357
+ supportedFeatures: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectProjectFeature[];
3358
+ webStorageUsageInBytes: number;
3359
+ webStorageUsageInBytesSetAt: string;
3360
+ }>;
3361
+ /** Get a ProjectInvite by token. */
3362
+ getProjectTokenInvite: (conf: {
3363
+ headers: {
3364
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3365
+ token: string;
3366
+ "x-access-token"?: string | undefined;
3367
+ };
3368
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3369
+ avatarRefId?: string | undefined;
3370
+ id: string;
3371
+ information: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipInviteInformation;
3372
+ mailAddress: string;
3373
+ membershipExpiresAt?: string | undefined;
3374
+ message?: string | undefined;
3375
+ projectDescription: string;
3376
+ projectId: string;
3377
+ role: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipProjectRoles;
3378
+ }>;
3379
+ /** Get the executing user's membership in a Project. */
3380
+ getSelfMembershipForProject: (conf: {
3381
+ projectId: string;
3382
+ headers?: {
3383
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3384
+ "x-access-token"?: string | undefined;
3385
+ } | undefined;
3386
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3387
+ avatarRef?: string | undefined;
3388
+ email: string;
3389
+ expiresAt?: string | undefined;
3390
+ firstName: string;
3391
+ id: string;
3392
+ inherited: boolean;
3393
+ inviteId?: string | undefined;
3394
+ lastName: string;
3395
+ memberSince?: string | undefined;
3396
+ mfa: boolean;
3397
+ projectId: string;
3398
+ role: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipProjectRoles;
3399
+ userId: string;
3400
+ }>;
3401
+ /** Get a Server. */
3402
+ getServer: (conf: {
3403
+ serverId: string;
3404
+ headers?: {
3405
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3406
+ "x-access-token"?: string | undefined;
3407
+ } | undefined;
3408
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3409
+ clusterName: string;
3410
+ createdAt: string;
3411
+ customerId: string;
3412
+ description: string;
3413
+ disabledReason?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectServerDisableReason | undefined;
3414
+ groupId: string;
3415
+ id: string;
3416
+ imageRefId?: string | undefined;
3417
+ isReady: boolean;
3418
+ machineType: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectMachineType;
3419
+ readiness: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectDeprecatedServerReadinessStatus;
3420
+ shortId: string;
3421
+ statisticsBaseDomain?: string | undefined;
3422
+ status: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectServerStatus;
3423
+ storage: string;
3424
+ }>;
3425
+ /** List Projects belonging to a Customer. */
3426
+ listCustomerProjects: (conf: {
3427
+ customerId: string;
3428
+ headers?: {
3429
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3430
+ "x-access-token"?: string | undefined;
3431
+ } | undefined;
3432
+ queryParameters?: {
3433
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3434
+ searchTerm?: string | undefined;
3435
+ limit?: number | undefined;
3436
+ skip?: number | undefined;
3437
+ page?: number | undefined;
3438
+ sort?: "createdAt" | "description" | undefined;
3439
+ order?: "asc" | "desc" | undefined;
3440
+ } | undefined;
3441
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectProjectListItem[]>;
3442
+ /** List Memberships belonging to a Project. */
3443
+ listMembershipsForProject: (conf: {
3444
+ projectId: string;
3445
+ headers?: {
3446
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3447
+ "x-access-token"?: string | undefined;
3448
+ } | undefined;
3449
+ queryParameters?: {
3450
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3451
+ limit?: number | undefined;
3452
+ skip?: number | undefined;
3453
+ hasExpiry?: boolean | undefined;
3454
+ isInherited?: boolean | undefined;
3455
+ role?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipProjectRoles | undefined;
3456
+ hasMfa?: boolean | undefined;
3457
+ searchTerm?: string | undefined;
3458
+ } | undefined;
3459
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipProjectMembership[]>;
3460
+ /** Get the activities of a project. */
3461
+ listProjectActivities: (conf: {
3462
+ projectId: string;
3463
+ headers?: {
3464
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3465
+ } | undefined;
3466
+ queryParameters?: {
3467
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3468
+ aggregateName?: string | undefined;
3469
+ aggregateDomain?: string | undefined;
3470
+ aggregateId?: string | undefined;
3471
+ startTime?: string | undefined;
3472
+ endTime?: string | undefined;
3473
+ fulltextSearch?: string | undefined;
3474
+ limit?: number | undefined;
3475
+ skip?: number | undefined;
3476
+ page?: number | undefined;
3477
+ sort?: "dateTime" | undefined;
3478
+ order?: "asc" | "desc" | undefined;
3479
+ } | undefined;
3480
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ActivitylogLogEntry[]>;
3481
+ /** List ProjectInvites belonging to the executing user. */
3482
+ listProjectInvites: (conf?: {
3483
+ headers?: {
3484
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3485
+ "x-access-token"?: string | undefined;
3486
+ } | undefined;
3487
+ queryParameters?: {
3488
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3489
+ limit?: number | undefined;
3490
+ skip?: number | undefined;
3491
+ page?: number | undefined;
3492
+ } | undefined;
3493
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipProjectInvite[]>;
3494
+ /** List ProjectMemberships belonging to the executing user. */
3495
+ listProjectMemberships: (conf?: {
3496
+ headers?: {
3497
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3498
+ "x-access-token"?: string | undefined;
3499
+ } | undefined;
3500
+ queryParameters?: {
3501
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3502
+ limit?: number | undefined;
3503
+ skip?: number | undefined;
3504
+ page?: number | undefined;
3505
+ hasExpiry?: boolean | undefined;
3506
+ isInherited?: boolean | undefined;
3507
+ role?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipProjectRoles | undefined;
3508
+ } | undefined;
3509
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.MembershipProjectMembership[]>;
3510
+ /** List Projects belonging to the executing user. */
3511
+ listProjects: (conf?: {
3512
+ headers?: {
3513
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3514
+ "x-access-token"?: string | undefined;
3515
+ } | undefined;
3516
+ queryParameters?: {
3517
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3518
+ customerId?: string | undefined;
3519
+ serverId?: string | undefined;
3520
+ searchTerm?: string | undefined;
3521
+ limit?: number | undefined;
3522
+ skip?: number | undefined;
3523
+ page?: number | undefined;
3524
+ sort?: "createdAt" | "description" | undefined;
3525
+ order?: "asc" | "desc" | undefined;
3526
+ } | undefined;
3527
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectProjectListItem[]>;
3528
+ /** List Servers belonging to the executing user. */
3529
+ listServers: (conf?: {
3530
+ headers?: {
3531
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3532
+ "x-access-token"?: string | undefined;
3533
+ } | undefined;
3534
+ queryParameters?: {
3535
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3536
+ customerId?: string | undefined;
3537
+ searchTerm?: string | undefined;
3538
+ limit?: number | undefined;
3539
+ skip?: number | undefined;
3540
+ page?: number | undefined;
3541
+ sort?: "createdAt" | "description" | undefined;
3542
+ order?: "asc" | "desc" | undefined;
3543
+ } | undefined;
3544
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectServer[]>;
3545
+ /** Get storage space Statistics belonging to a Project. */
3546
+ storagespaceGetProjectStatistics: (conf: {
3547
+ projectId: string;
3548
+ headers?: {
3549
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3550
+ "x-access-token"?: string | undefined;
3551
+ } | undefined;
3552
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3553
+ childStatistics?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.StoragespaceStatistics[] | undefined;
3554
+ description?: string | undefined;
3555
+ id: string;
3556
+ kind: import("./types.js").MittwaldAPIV3Next.Components.Schemas.StoragespaceStatisticsKind;
3557
+ meta: import("./types.js").MittwaldAPIV3Next.Components.Schemas.StoragespaceStatisticsMeta;
3558
+ name: string;
3559
+ notificationThresholdInBytes?: number | undefined;
3560
+ statisticCategories?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.StoragespaceStatisticsCategory[] | undefined;
3561
+ }>;
3562
+ /** Get storage space Statistics belonging to a Server. */
3563
+ storagespaceGetServerStatistics: (conf: {
3564
+ serverId: string;
3565
+ headers?: {
3566
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3567
+ "x-access-token"?: string | undefined;
3568
+ } | undefined;
3569
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3570
+ childStatistics?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.StoragespaceStatistics[] | undefined;
3571
+ description?: string | undefined;
3572
+ id: string;
3573
+ kind: import("./types.js").MittwaldAPIV3Next.Components.Schemas.StoragespaceStatisticsKind;
3574
+ meta: import("./types.js").MittwaldAPIV3Next.Components.Schemas.StoragespaceStatisticsMeta;
3575
+ name: string;
3576
+ notificationThresholdInBytes?: number | undefined;
3577
+ statisticCategories?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.StoragespaceStatisticsCategory[] | undefined;
3578
+ }>;
3579
+ };
3580
+ declare const buildProjectFileSystemApi: (baseClient: MittwaldAPIV3NextClient) => {
3581
+ /** List directories belonging to a Project. */
3582
+ getDirectories: (conf: {
3583
+ projectId: string;
3584
+ headers?: {
3585
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3586
+ "x-access-token"?: string | undefined;
3587
+ } | undefined;
3588
+ queryParameters?: {
3589
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3590
+ directory?: string | undefined;
3591
+ name?: string | undefined;
3592
+ max_depth?: number | undefined;
3593
+ type?: string[] | undefined;
3594
+ executable?: boolean | undefined;
3595
+ hidden?: boolean | undefined;
3596
+ } | undefined;
3597
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3598
+ absolutePath: string;
3599
+ isDirectory?: boolean | undefined;
3600
+ isExecutable?: boolean | undefined;
3601
+ isFile?: boolean | undefined;
3602
+ isSymlink?: boolean | undefined;
3603
+ items?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectFilesystemDirectoryListing[] | undefined;
3604
+ name: string;
3605
+ size: number;
3606
+ target?: string | undefined;
3607
+ }>;
3608
+ /** Get a Project directory filesystem usage. */
3609
+ getDiskUsage: (conf: {
3610
+ projectId: string;
3611
+ headers?: {
3612
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3613
+ "x-access-token"?: string | undefined;
3614
+ } | undefined;
3615
+ queryParameters?: {
3616
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3617
+ directory?: string | undefined;
3618
+ } | undefined;
3619
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3620
+ path?: string | undefined;
3621
+ totalBytes?: number | undefined;
3622
+ usedBytes?: number | undefined;
3623
+ }>;
3624
+ /** Get a Project file's content. */
3625
+ getFileContent: (conf: {
3626
+ projectId: string;
3627
+ headers?: {
3628
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3629
+ "x-access-token"?: string | undefined;
3630
+ } | undefined;
3631
+ queryParameters?: {
3632
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3633
+ file?: string | undefined;
3634
+ inline?: boolean | undefined;
3635
+ } | undefined;
3636
+ }) => import("@mittwald/react-use-promise").AsyncResource<string>;
3637
+ /** Get a Project's file/filesystem authorization token. */
3638
+ getJwt: (conf: {
3639
+ projectId: string;
3640
+ headers?: {
3641
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3642
+ "x-access-token"?: string | undefined;
3643
+ } | undefined;
3644
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3645
+ jwt: string;
3646
+ }>;
3647
+ /** Get a Project file's information. */
3648
+ listFiles: (conf: {
3649
+ projectId: string;
3650
+ headers?: {
3651
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3652
+ "x-access-token"?: string | undefined;
3653
+ } | undefined;
3654
+ queryParameters?: {
3655
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3656
+ file?: string | undefined;
3657
+ } | undefined;
3658
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3659
+ absolutePath: string;
3660
+ isDirectory?: boolean | undefined;
3661
+ isExecutable?: boolean | undefined;
3662
+ isFile?: boolean | undefined;
3663
+ isSymlink?: boolean | undefined;
3664
+ items?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.ProjectFilesystemDirectoryListing[] | undefined;
3665
+ name: string;
3666
+ size: number;
3667
+ target?: string | undefined;
3668
+ }>;
3669
+ };
3670
+ declare const buildSshsftpUserApi: (baseClient: MittwaldAPIV3NextClient) => {
3671
+ /** Get all SFTPUsers for a Project. */
3672
+ sftpUserListSftpUsers: (conf: {
3673
+ projectId: string;
3674
+ headers?: {
3675
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3676
+ "x-access-token"?: string | undefined;
3677
+ } | undefined;
3678
+ queryParameters?: {
3679
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3680
+ limit?: number | undefined;
3681
+ skip?: number | undefined;
3682
+ } | undefined;
3683
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.SshuserSftpUser[]>;
3684
+ /** Get an SFTPUser. */
3685
+ sftpUserGetSftpUser: (conf: {
3686
+ sftpUserId: string;
3687
+ headers?: {
3688
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3689
+ "x-access-token"?: string | undefined;
3690
+ } | undefined;
3691
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3692
+ accessLevel: import("./types.js").MittwaldAPIV3Next.Components.Schemas.SshuserAccessLevel;
3693
+ active?: boolean | undefined;
3694
+ authUpdatedAt: string;
3695
+ createdAt: string;
3696
+ description: string;
3697
+ directories?: string[] | undefined;
3698
+ expiresAt?: string | undefined;
3699
+ hasPassword: boolean;
3700
+ id: string;
3701
+ projectId: string;
3702
+ publicKeys?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.SshuserPublicKey[] | undefined;
3703
+ updatedAt?: string | undefined;
3704
+ userName: string;
3705
+ }>;
3706
+ /** Get all SSHUsers for a Project. */
3707
+ sshUserListSshUsers: (conf: {
3708
+ projectId: string;
3709
+ headers?: {
3710
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3711
+ "x-access-token"?: string | undefined;
3712
+ } | undefined;
3713
+ queryParameters?: {
3714
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3715
+ limit?: number | undefined;
3716
+ skip?: number | undefined;
3717
+ } | undefined;
3718
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.SshuserSshUser[]>;
3719
+ /** Get an SSHUser. */
3720
+ sshUserGetSshUser: (conf: {
3721
+ sshUserId: string;
3722
+ headers?: {
3723
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3724
+ "x-access-token"?: string | undefined;
3725
+ } | undefined;
3726
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3727
+ active?: boolean | undefined;
3728
+ authUpdatedAt: string;
3729
+ createdAt: string;
3730
+ description: string;
3731
+ expiresAt?: string | undefined;
3732
+ hasPassword: boolean;
3733
+ id: string;
3734
+ projectId: string;
3735
+ publicKeys?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.SshuserPublicKey[] | undefined;
3736
+ updatedAt?: string | undefined;
3737
+ userName: string;
3738
+ }>;
3739
+ };
3740
+ export declare class MittwaldAPIV3NextClientReact {
3741
+ /** The AI hosting provides access to multiple large language and embedding models – GDPR compliant and hosted in Germany. */
3742
+ readonly aiHosting: ReturnType<typeof buildAiHostingApi>;
3743
+ /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
3744
+ readonly app: ReturnType<typeof buildAppApi>;
3745
+ /** The article API allows you to read article information. */
3746
+ readonly article: ReturnType<typeof buildArticleApi>;
3747
+ /** The backup API allows you to manage your project backups. */
3748
+ readonly backup: ReturnType<typeof buildBackupApi>;
3749
+ /** The container API allows you to manage your stacks, containers, volumes and registries. */
3750
+ readonly container: ReturnType<typeof buildContainerApi>;
3751
+ /** The contract API allows you to manage your contracts and orders */
3752
+ readonly contract: ReturnType<typeof buildContractApi>;
3753
+ /** The marketplace API allows you to manage extensions and more information regaring the marketplace. */
3754
+ readonly marketplace: ReturnType<typeof buildMarketplaceApi>;
3755
+ /** The conversation API allows you to manage your support conversations. */
3756
+ readonly conversation: ReturnType<typeof buildConversationApi>;
3757
+ /** The cronjob API allows you to manage cronjobs within a project. */
3758
+ readonly cronjob: ReturnType<typeof buildCronjobApi>;
3759
+ /** The customer API allows you to manage your own organizations and users. */
3760
+ readonly customer: ReturnType<typeof buildCustomerApi>;
3761
+ /** The database API allows you to manage your databases, like MySQL and Redis databases. */
3762
+ readonly database: ReturnType<typeof buildDatabaseApi>;
3763
+ /** The domain API allows you to manage your domains, DNS records, SSL certificates and ingress resources. */
3764
+ readonly domain: ReturnType<typeof buildDomainApi>;
3765
+ /** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
3766
+ readonly file: ReturnType<typeof buildFileApi>;
3767
+ /** The lead fyndr api allow you to manage you leads and your fyndr profile. */
3768
+ readonly leadFyndr: ReturnType<typeof buildLeadFyndrApi>;
3769
+ /** The license API allows you to manage your paid licenses. */
3770
+ readonly license: ReturnType<typeof buildLicenseApi>;
3771
+ /** The mail API allows you to manage your mail accounts. */
3772
+ readonly mail: ReturnType<typeof buildMailApi>;
3773
+ /** API endpoints that are not related to any specific API domain */
3774
+ readonly misc: ReturnType<typeof buildMiscApi>;
3775
+ /** The notification API allows you to manage your notifications. */
3776
+ readonly notification: ReturnType<typeof buildNotificationApi>;
3777
+ /** The page insights API allows you to get page insights information. */
3778
+ readonly pageInsights: ReturnType<typeof buildPageInsightsApi>;
3779
+ /** The user API allows you to manage your own user and access information of other users that might be visible to you. */
3780
+ readonly user: ReturnType<typeof buildUserApi>;
3781
+ /** The project API allows you to manage your projects, and also any kinds of user memberships concerning these projects. */
3782
+ readonly project: ReturnType<typeof buildProjectApi>;
3783
+ /** The filesystem API allows you to directly access the filesystem of your project. */
3784
+ readonly projectFileSystem: ReturnType<typeof buildProjectFileSystemApi>;
3785
+ /** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
3786
+ readonly sshsftpUser: ReturnType<typeof buildSshsftpUserApi>;
3787
+ private constructor();
3788
+ static fromBaseClient(baseClient: MittwaldAPIV3NextClient): MittwaldAPIV3NextClientReact;
3789
+ }