@mittwald/api-client 4.327.0 → 4.329.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 +35 -35
- package/dist/esm/generated/v2/client.js +69 -69
- package/dist/esm/generated/v2/descriptors.js +204 -204
- package/dist/esm/version.js +1 -1
- package/dist/types/generated/v2/client-react.d.ts +248 -248
- package/dist/types/generated/v2/client.d.ts +2248 -2252
- package/dist/types/generated/v2/descriptors.d.ts +73 -73
- package/dist/types/generated/v2/types.d.ts +4625 -4632
- package/dist/types/version.d.ts +1 -1
- package/package.json +4 -4
|
@@ -609,6 +609,19 @@ declare const buildContainerApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
609
609
|
status: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceStatus;
|
|
610
610
|
statusSetAt: string;
|
|
611
611
|
}>;
|
|
612
|
+
/** List Stacks belonging to the executing user. */
|
|
613
|
+
listSelfStacks: (conf?: {
|
|
614
|
+
headers?: {
|
|
615
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
616
|
+
"x-access-token"?: string | undefined;
|
|
617
|
+
} | undefined;
|
|
618
|
+
queryParameters?: {
|
|
619
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
620
|
+
limit?: number | undefined;
|
|
621
|
+
skip?: number | undefined;
|
|
622
|
+
page?: number | undefined;
|
|
623
|
+
} | undefined;
|
|
624
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerStackResponse[]>;
|
|
612
625
|
/** List Services belonging to a Project. */
|
|
613
626
|
listServices: (conf: {
|
|
614
627
|
projectId: string;
|
|
@@ -675,19 +688,6 @@ declare const buildContainerApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
675
688
|
page?: number | undefined;
|
|
676
689
|
} | undefined;
|
|
677
690
|
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[]>;
|
|
678
|
-
/** List Stacks belonging to the executing user. */
|
|
679
|
-
listSelfStacks: (conf?: {
|
|
680
|
-
headers?: {
|
|
681
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
682
|
-
"x-access-token"?: string | undefined;
|
|
683
|
-
} | undefined;
|
|
684
|
-
queryParameters?: {
|
|
685
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
686
|
-
limit?: number | undefined;
|
|
687
|
-
skip?: number | undefined;
|
|
688
|
-
page?: number | undefined;
|
|
689
|
-
} | undefined;
|
|
690
|
-
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerStackResponse[]>;
|
|
691
691
|
};
|
|
692
692
|
declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
|
|
693
693
|
/** Return the BaseItem of the Contract with the given ID. */
|
|
@@ -1687,19 +1687,6 @@ declare const buildCronjobApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1687
1687
|
}>;
|
|
1688
1688
|
};
|
|
1689
1689
|
declare const buildCustomerApi: (baseClient: MittwaldAPIV2Client) => {
|
|
1690
|
-
/** List Invites belonging to a Customer. */
|
|
1691
|
-
listInvitesForCustomer: (conf: {
|
|
1692
|
-
customerId: string;
|
|
1693
|
-
headers?: {
|
|
1694
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1695
|
-
"x-access-token"?: string | undefined;
|
|
1696
|
-
} | undefined;
|
|
1697
|
-
queryParameters?: {
|
|
1698
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1699
|
-
limit?: number | undefined;
|
|
1700
|
-
skip?: number | undefined;
|
|
1701
|
-
} | undefined;
|
|
1702
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerInvite[]>;
|
|
1703
1690
|
/** Get all customer profiles the authenticated user has access to. */
|
|
1704
1691
|
listCustomers: (conf?: {
|
|
1705
1692
|
headers?: {
|
|
@@ -1728,6 +1715,47 @@ declare const buildCustomerApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1728
1715
|
recommendationCode?: string | undefined;
|
|
1729
1716
|
walletId: string;
|
|
1730
1717
|
}>;
|
|
1718
|
+
/** Get a customer profile. */
|
|
1719
|
+
getCustomer: (conf: {
|
|
1720
|
+
customerId: string;
|
|
1721
|
+
headers?: {
|
|
1722
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1723
|
+
"x-access-token"?: string | undefined;
|
|
1724
|
+
} | undefined;
|
|
1725
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1726
|
+
activeSuspension?: {
|
|
1727
|
+
createdAt: string;
|
|
1728
|
+
} | undefined;
|
|
1729
|
+
avatarRefId?: string | undefined;
|
|
1730
|
+
categoryId?: string | undefined;
|
|
1731
|
+
creationDate: string;
|
|
1732
|
+
customerId: string;
|
|
1733
|
+
customerNumber: string;
|
|
1734
|
+
deletionProhibitedBy?: ("hasOpenInvoices" | "hasActiveContracts" | "hasActiveExtensionSubscriptions" | "isActiveContributor")[] | undefined;
|
|
1735
|
+
executingUserRoles?: import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerRole[] | undefined;
|
|
1736
|
+
flags?: import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerCustomerFlag[] | undefined;
|
|
1737
|
+
isAllowedToPlaceOrders?: boolean | undefined;
|
|
1738
|
+
isBanned?: boolean | undefined;
|
|
1739
|
+
isInDefaultOfPayment?: boolean | undefined;
|
|
1740
|
+
isMailAddressInvalid?: boolean | undefined;
|
|
1741
|
+
levelOfUndeliverableDunningNotice?: "first" | "second" | undefined;
|
|
1742
|
+
memberCount: number;
|
|
1743
|
+
name: string;
|
|
1744
|
+
owner?: import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerContact | undefined;
|
|
1745
|
+
projectCount: number;
|
|
1746
|
+
vatId?: string | undefined;
|
|
1747
|
+
vatIdValidationState?: "valid" | "invalid" | "pending" | "unspecified" | undefined;
|
|
1748
|
+
}>;
|
|
1749
|
+
/** Check if the customer profile has a valid contract partner configured. */
|
|
1750
|
+
isCustomerLegallyCompetent: (conf: {
|
|
1751
|
+
customerId: string;
|
|
1752
|
+
headers?: {
|
|
1753
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1754
|
+
"x-access-token"?: string | undefined;
|
|
1755
|
+
} | undefined;
|
|
1756
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1757
|
+
isLegallyCompetent?: boolean | undefined;
|
|
1758
|
+
}>;
|
|
1731
1759
|
/** Get a CustomerInvite. */
|
|
1732
1760
|
getCustomerInvite: (conf: {
|
|
1733
1761
|
customerInviteId: string;
|
|
@@ -1767,37 +1795,19 @@ declare const buildCustomerApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1767
1795
|
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerRoles;
|
|
1768
1796
|
userId: string;
|
|
1769
1797
|
}>;
|
|
1770
|
-
/**
|
|
1771
|
-
|
|
1798
|
+
/** List Invites belonging to a Customer. */
|
|
1799
|
+
listInvitesForCustomer: (conf: {
|
|
1772
1800
|
customerId: string;
|
|
1773
1801
|
headers?: {
|
|
1774
1802
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1775
1803
|
"x-access-token"?: string | undefined;
|
|
1776
1804
|
} | undefined;
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
|
|
1805
|
+
queryParameters?: {
|
|
1806
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1807
|
+
limit?: number | undefined;
|
|
1808
|
+
skip?: number | undefined;
|
|
1780
1809
|
} | undefined;
|
|
1781
|
-
|
|
1782
|
-
categoryId?: string | undefined;
|
|
1783
|
-
creationDate: string;
|
|
1784
|
-
customerId: string;
|
|
1785
|
-
customerNumber: string;
|
|
1786
|
-
deletionProhibitedBy?: ("hasOpenInvoices" | "hasActiveContracts" | "hasActiveExtensionSubscriptions" | "isActiveContributor")[] | undefined;
|
|
1787
|
-
executingUserRoles?: import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerRole[] | undefined;
|
|
1788
|
-
flags?: import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerCustomerFlag[] | undefined;
|
|
1789
|
-
isAllowedToPlaceOrders?: boolean | undefined;
|
|
1790
|
-
isBanned?: boolean | undefined;
|
|
1791
|
-
isInDefaultOfPayment?: boolean | undefined;
|
|
1792
|
-
isMailAddressInvalid?: boolean | undefined;
|
|
1793
|
-
levelOfUndeliverableDunningNotice?: "first" | "second" | undefined;
|
|
1794
|
-
memberCount: number;
|
|
1795
|
-
name: string;
|
|
1796
|
-
owner?: import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerContact | undefined;
|
|
1797
|
-
projectCount: number;
|
|
1798
|
-
vatId?: string | undefined;
|
|
1799
|
-
vatIdValidationState?: "valid" | "invalid" | "pending" | "unspecified" | undefined;
|
|
1800
|
-
}>;
|
|
1810
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerInvite[]>;
|
|
1801
1811
|
/** Get a CustomerInvite by token. */
|
|
1802
1812
|
getCustomerTokenInvite: (conf: {
|
|
1803
1813
|
headers: {
|
|
@@ -1816,29 +1826,6 @@ declare const buildCustomerApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1816
1826
|
message?: string | undefined;
|
|
1817
1827
|
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerRoles;
|
|
1818
1828
|
}>;
|
|
1819
|
-
/** Check if the customer profile has a valid contract partner configured. */
|
|
1820
|
-
isCustomerLegallyCompetent: (conf: {
|
|
1821
|
-
customerId: string;
|
|
1822
|
-
headers?: {
|
|
1823
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1824
|
-
"x-access-token"?: string | undefined;
|
|
1825
|
-
} | undefined;
|
|
1826
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1827
|
-
isLegallyCompetent?: boolean | undefined;
|
|
1828
|
-
}>;
|
|
1829
|
-
/** List CustomerInvites belonging to the executing user. */
|
|
1830
|
-
listCustomerInvites: (conf?: {
|
|
1831
|
-
headers?: {
|
|
1832
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1833
|
-
"x-access-token"?: string | undefined;
|
|
1834
|
-
} | undefined;
|
|
1835
|
-
queryParameters?: {
|
|
1836
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1837
|
-
limit?: number | undefined;
|
|
1838
|
-
skip?: number | undefined;
|
|
1839
|
-
page?: number | undefined;
|
|
1840
|
-
} | undefined;
|
|
1841
|
-
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerInvite[]>;
|
|
1842
1829
|
/** List CustomerMemberships belonging to the executing user. */
|
|
1843
1830
|
listCustomerMemberships: (conf?: {
|
|
1844
1831
|
headers?: {
|
|
@@ -1869,6 +1856,19 @@ declare const buildCustomerApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1869
1856
|
role?: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerRoles | undefined;
|
|
1870
1857
|
} | undefined;
|
|
1871
1858
|
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerMembership[]>;
|
|
1859
|
+
/** List CustomerInvites belonging to the executing user. */
|
|
1860
|
+
listCustomerInvites: (conf?: {
|
|
1861
|
+
headers?: {
|
|
1862
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1863
|
+
"x-access-token"?: string | undefined;
|
|
1864
|
+
} | undefined;
|
|
1865
|
+
queryParameters?: {
|
|
1866
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
1867
|
+
limit?: number | undefined;
|
|
1868
|
+
skip?: number | undefined;
|
|
1869
|
+
page?: number | undefined;
|
|
1870
|
+
} | undefined;
|
|
1871
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerInvite[]>;
|
|
1872
1872
|
};
|
|
1873
1873
|
declare const buildDatabaseApi: (baseClient: MittwaldAPIV2Client) => {
|
|
1874
1874
|
/** List MySQLDatabases belonging to a Project. */
|
|
@@ -2555,6 +2555,39 @@ declare const buildLeadFyndrApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
2555
2555
|
totalCount: number;
|
|
2556
2556
|
}>;
|
|
2557
2557
|
};
|
|
2558
|
+
declare const buildLicenseApi: (baseClient: MittwaldAPIV2Client) => {
|
|
2559
|
+
/** Get a license. */
|
|
2560
|
+
getLicense: (conf: {
|
|
2561
|
+
licenseId: string;
|
|
2562
|
+
headers?: {
|
|
2563
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2564
|
+
"x-access-token"?: string | undefined;
|
|
2565
|
+
} | undefined;
|
|
2566
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2567
|
+
description: string;
|
|
2568
|
+
expiryDate?: string | undefined;
|
|
2569
|
+
id: string;
|
|
2570
|
+
keyReference?: (import("./types.js").MittwaldAPIV2.Components.Schemas.LicenseKey | import("./types.js").MittwaldAPIV2.Components.Schemas.LicenseExternalKey) | undefined;
|
|
2571
|
+
kind: import("./types.js").MittwaldAPIV2.Components.Schemas.LicenseKind;
|
|
2572
|
+
meta: import("./types.js").MittwaldAPIV2.Components.Schemas.LicenseMeta;
|
|
2573
|
+
reference: import("./types.js").MittwaldAPIV2.Components.Schemas.LicenseReference;
|
|
2574
|
+
volume?: number | undefined;
|
|
2575
|
+
}>;
|
|
2576
|
+
/** List Licenses belonging to a Project. */
|
|
2577
|
+
listLicensesForProject: (conf: {
|
|
2578
|
+
projectId: string;
|
|
2579
|
+
headers?: {
|
|
2580
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2581
|
+
"x-access-token"?: string | undefined;
|
|
2582
|
+
} | undefined;
|
|
2583
|
+
queryParameters?: {
|
|
2584
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
2585
|
+
limit?: number | undefined;
|
|
2586
|
+
skip?: number | undefined;
|
|
2587
|
+
page?: number | undefined;
|
|
2588
|
+
} | undefined;
|
|
2589
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.LicenseLicense[]>;
|
|
2590
|
+
};
|
|
2558
2591
|
declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
|
|
2559
2592
|
/** List DeliveryBoxes belonging to a Project. */
|
|
2560
2593
|
listDeliveryBoxes: (conf: {
|
|
@@ -3029,59 +3062,6 @@ declare const buildUserApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
3029
3062
|
}>;
|
|
3030
3063
|
};
|
|
3031
3064
|
declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
3032
|
-
/** List Invites belonging to a Project. */
|
|
3033
|
-
listInvitesForProject: (conf: {
|
|
3034
|
-
projectId: string;
|
|
3035
|
-
headers?: {
|
|
3036
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3037
|
-
"x-access-token"?: string | undefined;
|
|
3038
|
-
} | undefined;
|
|
3039
|
-
queryParameters?: {
|
|
3040
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3041
|
-
limit?: number | undefined;
|
|
3042
|
-
skip?: number | undefined;
|
|
3043
|
-
} | undefined;
|
|
3044
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectInvite[]>;
|
|
3045
|
-
/** Get a ProjectInvite. */
|
|
3046
|
-
getProjectInvite: (conf: {
|
|
3047
|
-
projectInviteId: string;
|
|
3048
|
-
headers?: {
|
|
3049
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3050
|
-
"x-access-token"?: string | undefined;
|
|
3051
|
-
} | undefined;
|
|
3052
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
3053
|
-
avatarRefId?: string | undefined;
|
|
3054
|
-
id: string;
|
|
3055
|
-
information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
|
|
3056
|
-
mailAddress: string;
|
|
3057
|
-
membershipExpiresAt?: string | undefined;
|
|
3058
|
-
message?: string | undefined;
|
|
3059
|
-
projectDescription: string;
|
|
3060
|
-
projectId: string;
|
|
3061
|
-
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
3062
|
-
}>;
|
|
3063
|
-
/** Get a ProjectMembership */
|
|
3064
|
-
getProjectMembership: (conf: {
|
|
3065
|
-
projectMembershipId: string;
|
|
3066
|
-
headers?: {
|
|
3067
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3068
|
-
"x-access-token"?: string | undefined;
|
|
3069
|
-
} | undefined;
|
|
3070
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
3071
|
-
avatarRef?: string | undefined;
|
|
3072
|
-
email: string;
|
|
3073
|
-
expiresAt?: string | undefined;
|
|
3074
|
-
firstName: string;
|
|
3075
|
-
id: string;
|
|
3076
|
-
inherited: boolean;
|
|
3077
|
-
inviteId?: string | undefined;
|
|
3078
|
-
lastName: string;
|
|
3079
|
-
memberSince?: string | undefined;
|
|
3080
|
-
mfa: boolean;
|
|
3081
|
-
projectId: string;
|
|
3082
|
-
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
3083
|
-
userId: string;
|
|
3084
|
-
}>;
|
|
3085
3065
|
/** Get a Project. */
|
|
3086
3066
|
getProject: (conf: {
|
|
3087
3067
|
projectId: string;
|
|
@@ -3122,46 +3102,6 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
3122
3102
|
webStorageUsageInBytes: number;
|
|
3123
3103
|
webStorageUsageInBytesSetAt: string;
|
|
3124
3104
|
}>;
|
|
3125
|
-
/** Get a ProjectInvite by token. */
|
|
3126
|
-
getProjectTokenInvite: (conf: {
|
|
3127
|
-
headers: {
|
|
3128
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3129
|
-
token: string;
|
|
3130
|
-
"x-access-token"?: string | undefined;
|
|
3131
|
-
};
|
|
3132
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
3133
|
-
avatarRefId?: string | undefined;
|
|
3134
|
-
id: string;
|
|
3135
|
-
information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
|
|
3136
|
-
mailAddress: string;
|
|
3137
|
-
membershipExpiresAt?: string | undefined;
|
|
3138
|
-
message?: string | undefined;
|
|
3139
|
-
projectDescription: string;
|
|
3140
|
-
projectId: string;
|
|
3141
|
-
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
3142
|
-
}>;
|
|
3143
|
-
/** Get the executing user's membership in a Project. */
|
|
3144
|
-
getSelfMembershipForProject: (conf: {
|
|
3145
|
-
projectId: string;
|
|
3146
|
-
headers?: {
|
|
3147
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3148
|
-
"x-access-token"?: string | undefined;
|
|
3149
|
-
} | undefined;
|
|
3150
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
3151
|
-
avatarRef?: string | undefined;
|
|
3152
|
-
email: string;
|
|
3153
|
-
expiresAt?: string | undefined;
|
|
3154
|
-
firstName: string;
|
|
3155
|
-
id: string;
|
|
3156
|
-
inherited: boolean;
|
|
3157
|
-
inviteId?: string | undefined;
|
|
3158
|
-
lastName: string;
|
|
3159
|
-
memberSince?: string | undefined;
|
|
3160
|
-
mfa: boolean;
|
|
3161
|
-
projectId: string;
|
|
3162
|
-
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
3163
|
-
userId: string;
|
|
3164
|
-
}>;
|
|
3165
3105
|
/** Get a Server. */
|
|
3166
3106
|
getServer: (conf: {
|
|
3167
3107
|
serverId: string;
|
|
@@ -3185,52 +3125,6 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
3185
3125
|
status: import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectServerStatus;
|
|
3186
3126
|
storage: string;
|
|
3187
3127
|
}>;
|
|
3188
|
-
/** List Memberships belonging to a Project. */
|
|
3189
|
-
listMembershipsForProject: (conf: {
|
|
3190
|
-
projectId: string;
|
|
3191
|
-
headers?: {
|
|
3192
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3193
|
-
"x-access-token"?: string | undefined;
|
|
3194
|
-
} | undefined;
|
|
3195
|
-
queryParameters?: {
|
|
3196
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3197
|
-
limit?: number | undefined;
|
|
3198
|
-
skip?: number | undefined;
|
|
3199
|
-
hasExpiry?: boolean | undefined;
|
|
3200
|
-
isInherited?: boolean | undefined;
|
|
3201
|
-
role?: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles | undefined;
|
|
3202
|
-
hasMfa?: boolean | undefined;
|
|
3203
|
-
} | undefined;
|
|
3204
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectMembership[]>;
|
|
3205
|
-
/** List ProjectInvites belonging to the executing user. */
|
|
3206
|
-
listProjectInvites: (conf?: {
|
|
3207
|
-
headers?: {
|
|
3208
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3209
|
-
"x-access-token"?: string | undefined;
|
|
3210
|
-
} | undefined;
|
|
3211
|
-
queryParameters?: {
|
|
3212
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3213
|
-
limit?: number | undefined;
|
|
3214
|
-
skip?: number | undefined;
|
|
3215
|
-
page?: number | undefined;
|
|
3216
|
-
} | undefined;
|
|
3217
|
-
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectInvite[]>;
|
|
3218
|
-
/** List ProjectMemberships belonging to the executing user. */
|
|
3219
|
-
listProjectMemberships: (conf?: {
|
|
3220
|
-
headers?: {
|
|
3221
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3222
|
-
"x-access-token"?: string | undefined;
|
|
3223
|
-
} | undefined;
|
|
3224
|
-
queryParameters?: {
|
|
3225
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3226
|
-
limit?: number | undefined;
|
|
3227
|
-
skip?: number | undefined;
|
|
3228
|
-
page?: number | undefined;
|
|
3229
|
-
hasExpiry?: boolean | undefined;
|
|
3230
|
-
isInherited?: boolean | undefined;
|
|
3231
|
-
role?: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles | undefined;
|
|
3232
|
-
} | undefined;
|
|
3233
|
-
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectMembership[]>;
|
|
3234
3128
|
/** List Projects belonging to the executing user. */
|
|
3235
3129
|
listProjects: (conf?: {
|
|
3236
3130
|
headers?: {
|
|
@@ -3325,6 +3219,145 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
3325
3219
|
notificationThresholdInBytes?: number | undefined;
|
|
3326
3220
|
statisticCategories?: import("./types.js").MittwaldAPIV2.Components.Schemas.StoragespaceStatisticsCategory[] | undefined;
|
|
3327
3221
|
}>;
|
|
3222
|
+
/** Get a ProjectInvite. */
|
|
3223
|
+
getProjectInvite: (conf: {
|
|
3224
|
+
projectInviteId: string;
|
|
3225
|
+
headers?: {
|
|
3226
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3227
|
+
"x-access-token"?: string | undefined;
|
|
3228
|
+
} | undefined;
|
|
3229
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
3230
|
+
avatarRefId?: string | undefined;
|
|
3231
|
+
id: string;
|
|
3232
|
+
information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
|
|
3233
|
+
mailAddress: string;
|
|
3234
|
+
membershipExpiresAt?: string | undefined;
|
|
3235
|
+
message?: string | undefined;
|
|
3236
|
+
projectDescription: string;
|
|
3237
|
+
projectId: string;
|
|
3238
|
+
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
3239
|
+
}>;
|
|
3240
|
+
/** Get the executing user's membership in a Project. */
|
|
3241
|
+
getSelfMembershipForProject: (conf: {
|
|
3242
|
+
projectId: string;
|
|
3243
|
+
headers?: {
|
|
3244
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3245
|
+
"x-access-token"?: string | undefined;
|
|
3246
|
+
} | undefined;
|
|
3247
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
3248
|
+
avatarRef?: string | undefined;
|
|
3249
|
+
email: string;
|
|
3250
|
+
expiresAt?: string | undefined;
|
|
3251
|
+
firstName: string;
|
|
3252
|
+
id: string;
|
|
3253
|
+
inherited: boolean;
|
|
3254
|
+
inviteId?: string | undefined;
|
|
3255
|
+
lastName: string;
|
|
3256
|
+
memberSince?: string | undefined;
|
|
3257
|
+
mfa: boolean;
|
|
3258
|
+
projectId: string;
|
|
3259
|
+
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
3260
|
+
userId: string;
|
|
3261
|
+
}>;
|
|
3262
|
+
/** Get a ProjectMembership */
|
|
3263
|
+
getProjectMembership: (conf: {
|
|
3264
|
+
projectMembershipId: string;
|
|
3265
|
+
headers?: {
|
|
3266
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3267
|
+
"x-access-token"?: string | undefined;
|
|
3268
|
+
} | undefined;
|
|
3269
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
3270
|
+
avatarRef?: string | undefined;
|
|
3271
|
+
email: string;
|
|
3272
|
+
expiresAt?: string | undefined;
|
|
3273
|
+
firstName: string;
|
|
3274
|
+
id: string;
|
|
3275
|
+
inherited: boolean;
|
|
3276
|
+
inviteId?: string | undefined;
|
|
3277
|
+
lastName: string;
|
|
3278
|
+
memberSince?: string | undefined;
|
|
3279
|
+
mfa: boolean;
|
|
3280
|
+
projectId: string;
|
|
3281
|
+
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
3282
|
+
userId: string;
|
|
3283
|
+
}>;
|
|
3284
|
+
/** List Invites belonging to a Project. */
|
|
3285
|
+
listInvitesForProject: (conf: {
|
|
3286
|
+
projectId: string;
|
|
3287
|
+
headers?: {
|
|
3288
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3289
|
+
"x-access-token"?: string | undefined;
|
|
3290
|
+
} | undefined;
|
|
3291
|
+
queryParameters?: {
|
|
3292
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3293
|
+
limit?: number | undefined;
|
|
3294
|
+
skip?: number | undefined;
|
|
3295
|
+
} | undefined;
|
|
3296
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectInvite[]>;
|
|
3297
|
+
/** Get a ProjectInvite by token. */
|
|
3298
|
+
getProjectTokenInvite: (conf: {
|
|
3299
|
+
headers: {
|
|
3300
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3301
|
+
token: string;
|
|
3302
|
+
"x-access-token"?: string | undefined;
|
|
3303
|
+
};
|
|
3304
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
3305
|
+
avatarRefId?: string | undefined;
|
|
3306
|
+
id: string;
|
|
3307
|
+
information: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipInviteInformation;
|
|
3308
|
+
mailAddress: string;
|
|
3309
|
+
membershipExpiresAt?: string | undefined;
|
|
3310
|
+
message?: string | undefined;
|
|
3311
|
+
projectDescription: string;
|
|
3312
|
+
projectId: string;
|
|
3313
|
+
role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
|
|
3314
|
+
}>;
|
|
3315
|
+
/** List ProjectMemberships belonging to the executing user. */
|
|
3316
|
+
listProjectMemberships: (conf?: {
|
|
3317
|
+
headers?: {
|
|
3318
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3319
|
+
"x-access-token"?: string | undefined;
|
|
3320
|
+
} | undefined;
|
|
3321
|
+
queryParameters?: {
|
|
3322
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3323
|
+
limit?: number | undefined;
|
|
3324
|
+
skip?: number | undefined;
|
|
3325
|
+
page?: number | undefined;
|
|
3326
|
+
hasExpiry?: boolean | undefined;
|
|
3327
|
+
isInherited?: boolean | undefined;
|
|
3328
|
+
role?: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles | undefined;
|
|
3329
|
+
} | undefined;
|
|
3330
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectMembership[]>;
|
|
3331
|
+
/** List ProjectInvites belonging to the executing user. */
|
|
3332
|
+
listProjectInvites: (conf?: {
|
|
3333
|
+
headers?: {
|
|
3334
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3335
|
+
"x-access-token"?: string | undefined;
|
|
3336
|
+
} | undefined;
|
|
3337
|
+
queryParameters?: {
|
|
3338
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3339
|
+
limit?: number | undefined;
|
|
3340
|
+
skip?: number | undefined;
|
|
3341
|
+
page?: number | undefined;
|
|
3342
|
+
} | undefined;
|
|
3343
|
+
} | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectInvite[]>;
|
|
3344
|
+
/** List Memberships belonging to a Project. */
|
|
3345
|
+
listMembershipsForProject: (conf: {
|
|
3346
|
+
projectId: string;
|
|
3347
|
+
headers?: {
|
|
3348
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3349
|
+
"x-access-token"?: string | undefined;
|
|
3350
|
+
} | undefined;
|
|
3351
|
+
queryParameters?: {
|
|
3352
|
+
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3353
|
+
limit?: number | undefined;
|
|
3354
|
+
skip?: number | undefined;
|
|
3355
|
+
hasExpiry?: boolean | undefined;
|
|
3356
|
+
isInherited?: boolean | undefined;
|
|
3357
|
+
role?: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectRoles | undefined;
|
|
3358
|
+
hasMfa?: boolean | undefined;
|
|
3359
|
+
} | undefined;
|
|
3360
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipProjectMembership[]>;
|
|
3328
3361
|
};
|
|
3329
3362
|
declare const buildProjectFileSystemApi: (baseClient: MittwaldAPIV2Client) => {
|
|
3330
3363
|
/** List directories belonging to a Project. */
|
|
@@ -3486,39 +3519,6 @@ declare const buildSshsftpUserApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
3486
3519
|
userName: string;
|
|
3487
3520
|
}>;
|
|
3488
3521
|
};
|
|
3489
|
-
declare const buildLicenseApi: (baseClient: MittwaldAPIV2Client) => {
|
|
3490
|
-
/** Get a license. */
|
|
3491
|
-
getLicense: (conf: {
|
|
3492
|
-
licenseId: string;
|
|
3493
|
-
headers?: {
|
|
3494
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3495
|
-
"x-access-token"?: string | undefined;
|
|
3496
|
-
} | undefined;
|
|
3497
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
3498
|
-
description: string;
|
|
3499
|
-
expiryDate?: string | undefined;
|
|
3500
|
-
id: string;
|
|
3501
|
-
keyReference?: (import("./types.js").MittwaldAPIV2.Components.Schemas.LicenseKey | import("./types.js").MittwaldAPIV2.Components.Schemas.LicenseExternalKey) | undefined;
|
|
3502
|
-
kind: import("./types.js").MittwaldAPIV2.Components.Schemas.LicenseKind;
|
|
3503
|
-
meta: import("./types.js").MittwaldAPIV2.Components.Schemas.LicenseMeta;
|
|
3504
|
-
reference: import("./types.js").MittwaldAPIV2.Components.Schemas.LicenseReference;
|
|
3505
|
-
volume?: number | undefined;
|
|
3506
|
-
}>;
|
|
3507
|
-
/** List Licenses belonging to a Project. */
|
|
3508
|
-
listLicensesForProject: (conf: {
|
|
3509
|
-
projectId: string;
|
|
3510
|
-
headers?: {
|
|
3511
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3512
|
-
"x-access-token"?: string | undefined;
|
|
3513
|
-
} | undefined;
|
|
3514
|
-
queryParameters?: {
|
|
3515
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
3516
|
-
limit?: number | undefined;
|
|
3517
|
-
skip?: number | undefined;
|
|
3518
|
-
page?: number | undefined;
|
|
3519
|
-
} | undefined;
|
|
3520
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.LicenseLicense[]>;
|
|
3521
|
-
};
|
|
3522
3522
|
export declare class MittwaldAPIV2ClientReact {
|
|
3523
3523
|
/** The AI hosting provides access to multiple large language and embedding models – GDPR compliant and hosted in Germany. */
|
|
3524
3524
|
readonly aiHosting: ReturnType<typeof buildAiHostingApi>;
|
|
@@ -3548,6 +3548,8 @@ export declare class MittwaldAPIV2ClientReact {
|
|
|
3548
3548
|
readonly file: ReturnType<typeof buildFileApi>;
|
|
3549
3549
|
/** The lead fyndr api allow you to manage you leads and your fyndr profile. */
|
|
3550
3550
|
readonly leadFyndr: ReturnType<typeof buildLeadFyndrApi>;
|
|
3551
|
+
/** The license API allows you to manage your paid licenses. */
|
|
3552
|
+
readonly license: ReturnType<typeof buildLicenseApi>;
|
|
3551
3553
|
/** The mail API allows you to manage your mail accounts. */
|
|
3552
3554
|
readonly mail: ReturnType<typeof buildMailApi>;
|
|
3553
3555
|
/** API endpoints that are not related to any specific API domain */
|
|
@@ -3564,8 +3566,6 @@ export declare class MittwaldAPIV2ClientReact {
|
|
|
3564
3566
|
readonly projectFileSystem: ReturnType<typeof buildProjectFileSystemApi>;
|
|
3565
3567
|
/** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
|
|
3566
3568
|
readonly sshsftpUser: ReturnType<typeof buildSshsftpUserApi>;
|
|
3567
|
-
/** The license API allows you to manage your paid licenses. */
|
|
3568
|
-
readonly license: ReturnType<typeof buildLicenseApi>;
|
|
3569
3569
|
private constructor();
|
|
3570
3570
|
static fromBaseClient(baseClient: MittwaldAPIV2Client): MittwaldAPIV2ClientReact;
|
|
3571
3571
|
}
|