@mittwald/api-client 0.0.0-development-11873f7-20260707 → 0.0.0-development-d575ea2-20260713

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