@mittwald/api-client 0.0.0-development-8335166-20260625 → 0.0.0-development-38105fd-20260708

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