@mittwald/api-client 4.16.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.
@@ -114,12 +114,26 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
114
114
  }) => import("@mittwald/react-use-promise").AsyncResource<{
115
115
  expiryDate?: string | undefined;
116
116
  externalVersion: string;
117
+ fee?: import("./types.js").MittwaldAPIV2.Components.Schemas.FeeFeeStrategy | undefined;
117
118
  id: string;
118
119
  internalVersion: string;
119
120
  recommended?: boolean | undefined;
120
121
  systemSoftwareDependencies?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[] | undefined;
121
122
  userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppUserInput[] | undefined;
122
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[]>;
123
137
  /** List AppInstallations belonging to a Project. */
124
138
  listAppinstallations: (conf: {
125
139
  projectId: string;
@@ -313,6 +327,149 @@ declare const buildBackupApi: (baseClient: MittwaldAPIV2Client) => {
313
327
  status: string;
314
328
  }>;
315
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
+ };
316
473
  declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
317
474
  /** Return the BaseItem of the Contract with the given ID. */
318
475
  getBaseItemOfContract: (conf: {
@@ -571,7 +728,7 @@ declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
571
728
  dueDate?: string | undefined;
572
729
  invoicingPeriod: number;
573
730
  items: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderOrderItem[];
574
- orderDate: string;
731
+ orderDate?: string | undefined;
575
732
  orderId: string;
576
733
  orderNumber: string;
577
734
  profile?: import("./types.js").MittwaldAPIV2.Components.Schemas.OrderProfile | undefined;
@@ -648,6 +805,21 @@ declare const buildConversationApi: (baseClient: MittwaldAPIV2Client) => {
648
805
  }) => import("@mittwald/react-use-promise").AsyncResource<(import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser & {
649
806
  active: boolean;
650
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
+ }>;
651
823
  /** Get a support conversation. */
652
824
  getConversation: (conf: {
653
825
  conversationId: string;
@@ -666,7 +838,7 @@ declare const buildConversationApi: (baseClient: MittwaldAPIV2Client) => {
666
838
  relations?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference[] | undefined;
667
839
  sharedWith?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
668
840
  shortId: string;
669
- status: "open" | "answered" | "closed" | "inProgress";
841
+ status: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationStatus;
670
842
  title: string;
671
843
  visibility: "shared" | "private";
672
844
  }>;
@@ -1501,6 +1673,36 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
1501
1673
  projectId: string;
1502
1674
  whitelist: string[];
1503
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[]>;
1504
1706
  };
1505
1707
  declare const buildNotificationApi: (baseClient: MittwaldAPIV2Client) => {
1506
1708
  /** Getting the subscription status of the subscription. */
@@ -1603,206 +1805,6 @@ declare const buildPageInsightsApi: (baseClient: MittwaldAPIV2Client) => {
1603
1805
  }[];
1604
1806
  }[]>;
1605
1807
  };
1606
- declare const buildUserApi: (baseClient: MittwaldAPIV2Client) => {
1607
- /** Get a PasswordPolicy. */
1608
- passwordValidationGetPasswordPolicy: (conf: {
1609
- passwordPolicy: string;
1610
- headers?: {
1611
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1612
- } | undefined;
1613
- }) => import("@mittwald/react-use-promise").AsyncResource<string>;
1614
- /** Get your verified Email-Address. */
1615
- getOwnEmail: (conf?: {
1616
- headers?: {
1617
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1618
- "x-access-token"?: string | undefined;
1619
- } | undefined;
1620
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
1621
- email: string;
1622
- }>;
1623
- /** Get your current multi factor auth status. */
1624
- getMfaStatus: (conf?: {
1625
- headers?: {
1626
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1627
- "x-access-token"?: string | undefined;
1628
- } | undefined;
1629
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
1630
- confirmed: boolean;
1631
- initialized: boolean;
1632
- }>;
1633
- /** List all of your ApiTokens. */
1634
- listApiTokens: (conf?: {
1635
- headers?: {
1636
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1637
- "x-access-token"?: string | undefined;
1638
- } | undefined;
1639
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.SignupApiToken[]>;
1640
- /** Get your stored ssh-keys. */
1641
- listSshKeys: (conf?: {
1642
- headers?: {
1643
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1644
- "x-access-token"?: string | undefined;
1645
- } | undefined;
1646
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
1647
- sshKeys?: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupSshKey[] | undefined;
1648
- }>;
1649
- /** Get a specific ApiToken. */
1650
- getApiToken: (conf: {
1651
- apiTokenId: string;
1652
- headers?: {
1653
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1654
- "x-access-token"?: string | undefined;
1655
- } | undefined;
1656
- }) => import("@mittwald/react-use-promise").AsyncResource<{
1657
- apiTokenId: string;
1658
- createdAt: string;
1659
- description: string;
1660
- expiresAt?: string | undefined;
1661
- roles: ("api_read" | "api_write")[];
1662
- }>;
1663
- /** Get a specific stored ssh-key. */
1664
- getSshKey: (conf: {
1665
- sshKeyId: string;
1666
- headers?: {
1667
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1668
- "x-access-token"?: string | undefined;
1669
- } | undefined;
1670
- }) => import("@mittwald/react-use-promise").AsyncResource<{
1671
- sshKey: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupSshKey;
1672
- }>;
1673
- /** Get your account information. */
1674
- getOwnAccount: (conf?: {
1675
- headers?: {
1676
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1677
- "x-access-token"?: string | undefined;
1678
- } | undefined;
1679
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
1680
- email?: string | undefined;
1681
- mfaDetails?: {
1682
- mfaConfirmed?: boolean | undefined;
1683
- mfaInitialized?: boolean | undefined;
1684
- } | undefined;
1685
- passwordUpdatedAt?: string | undefined;
1686
- person?: import("./types.js").MittwaldAPIV2.Components.Schemas.CommonsPerson | undefined;
1687
- userId?: string | undefined;
1688
- }>;
1689
- /** The timestamp of your latest password change. */
1690
- getPasswordUpdatedAt: (conf?: {
1691
- headers?: {
1692
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1693
- "x-access-token"?: string | undefined;
1694
- } | undefined;
1695
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
1696
- passwordUpdatedAt: string;
1697
- }>;
1698
- /** Get personalized settings. */
1699
- getPersonalizedSettings: (conf: {
1700
- userId: string;
1701
- headers?: {
1702
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1703
- "x-access-token"?: string | undefined;
1704
- } | undefined;
1705
- }) => import("@mittwald/react-use-promise").AsyncResource<{
1706
- settingsString?: string | undefined;
1707
- }>;
1708
- /** Get poll settings for the specified user. */
1709
- getPollStatus: (conf: {
1710
- userId: string;
1711
- headers?: {
1712
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1713
- } | undefined;
1714
- }) => import("@mittwald/react-use-promise").AsyncResource<{
1715
- completedAt?: string | undefined;
1716
- dontShowUntil?: string | undefined;
1717
- ignoredAt?: string | undefined;
1718
- shouldShow: boolean;
1719
- status: "completed" | "muted" | "ignored" | "new";
1720
- userId: string;
1721
- }>;
1722
- /** Get a specific session. */
1723
- getSession: (conf: {
1724
- tokenId: string;
1725
- headers?: {
1726
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1727
- "x-access-token"?: string | undefined;
1728
- } | undefined;
1729
- }) => import("@mittwald/react-use-promise").AsyncResource<{
1730
- created: string;
1731
- device: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupDeviceInfo;
1732
- lastAccess?: string | undefined;
1733
- location?: import("./types.js").MittwaldAPIV2.Components.Schemas.SignupLocation | undefined;
1734
- tokenId: string;
1735
- }>;
1736
- /** Get profile information for a user. */
1737
- getUser: (conf: {
1738
- userId: string;
1739
- headers?: {
1740
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1741
- "x-access-token"?: string | undefined;
1742
- } | undefined;
1743
- }) => import("@mittwald/react-use-promise").AsyncResource<{
1744
- avatarRef?: string | undefined;
1745
- email?: string | undefined;
1746
- employeeInformation?: {
1747
- department: string;
1748
- } | undefined;
1749
- person: import("./types.js").MittwaldAPIV2.Components.Schemas.CommonsPerson;
1750
- phoneNumber?: string | undefined;
1751
- registeredAt?: string | undefined;
1752
- userId: string;
1753
- }>;
1754
- /** Submitted feedback of the given user. */
1755
- listFeedback: (conf: {
1756
- userId: string;
1757
- headers?: {
1758
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1759
- "x-access-token"?: string | undefined;
1760
- } | undefined;
1761
- queryParameters?: {
1762
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1763
- subject?: string | undefined;
1764
- } | undefined;
1765
- }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.UserUserFeedback[]>;
1766
- /** List all sessions. */
1767
- listSessions: (conf?: {
1768
- headers?: {
1769
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1770
- "x-access-token"?: string | undefined;
1771
- } | undefined;
1772
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.SignupUserSession[]>;
1773
- /** Obtain authorization from the resource owner. */
1774
- oauthGetAuthorization: (conf: {
1775
- queryParameters: {
1776
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1777
- response_type: "code";
1778
- client_id: string;
1779
- grant_consent?: boolean | undefined;
1780
- grant_type?: "authorization_code" | undefined;
1781
- redirect_uri?: string | undefined;
1782
- scope?: string | undefined;
1783
- state?: string | undefined;
1784
- code_challenge?: string | undefined;
1785
- code_challenge_method?: "S256" | undefined;
1786
- };
1787
- headers?: {
1788
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1789
- } | undefined;
1790
- }) => import("@mittwald/react-use-promise").AsyncResource<never>;
1791
- /** Request a support code. */
1792
- supportCodeRequest: (conf?: {
1793
- headers?: {
1794
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1795
- "x-access-token"?: string | undefined;
1796
- } | undefined;
1797
- queryParameters?: {
1798
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1799
- forceRecreate?: boolean | undefined;
1800
- } | undefined;
1801
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
1802
- expiresAt: string;
1803
- supportCode: string;
1804
- }>;
1805
- };
1806
1808
  declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
1807
1809
  /** List Invites belonging to a Project. */
1808
1810
  listInvitesForProject: (conf: {
@@ -1884,6 +1886,8 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
1884
1886
  statisticsBaseDomain?: string | undefined;
1885
1887
  status: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectProjectStatus;
1886
1888
  statusSetAt: string;
1889
+ webStorageUsageInBytes: number;
1890
+ webStorageUsageInBytesSetAt: string;
1887
1891
  }>;
1888
1892
  /** Get a ProjectInvite by token. */
1889
1893
  getProjectTokenInvite: (conf: {
@@ -2011,6 +2015,8 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
2011
2015
  shortId: string;
2012
2016
  status: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectProjectStatus;
2013
2017
  statusSetAt: string;
2018
+ webStorageUsageInBytes: number;
2019
+ webStorageUsageInBytesSetAt: string;
2014
2020
  }[]>;
2015
2021
  /** List Servers belonging to the executing user. */
2016
2022
  listServers: (conf?: {
@@ -2187,6 +2193,199 @@ declare const buildSshsftpUserApi: (baseClient: MittwaldAPIV2Client) => {
2187
2193
  userName: string;
2188
2194
  }>;
2189
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
+ };
2190
2389
  export declare class MittwaldAPIV2ClientReact {
2191
2390
  /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
2192
2391
  readonly app: ReturnType<typeof buildAppApi>;
@@ -2194,6 +2393,8 @@ export declare class MittwaldAPIV2ClientReact {
2194
2393
  readonly article: ReturnType<typeof buildArticleApi>;
2195
2394
  /** The backup API allows you to manage your project backups. */
2196
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>;
2197
2398
  /** The contract API allows you to manage your contracts and orders */
2198
2399
  readonly contract: ReturnType<typeof buildContractApi>;
2199
2400
  /** The conversation API allows you to manage your support conversations. */
@@ -2216,14 +2417,14 @@ export declare class MittwaldAPIV2ClientReact {
2216
2417
  readonly notification: ReturnType<typeof buildNotificationApi>;
2217
2418
  /** The page insights API allows you to get page insights information. */
2218
2419
  readonly pageInsights: ReturnType<typeof buildPageInsightsApi>;
2219
- /** The user API allows you to manage your own user and access information of other users that might be visible to you. */
2220
- readonly user: ReturnType<typeof buildUserApi>;
2221
2420
  /** The project API allows you to manage your projects, and also any kinds of user memberships concerning these projects. */
2222
2421
  readonly project: ReturnType<typeof buildProjectApi>;
2223
2422
  /** The filesystem API allows you to directly access the filesystem of your project. */
2224
2423
  readonly projectFileSystem: ReturnType<typeof buildProjectFileSystemApi>;
2225
2424
  /** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
2226
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>;
2227
2428
  private constructor();
2228
2429
  static fromBaseClient(baseClient: MittwaldAPIV2Client): MittwaldAPIV2ClientReact;
2229
2430
  }