@mittwald/api-client 4.52.0 → 4.53.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 +42 -71
- package/dist/esm/generated/v2/client.js +144 -205
- package/dist/esm/generated/v2/descriptors.js +36 -204
- package/dist/esm/version.js +1 -1
- package/dist/types/generated/v2/client-react.d.ts +342 -493
- package/dist/types/generated/v2/client.d.ts +5136 -5579
- package/dist/types/generated/v2/descriptors.d.ts +321 -377
- package/dist/types/generated/v2/types.d.ts +2707 -2132
- package/dist/types/version.d.ts +1 -1
- package/package.json +2 -2
|
@@ -327,149 +327,6 @@ declare const buildBackupApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
327
327
|
status: string;
|
|
328
328
|
}>;
|
|
329
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
|
-
};
|
|
473
330
|
declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
|
|
474
331
|
/** Return the BaseItem of the Contract with the given ID. */
|
|
475
332
|
getBaseItemOfContract: (conf: {
|
|
@@ -831,6 +688,10 @@ declare const buildConversationApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
831
688
|
conversationId: string;
|
|
832
689
|
createdAt: string;
|
|
833
690
|
createdBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser | undefined;
|
|
691
|
+
lastMessage?: {
|
|
692
|
+
createdAt: string;
|
|
693
|
+
createdBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser;
|
|
694
|
+
} | undefined;
|
|
834
695
|
lastMessageAt?: string | undefined;
|
|
835
696
|
lastMessageBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser | undefined;
|
|
836
697
|
mainUser: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser;
|
|
@@ -942,15 +803,6 @@ declare const buildCronjobApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
942
803
|
}>;
|
|
943
804
|
};
|
|
944
805
|
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
806
|
/** Get all customer profiles the authenticated user has access to. */
|
|
955
807
|
listCustomers: (conf?: {
|
|
956
808
|
headers?: {
|
|
@@ -960,25 +812,12 @@ declare const buildCustomerApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
960
812
|
queryParameters?: {
|
|
961
813
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
962
814
|
role?: string | undefined;
|
|
815
|
+
search?: string | undefined;
|
|
963
816
|
limit?: number | undefined;
|
|
964
817
|
skip?: number | undefined;
|
|
965
818
|
page?: number | undefined;
|
|
966
819
|
} | undefined;
|
|
967
820
|
} | 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
821
|
/** Get a CustomerInvite. */
|
|
983
822
|
getCustomerInvite: (conf: {
|
|
984
823
|
customerInviteId: string;
|
|
@@ -1354,6 +1193,21 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1354
1193
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1355
1194
|
} | undefined;
|
|
1356
1195
|
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DomainTopLevel[]>;
|
|
1196
|
+
/** Suggest a list of domains based on a prompt using AI. */
|
|
1197
|
+
suggest: (conf: {
|
|
1198
|
+
queryParameters: {
|
|
1199
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1200
|
+
prompt: string;
|
|
1201
|
+
domainCount?: number | undefined;
|
|
1202
|
+
tlds?: string[] | undefined;
|
|
1203
|
+
};
|
|
1204
|
+
headers?: {
|
|
1205
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1206
|
+
"x-access-token"?: string | undefined;
|
|
1207
|
+
} | undefined;
|
|
1208
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1209
|
+
domains: string[];
|
|
1210
|
+
}>;
|
|
1357
1211
|
/** List Ingresses. */
|
|
1358
1212
|
ingressListIngresses: (conf?: {
|
|
1359
1213
|
headers?: {
|
|
@@ -1448,14 +1302,20 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1448
1302
|
"x-access-token"?: string | undefined;
|
|
1449
1303
|
} | undefined;
|
|
1450
1304
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1305
|
+
blocked: boolean;
|
|
1451
1306
|
context: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext;
|
|
1452
1307
|
contributorId: string;
|
|
1453
1308
|
description: string;
|
|
1309
|
+
detailedDescriptions?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceDetailedDescriptions | undefined;
|
|
1310
|
+
disabled: boolean;
|
|
1454
1311
|
frontendComponents?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExternalComponent[] | undefined;
|
|
1312
|
+
frontendFragments?: {
|
|
1313
|
+
[k: string]: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceFrontendFragment;
|
|
1314
|
+
} | undefined;
|
|
1455
1315
|
id: string;
|
|
1456
1316
|
name: string;
|
|
1457
1317
|
scopes: string[];
|
|
1458
|
-
state:
|
|
1318
|
+
state: "enabled" | "blocked" | "disabled";
|
|
1459
1319
|
support: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceSupportMeta;
|
|
1460
1320
|
tags: string[];
|
|
1461
1321
|
}>;
|
|
@@ -1673,36 +1533,6 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1673
1533
|
projectId: string;
|
|
1674
1534
|
whitelist: string[];
|
|
1675
1535
|
}>;
|
|
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[]>;
|
|
1706
1536
|
};
|
|
1707
1537
|
declare const buildNotificationApi: (baseClient: MittwaldAPIV2Client) => {
|
|
1708
1538
|
/** Getting the subscription status of the subscription. */
|
|
@@ -1738,6 +1568,9 @@ declare const buildNotificationApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1738
1568
|
queryParameters?: {
|
|
1739
1569
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1740
1570
|
status?: ("unread" | "read") | undefined;
|
|
1571
|
+
limit?: number | undefined;
|
|
1572
|
+
skip?: number | undefined;
|
|
1573
|
+
page?: number | undefined;
|
|
1741
1574
|
} | undefined;
|
|
1742
1575
|
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MessagingNotification[]>;
|
|
1743
1576
|
};
|
|
@@ -1805,136 +1638,344 @@ declare const buildPageInsightsApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1805
1638
|
}[];
|
|
1806
1639
|
}[]>;
|
|
1807
1640
|
};
|
|
1808
|
-
declare const
|
|
1809
|
-
/**
|
|
1810
|
-
|
|
1811
|
-
|
|
1641
|
+
declare const buildUserApi: (baseClient: MittwaldAPIV2Client) => {
|
|
1642
|
+
/** Get a PasswordPolicy. */
|
|
1643
|
+
passwordValidationGetPasswordPolicy: (conf: {
|
|
1644
|
+
passwordPolicy: string;
|
|
1812
1645
|
headers?: {
|
|
1813
1646
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1814
|
-
"x-access-token"?: string | undefined;
|
|
1815
|
-
} | undefined;
|
|
1816
|
-
queryParameters?: {
|
|
1817
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1818
|
-
limit?: number | undefined;
|
|
1819
|
-
skip?: number | undefined;
|
|
1820
1647
|
} | undefined;
|
|
1821
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<
|
|
1822
|
-
/** Get
|
|
1823
|
-
|
|
1824
|
-
projectInviteId: string;
|
|
1648
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<string>;
|
|
1649
|
+
/** Get your verified Email-Address. */
|
|
1650
|
+
getOwnEmail: (conf?: {
|
|
1825
1651
|
headers?: {
|
|
1826
1652
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1827
1653
|
"x-access-token"?: string | undefined;
|
|
1828
1654
|
} | undefined;
|
|
1829
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1830
|
-
|
|
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;
|
|
1655
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1656
|
+
email: string;
|
|
1838
1657
|
}>;
|
|
1839
|
-
/** Get
|
|
1840
|
-
|
|
1841
|
-
projectMembershipId: string;
|
|
1658
|
+
/** Get your current multi factor auth status. */
|
|
1659
|
+
getMfaStatus: (conf?: {
|
|
1842
1660
|
headers?: {
|
|
1843
1661
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1844
1662
|
"x-access-token"?: string | undefined;
|
|
1845
1663
|
} | undefined;
|
|
1846
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1847
|
-
|
|
1848
|
-
|
|
1849
|
-
id: string;
|
|
1850
|
-
inherited: boolean;
|
|
1851
|
-
inviteId?: string | undefined;
|
|
1852
|
-
memberSince?: string | undefined;
|
|
1853
|
-
mfa: boolean;
|
|
1854
|
-
projectId: string;
|
|
1855
|
-
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
1856
|
-
userId: string;
|
|
1664
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1665
|
+
confirmed: boolean;
|
|
1666
|
+
initialized: boolean;
|
|
1857
1667
|
}>;
|
|
1858
|
-
/**
|
|
1859
|
-
|
|
1860
|
-
projectId: string;
|
|
1668
|
+
/** List all of your ApiTokens. */
|
|
1669
|
+
listApiTokens: (conf?: {
|
|
1861
1670
|
headers?: {
|
|
1862
1671
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1863
1672
|
"x-access-token"?: string | undefined;
|
|
1864
1673
|
} | undefined;
|
|
1865
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<
|
|
1866
|
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
customerId: string;
|
|
1870
|
-
description: string;
|
|
1871
|
-
directories: {
|
|
1872
|
-
[k: string]: string;
|
|
1873
|
-
};
|
|
1874
|
-
disableReason?: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectDisableReason | undefined;
|
|
1875
|
-
disabledAt?: string | undefined;
|
|
1876
|
-
enabled: boolean;
|
|
1877
|
-
id: string;
|
|
1878
|
-
imageRefId?: string | undefined;
|
|
1879
|
-
isReady: boolean;
|
|
1880
|
-
projectHostingId?: string | undefined;
|
|
1881
|
-
readiness: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectDeprecatedProjectReadinessStatus;
|
|
1882
|
-
serverId?: string | undefined;
|
|
1883
|
-
serverShortId?: string | undefined;
|
|
1884
|
-
shortId: string;
|
|
1885
|
-
spec?: (import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectVisitorSpec | import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectHardwareSpec) | undefined;
|
|
1886
|
-
statisticsBaseDomain?: string | undefined;
|
|
1887
|
-
status: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectProjectStatus;
|
|
1888
|
-
statusSetAt: string;
|
|
1889
|
-
webStorageUsageInBytes: number;
|
|
1890
|
-
webStorageUsageInBytesSetAt: string;
|
|
1891
|
-
}>;
|
|
1892
|
-
/** Get a ProjectInvite by token. */
|
|
1893
|
-
getProjectTokenInvite: (conf: {
|
|
1894
|
-
headers: {
|
|
1674
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.SignupApiToken[]>;
|
|
1675
|
+
/** Get your stored ssh-keys. */
|
|
1676
|
+
listSshKeys: (conf?: {
|
|
1677
|
+
headers?: {
|
|
1895
1678
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1896
|
-
token: string;
|
|
1897
1679
|
"x-access-token"?: string | undefined;
|
|
1898
|
-
};
|
|
1899
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1900
|
-
|
|
1901
|
-
information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
|
|
1902
|
-
mailAddress: string;
|
|
1903
|
-
membershipExpiresAt?: string | undefined;
|
|
1904
|
-
message?: string | undefined;
|
|
1905
|
-
projectDescription: string;
|
|
1906
|
-
projectId: string;
|
|
1907
|
-
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
1680
|
+
} | undefined;
|
|
1681
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1682
|
+
sshKeys?: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupSshKey[] | undefined;
|
|
1908
1683
|
}>;
|
|
1909
|
-
/** Get
|
|
1910
|
-
|
|
1911
|
-
|
|
1684
|
+
/** Get a specific ApiToken. */
|
|
1685
|
+
getApiToken: (conf: {
|
|
1686
|
+
apiTokenId: string;
|
|
1912
1687
|
headers?: {
|
|
1913
1688
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1914
1689
|
"x-access-token"?: string | undefined;
|
|
1915
1690
|
} | undefined;
|
|
1916
1691
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1917
|
-
|
|
1692
|
+
apiTokenId: string;
|
|
1693
|
+
createdAt: string;
|
|
1694
|
+
description: string;
|
|
1918
1695
|
expiresAt?: string | undefined;
|
|
1919
|
-
|
|
1920
|
-
inherited: boolean;
|
|
1921
|
-
inviteId?: string | undefined;
|
|
1922
|
-
memberSince?: string | undefined;
|
|
1923
|
-
mfa: boolean;
|
|
1924
|
-
projectId: string;
|
|
1925
|
-
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
1926
|
-
userId: string;
|
|
1696
|
+
roles: ("api_read" | "api_write")[];
|
|
1927
1697
|
}>;
|
|
1928
|
-
/** Get a
|
|
1929
|
-
|
|
1930
|
-
|
|
1698
|
+
/** Get a specific stored ssh-key. */
|
|
1699
|
+
getSshKey: (conf: {
|
|
1700
|
+
sshKeyId: string;
|
|
1931
1701
|
headers?: {
|
|
1932
1702
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1933
1703
|
"x-access-token"?: string | undefined;
|
|
1934
1704
|
} | undefined;
|
|
1935
1705
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1936
|
-
|
|
1937
|
-
|
|
1706
|
+
sshKey: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupSshKey;
|
|
1707
|
+
}>;
|
|
1708
|
+
/** Get your account information. */
|
|
1709
|
+
getOwnAccount: (conf?: {
|
|
1710
|
+
headers?: {
|
|
1711
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1712
|
+
"x-access-token"?: string | undefined;
|
|
1713
|
+
} | undefined;
|
|
1714
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1715
|
+
email?: string | undefined;
|
|
1716
|
+
mfaDetails?: {
|
|
1717
|
+
mfaConfirmed?: boolean;
|
|
1718
|
+
mfaInitialized?: boolean;
|
|
1719
|
+
} | undefined;
|
|
1720
|
+
passwordUpdatedAt?: string | undefined;
|
|
1721
|
+
person?: import("./types.js").MittwaldAPIV2.Components.Schemas.CommonsPerson | undefined;
|
|
1722
|
+
userId?: string | undefined;
|
|
1723
|
+
}>;
|
|
1724
|
+
/** The timestamp of your latest password change. */
|
|
1725
|
+
getPasswordUpdatedAt: (conf?: {
|
|
1726
|
+
headers?: {
|
|
1727
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1728
|
+
"x-access-token"?: string | undefined;
|
|
1729
|
+
} | undefined;
|
|
1730
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1731
|
+
passwordUpdatedAt: string;
|
|
1732
|
+
}>;
|
|
1733
|
+
/** Get personalized settings. */
|
|
1734
|
+
getPersonalizedSettings: (conf: {
|
|
1735
|
+
userId: string;
|
|
1736
|
+
headers?: {
|
|
1737
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1738
|
+
"x-access-token"?: string | undefined;
|
|
1739
|
+
} | undefined;
|
|
1740
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1741
|
+
settingsString?: string | undefined;
|
|
1742
|
+
}>;
|
|
1743
|
+
/** Get poll settings for the specified user. */
|
|
1744
|
+
getPollStatus: (conf: {
|
|
1745
|
+
userId: string;
|
|
1746
|
+
headers?: {
|
|
1747
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1748
|
+
} | undefined;
|
|
1749
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1750
|
+
completedAt?: string | undefined;
|
|
1751
|
+
dontShowUntil?: string | undefined;
|
|
1752
|
+
ignoredAt?: string | undefined;
|
|
1753
|
+
shouldShow: boolean;
|
|
1754
|
+
status: "completed" | "muted" | "ignored" | "new";
|
|
1755
|
+
userId: string;
|
|
1756
|
+
}>;
|
|
1757
|
+
/** Get a specific session. */
|
|
1758
|
+
getSession: (conf: {
|
|
1759
|
+
tokenId: string;
|
|
1760
|
+
headers?: {
|
|
1761
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1762
|
+
"x-access-token"?: string | undefined;
|
|
1763
|
+
} | undefined;
|
|
1764
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1765
|
+
created: string;
|
|
1766
|
+
device: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupDeviceInfo;
|
|
1767
|
+
lastAccess?: string | undefined;
|
|
1768
|
+
location?: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupLocation | undefined;
|
|
1769
|
+
tokenId: string;
|
|
1770
|
+
}>;
|
|
1771
|
+
/** Get profile information for a user. */
|
|
1772
|
+
getUser: (conf: {
|
|
1773
|
+
userId: string;
|
|
1774
|
+
headers?: {
|
|
1775
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1776
|
+
"x-access-token"?: string | undefined;
|
|
1777
|
+
} | undefined;
|
|
1778
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1779
|
+
avatarRef?: string | undefined;
|
|
1780
|
+
email?: string | undefined;
|
|
1781
|
+
employeeInformation?: {
|
|
1782
|
+
department: string;
|
|
1783
|
+
} | undefined;
|
|
1784
|
+
mfa?: {
|
|
1785
|
+
active: boolean;
|
|
1786
|
+
setup: boolean;
|
|
1787
|
+
} | undefined;
|
|
1788
|
+
passwordUpdatedAt?: string | undefined;
|
|
1789
|
+
person: import("./types.js").MittwaldAPIV2.Components.Schemas.CommonsPerson;
|
|
1790
|
+
phoneNumber?: string | undefined;
|
|
1791
|
+
registeredAt?: string | undefined;
|
|
1792
|
+
userId: string;
|
|
1793
|
+
}>;
|
|
1794
|
+
/** Submitted feedback of the given user. */
|
|
1795
|
+
listFeedback: (conf: {
|
|
1796
|
+
userId: string;
|
|
1797
|
+
headers?: {
|
|
1798
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1799
|
+
"x-access-token"?: string | undefined;
|
|
1800
|
+
} | undefined;
|
|
1801
|
+
queryParameters?: {
|
|
1802
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1803
|
+
subject?: string | undefined;
|
|
1804
|
+
} | undefined;
|
|
1805
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.UserUserFeedback[]>;
|
|
1806
|
+
/** List all sessions. */
|
|
1807
|
+
listSessions: (conf?: {
|
|
1808
|
+
headers?: {
|
|
1809
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1810
|
+
"x-access-token"?: string | undefined;
|
|
1811
|
+
} | undefined;
|
|
1812
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.SignupUserSession[]>;
|
|
1813
|
+
/** Obtain authorization from the resource owner. */
|
|
1814
|
+
oauthGetAuthorization: (conf: {
|
|
1815
|
+
queryParameters: {
|
|
1816
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1817
|
+
response_type: "code";
|
|
1818
|
+
client_id: string;
|
|
1819
|
+
grant_consent?: boolean | undefined;
|
|
1820
|
+
grant_type?: "authorization_code" | undefined;
|
|
1821
|
+
redirect_uri?: string | undefined;
|
|
1822
|
+
scope?: string | undefined;
|
|
1823
|
+
state?: string | undefined;
|
|
1824
|
+
code_challenge?: string | undefined;
|
|
1825
|
+
code_challenge_method?: "S256" | undefined;
|
|
1826
|
+
};
|
|
1827
|
+
headers?: {
|
|
1828
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1829
|
+
} | undefined;
|
|
1830
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<never>;
|
|
1831
|
+
/** Request a support code. */
|
|
1832
|
+
supportCodeRequest: (conf?: {
|
|
1833
|
+
headers?: {
|
|
1834
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1835
|
+
"x-access-token"?: string | undefined;
|
|
1836
|
+
} | undefined;
|
|
1837
|
+
queryParameters?: {
|
|
1838
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1839
|
+
forceRecreate?: boolean | undefined;
|
|
1840
|
+
} | undefined;
|
|
1841
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1842
|
+
expiresAt: string;
|
|
1843
|
+
supportCode: string;
|
|
1844
|
+
}>;
|
|
1845
|
+
};
|
|
1846
|
+
declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
1847
|
+
/** List Invites belonging to a Project. */
|
|
1848
|
+
listInvitesForProject: (conf: {
|
|
1849
|
+
projectId: string;
|
|
1850
|
+
headers?: {
|
|
1851
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1852
|
+
"x-access-token"?: string | undefined;
|
|
1853
|
+
} | undefined;
|
|
1854
|
+
queryParameters?: {
|
|
1855
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1856
|
+
limit?: number | undefined;
|
|
1857
|
+
skip?: number | undefined;
|
|
1858
|
+
} | undefined;
|
|
1859
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectInvite[]>;
|
|
1860
|
+
/** Get a ProjectInvite. */
|
|
1861
|
+
getProjectInvite: (conf: {
|
|
1862
|
+
projectInviteId: string;
|
|
1863
|
+
headers?: {
|
|
1864
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1865
|
+
"x-access-token"?: string | undefined;
|
|
1866
|
+
} | undefined;
|
|
1867
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1868
|
+
avatarRefId?: string | undefined;
|
|
1869
|
+
id: string;
|
|
1870
|
+
information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
|
|
1871
|
+
mailAddress: string;
|
|
1872
|
+
membershipExpiresAt?: string | undefined;
|
|
1873
|
+
message?: string | undefined;
|
|
1874
|
+
projectDescription: string;
|
|
1875
|
+
projectId: string;
|
|
1876
|
+
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
1877
|
+
}>;
|
|
1878
|
+
/** Get a ProjectMembership */
|
|
1879
|
+
getProjectMembership: (conf: {
|
|
1880
|
+
projectMembershipId: string;
|
|
1881
|
+
headers?: {
|
|
1882
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1883
|
+
"x-access-token"?: string | undefined;
|
|
1884
|
+
} | undefined;
|
|
1885
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1886
|
+
email: string;
|
|
1887
|
+
expiresAt?: string | undefined;
|
|
1888
|
+
id: string;
|
|
1889
|
+
inherited: boolean;
|
|
1890
|
+
inviteId?: string | undefined;
|
|
1891
|
+
memberSince?: string | undefined;
|
|
1892
|
+
mfa: boolean;
|
|
1893
|
+
projectId: string;
|
|
1894
|
+
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
1895
|
+
userId: string;
|
|
1896
|
+
}>;
|
|
1897
|
+
/** Get a Project. */
|
|
1898
|
+
getProject: (conf: {
|
|
1899
|
+
projectId: string;
|
|
1900
|
+
headers?: {
|
|
1901
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1902
|
+
"x-access-token"?: string | undefined;
|
|
1903
|
+
} | undefined;
|
|
1904
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1905
|
+
clusterDomain?: string | undefined;
|
|
1906
|
+
clusterID?: string | undefined;
|
|
1907
|
+
clusterId?: string | undefined;
|
|
1908
|
+
createdAt: string;
|
|
1909
|
+
customerId: string;
|
|
1910
|
+
description: string;
|
|
1911
|
+
directories: {
|
|
1912
|
+
[k: string]: string;
|
|
1913
|
+
};
|
|
1914
|
+
disableReason?: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectDisableReason | undefined;
|
|
1915
|
+
disabledAt?: string | undefined;
|
|
1916
|
+
enabled: boolean;
|
|
1917
|
+
id: string;
|
|
1918
|
+
imageRefId?: string | undefined;
|
|
1919
|
+
isReady: boolean;
|
|
1920
|
+
projectHostingId?: string | undefined;
|
|
1921
|
+
readiness: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectDeprecatedProjectReadinessStatus;
|
|
1922
|
+
serverId?: string | undefined;
|
|
1923
|
+
serverShortId?: string | undefined;
|
|
1924
|
+
shortId: string;
|
|
1925
|
+
spec?: (import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectVisitorSpec | import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectHardwareSpec) | undefined;
|
|
1926
|
+
statisticsBaseDomain?: string | undefined;
|
|
1927
|
+
status: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectProjectStatus;
|
|
1928
|
+
statusSetAt: string;
|
|
1929
|
+
webStorageUsageInBytes: number;
|
|
1930
|
+
webStorageUsageInBytesSetAt: string;
|
|
1931
|
+
}>;
|
|
1932
|
+
/** Get a ProjectInvite by token. */
|
|
1933
|
+
getProjectTokenInvite: (conf: {
|
|
1934
|
+
headers: {
|
|
1935
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1936
|
+
token: string;
|
|
1937
|
+
"x-access-token"?: string | undefined;
|
|
1938
|
+
};
|
|
1939
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1940
|
+
avatarRefId?: string | undefined;
|
|
1941
|
+
id: string;
|
|
1942
|
+
information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
|
|
1943
|
+
mailAddress: string;
|
|
1944
|
+
membershipExpiresAt?: string | undefined;
|
|
1945
|
+
message?: string | undefined;
|
|
1946
|
+
projectDescription: string;
|
|
1947
|
+
projectId: string;
|
|
1948
|
+
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
1949
|
+
}>;
|
|
1950
|
+
/** Get the executing user's membership in a Project. */
|
|
1951
|
+
getSelfMembershipForProject: (conf: {
|
|
1952
|
+
projectId: string;
|
|
1953
|
+
headers?: {
|
|
1954
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1955
|
+
"x-access-token"?: string | undefined;
|
|
1956
|
+
} | undefined;
|
|
1957
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1958
|
+
email: string;
|
|
1959
|
+
expiresAt?: string | undefined;
|
|
1960
|
+
id: string;
|
|
1961
|
+
inherited: boolean;
|
|
1962
|
+
inviteId?: string | undefined;
|
|
1963
|
+
memberSince?: string | undefined;
|
|
1964
|
+
mfa: boolean;
|
|
1965
|
+
projectId: string;
|
|
1966
|
+
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
1967
|
+
userId: string;
|
|
1968
|
+
}>;
|
|
1969
|
+
/** Get a Server. */
|
|
1970
|
+
getServer: (conf: {
|
|
1971
|
+
serverId: 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
|
+
clusterName: string;
|
|
1978
|
+
createdAt: string;
|
|
1938
1979
|
customerId: string;
|
|
1939
1980
|
description: string;
|
|
1940
1981
|
disabledReason?: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectServerDisableReason | undefined;
|
|
@@ -1995,6 +2036,9 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1995
2036
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1996
2037
|
customerId?: string | undefined;
|
|
1997
2038
|
serverId?: string | undefined;
|
|
2039
|
+
limit?: number | undefined;
|
|
2040
|
+
skip?: number | undefined;
|
|
2041
|
+
page?: number | undefined;
|
|
1998
2042
|
} | undefined;
|
|
1999
2043
|
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2000
2044
|
createdAt: string;
|
|
@@ -2193,199 +2237,6 @@ declare const buildSshsftpUserApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
2193
2237
|
userName: string;
|
|
2194
2238
|
}>;
|
|
2195
2239
|
};
|
|
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;
|
|
2266
|
-
mfaInitialized?: boolean;
|
|
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
|
-
};
|
|
2389
2240
|
export declare class MittwaldAPIV2ClientReact {
|
|
2390
2241
|
/** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
|
|
2391
2242
|
readonly app: ReturnType<typeof buildAppApi>;
|
|
@@ -2393,8 +2244,6 @@ export declare class MittwaldAPIV2ClientReact {
|
|
|
2393
2244
|
readonly article: ReturnType<typeof buildArticleApi>;
|
|
2394
2245
|
/** The backup API allows you to manage your project backups. */
|
|
2395
2246
|
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>;
|
|
2398
2247
|
/** The contract API allows you to manage your contracts and orders */
|
|
2399
2248
|
readonly contract: ReturnType<typeof buildContractApi>;
|
|
2400
2249
|
/** The conversation API allows you to manage your support conversations. */
|
|
@@ -2405,7 +2254,7 @@ export declare class MittwaldAPIV2ClientReact {
|
|
|
2405
2254
|
readonly customer: ReturnType<typeof buildCustomerApi>;
|
|
2406
2255
|
/** The database API allows you to manage your databases, like MySQL and Redis databases. */
|
|
2407
2256
|
readonly database: ReturnType<typeof buildDatabaseApi>;
|
|
2408
|
-
/** The domain API allows you to manage your domains, DNS records and ingress resources. */
|
|
2257
|
+
/** The domain API allows you to manage your domains, DNS records, SSL certificates and ingress resources. */
|
|
2409
2258
|
readonly domain: ReturnType<typeof buildDomainApi>;
|
|
2410
2259
|
/** The marketplace API allows you to manage extensions and more information regaring the marketplace. */
|
|
2411
2260
|
readonly marketplace: ReturnType<typeof buildMarketplaceApi>;
|
|
@@ -2417,14 +2266,14 @@ export declare class MittwaldAPIV2ClientReact {
|
|
|
2417
2266
|
readonly notification: ReturnType<typeof buildNotificationApi>;
|
|
2418
2267
|
/** The page insights API allows you to get page insights information. */
|
|
2419
2268
|
readonly pageInsights: ReturnType<typeof buildPageInsightsApi>;
|
|
2269
|
+
/** The user API allows you to manage your own user and access information of other users that might be visible to you. */
|
|
2270
|
+
readonly user: ReturnType<typeof buildUserApi>;
|
|
2420
2271
|
/** The project API allows you to manage your projects, and also any kinds of user memberships concerning these projects. */
|
|
2421
2272
|
readonly project: ReturnType<typeof buildProjectApi>;
|
|
2422
2273
|
/** The filesystem API allows you to directly access the filesystem of your project. */
|
|
2423
2274
|
readonly projectFileSystem: ReturnType<typeof buildProjectFileSystemApi>;
|
|
2424
2275
|
/** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
|
|
2425
2276
|
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>;
|
|
2428
2277
|
private constructor();
|
|
2429
2278
|
static fromBaseClient(baseClient: MittwaldAPIV2Client): MittwaldAPIV2ClientReact;
|
|
2430
2279
|
}
|