@mittwald/api-client 0.0.0-development-74e1fd1-20240611 → 0.0.0-development-e096ee7-20240924
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 +14 -6
- package/dist/esm/generated/v2/client.js +65 -49
- package/dist/esm/generated/v2/descriptors.js +97 -49
- package/dist/esm/index.js +2 -1
- package/dist/esm/version.js +1 -1
- package/dist/types/generated/v2/client-react.d.ts +212 -72
- package/dist/types/generated/v2/client.d.ts +14142 -3956
- package/dist/types/generated/v2/descriptors.d.ts +368 -352
- package/dist/types/generated/v2/types.d.ts +3838 -655
- package/dist/types/index.d.ts +2 -1
- package/dist/types/version.d.ts +1 -1
- package/package.json +19 -18
|
@@ -249,7 +249,7 @@ declare const buildArticleApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
249
249
|
} | undefined;
|
|
250
250
|
modifierArticles?: import("./types.js").MittwaldAPIV2.Components.Schemas.ArticleReadableModifierArticleOptions[] | undefined;
|
|
251
251
|
name: string;
|
|
252
|
-
orderable: "
|
|
252
|
+
orderable: "forbidden" | "internal" | "beta_testing" | "full" | "deprecated";
|
|
253
253
|
possibleArticleChanges?: import("./types.js").MittwaldAPIV2.Components.Schemas.ArticleReadableChangeArticleOptions[] | undefined;
|
|
254
254
|
price?: number | undefined;
|
|
255
255
|
tags?: import("./types.js").MittwaldAPIV2.Components.Schemas.ArticleArticleTag[] | undefined;
|
|
@@ -269,7 +269,7 @@ declare const buildArticleApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
269
269
|
tags?: string[] | undefined;
|
|
270
270
|
templateNames?: string[] | undefined;
|
|
271
271
|
articleIds?: string[] | undefined;
|
|
272
|
-
orderable?: ("
|
|
272
|
+
orderable?: ("forbidden" | "internal" | "beta_testing" | "full" | "deprecated")[] | undefined;
|
|
273
273
|
name?: string | undefined;
|
|
274
274
|
} | undefined;
|
|
275
275
|
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ArticleReadableArticle[]>;
|
|
@@ -503,6 +503,21 @@ declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
503
503
|
termination?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
|
|
504
504
|
totalPrice: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractPrice;
|
|
505
505
|
}>;
|
|
506
|
+
/** Return the Contract for the given Certificate. */
|
|
507
|
+
getDetailOfContractByCertificate: (conf: {
|
|
508
|
+
certificateId: string;
|
|
509
|
+
headers?: {
|
|
510
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
511
|
+
"x-access-token"?: string | undefined;
|
|
512
|
+
} | undefined;
|
|
513
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
514
|
+
additionalItems?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContractItem[] | undefined;
|
|
515
|
+
baseItem: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContractItem;
|
|
516
|
+
contractId: string;
|
|
517
|
+
contractNumber: string;
|
|
518
|
+
customerId: string;
|
|
519
|
+
termination?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
|
|
520
|
+
}>;
|
|
506
521
|
/** Return the Contract for the given Domain. */
|
|
507
522
|
getDetailOfContractByDomain: (conf: {
|
|
508
523
|
domainId: string;
|
|
@@ -637,8 +652,8 @@ declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
637
652
|
customerId: string;
|
|
638
653
|
date: string;
|
|
639
654
|
groups: {
|
|
640
|
-
contractId?: string
|
|
641
|
-
description?: string
|
|
655
|
+
contractId?: string;
|
|
656
|
+
description?: string;
|
|
642
657
|
items: import("./types.js").MittwaldAPIV2.Components.Schemas.InvoiceInvoiceItem[];
|
|
643
658
|
}[];
|
|
644
659
|
id: string;
|
|
@@ -816,8 +831,8 @@ declare const buildConversationApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
816
831
|
preferredUsers: {
|
|
817
832
|
categoryUserPairs?: {
|
|
818
833
|
[k: string]: string;
|
|
819
|
-
}
|
|
820
|
-
fallback?: string
|
|
834
|
+
};
|
|
835
|
+
fallback?: string;
|
|
821
836
|
};
|
|
822
837
|
}>;
|
|
823
838
|
/** Get a support conversation. */
|
|
@@ -831,6 +846,10 @@ declare const buildConversationApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
831
846
|
conversationId: string;
|
|
832
847
|
createdAt: string;
|
|
833
848
|
createdBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser | undefined;
|
|
849
|
+
lastMessage?: {
|
|
850
|
+
createdAt: string;
|
|
851
|
+
createdBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser;
|
|
852
|
+
} | undefined;
|
|
834
853
|
lastMessageAt?: string | undefined;
|
|
835
854
|
lastMessageBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser | undefined;
|
|
836
855
|
mainUser: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser;
|
|
@@ -904,7 +923,7 @@ declare const buildCronjobApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
904
923
|
appId: string;
|
|
905
924
|
createdAt: string;
|
|
906
925
|
description: string;
|
|
907
|
-
destination: import("./types.js").MittwaldAPIV2.Components.Schemas.
|
|
926
|
+
destination: import("./types.js").MittwaldAPIV2.Components.Schemas.CronjobCronjobUrl | import("./types.js").MittwaldAPIV2.Components.Schemas.CronjobCronjobCommand;
|
|
908
927
|
email?: string | undefined;
|
|
909
928
|
id: string;
|
|
910
929
|
interval: string;
|
|
@@ -925,7 +944,7 @@ declare const buildCronjobApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
925
944
|
} | undefined;
|
|
926
945
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
927
946
|
abortedBy?: {
|
|
928
|
-
id?: string
|
|
947
|
+
id?: string;
|
|
929
948
|
} | undefined;
|
|
930
949
|
durationInMilliseconds?: number | undefined;
|
|
931
950
|
end?: string | undefined;
|
|
@@ -934,23 +953,14 @@ declare const buildCronjobApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
934
953
|
id: string;
|
|
935
954
|
logPath?: string | undefined;
|
|
936
955
|
start?: string | undefined;
|
|
937
|
-
status: "
|
|
956
|
+
status: "Complete" | "Failed" | "AbortedBySystem" | "Pending" | "Running" | "AbortedByUser" | "TimedOut";
|
|
938
957
|
successful: boolean;
|
|
939
958
|
triggeredBy?: {
|
|
940
|
-
id?: string
|
|
959
|
+
id?: string;
|
|
941
960
|
} | undefined;
|
|
942
961
|
}>;
|
|
943
962
|
};
|
|
944
963
|
declare const buildCustomerApi: (baseClient: MittwaldAPIV2Client) => {
|
|
945
|
-
/** Get all customer categories. */
|
|
946
|
-
listOfCustomerCategories: (conf?: {
|
|
947
|
-
headers?: {
|
|
948
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
949
|
-
"x-access-token"?: string | undefined;
|
|
950
|
-
} | undefined;
|
|
951
|
-
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
952
|
-
categories?: import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerCategory[] | undefined;
|
|
953
|
-
}>;
|
|
954
964
|
/** Get all customer profiles the authenticated user has access to. */
|
|
955
965
|
listCustomers: (conf?: {
|
|
956
966
|
headers?: {
|
|
@@ -960,25 +970,12 @@ declare const buildCustomerApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
960
970
|
queryParameters?: {
|
|
961
971
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
962
972
|
role?: string | undefined;
|
|
973
|
+
search?: string | undefined;
|
|
963
974
|
limit?: number | undefined;
|
|
964
975
|
skip?: number | undefined;
|
|
965
976
|
page?: number | undefined;
|
|
966
977
|
} | undefined;
|
|
967
978
|
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerCustomer[]>;
|
|
968
|
-
/** Get a customer category. */
|
|
969
|
-
getCustomerCategory: (conf: {
|
|
970
|
-
categoryId: string;
|
|
971
|
-
headers?: {
|
|
972
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
973
|
-
"x-access-token"?: string | undefined;
|
|
974
|
-
} | undefined;
|
|
975
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
976
|
-
id: string;
|
|
977
|
-
isPublic: boolean;
|
|
978
|
-
name: string;
|
|
979
|
-
useAgencyDomainPrices: boolean;
|
|
980
|
-
useAgencySslPrices: boolean;
|
|
981
|
-
}>;
|
|
982
979
|
/** Get a CustomerInvite. */
|
|
983
980
|
getCustomerInvite: (conf: {
|
|
984
981
|
customerInviteId: string;
|
|
@@ -1039,7 +1036,7 @@ declare const buildCustomerApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1039
1036
|
owner?: import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerContact | undefined;
|
|
1040
1037
|
projectCount: number;
|
|
1041
1038
|
vatId?: string | undefined;
|
|
1042
|
-
vatIdValidationState?: "
|
|
1039
|
+
vatIdValidationState?: ("valid" | "invalid" | "pending" | "unspecified") | undefined;
|
|
1043
1040
|
}>;
|
|
1044
1041
|
/** Get a CustomerInvite by token. */
|
|
1045
1042
|
getCustomerTokenInvite: (conf: {
|
|
@@ -1298,6 +1295,7 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1298
1295
|
page?: number | undefined;
|
|
1299
1296
|
limit?: number | undefined;
|
|
1300
1297
|
domainSearchName?: string | undefined;
|
|
1298
|
+
contactHash?: string | undefined;
|
|
1301
1299
|
} | undefined;
|
|
1302
1300
|
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DomainDomain[]>;
|
|
1303
1301
|
/** Get a Domain. */
|
|
@@ -1311,11 +1309,12 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1311
1309
|
authCode?: import("./types.js").MittwaldAPIV2.Components.Schemas.DomainAuthCode | undefined;
|
|
1312
1310
|
authCode2?: import("./types.js").MittwaldAPIV2.Components.Schemas.DomainAuthCode2 | undefined;
|
|
1313
1311
|
connected: boolean;
|
|
1312
|
+
contactHash?: string | undefined;
|
|
1314
1313
|
deleted: boolean;
|
|
1315
1314
|
domain: string;
|
|
1316
1315
|
domainId: string;
|
|
1317
1316
|
handles: {
|
|
1318
|
-
adminC?: import("./types.js").MittwaldAPIV2.Components.Schemas.DomainHandleReadable
|
|
1317
|
+
adminC?: import("./types.js").MittwaldAPIV2.Components.Schemas.DomainHandleReadable;
|
|
1319
1318
|
ownerC: import("./types.js").MittwaldAPIV2.Components.Schemas.DomainHandleReadable;
|
|
1320
1319
|
};
|
|
1321
1320
|
nameservers: string[];
|
|
@@ -1354,6 +1353,21 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1354
1353
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1355
1354
|
} | undefined;
|
|
1356
1355
|
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DomainTopLevel[]>;
|
|
1356
|
+
/** Suggest a list of domains based on a prompt using AI. */
|
|
1357
|
+
suggest: (conf: {
|
|
1358
|
+
queryParameters: {
|
|
1359
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1360
|
+
prompt: string;
|
|
1361
|
+
domainCount?: number | undefined;
|
|
1362
|
+
tlds?: string[] | undefined;
|
|
1363
|
+
};
|
|
1364
|
+
headers?: {
|
|
1365
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1366
|
+
"x-access-token"?: string | undefined;
|
|
1367
|
+
} | undefined;
|
|
1368
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1369
|
+
domains: string[];
|
|
1370
|
+
}>;
|
|
1357
1371
|
/** List Ingresses. */
|
|
1358
1372
|
ingressListIngresses: (conf?: {
|
|
1359
1373
|
headers?: {
|
|
@@ -1363,6 +1377,10 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1363
1377
|
queryParameters?: {
|
|
1364
1378
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1365
1379
|
projectId?: string | undefined;
|
|
1380
|
+
certificateId?: string | undefined;
|
|
1381
|
+
limit?: number | undefined;
|
|
1382
|
+
skip?: number | undefined;
|
|
1383
|
+
page?: number | undefined;
|
|
1366
1384
|
} | undefined;
|
|
1367
1385
|
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.IngressIngress[]>;
|
|
1368
1386
|
/** Get an Ingress. */
|
|
@@ -1387,6 +1405,75 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1387
1405
|
projectId: string;
|
|
1388
1406
|
tls: import("./types.js").MittwaldAPIV2.Components.Schemas.IngressTlsAcme | import("./types.js").MittwaldAPIV2.Components.Schemas.IngressTlsCertificate;
|
|
1389
1407
|
}>;
|
|
1408
|
+
/** List CertificateRequests belonging to a Project or an Ingress. */
|
|
1409
|
+
sslListCertificateRequests: (conf?: {
|
|
1410
|
+
headers?: {
|
|
1411
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1412
|
+
"x-access-token"?: string | undefined;
|
|
1413
|
+
} | undefined;
|
|
1414
|
+
queryParameters?: {
|
|
1415
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1416
|
+
projectId?: string | undefined;
|
|
1417
|
+
ingressId?: string | undefined;
|
|
1418
|
+
} | undefined;
|
|
1419
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.SslCertificateRequest[]>;
|
|
1420
|
+
/** Get a CertificateRequest. */
|
|
1421
|
+
sslGetCertificateRequest: (conf: {
|
|
1422
|
+
certificateRequestId: string;
|
|
1423
|
+
headers?: {
|
|
1424
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1425
|
+
"x-access-token"?: string | undefined;
|
|
1426
|
+
} | undefined;
|
|
1427
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1428
|
+
certificateData: import("./types.js").MittwaldAPIV2.Components.Schemas.SslCertificateData;
|
|
1429
|
+
certificateType: import("./types.js").MittwaldAPIV2.Components.Schemas.SslCertificateType;
|
|
1430
|
+
commonName?: string | undefined;
|
|
1431
|
+
contact?: import("./types.js").MittwaldAPIV2.Components.Schemas.SslContact | undefined;
|
|
1432
|
+
createdAt: string;
|
|
1433
|
+
dnsNames?: string[] | undefined;
|
|
1434
|
+
id: string;
|
|
1435
|
+
isCompleted: boolean;
|
|
1436
|
+
issuer?: string | undefined;
|
|
1437
|
+
projectId: string;
|
|
1438
|
+
validFrom?: string | undefined;
|
|
1439
|
+
validTo?: string | undefined;
|
|
1440
|
+
}>;
|
|
1441
|
+
/** Get a Certificate. */
|
|
1442
|
+
sslGetCertificate: (conf: {
|
|
1443
|
+
certificateId: string;
|
|
1444
|
+
headers?: {
|
|
1445
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1446
|
+
"x-access-token"?: string | undefined;
|
|
1447
|
+
} | undefined;
|
|
1448
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1449
|
+
caBundle?: string | undefined;
|
|
1450
|
+
certificate: string;
|
|
1451
|
+
certificateOrderId?: string | undefined;
|
|
1452
|
+
certificateRequestId: string;
|
|
1453
|
+
certificateType: import("./types.js").MittwaldAPIV2.Components.Schemas.SslCertificateType;
|
|
1454
|
+
commonName?: string | undefined;
|
|
1455
|
+
contact?: import("./types.js").MittwaldAPIV2.Components.Schemas.SslContact | undefined;
|
|
1456
|
+
dnsNames?: string[] | undefined;
|
|
1457
|
+
id: string;
|
|
1458
|
+
isExpired: boolean;
|
|
1459
|
+
issuer?: string | undefined;
|
|
1460
|
+
lastExpirationThresholdHit: number;
|
|
1461
|
+
projectId: string;
|
|
1462
|
+
validFrom: string;
|
|
1463
|
+
validTo: string;
|
|
1464
|
+
}>;
|
|
1465
|
+
/** List Certificates belonging to a Project or an Ingress. */
|
|
1466
|
+
sslListCertificates: (conf?: {
|
|
1467
|
+
headers?: {
|
|
1468
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1469
|
+
"x-access-token"?: string | undefined;
|
|
1470
|
+
} | undefined;
|
|
1471
|
+
queryParameters?: {
|
|
1472
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1473
|
+
projectId?: string | undefined;
|
|
1474
|
+
ingressId?: string | undefined;
|
|
1475
|
+
} | undefined;
|
|
1476
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.SslCertificate[]>;
|
|
1390
1477
|
};
|
|
1391
1478
|
declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
|
|
1392
1479
|
/** List ExtensionInstances. */
|
|
@@ -1422,6 +1509,8 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1422
1509
|
disabled: boolean;
|
|
1423
1510
|
extensionId: string;
|
|
1424
1511
|
id: string;
|
|
1512
|
+
pendingInstallation: boolean;
|
|
1513
|
+
pendingRemoval: boolean;
|
|
1425
1514
|
}>;
|
|
1426
1515
|
/** Get a Contributor. */
|
|
1427
1516
|
extensionGetContributor: (conf: {
|
|
@@ -1448,14 +1537,20 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1448
1537
|
"x-access-token"?: string | undefined;
|
|
1449
1538
|
} | undefined;
|
|
1450
1539
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1540
|
+
blocked: boolean;
|
|
1451
1541
|
context: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext;
|
|
1452
1542
|
contributorId: string;
|
|
1453
1543
|
description: string;
|
|
1544
|
+
detailedDescriptions?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceDetailedDescriptions | undefined;
|
|
1545
|
+
disabled: boolean;
|
|
1454
1546
|
frontendComponents?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExternalComponent[] | undefined;
|
|
1547
|
+
frontendFragments?: {
|
|
1548
|
+
[k: string]: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceFrontendFragment;
|
|
1549
|
+
} | undefined;
|
|
1455
1550
|
id: string;
|
|
1456
1551
|
name: string;
|
|
1457
1552
|
scopes: string[];
|
|
1458
|
-
state:
|
|
1553
|
+
state: "enabled" | "blocked" | "disabled";
|
|
1459
1554
|
support: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceSupportMeta;
|
|
1460
1555
|
tags: string[];
|
|
1461
1556
|
}>;
|
|
@@ -1505,9 +1600,15 @@ declare const buildFileApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1505
1600
|
fileId: string;
|
|
1506
1601
|
headers?: {
|
|
1507
1602
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1603
|
+
Token?: string | undefined;
|
|
1604
|
+
} | undefined;
|
|
1605
|
+
queryParameters?: {
|
|
1606
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1607
|
+
token?: string | undefined;
|
|
1508
1608
|
} | undefined;
|
|
1509
1609
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1510
1610
|
friendlyURL: string;
|
|
1611
|
+
friendlyUrl: string;
|
|
1511
1612
|
id: string;
|
|
1512
1613
|
mimeType: string;
|
|
1513
1614
|
name: string;
|
|
@@ -1525,18 +1626,19 @@ declare const buildFileApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1525
1626
|
fileTypes: import("./types.js").MittwaldAPIV2.Components.Schemas.FileFileType[];
|
|
1526
1627
|
maxSizeInBytes: number;
|
|
1527
1628
|
maxSizeInKB: number;
|
|
1629
|
+
maxSizeInKb: number;
|
|
1528
1630
|
mimeTypes: string[];
|
|
1529
1631
|
properties?: {
|
|
1530
1632
|
imageDimensions?: {
|
|
1531
1633
|
max?: {
|
|
1532
|
-
height?: number
|
|
1533
|
-
width?: number
|
|
1534
|
-
}
|
|
1634
|
+
height?: number;
|
|
1635
|
+
width?: number;
|
|
1636
|
+
};
|
|
1535
1637
|
min?: {
|
|
1536
|
-
height?: number
|
|
1537
|
-
width?: number
|
|
1538
|
-
}
|
|
1539
|
-
}
|
|
1638
|
+
height?: number;
|
|
1639
|
+
width?: number;
|
|
1640
|
+
};
|
|
1641
|
+
};
|
|
1540
1642
|
} | undefined;
|
|
1541
1643
|
}>;
|
|
1542
1644
|
/** Get a FileUploadType's rules. */
|
|
@@ -1550,18 +1652,19 @@ declare const buildFileApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1550
1652
|
fileTypes: import("./types.js").MittwaldAPIV2.Components.Schemas.FileFileType[];
|
|
1551
1653
|
maxSizeInBytes: number;
|
|
1552
1654
|
maxSizeInKB: number;
|
|
1655
|
+
maxSizeInKb: number;
|
|
1553
1656
|
mimeTypes: string[];
|
|
1554
1657
|
properties?: {
|
|
1555
1658
|
imageDimensions?: {
|
|
1556
1659
|
max?: {
|
|
1557
|
-
height?: number
|
|
1558
|
-
width?: number
|
|
1559
|
-
}
|
|
1660
|
+
height?: number;
|
|
1661
|
+
width?: number;
|
|
1662
|
+
};
|
|
1560
1663
|
min?: {
|
|
1561
|
-
height?: number
|
|
1562
|
-
width?: number
|
|
1563
|
-
}
|
|
1564
|
-
}
|
|
1664
|
+
height?: number;
|
|
1665
|
+
width?: number;
|
|
1666
|
+
};
|
|
1667
|
+
};
|
|
1565
1668
|
} | undefined;
|
|
1566
1669
|
}>;
|
|
1567
1670
|
/** Get a File. */
|
|
@@ -1569,21 +1672,29 @@ declare const buildFileApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1569
1672
|
fileId: string;
|
|
1570
1673
|
headers?: {
|
|
1571
1674
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1572
|
-
Accept?: "application/octet-stream" | "text/plain;base64" | undefined;
|
|
1573
|
-
"Content-Disposition"?: "inline" | "attachment" | undefined;
|
|
1675
|
+
Accept?: ("application/octet-stream" | "text/plain;base64") | undefined;
|
|
1676
|
+
"Content-Disposition"?: ("inline" | "attachment") | undefined;
|
|
1574
1677
|
Token?: string | undefined;
|
|
1575
1678
|
} | undefined;
|
|
1679
|
+
queryParameters?: {
|
|
1680
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1681
|
+
token?: string | undefined;
|
|
1682
|
+
} | undefined;
|
|
1576
1683
|
}) => import("@mittwald/react-use-promise").AsyncResource<string>;
|
|
1577
|
-
/** Get a File. */
|
|
1684
|
+
/** Get a File with user-friendly url. */
|
|
1578
1685
|
getFileWithName: (conf: {
|
|
1579
1686
|
fileId: string;
|
|
1580
1687
|
fileName: string;
|
|
1581
1688
|
headers?: {
|
|
1582
1689
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1583
|
-
Accept?: "application/octet-stream" | "text/plain;base64" | undefined;
|
|
1584
|
-
"Content-Disposition"?: "inline" | "attachment" | undefined;
|
|
1690
|
+
Accept?: ("application/octet-stream" | "text/plain;base64") | undefined;
|
|
1691
|
+
"Content-Disposition"?: ("inline" | "attachment") | undefined;
|
|
1585
1692
|
Token?: string | undefined;
|
|
1586
1693
|
} | undefined;
|
|
1694
|
+
queryParameters?: {
|
|
1695
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1696
|
+
token?: string | undefined;
|
|
1697
|
+
} | undefined;
|
|
1587
1698
|
}) => import("@mittwald/react-use-promise").AsyncResource<string>;
|
|
1588
1699
|
};
|
|
1589
1700
|
declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
|
|
@@ -1594,6 +1705,13 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1594
1705
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1595
1706
|
"x-access-token"?: string | undefined;
|
|
1596
1707
|
} | undefined;
|
|
1708
|
+
queryParameters?: {
|
|
1709
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1710
|
+
search?: string | undefined;
|
|
1711
|
+
limit?: number | undefined;
|
|
1712
|
+
skip?: number | undefined;
|
|
1713
|
+
page?: number | undefined;
|
|
1714
|
+
} | undefined;
|
|
1597
1715
|
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MailDeliverybox[]>;
|
|
1598
1716
|
/** List MailAddresses belonging to a Project. */
|
|
1599
1717
|
listMailAddresses: (conf: {
|
|
@@ -1602,6 +1720,13 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1602
1720
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1603
1721
|
"x-access-token"?: string | undefined;
|
|
1604
1722
|
} | undefined;
|
|
1723
|
+
queryParameters?: {
|
|
1724
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1725
|
+
search?: string | undefined;
|
|
1726
|
+
limit?: number | undefined;
|
|
1727
|
+
skip?: number | undefined;
|
|
1728
|
+
page?: number | undefined;
|
|
1729
|
+
} | undefined;
|
|
1605
1730
|
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MailMailAddress[]>;
|
|
1606
1731
|
/** Get a DeliveryBox. */
|
|
1607
1732
|
getDeliveryBox: (conf: {
|
|
@@ -1631,9 +1756,9 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1631
1756
|
address: string;
|
|
1632
1757
|
autoResponder: {
|
|
1633
1758
|
active: boolean;
|
|
1634
|
-
expiresAt?: string
|
|
1635
|
-
message?: string
|
|
1636
|
-
startsAt?: string
|
|
1759
|
+
expiresAt?: string;
|
|
1760
|
+
message?: string;
|
|
1761
|
+
startsAt?: string;
|
|
1637
1762
|
};
|
|
1638
1763
|
forwardAddresses: string[];
|
|
1639
1764
|
id: string;
|
|
@@ -1737,7 +1862,10 @@ declare const buildNotificationApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1737
1862
|
} | undefined;
|
|
1738
1863
|
queryParameters?: {
|
|
1739
1864
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1740
|
-
status?: "unread" | "read" | undefined;
|
|
1865
|
+
status?: ("unread" | "read") | undefined;
|
|
1866
|
+
limit?: number | undefined;
|
|
1867
|
+
skip?: number | undefined;
|
|
1868
|
+
page?: number | undefined;
|
|
1741
1869
|
} | undefined;
|
|
1742
1870
|
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MessagingNotification[]>;
|
|
1743
1871
|
};
|
|
@@ -1760,7 +1888,7 @@ declare const buildPageInsightsApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1760
1888
|
metrics?: {
|
|
1761
1889
|
createdAt: string;
|
|
1762
1890
|
name: string;
|
|
1763
|
-
score?: number
|
|
1891
|
+
score?: number;
|
|
1764
1892
|
value: number;
|
|
1765
1893
|
}[] | undefined;
|
|
1766
1894
|
moreDataAvailable?: string[] | undefined;
|
|
@@ -1782,7 +1910,7 @@ declare const buildPageInsightsApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1782
1910
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1783
1911
|
executedAt: string;
|
|
1784
1912
|
id: string;
|
|
1785
|
-
result: import("./types.js").MittwaldAPIV2.Components.Schemas.
|
|
1913
|
+
result: import("./types.js").MittwaldAPIV2.Components.Schemas.StraceError | import("./types.js").MittwaldAPIV2.Components.Schemas.StraceData;
|
|
1786
1914
|
}>;
|
|
1787
1915
|
/** List websites (specified as domain and path) from a project where performance data is available. */
|
|
1788
1916
|
pageinsightsListPerformanceDataForProject: (conf: {
|
|
@@ -1801,7 +1929,7 @@ declare const buildPageInsightsApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1801
1929
|
createdAt: string;
|
|
1802
1930
|
path: string;
|
|
1803
1931
|
performanceScore: number;
|
|
1804
|
-
screenshotFileRef?: string
|
|
1932
|
+
screenshotFileRef?: string;
|
|
1805
1933
|
}[];
|
|
1806
1934
|
}[]>;
|
|
1807
1935
|
};
|
|
@@ -1827,6 +1955,7 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1827
1955
|
"x-access-token"?: string | undefined;
|
|
1828
1956
|
} | undefined;
|
|
1829
1957
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1958
|
+
avatarRefId?: string | undefined;
|
|
1830
1959
|
id: string;
|
|
1831
1960
|
information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
|
|
1832
1961
|
mailAddress: string;
|
|
@@ -1865,6 +1994,7 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1865
1994
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1866
1995
|
clusterDomain?: string | undefined;
|
|
1867
1996
|
clusterID?: string | undefined;
|
|
1997
|
+
clusterId?: string | undefined;
|
|
1868
1998
|
createdAt: string;
|
|
1869
1999
|
customerId: string;
|
|
1870
2000
|
description: string;
|
|
@@ -1882,7 +2012,7 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1882
2012
|
serverId?: string | undefined;
|
|
1883
2013
|
serverShortId?: string | undefined;
|
|
1884
2014
|
shortId: string;
|
|
1885
|
-
spec?: import("./types.js").MittwaldAPIV2.Components.Schemas.
|
|
2015
|
+
spec?: (import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectVisitorSpec | import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectHardwareSpec) | undefined;
|
|
1886
2016
|
statisticsBaseDomain?: string | undefined;
|
|
1887
2017
|
status: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectProjectStatus;
|
|
1888
2018
|
statusSetAt: string;
|
|
@@ -1897,6 +2027,7 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1897
2027
|
"x-access-token"?: string | undefined;
|
|
1898
2028
|
};
|
|
1899
2029
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2030
|
+
avatarRefId?: string | undefined;
|
|
1900
2031
|
id: string;
|
|
1901
2032
|
information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
|
|
1902
2033
|
mailAddress: string;
|
|
@@ -1937,7 +2068,7 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1937
2068
|
createdAt: string;
|
|
1938
2069
|
customerId: string;
|
|
1939
2070
|
description: string;
|
|
1940
|
-
disabledReason?: "
|
|
2071
|
+
disabledReason?: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectServerDisableReason | undefined;
|
|
1941
2072
|
id: string;
|
|
1942
2073
|
imageRefId?: string | undefined;
|
|
1943
2074
|
isReady: boolean;
|
|
@@ -1995,6 +2126,9 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1995
2126
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1996
2127
|
customerId?: string | undefined;
|
|
1997
2128
|
serverId?: string | undefined;
|
|
2129
|
+
limit?: number | undefined;
|
|
2130
|
+
skip?: number | undefined;
|
|
2131
|
+
page?: number | undefined;
|
|
1998
2132
|
} | undefined;
|
|
1999
2133
|
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2000
2134
|
createdAt: string;
|
|
@@ -2003,15 +2137,15 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
2003
2137
|
id: string;
|
|
2004
2138
|
};
|
|
2005
2139
|
description: string;
|
|
2006
|
-
disableReason?: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectDisableReason
|
|
2007
|
-
disabledAt?: string
|
|
2140
|
+
disableReason?: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectDisableReason;
|
|
2141
|
+
disabledAt?: string;
|
|
2008
2142
|
enabled: boolean;
|
|
2009
2143
|
id: string;
|
|
2010
|
-
imageRefId?: string
|
|
2144
|
+
imageRefId?: string;
|
|
2011
2145
|
isReady: boolean;
|
|
2012
|
-
projectHostingId?: string
|
|
2146
|
+
projectHostingId?: string;
|
|
2013
2147
|
readiness: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectDeprecatedProjectReadinessStatus;
|
|
2014
|
-
serverId?: string
|
|
2148
|
+
serverId?: string;
|
|
2015
2149
|
shortId: string;
|
|
2016
2150
|
status: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectProjectStatus;
|
|
2017
2151
|
statusSetAt: string;
|
|
@@ -2262,8 +2396,8 @@ declare const buildUserApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
2262
2396
|
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2263
2397
|
email?: string | undefined;
|
|
2264
2398
|
mfaDetails?: {
|
|
2265
|
-
mfaConfirmed?: boolean
|
|
2266
|
-
mfaInitialized?: boolean
|
|
2399
|
+
mfaConfirmed?: boolean;
|
|
2400
|
+
mfaInitialized?: boolean;
|
|
2267
2401
|
} | undefined;
|
|
2268
2402
|
passwordUpdatedAt?: string | undefined;
|
|
2269
2403
|
person?: import("./types.js").MittwaldAPIV2.Components.Schemas.CommonsPerson | undefined;
|
|
@@ -2329,6 +2463,12 @@ declare const buildUserApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
2329
2463
|
employeeInformation?: {
|
|
2330
2464
|
department: string;
|
|
2331
2465
|
} | undefined;
|
|
2466
|
+
isEmployee?: boolean | undefined;
|
|
2467
|
+
mfa?: {
|
|
2468
|
+
active: boolean;
|
|
2469
|
+
setup: boolean;
|
|
2470
|
+
} | undefined;
|
|
2471
|
+
passwordUpdatedAt?: string | undefined;
|
|
2332
2472
|
person: import("./types.js").MittwaldAPIV2.Components.Schemas.CommonsPerson;
|
|
2333
2473
|
phoneNumber?: string | undefined;
|
|
2334
2474
|
registeredAt?: string | undefined;
|
|
@@ -2405,7 +2545,7 @@ export declare class MittwaldAPIV2ClientReact {
|
|
|
2405
2545
|
readonly customer: ReturnType<typeof buildCustomerApi>;
|
|
2406
2546
|
/** The database API allows you to manage your databases, like MySQL and Redis databases. */
|
|
2407
2547
|
readonly database: ReturnType<typeof buildDatabaseApi>;
|
|
2408
|
-
/** The domain API allows you to manage your domains, DNS records and ingress resources. */
|
|
2548
|
+
/** The domain API allows you to manage your domains, DNS records, SSL certificates and ingress resources. */
|
|
2409
2549
|
readonly domain: ReturnType<typeof buildDomainApi>;
|
|
2410
2550
|
/** The marketplace API allows you to manage extensions and more information regaring the marketplace. */
|
|
2411
2551
|
readonly marketplace: ReturnType<typeof buildMarketplaceApi>;
|