@mittwald/api-client 4.15.0 → 4.17.0
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.
- package/dist/esm/generated/v2/client-react.js +93 -39
- package/dist/esm/generated/v2/client.js +206 -108
- package/dist/esm/generated/v2/descriptors.js +294 -24
- package/dist/esm/version.js +1 -1
- package/dist/types/generated/v2/client-react.d.ts +590 -234
- package/dist/types/generated/v2/client.d.ts +5799 -4030
- package/dist/types/generated/v2/descriptors.d.ts +128 -38
- package/dist/types/generated/v2/types.d.ts +4470 -1495
- package/dist/types/version.d.ts +1 -1
- package/package.json +7 -4
|
@@ -48,6 +48,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
48
48
|
"x-access-token"?: string | undefined;
|
|
49
49
|
} | undefined;
|
|
50
50
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
51
|
+
appId: string;
|
|
51
52
|
breakingNote?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppBreakingNote | undefined;
|
|
52
53
|
databases?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppDatabaseDependency[] | undefined;
|
|
53
54
|
docRoot: string;
|
|
@@ -111,13 +112,28 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
111
112
|
"x-access-token"?: string | undefined;
|
|
112
113
|
} | undefined;
|
|
113
114
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
115
|
+
expiryDate?: string | undefined;
|
|
114
116
|
externalVersion: string;
|
|
117
|
+
fee?: import("./types.js").MittwaldAPIV2.Components.Schemas.FeeFeeStrategy | undefined;
|
|
115
118
|
id: string;
|
|
116
119
|
internalVersion: string;
|
|
117
120
|
recommended?: boolean | undefined;
|
|
118
121
|
systemSoftwareDependencies?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[] | undefined;
|
|
119
122
|
userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppUserInput[] | undefined;
|
|
120
123
|
}>;
|
|
124
|
+
/** List AppInstallations that a user has access to. */
|
|
125
|
+
listAppinstallationsForUser: (conf?: {
|
|
126
|
+
headers?: {
|
|
127
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
128
|
+
"x-access-token"?: string | undefined;
|
|
129
|
+
} | undefined;
|
|
130
|
+
queryParameters?: {
|
|
131
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
132
|
+
limit?: number | undefined;
|
|
133
|
+
page?: number | undefined;
|
|
134
|
+
skip?: number | undefined;
|
|
135
|
+
} | undefined;
|
|
136
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppInstallation[]>;
|
|
121
137
|
/** List AppInstallations belonging to a Project. */
|
|
122
138
|
listAppinstallations: (conf: {
|
|
123
139
|
projectId: string;
|
|
@@ -222,7 +238,7 @@ declare const buildArticleApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
222
238
|
attributes?: import("./types.js").MittwaldAPIV2.Components.Schemas.ArticleArticleAttributes[] | undefined;
|
|
223
239
|
balanceAddonKey?: string | undefined;
|
|
224
240
|
contractDurationInMonth: number;
|
|
225
|
-
description
|
|
241
|
+
description?: string | undefined;
|
|
226
242
|
forcedInvoicingPeriodInMonth?: number | undefined;
|
|
227
243
|
hasIndependentContractPeriod?: boolean | undefined;
|
|
228
244
|
hideOnInvoice?: boolean | undefined;
|
|
@@ -311,6 +327,149 @@ declare const buildBackupApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
311
327
|
status: string;
|
|
312
328
|
}>;
|
|
313
329
|
};
|
|
330
|
+
declare const buildContainerApi: (baseClient: MittwaldAPIV2Client) => {
|
|
331
|
+
/** List Registries belonging to a Project. */
|
|
332
|
+
listRegistries: (conf: {
|
|
333
|
+
projectId: string;
|
|
334
|
+
headers?: {
|
|
335
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
336
|
+
"x-access-token"?: string | undefined;
|
|
337
|
+
} | undefined;
|
|
338
|
+
queryParameters?: {
|
|
339
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
340
|
+
hasCredentials?: boolean | undefined;
|
|
341
|
+
limit?: number | undefined;
|
|
342
|
+
skip?: number | undefined;
|
|
343
|
+
} | undefined;
|
|
344
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerRegistry[]>;
|
|
345
|
+
/** Get a Stack. */
|
|
346
|
+
getStack: (conf: {
|
|
347
|
+
stackId: string;
|
|
348
|
+
headers?: {
|
|
349
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
350
|
+
"x-access-token"?: string | undefined;
|
|
351
|
+
} | undefined;
|
|
352
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
353
|
+
description: string;
|
|
354
|
+
disabled: boolean;
|
|
355
|
+
id: string;
|
|
356
|
+
prefix: string;
|
|
357
|
+
projectId: string;
|
|
358
|
+
services?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceResponse[] | undefined;
|
|
359
|
+
volumes?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[] | undefined;
|
|
360
|
+
}>;
|
|
361
|
+
/** Get a Registry. */
|
|
362
|
+
getRegistry: (conf: {
|
|
363
|
+
registryId: string;
|
|
364
|
+
headers?: {
|
|
365
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
366
|
+
"x-access-token"?: string | undefined;
|
|
367
|
+
} | undefined;
|
|
368
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
369
|
+
credentials?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerRegistryCredentials | undefined;
|
|
370
|
+
description: string;
|
|
371
|
+
id: string;
|
|
372
|
+
projectId: string;
|
|
373
|
+
uri: string;
|
|
374
|
+
}>;
|
|
375
|
+
/** Get a Volume belonging to a Stack. */
|
|
376
|
+
getVolume: (conf: {
|
|
377
|
+
stackId: string;
|
|
378
|
+
volumeId: string;
|
|
379
|
+
headers?: {
|
|
380
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
381
|
+
"x-access-token"?: string | undefined;
|
|
382
|
+
} | undefined;
|
|
383
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
384
|
+
id: string;
|
|
385
|
+
name: string;
|
|
386
|
+
orphaned: boolean;
|
|
387
|
+
stackId: string;
|
|
388
|
+
}>;
|
|
389
|
+
/** Get a ContainerImageConfig. */
|
|
390
|
+
getContainerImageConfig: (conf: {
|
|
391
|
+
queryParameters: {
|
|
392
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
393
|
+
imageReference: string;
|
|
394
|
+
useCredentialsForProjectId?: string | undefined;
|
|
395
|
+
useCredentialsForRegistryId?: string | undefined;
|
|
396
|
+
generateAiData?: boolean | undefined;
|
|
397
|
+
};
|
|
398
|
+
headers?: {
|
|
399
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
400
|
+
"x-access-token"?: string | undefined;
|
|
401
|
+
} | undefined;
|
|
402
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
403
|
+
command?: string[] | undefined;
|
|
404
|
+
entrypoint?: string[] | undefined;
|
|
405
|
+
env?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerContainerImageConfigEnv[] | undefined;
|
|
406
|
+
exposedPorts?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerContainerImageConfigExposedPort[] | undefined;
|
|
407
|
+
hasAiGeneratedData: boolean;
|
|
408
|
+
isUserRoot: boolean;
|
|
409
|
+
overwritingUser?: number | undefined;
|
|
410
|
+
user: string;
|
|
411
|
+
volumes?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerContainerImageConfigVolume[] | undefined;
|
|
412
|
+
}>;
|
|
413
|
+
/** Get logs belonging to a Service. */
|
|
414
|
+
getServiceLogs: (conf: {
|
|
415
|
+
stackId: string;
|
|
416
|
+
serviceId: string;
|
|
417
|
+
headers?: {
|
|
418
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
419
|
+
"x-access-token"?: string | undefined;
|
|
420
|
+
} | undefined;
|
|
421
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<string>;
|
|
422
|
+
/** Get a Service belonging to a Stack. */
|
|
423
|
+
getService: (conf: {
|
|
424
|
+
stackId: string;
|
|
425
|
+
serviceId: string;
|
|
426
|
+
headers?: {
|
|
427
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
428
|
+
"x-access-token"?: string | undefined;
|
|
429
|
+
} | undefined;
|
|
430
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
431
|
+
deployedState: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceState;
|
|
432
|
+
description: string;
|
|
433
|
+
id: string;
|
|
434
|
+
pendingState: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceState;
|
|
435
|
+
projectId: string;
|
|
436
|
+
serviceName: string;
|
|
437
|
+
stackId: string;
|
|
438
|
+
status: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceStatus;
|
|
439
|
+
}>;
|
|
440
|
+
/** List Services belonging to a Project. */
|
|
441
|
+
listServices: (conf: {
|
|
442
|
+
projectId: string;
|
|
443
|
+
headers?: {
|
|
444
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
445
|
+
"x-access-token"?: string | undefined;
|
|
446
|
+
} | undefined;
|
|
447
|
+
queryParameters?: {
|
|
448
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
449
|
+
stackId?: string | undefined;
|
|
450
|
+
} | undefined;
|
|
451
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceResponse[]>;
|
|
452
|
+
/** List Stacks belonging to a Project. */
|
|
453
|
+
listStacks: (conf: {
|
|
454
|
+
projectId: string;
|
|
455
|
+
headers?: {
|
|
456
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
457
|
+
"x-access-token"?: string | undefined;
|
|
458
|
+
} | undefined;
|
|
459
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerStackResponse[]>;
|
|
460
|
+
/** List Volumes belonging to a Project. */
|
|
461
|
+
listVolumes: (conf: {
|
|
462
|
+
projectId: string;
|
|
463
|
+
headers?: {
|
|
464
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
465
|
+
"x-access-token"?: string | undefined;
|
|
466
|
+
} | undefined;
|
|
467
|
+
queryParameters?: {
|
|
468
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
469
|
+
stackId?: string | undefined;
|
|
470
|
+
} | undefined;
|
|
471
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[]>;
|
|
472
|
+
};
|
|
314
473
|
declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
|
|
315
474
|
/** Return the BaseItem of the Contract with the given ID. */
|
|
316
475
|
getBaseItemOfContract: (conf: {
|
|
@@ -327,6 +486,7 @@ declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
327
486
|
description: string;
|
|
328
487
|
freeTrialDays?: number | undefined;
|
|
329
488
|
groupByProjectId?: string | undefined;
|
|
489
|
+
invoiceStop?: string | undefined;
|
|
330
490
|
invoicingPeriod?: number | undefined;
|
|
331
491
|
isActivated: boolean;
|
|
332
492
|
isBaseItem: boolean;
|
|
@@ -336,7 +496,7 @@ declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
336
496
|
nextPossibleDowngradeDate?: string | undefined;
|
|
337
497
|
nextPossibleTerminationDate?: string | undefined;
|
|
338
498
|
nextPossibleUpgradeDate?: string | undefined;
|
|
339
|
-
orderDate
|
|
499
|
+
orderDate?: string | undefined;
|
|
340
500
|
orderId?: string | undefined;
|
|
341
501
|
replacedByItem?: string | undefined;
|
|
342
502
|
tariffChange?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTariffChange | undefined;
|
|
@@ -404,6 +564,7 @@ declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
404
564
|
description: string;
|
|
405
565
|
freeTrialDays?: number | undefined;
|
|
406
566
|
groupByProjectId?: string | undefined;
|
|
567
|
+
invoiceStop?: string | undefined;
|
|
407
568
|
invoicingPeriod?: number | undefined;
|
|
408
569
|
isActivated: boolean;
|
|
409
570
|
isBaseItem: boolean;
|
|
@@ -413,7 +574,7 @@ declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
413
574
|
nextPossibleDowngradeDate?: string | undefined;
|
|
414
575
|
nextPossibleTerminationDate?: string | undefined;
|
|
415
576
|
nextPossibleUpgradeDate?: string | undefined;
|
|
416
|
-
orderDate
|
|
577
|
+
orderDate?: string | undefined;
|
|
417
578
|
orderId?: string | undefined;
|
|
418
579
|
replacedByItem?: string | undefined;
|
|
419
580
|
tariffChange?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTariffChange | undefined;
|
|
@@ -500,6 +661,7 @@ declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
500
661
|
} | undefined;
|
|
501
662
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
502
663
|
additionalEmailRecipients?: string[] | undefined;
|
|
664
|
+
debitPaymentStopUntil?: string | undefined;
|
|
503
665
|
id: string;
|
|
504
666
|
invoicePeriod?: number | undefined;
|
|
505
667
|
lastBankingInformation?: import("./types.js").MittwaldAPIV2.Components.Schemas.InvoiceBankingInformation | undefined;
|
|
@@ -537,6 +699,22 @@ declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
537
699
|
page?: number | undefined;
|
|
538
700
|
} | undefined;
|
|
539
701
|
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.InvoiceInvoice[]>;
|
|
702
|
+
/** Get list of Orders. */
|
|
703
|
+
orderListOrders: (conf?: {
|
|
704
|
+
headers?: {
|
|
705
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
706
|
+
"x-access-token"?: string | undefined;
|
|
707
|
+
} | undefined;
|
|
708
|
+
queryParameters?: {
|
|
709
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
710
|
+
limit?: number | undefined;
|
|
711
|
+
skip?: number | undefined;
|
|
712
|
+
page?: number | undefined;
|
|
713
|
+
includesStatus?: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderOrderStatus[] | undefined;
|
|
714
|
+
excludesStatus?: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderOrderStatus[] | undefined;
|
|
715
|
+
templateNames?: string[] | undefined;
|
|
716
|
+
} | undefined;
|
|
717
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.OrderCustomerOrder[]>;
|
|
540
718
|
/** Get Order for Customer. */
|
|
541
719
|
orderGetOrder: (conf: {
|
|
542
720
|
orderId: string;
|
|
@@ -550,7 +728,7 @@ declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
550
728
|
dueDate?: string | undefined;
|
|
551
729
|
invoicingPeriod: number;
|
|
552
730
|
items: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderOrderItem[];
|
|
553
|
-
orderDate
|
|
731
|
+
orderDate?: string | undefined;
|
|
554
732
|
orderId: string;
|
|
555
733
|
orderNumber: string;
|
|
556
734
|
profile?: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderProfile | undefined;
|
|
@@ -627,6 +805,21 @@ declare const buildConversationApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
627
805
|
}) => import("@mittwald/react-use-promise").AsyncResource<(import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser & {
|
|
628
806
|
active: boolean;
|
|
629
807
|
})[]>;
|
|
808
|
+
/** Get preferences for customer conversations. */
|
|
809
|
+
getConversationPreferencesOfCustomer: (conf: {
|
|
810
|
+
customerId: string;
|
|
811
|
+
headers?: {
|
|
812
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
813
|
+
} | undefined;
|
|
814
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
815
|
+
customerId: string;
|
|
816
|
+
preferredUsers: {
|
|
817
|
+
categoryUserPairs?: {
|
|
818
|
+
[k: string]: string;
|
|
819
|
+
} | undefined;
|
|
820
|
+
fallback?: string | undefined;
|
|
821
|
+
};
|
|
822
|
+
}>;
|
|
630
823
|
/** Get a support conversation. */
|
|
631
824
|
getConversation: (conf: {
|
|
632
825
|
conversationId: string;
|
|
@@ -645,7 +838,7 @@ declare const buildConversationApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
645
838
|
relations?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference[] | undefined;
|
|
646
839
|
sharedWith?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
|
|
647
840
|
shortId: string;
|
|
648
|
-
status: "
|
|
841
|
+
status: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationStatus;
|
|
649
842
|
title: string;
|
|
650
843
|
visibility: "shared" | "private";
|
|
651
844
|
}>;
|
|
@@ -970,6 +1163,10 @@ declare const buildDatabaseApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
970
1163
|
isShared: boolean;
|
|
971
1164
|
name: string;
|
|
972
1165
|
projectId: string;
|
|
1166
|
+
status: import("./types.js").MittwaldAPIV2.Components.Schemas.DatabaseDatabaseStatus;
|
|
1167
|
+
statusSetAt: string;
|
|
1168
|
+
storageUsageInBytes: number;
|
|
1169
|
+
storageUsageInBytesSetAt: string;
|
|
973
1170
|
updatedAt: string;
|
|
974
1171
|
version: string;
|
|
975
1172
|
}>;
|
|
@@ -1011,6 +1208,10 @@ declare const buildDatabaseApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1011
1208
|
name: string;
|
|
1012
1209
|
port: number;
|
|
1013
1210
|
projectId: string;
|
|
1211
|
+
status: import("./types.js").MittwaldAPIV2.Components.Schemas.DatabaseDatabaseStatus;
|
|
1212
|
+
statusSetAt: string;
|
|
1213
|
+
storageUsageInBytes: number;
|
|
1214
|
+
storageUsageInBytesSetAt: string;
|
|
1014
1215
|
updatedAt: string;
|
|
1015
1216
|
version: string;
|
|
1016
1217
|
}>;
|
|
@@ -1117,8 +1318,7 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1117
1318
|
adminC?: import("./types.js").MittwaldAPIV2.Components.Schemas.DomainHandleReadable | undefined;
|
|
1118
1319
|
ownerC: import("./types.js").MittwaldAPIV2.Components.Schemas.DomainHandleReadable;
|
|
1119
1320
|
};
|
|
1120
|
-
|
|
1121
|
-
nameservers: [string, string, ...string[]];
|
|
1321
|
+
nameservers: string[];
|
|
1122
1322
|
processes?: import("./types.js").MittwaldAPIV2.Components.Schemas.DomainProcess[] | undefined;
|
|
1123
1323
|
projectId: string;
|
|
1124
1324
|
transferInAuthCode?: string | undefined;
|
|
@@ -1188,6 +1388,117 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1188
1388
|
tls: import("./types.js").MittwaldAPIV2.Components.Schemas.IngressTlsAcme | import("./types.js").MittwaldAPIV2.Components.Schemas.IngressTlsCertificate;
|
|
1189
1389
|
}>;
|
|
1190
1390
|
};
|
|
1391
|
+
declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
|
|
1392
|
+
/** List ExtensionInstances. */
|
|
1393
|
+
extensionListExtensionInstances: (conf: {
|
|
1394
|
+
queryParameters: {
|
|
1395
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1396
|
+
context: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext;
|
|
1397
|
+
contextId: string;
|
|
1398
|
+
limit?: number | undefined;
|
|
1399
|
+
skip?: number | undefined;
|
|
1400
|
+
page?: number | undefined;
|
|
1401
|
+
};
|
|
1402
|
+
headers?: {
|
|
1403
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1404
|
+
"x-access-token"?: string | undefined;
|
|
1405
|
+
} | undefined;
|
|
1406
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionInstance[]>;
|
|
1407
|
+
/** Get an ExtensionInstance. */
|
|
1408
|
+
extensionGetExtensionInstance: (conf: {
|
|
1409
|
+
extensionInstanceId: string;
|
|
1410
|
+
headers?: {
|
|
1411
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1412
|
+
"x-access-token"?: string | undefined;
|
|
1413
|
+
} | undefined;
|
|
1414
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1415
|
+
aggregateReference: {
|
|
1416
|
+
aggregate: string;
|
|
1417
|
+
domain: string;
|
|
1418
|
+
id: string;
|
|
1419
|
+
};
|
|
1420
|
+
consentedScopes: string[];
|
|
1421
|
+
createdAt?: string | undefined;
|
|
1422
|
+
disabled: boolean;
|
|
1423
|
+
extensionId: string;
|
|
1424
|
+
id: string;
|
|
1425
|
+
}>;
|
|
1426
|
+
/** Get a Contributor. */
|
|
1427
|
+
extensionGetContributor: (conf: {
|
|
1428
|
+
contributorId: string;
|
|
1429
|
+
headers?: {
|
|
1430
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1431
|
+
"x-access-token"?: string | undefined;
|
|
1432
|
+
} | undefined;
|
|
1433
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1434
|
+
customerId: string;
|
|
1435
|
+
email?: string | undefined;
|
|
1436
|
+
id: string;
|
|
1437
|
+
logoRefId?: string | undefined;
|
|
1438
|
+
name: string;
|
|
1439
|
+
phone?: string | undefined;
|
|
1440
|
+
state: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContributorState;
|
|
1441
|
+
url?: string | undefined;
|
|
1442
|
+
}>;
|
|
1443
|
+
/** Get an Extension. */
|
|
1444
|
+
extensionGetExtension: (conf: {
|
|
1445
|
+
extensionId: string;
|
|
1446
|
+
headers?: {
|
|
1447
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1448
|
+
"x-access-token"?: string | undefined;
|
|
1449
|
+
} | undefined;
|
|
1450
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1451
|
+
context: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext;
|
|
1452
|
+
contributorId: string;
|
|
1453
|
+
description: string;
|
|
1454
|
+
frontendComponents?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExternalComponent[] | undefined;
|
|
1455
|
+
id: string;
|
|
1456
|
+
name: string;
|
|
1457
|
+
scopes: string[];
|
|
1458
|
+
state: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionState;
|
|
1459
|
+
support: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceSupportMeta;
|
|
1460
|
+
tags: string[];
|
|
1461
|
+
}>;
|
|
1462
|
+
/** Get the public key to verify the webhook signature. */
|
|
1463
|
+
extensionGetPublicKey: (conf: {
|
|
1464
|
+
serial: string;
|
|
1465
|
+
headers?: {
|
|
1466
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1467
|
+
"x-access-token"?: string | undefined;
|
|
1468
|
+
} | undefined;
|
|
1469
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1470
|
+
algorithm: string;
|
|
1471
|
+
key: string;
|
|
1472
|
+
serial: string;
|
|
1473
|
+
}>;
|
|
1474
|
+
/** List Contributors. */
|
|
1475
|
+
extensionListContributors: (conf?: {
|
|
1476
|
+
headers?: {
|
|
1477
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1478
|
+
"x-access-token"?: string | undefined;
|
|
1479
|
+
} | undefined;
|
|
1480
|
+
queryParameters?: {
|
|
1481
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1482
|
+
limit?: number | undefined;
|
|
1483
|
+
skip?: number | undefined;
|
|
1484
|
+
page?: number | undefined;
|
|
1485
|
+
} | undefined;
|
|
1486
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContributor[]>;
|
|
1487
|
+
/** List Extensions. */
|
|
1488
|
+
extensionListExtensions: (conf?: {
|
|
1489
|
+
headers?: {
|
|
1490
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1491
|
+
"x-access-token"?: string | undefined;
|
|
1492
|
+
} | undefined;
|
|
1493
|
+
queryParameters?: {
|
|
1494
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1495
|
+
context?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext | undefined;
|
|
1496
|
+
limit?: number | undefined;
|
|
1497
|
+
skip?: number | undefined;
|
|
1498
|
+
page?: number | undefined;
|
|
1499
|
+
} | undefined;
|
|
1500
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtension[]>;
|
|
1501
|
+
};
|
|
1191
1502
|
declare const buildFileApi: (baseClient: MittwaldAPIV2Client) => {
|
|
1192
1503
|
/** Get a File's meta. */
|
|
1193
1504
|
getFileMeta: (conf: {
|
|
@@ -1210,7 +1521,9 @@ declare const buildFileApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1210
1521
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1211
1522
|
} | undefined;
|
|
1212
1523
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1524
|
+
extensions: string[];
|
|
1213
1525
|
fileTypes: import("./types.js").MittwaldAPIV2.Components.Schemas.FileFileType[];
|
|
1526
|
+
maxSizeInBytes: number;
|
|
1214
1527
|
maxSizeInKB: number;
|
|
1215
1528
|
mimeTypes: string[];
|
|
1216
1529
|
properties?: {
|
|
@@ -1233,7 +1546,9 @@ declare const buildFileApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1233
1546
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1234
1547
|
} | undefined;
|
|
1235
1548
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1549
|
+
extensions: string[];
|
|
1236
1550
|
fileTypes: import("./types.js").MittwaldAPIV2.Components.Schemas.FileFileType[];
|
|
1551
|
+
maxSizeInBytes: number;
|
|
1237
1552
|
maxSizeInKB: number;
|
|
1238
1553
|
mimeTypes: string[];
|
|
1239
1554
|
properties?: {
|
|
@@ -1258,7 +1573,17 @@ declare const buildFileApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1258
1573
|
"Content-Disposition"?: "inline" | "attachment" | undefined;
|
|
1259
1574
|
Token?: string | undefined;
|
|
1260
1575
|
} | undefined;
|
|
1261
|
-
|
|
1576
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<string>;
|
|
1577
|
+
/** Get a File. */
|
|
1578
|
+
getFileWithName: (conf: {
|
|
1579
|
+
fileId: string;
|
|
1580
|
+
fileName: string;
|
|
1581
|
+
headers?: {
|
|
1582
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1583
|
+
Accept?: "application/octet-stream" | "text/plain;base64" | undefined;
|
|
1584
|
+
"Content-Disposition"?: "inline" | "attachment" | undefined;
|
|
1585
|
+
Token?: string | undefined;
|
|
1586
|
+
} | undefined;
|
|
1262
1587
|
}) => import("@mittwald/react-use-promise").AsyncResource<string>;
|
|
1263
1588
|
};
|
|
1264
1589
|
declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
|
|
@@ -1348,6 +1673,36 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1348
1673
|
projectId: string;
|
|
1349
1674
|
whitelist: string[];
|
|
1350
1675
|
}>;
|
|
1676
|
+
/** Get a Migration. */
|
|
1677
|
+
migrationGetMigration: (conf: {
|
|
1678
|
+
migrationId: string;
|
|
1679
|
+
headers?: {
|
|
1680
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1681
|
+
"x-access-token"?: string | undefined;
|
|
1682
|
+
} | undefined;
|
|
1683
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1684
|
+
aborted: boolean;
|
|
1685
|
+
addresses: import("./types.js").MittwaldAPIV2.Components.Schemas.MailmigrationMigrationMailAddress[];
|
|
1686
|
+
finalizers: import("./types.js").MittwaldAPIV2.Components.Schemas.MailmigrationMigrationFinalizeJob;
|
|
1687
|
+
finished: boolean;
|
|
1688
|
+
id: string;
|
|
1689
|
+
mailboxes: import("./types.js").MittwaldAPIV2.Components.Schemas.MailmigrationMigrationMailbox[];
|
|
1690
|
+
sourceCoabProjectId: string;
|
|
1691
|
+
targetNexusProjectId: string;
|
|
1692
|
+
}>;
|
|
1693
|
+
/** List Migrations belonging to a Project in customer center or mStudio. */
|
|
1694
|
+
migrationListMigrations: (conf: {
|
|
1695
|
+
headers: {
|
|
1696
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1697
|
+
Authorization: string;
|
|
1698
|
+
"x-access-token"?: string | undefined;
|
|
1699
|
+
};
|
|
1700
|
+
queryParameters?: {
|
|
1701
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1702
|
+
pAccountName?: string | undefined;
|
|
1703
|
+
projectId?: string | undefined;
|
|
1704
|
+
} | undefined;
|
|
1705
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MailmigrationMigration[]>;
|
|
1351
1706
|
};
|
|
1352
1707
|
declare const buildNotificationApi: (baseClient: MittwaldAPIV2Client) => {
|
|
1353
1708
|
/** Getting the subscription status of the subscription. */
|
|
@@ -1450,240 +1805,40 @@ declare const buildPageInsightsApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1450
1805
|
}[];
|
|
1451
1806
|
}[]>;
|
|
1452
1807
|
};
|
|
1453
|
-
declare const
|
|
1454
|
-
/**
|
|
1455
|
-
|
|
1456
|
-
|
|
1808
|
+
declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
1809
|
+
/** List Invites belonging to a Project. */
|
|
1810
|
+
listInvitesForProject: (conf: {
|
|
1811
|
+
projectId: string;
|
|
1457
1812
|
headers?: {
|
|
1458
1813
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1814
|
+
"x-access-token"?: string | undefined;
|
|
1459
1815
|
} | undefined;
|
|
1460
|
-
|
|
1461
|
-
/** Get your verified Email-Address. */
|
|
1462
|
-
getOwnEmail: (conf?: {
|
|
1463
|
-
headers?: {
|
|
1816
|
+
queryParameters?: {
|
|
1464
1817
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1465
|
-
|
|
1818
|
+
limit?: number | undefined;
|
|
1819
|
+
skip?: number | undefined;
|
|
1466
1820
|
} | undefined;
|
|
1467
|
-
}
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
getMfaStatus: (conf?: {
|
|
1821
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectInvite[]>;
|
|
1822
|
+
/** Get a ProjectInvite. */
|
|
1823
|
+
getProjectInvite: (conf: {
|
|
1824
|
+
projectInviteId: string;
|
|
1472
1825
|
headers?: {
|
|
1473
1826
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1474
1827
|
"x-access-token"?: string | undefined;
|
|
1475
1828
|
} | undefined;
|
|
1476
|
-
}
|
|
1477
|
-
|
|
1478
|
-
|
|
1829
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1830
|
+
id: string;
|
|
1831
|
+
information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
|
|
1832
|
+
mailAddress: string;
|
|
1833
|
+
membershipExpiresAt?: string | undefined;
|
|
1834
|
+
message?: string | undefined;
|
|
1835
|
+
projectDescription: string;
|
|
1836
|
+
projectId: string;
|
|
1837
|
+
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
1479
1838
|
}>;
|
|
1480
|
-
/**
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1484
|
-
"x-access-token"?: string | undefined;
|
|
1485
|
-
} | undefined;
|
|
1486
|
-
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.SignupApiToken[]>;
|
|
1487
|
-
/** Get your stored ssh-keys. */
|
|
1488
|
-
listSshKeys: (conf?: {
|
|
1489
|
-
headers?: {
|
|
1490
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1491
|
-
"x-access-token"?: string | undefined;
|
|
1492
|
-
} | undefined;
|
|
1493
|
-
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1494
|
-
sshKeys?: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupSshKey[] | undefined;
|
|
1495
|
-
}>;
|
|
1496
|
-
/** Get a specific ApiToken. */
|
|
1497
|
-
getApiToken: (conf: {
|
|
1498
|
-
apiTokenId: string;
|
|
1499
|
-
headers?: {
|
|
1500
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1501
|
-
"x-access-token"?: string | undefined;
|
|
1502
|
-
} | undefined;
|
|
1503
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1504
|
-
apiTokenId: string;
|
|
1505
|
-
createdAt: string;
|
|
1506
|
-
description: string;
|
|
1507
|
-
expiresAt?: string | undefined;
|
|
1508
|
-
roles: ("api_read" | "api_write")[];
|
|
1509
|
-
}>;
|
|
1510
|
-
/** Get a specific stored ssh-key. */
|
|
1511
|
-
getSshKey: (conf: {
|
|
1512
|
-
sshKeyId: string;
|
|
1513
|
-
headers?: {
|
|
1514
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1515
|
-
"x-access-token"?: string | undefined;
|
|
1516
|
-
} | undefined;
|
|
1517
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1518
|
-
sshKey: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupSshKey;
|
|
1519
|
-
}>;
|
|
1520
|
-
/** Get your account information. */
|
|
1521
|
-
getOwnAccount: (conf?: {
|
|
1522
|
-
headers?: {
|
|
1523
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1524
|
-
"x-access-token"?: string | undefined;
|
|
1525
|
-
} | undefined;
|
|
1526
|
-
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1527
|
-
email?: string | undefined;
|
|
1528
|
-
mfaDetails?: {
|
|
1529
|
-
mfaConfirmed?: boolean | undefined;
|
|
1530
|
-
mfaInitialized?: boolean | undefined;
|
|
1531
|
-
} | undefined;
|
|
1532
|
-
passwordUpdatedAt?: string | undefined;
|
|
1533
|
-
person?: import("./types.js").MittwaldAPIV2.Components.Schemas.CommonsPerson | undefined;
|
|
1534
|
-
userId?: string | undefined;
|
|
1535
|
-
}>;
|
|
1536
|
-
/** The timestamp of your latest password change. */
|
|
1537
|
-
getPasswordUpdatedAt: (conf?: {
|
|
1538
|
-
headers?: {
|
|
1539
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1540
|
-
"x-access-token"?: string | undefined;
|
|
1541
|
-
} | undefined;
|
|
1542
|
-
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1543
|
-
passwordUpdatedAt: string;
|
|
1544
|
-
}>;
|
|
1545
|
-
/** Get personalized settings. */
|
|
1546
|
-
getPersonalizedSettings: (conf: {
|
|
1547
|
-
userId: string;
|
|
1548
|
-
headers?: {
|
|
1549
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1550
|
-
"x-access-token"?: string | undefined;
|
|
1551
|
-
} | undefined;
|
|
1552
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1553
|
-
settingsString?: string | undefined;
|
|
1554
|
-
}>;
|
|
1555
|
-
/** Get poll settings for the specified user. */
|
|
1556
|
-
getPollStatus: (conf: {
|
|
1557
|
-
userId: string;
|
|
1558
|
-
headers?: {
|
|
1559
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1560
|
-
} | undefined;
|
|
1561
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1562
|
-
completedAt?: string | undefined;
|
|
1563
|
-
dontShowUntil?: string | undefined;
|
|
1564
|
-
ignoredAt?: string | undefined;
|
|
1565
|
-
shouldShow: boolean;
|
|
1566
|
-
status: "completed" | "muted" | "ignored" | "new";
|
|
1567
|
-
userId: string;
|
|
1568
|
-
}>;
|
|
1569
|
-
/** Get a specific session. */
|
|
1570
|
-
getSession: (conf: {
|
|
1571
|
-
tokenId: string;
|
|
1572
|
-
headers?: {
|
|
1573
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1574
|
-
"x-access-token"?: string | undefined;
|
|
1575
|
-
} | undefined;
|
|
1576
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1577
|
-
created: string;
|
|
1578
|
-
device: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupDeviceInfo;
|
|
1579
|
-
lastAccess?: string | undefined;
|
|
1580
|
-
location?: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupLocation | undefined;
|
|
1581
|
-
tokenId: string;
|
|
1582
|
-
}>;
|
|
1583
|
-
/** Get profile information for a user. */
|
|
1584
|
-
getUser: (conf: {
|
|
1585
|
-
userId: string;
|
|
1586
|
-
headers?: {
|
|
1587
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1588
|
-
"x-access-token"?: string | undefined;
|
|
1589
|
-
} | undefined;
|
|
1590
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1591
|
-
avatarRef?: string | undefined;
|
|
1592
|
-
email?: string | undefined;
|
|
1593
|
-
employeeInformation?: {
|
|
1594
|
-
department: string;
|
|
1595
|
-
} | undefined;
|
|
1596
|
-
person: import("./types.js").MittwaldAPIV2.Components.Schemas.CommonsPerson;
|
|
1597
|
-
phoneNumber?: string | undefined;
|
|
1598
|
-
registeredAt?: string | undefined;
|
|
1599
|
-
userId: string;
|
|
1600
|
-
}>;
|
|
1601
|
-
/** Submitted feedback of the given user. */
|
|
1602
|
-
listFeedback: (conf: {
|
|
1603
|
-
userId: string;
|
|
1604
|
-
headers?: {
|
|
1605
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1606
|
-
"x-access-token"?: string | undefined;
|
|
1607
|
-
} | undefined;
|
|
1608
|
-
queryParameters?: {
|
|
1609
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1610
|
-
subject?: string | undefined;
|
|
1611
|
-
} | undefined;
|
|
1612
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.UserUserFeedback[]>;
|
|
1613
|
-
/** List all sessions. */
|
|
1614
|
-
listSessions: (conf?: {
|
|
1615
|
-
headers?: {
|
|
1616
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1617
|
-
"x-access-token"?: string | undefined;
|
|
1618
|
-
} | undefined;
|
|
1619
|
-
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.SignupUserSession[]>;
|
|
1620
|
-
/** Obtain authorization from the resource owner. */
|
|
1621
|
-
oauthGetAuthorization: (conf: {
|
|
1622
|
-
queryParameters: {
|
|
1623
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1624
|
-
response_type: "code";
|
|
1625
|
-
client_id: string;
|
|
1626
|
-
grant_consent?: boolean | undefined;
|
|
1627
|
-
grant_type?: "authorization_code" | undefined;
|
|
1628
|
-
redirect_uri?: string | undefined;
|
|
1629
|
-
scope?: string | undefined;
|
|
1630
|
-
state?: string | undefined;
|
|
1631
|
-
code_challenge?: string | undefined;
|
|
1632
|
-
code_challenge_method?: "S256" | undefined;
|
|
1633
|
-
};
|
|
1634
|
-
headers?: {
|
|
1635
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1636
|
-
} | undefined;
|
|
1637
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<never>;
|
|
1638
|
-
/** Request a support code. */
|
|
1639
|
-
supportCodeRequest: (conf?: {
|
|
1640
|
-
headers?: {
|
|
1641
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1642
|
-
"x-access-token"?: string | undefined;
|
|
1643
|
-
} | undefined;
|
|
1644
|
-
queryParameters?: {
|
|
1645
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1646
|
-
forceRecreate?: boolean | undefined;
|
|
1647
|
-
} | undefined;
|
|
1648
|
-
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1649
|
-
expiresAt: string;
|
|
1650
|
-
supportCode: string;
|
|
1651
|
-
}>;
|
|
1652
|
-
};
|
|
1653
|
-
declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
1654
|
-
/** List Invites belonging to a Project. */
|
|
1655
|
-
listInvitesForProject: (conf: {
|
|
1656
|
-
projectId: string;
|
|
1657
|
-
headers?: {
|
|
1658
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1659
|
-
"x-access-token"?: string | undefined;
|
|
1660
|
-
} | undefined;
|
|
1661
|
-
queryParameters?: {
|
|
1662
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1663
|
-
limit?: number | undefined;
|
|
1664
|
-
skip?: number | undefined;
|
|
1665
|
-
} | undefined;
|
|
1666
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectInvite[]>;
|
|
1667
|
-
/** Get a ProjectInvite. */
|
|
1668
|
-
getProjectInvite: (conf: {
|
|
1669
|
-
projectInviteId: string;
|
|
1670
|
-
headers?: {
|
|
1671
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1672
|
-
"x-access-token"?: string | undefined;
|
|
1673
|
-
} | undefined;
|
|
1674
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1675
|
-
id: string;
|
|
1676
|
-
information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
|
|
1677
|
-
mailAddress: string;
|
|
1678
|
-
membershipExpiresAt?: string | undefined;
|
|
1679
|
-
message?: string | undefined;
|
|
1680
|
-
projectDescription: string;
|
|
1681
|
-
projectId: string;
|
|
1682
|
-
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
1683
|
-
}>;
|
|
1684
|
-
/** Get a ProjectMembership */
|
|
1685
|
-
getProjectMembership: (conf: {
|
|
1686
|
-
projectMembershipId: string;
|
|
1839
|
+
/** Get a ProjectMembership */
|
|
1840
|
+
getProjectMembership: (conf: {
|
|
1841
|
+
projectMembershipId: string;
|
|
1687
1842
|
headers?: {
|
|
1688
1843
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1689
1844
|
"x-access-token"?: string | undefined;
|
|
@@ -1731,6 +1886,8 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1731
1886
|
statisticsBaseDomain?: string | undefined;
|
|
1732
1887
|
status: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectProjectStatus;
|
|
1733
1888
|
statusSetAt: string;
|
|
1889
|
+
webStorageUsageInBytes: number;
|
|
1890
|
+
webStorageUsageInBytesSetAt: string;
|
|
1734
1891
|
}>;
|
|
1735
1892
|
/** Get a ProjectInvite by token. */
|
|
1736
1893
|
getProjectTokenInvite: (conf: {
|
|
@@ -1858,6 +2015,8 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1858
2015
|
shortId: string;
|
|
1859
2016
|
status: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectProjectStatus;
|
|
1860
2017
|
statusSetAt: string;
|
|
2018
|
+
webStorageUsageInBytes: number;
|
|
2019
|
+
webStorageUsageInBytesSetAt: string;
|
|
1861
2020
|
}[]>;
|
|
1862
2021
|
/** List Servers belonging to the executing user. */
|
|
1863
2022
|
listServers: (conf?: {
|
|
@@ -2034,6 +2193,199 @@ declare const buildSshsftpUserApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
2034
2193
|
userName: string;
|
|
2035
2194
|
}>;
|
|
2036
2195
|
};
|
|
2196
|
+
declare const buildUserApi: (baseClient: MittwaldAPIV2Client) => {
|
|
2197
|
+
/** Get your verified Email-Address. */
|
|
2198
|
+
getOwnEmail: (conf?: {
|
|
2199
|
+
headers?: {
|
|
2200
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2201
|
+
"x-access-token"?: string | undefined;
|
|
2202
|
+
} | undefined;
|
|
2203
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2204
|
+
email: string;
|
|
2205
|
+
}>;
|
|
2206
|
+
/** Get your current multi factor auth status. */
|
|
2207
|
+
getMfaStatus: (conf?: {
|
|
2208
|
+
headers?: {
|
|
2209
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2210
|
+
"x-access-token"?: string | undefined;
|
|
2211
|
+
} | undefined;
|
|
2212
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2213
|
+
confirmed: boolean;
|
|
2214
|
+
initialized: boolean;
|
|
2215
|
+
}>;
|
|
2216
|
+
/** List all of your ApiTokens. */
|
|
2217
|
+
listApiTokens: (conf?: {
|
|
2218
|
+
headers?: {
|
|
2219
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2220
|
+
"x-access-token"?: string | undefined;
|
|
2221
|
+
} | undefined;
|
|
2222
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.SignupApiToken[]>;
|
|
2223
|
+
/** Get your stored ssh-keys. */
|
|
2224
|
+
listSshKeys: (conf?: {
|
|
2225
|
+
headers?: {
|
|
2226
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2227
|
+
"x-access-token"?: string | undefined;
|
|
2228
|
+
} | undefined;
|
|
2229
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2230
|
+
sshKeys?: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupSshKey[] | undefined;
|
|
2231
|
+
}>;
|
|
2232
|
+
/** Get a specific ApiToken. */
|
|
2233
|
+
getApiToken: (conf: {
|
|
2234
|
+
apiTokenId: string;
|
|
2235
|
+
headers?: {
|
|
2236
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2237
|
+
"x-access-token"?: string | undefined;
|
|
2238
|
+
} | undefined;
|
|
2239
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2240
|
+
apiTokenId: string;
|
|
2241
|
+
createdAt: string;
|
|
2242
|
+
description: string;
|
|
2243
|
+
expiresAt?: string | undefined;
|
|
2244
|
+
roles: ("api_read" | "api_write")[];
|
|
2245
|
+
}>;
|
|
2246
|
+
/** Get a specific stored ssh-key. */
|
|
2247
|
+
getSshKey: (conf: {
|
|
2248
|
+
sshKeyId: string;
|
|
2249
|
+
headers?: {
|
|
2250
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2251
|
+
"x-access-token"?: string | undefined;
|
|
2252
|
+
} | undefined;
|
|
2253
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2254
|
+
sshKey: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupSshKey;
|
|
2255
|
+
}>;
|
|
2256
|
+
/** Get your account information. */
|
|
2257
|
+
getOwnAccount: (conf?: {
|
|
2258
|
+
headers?: {
|
|
2259
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2260
|
+
"x-access-token"?: string | undefined;
|
|
2261
|
+
} | undefined;
|
|
2262
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2263
|
+
email?: string | undefined;
|
|
2264
|
+
mfaDetails?: {
|
|
2265
|
+
mfaConfirmed?: boolean | undefined;
|
|
2266
|
+
mfaInitialized?: boolean | undefined;
|
|
2267
|
+
} | undefined;
|
|
2268
|
+
passwordUpdatedAt?: string | undefined;
|
|
2269
|
+
person?: import("./types.js").MittwaldAPIV2.Components.Schemas.CommonsPerson | undefined;
|
|
2270
|
+
userId?: string | undefined;
|
|
2271
|
+
}>;
|
|
2272
|
+
/** The timestamp of your latest password change. */
|
|
2273
|
+
getPasswordUpdatedAt: (conf?: {
|
|
2274
|
+
headers?: {
|
|
2275
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2276
|
+
"x-access-token"?: string | undefined;
|
|
2277
|
+
} | undefined;
|
|
2278
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2279
|
+
passwordUpdatedAt: string;
|
|
2280
|
+
}>;
|
|
2281
|
+
/** Get personalized settings. */
|
|
2282
|
+
getPersonalizedSettings: (conf: {
|
|
2283
|
+
userId: string;
|
|
2284
|
+
headers?: {
|
|
2285
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2286
|
+
"x-access-token"?: string | undefined;
|
|
2287
|
+
} | undefined;
|
|
2288
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2289
|
+
settingsString?: string | undefined;
|
|
2290
|
+
}>;
|
|
2291
|
+
/** Get poll settings for the specified user. */
|
|
2292
|
+
getPollStatus: (conf: {
|
|
2293
|
+
userId: string;
|
|
2294
|
+
headers?: {
|
|
2295
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2296
|
+
} | undefined;
|
|
2297
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2298
|
+
completedAt?: string | undefined;
|
|
2299
|
+
dontShowUntil?: string | undefined;
|
|
2300
|
+
ignoredAt?: string | undefined;
|
|
2301
|
+
shouldShow: boolean;
|
|
2302
|
+
status: "completed" | "muted" | "ignored" | "new";
|
|
2303
|
+
userId: string;
|
|
2304
|
+
}>;
|
|
2305
|
+
/** Get a specific session. */
|
|
2306
|
+
getSession: (conf: {
|
|
2307
|
+
tokenId: string;
|
|
2308
|
+
headers?: {
|
|
2309
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2310
|
+
"x-access-token"?: string | undefined;
|
|
2311
|
+
} | undefined;
|
|
2312
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2313
|
+
created: string;
|
|
2314
|
+
device: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupDeviceInfo;
|
|
2315
|
+
lastAccess?: string | undefined;
|
|
2316
|
+
location?: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupLocation | undefined;
|
|
2317
|
+
tokenId: string;
|
|
2318
|
+
}>;
|
|
2319
|
+
/** Get profile information for a user. */
|
|
2320
|
+
getUser: (conf: {
|
|
2321
|
+
userId: string;
|
|
2322
|
+
headers?: {
|
|
2323
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2324
|
+
"x-access-token"?: string | undefined;
|
|
2325
|
+
} | undefined;
|
|
2326
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2327
|
+
avatarRef?: string | undefined;
|
|
2328
|
+
email?: string | undefined;
|
|
2329
|
+
employeeInformation?: {
|
|
2330
|
+
department: string;
|
|
2331
|
+
} | undefined;
|
|
2332
|
+
person: import("./types.js").MittwaldAPIV2.Components.Schemas.CommonsPerson;
|
|
2333
|
+
phoneNumber?: string | undefined;
|
|
2334
|
+
registeredAt?: string | undefined;
|
|
2335
|
+
userId: string;
|
|
2336
|
+
}>;
|
|
2337
|
+
/** Submitted feedback of the given user. */
|
|
2338
|
+
listFeedback: (conf: {
|
|
2339
|
+
userId: string;
|
|
2340
|
+
headers?: {
|
|
2341
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2342
|
+
"x-access-token"?: string | undefined;
|
|
2343
|
+
} | undefined;
|
|
2344
|
+
queryParameters?: {
|
|
2345
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2346
|
+
subject?: string | undefined;
|
|
2347
|
+
} | undefined;
|
|
2348
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.UserUserFeedback[]>;
|
|
2349
|
+
/** List all sessions. */
|
|
2350
|
+
listSessions: (conf?: {
|
|
2351
|
+
headers?: {
|
|
2352
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2353
|
+
"x-access-token"?: string | undefined;
|
|
2354
|
+
} | undefined;
|
|
2355
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.SignupUserSession[]>;
|
|
2356
|
+
/** Obtain authorization from the resource owner. */
|
|
2357
|
+
oauthGetAuthorization: (conf: {
|
|
2358
|
+
queryParameters: {
|
|
2359
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2360
|
+
response_type: "code";
|
|
2361
|
+
client_id: string;
|
|
2362
|
+
grant_consent?: boolean | undefined;
|
|
2363
|
+
grant_type?: "authorization_code" | undefined;
|
|
2364
|
+
redirect_uri?: string | undefined;
|
|
2365
|
+
scope?: string | undefined;
|
|
2366
|
+
state?: string | undefined;
|
|
2367
|
+
code_challenge?: string | undefined;
|
|
2368
|
+
code_challenge_method?: "S256" | undefined;
|
|
2369
|
+
};
|
|
2370
|
+
headers?: {
|
|
2371
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2372
|
+
} | undefined;
|
|
2373
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<never>;
|
|
2374
|
+
/** Request a support code. */
|
|
2375
|
+
supportCodeRequest: (conf?: {
|
|
2376
|
+
headers?: {
|
|
2377
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2378
|
+
"x-access-token"?: string | undefined;
|
|
2379
|
+
} | undefined;
|
|
2380
|
+
queryParameters?: {
|
|
2381
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2382
|
+
forceRecreate?: boolean | undefined;
|
|
2383
|
+
} | undefined;
|
|
2384
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2385
|
+
expiresAt: string;
|
|
2386
|
+
supportCode: string;
|
|
2387
|
+
}>;
|
|
2388
|
+
};
|
|
2037
2389
|
export declare class MittwaldAPIV2ClientReact {
|
|
2038
2390
|
/** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
|
|
2039
2391
|
readonly app: ReturnType<typeof buildAppApi>;
|
|
@@ -2041,6 +2393,8 @@ export declare class MittwaldAPIV2ClientReact {
|
|
|
2041
2393
|
readonly article: ReturnType<typeof buildArticleApi>;
|
|
2042
2394
|
/** The backup API allows you to manage your project backups. */
|
|
2043
2395
|
readonly backup: ReturnType<typeof buildBackupApi>;
|
|
2396
|
+
/** The container API allows you to manage your stacks, containers, volumes and registries. */
|
|
2397
|
+
readonly container: ReturnType<typeof buildContainerApi>;
|
|
2044
2398
|
/** The contract API allows you to manage your contracts and orders */
|
|
2045
2399
|
readonly contract: ReturnType<typeof buildContractApi>;
|
|
2046
2400
|
/** The conversation API allows you to manage your support conversations. */
|
|
@@ -2053,6 +2407,8 @@ export declare class MittwaldAPIV2ClientReact {
|
|
|
2053
2407
|
readonly database: ReturnType<typeof buildDatabaseApi>;
|
|
2054
2408
|
/** The domain API allows you to manage your domains, DNS records and ingress resources. */
|
|
2055
2409
|
readonly domain: ReturnType<typeof buildDomainApi>;
|
|
2410
|
+
/** The marketplace API allows you to manage extensions and more information regaring the marketplace. */
|
|
2411
|
+
readonly marketplace: ReturnType<typeof buildMarketplaceApi>;
|
|
2056
2412
|
/** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
|
|
2057
2413
|
readonly file: ReturnType<typeof buildFileApi>;
|
|
2058
2414
|
/** The mail API allows you to manage your mail accounts. */
|
|
@@ -2061,14 +2417,14 @@ export declare class MittwaldAPIV2ClientReact {
|
|
|
2061
2417
|
readonly notification: ReturnType<typeof buildNotificationApi>;
|
|
2062
2418
|
/** The page insights API allows you to get page insights information. */
|
|
2063
2419
|
readonly pageInsights: ReturnType<typeof buildPageInsightsApi>;
|
|
2064
|
-
/** The user API allows you to manage your own user and access information of other users that might be visible to you. */
|
|
2065
|
-
readonly user: ReturnType<typeof buildUserApi>;
|
|
2066
2420
|
/** The project API allows you to manage your projects, and also any kinds of user memberships concerning these projects. */
|
|
2067
2421
|
readonly project: ReturnType<typeof buildProjectApi>;
|
|
2068
2422
|
/** The filesystem API allows you to directly access the filesystem of your project. */
|
|
2069
2423
|
readonly projectFileSystem: ReturnType<typeof buildProjectFileSystemApi>;
|
|
2070
2424
|
/** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
|
|
2071
2425
|
readonly sshsftpUser: ReturnType<typeof buildSshsftpUserApi>;
|
|
2426
|
+
/** The user API allows you to manage your own user and access information of other users that might be visible to you. */
|
|
2427
|
+
readonly user: ReturnType<typeof buildUserApi>;
|
|
2072
2428
|
private constructor();
|
|
2073
2429
|
static fromBaseClient(baseClient: MittwaldAPIV2Client): MittwaldAPIV2ClientReact;
|
|
2074
2430
|
}
|