@mittwald/api-client 3.1.2 → 3.1.3
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/cjs/generated/v2/client-react.d.ts +13 -13
- package/dist/cjs/generated/v2/client-react.js +13 -13
- package/dist/cjs/generated/v2/client.d.ts +21 -23
- package/dist/cjs/generated/v2/client.js +21 -21
- package/dist/cjs/generated/v2/descriptors.d.ts +24 -24
- package/dist/cjs/generated/v2/descriptors.js +26 -26
- package/dist/cjs/generated/v2/types.d.ts +3 -9
- package/dist/esm/generated/v2/client-react.d.ts +13 -13
- package/dist/esm/generated/v2/client-react.js +13 -13
- package/dist/esm/generated/v2/client.d.ts +21 -23
- package/dist/esm/generated/v2/client.js +21 -21
- package/dist/esm/generated/v2/descriptors.d.ts +24 -24
- package/dist/esm/generated/v2/descriptors.js +26 -26
- package/dist/esm/generated/v2/types.d.ts +3 -9
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
|
@@ -6,127 +6,127 @@ exports.fileGetFileTypeRules = exports.fileGetFileTokenRules = exports.fileGetFi
|
|
|
6
6
|
exports.projectCreateProjectInvite = exports.projectAcceptProjectInvite = exports.passwordValidationGetPasswordPolicy = exports.pageinsightsListPerformanceDataForProject = exports.pageinsightsGetPerformanceData = exports.orderPreviewTariffChange = exports.orderPreviewOrder = exports.orderListProjectOrders = exports.orderListCustomerOrders = exports.orderGetOrder = exports.orderCreateTariffChange = exports.orderCreateOrder = exports.notificationsReadNotification = exports.notificationsReadAllNotifications = exports.notificationsListNotifications = exports.notificationsCountUnreadNotifications = exports.newsletterUnsubscribeUser = exports.newsletterGetInfo = exports.mailUpdateProjectMailSetting = exports.mailUpdateMailAddressSpamProtection = exports.mailUpdateMailAddressQuota = exports.mailUpdateMailAddressPassword = exports.mailUpdateMailAddressForwardAddresses = exports.mailUpdateMailAddressCatchall = exports.mailUpdateMailAddressAutoresponder = exports.mailUpdateMailAddressAddress = exports.mailUpdateDeliveryBoxPassword = exports.mailUpdateDeliveryBoxDescription = exports.mailListProjectMailSettings = exports.mailDeleteMailAddress = exports.mailGetMailAddress = exports.mailDeleteDeliveryBox = exports.mailGetDeliveryBox = exports.mailCreateMailAddress = exports.mailListMailAddresses = exports.mailCreateDeliverybox = exports.mailListDeliveryBoxes = exports.invoiceListCustomerInvoices = exports.invoiceUpdateInvoiceSettings = exports.invoiceGetDetailOfInvoiceSettings = exports.invoiceDetailOfInvoice = exports.ingressTls = exports.ingressRequestAcmeCertificateIssuance = exports.ingressPaths = exports.ingressListForProject = exports.ingressListAccessible = exports.ingressDelete = exports.ingressGetSpecific = exports.ingressCreate = exports.fileGetFile = void 0;
|
|
7
7
|
exports.userChangeEmail = exports.userGetOwnEmail = exports.userAuthenticate = exports.userAuthenticateMfa = exports.userRemovePhoneNumber = exports.userAddPhoneNumber = exports.sshUserUpdateSshUser = exports.sshUserDeleteSshUser = exports.sshUserGetSshUser = exports.sshUserCreateSshUser = exports.sshUserListSshUsers = exports.sftpUserUpdateSftpUser = exports.sftpUserDeleteSftpUser = exports.sftpUserGetSftpUser = exports.sftpUserCreateSftpUser = exports.sftpUserListSftpUsers = exports.servicetokenAuthenticateService = exports.relocationCreateRelocation = exports.relocationCreateLegacyTariffChange = exports.projectUpdateServerDescription = exports.projectUpdateProjectDescription = exports.projectResendProjectInviteMail = exports.projectListServers = exports.projectListProjects = exports.projectListProjectMemberships = exports.projectListProjectInvites = exports.projectListMembershipsForProject = exports.projectListInvitesForProject = exports.projectLeaveProject = exports.projectGetServer = exports.projectGetSelfMembershipForProject = exports.projectGetProjectTokenInvite = exports.projectFileSystemListFiles = exports.projectFileSystemGetJwt = exports.projectFileSystemGetFileContent = exports.projectFileSystemGetDiskUsage = exports.projectFileSystemGetDirectories = exports.projectDeleteServerAvatar = exports.projectRequestServerAvatarUpload = exports.projectDeleteProject = exports.projectGetProject = exports.projectUpdateProjectMembership = exports.projectDeleteProjectMembership = exports.projectGetProjectMembership = exports.projectDeleteProjectInvite = exports.projectGetProjectInvite = exports.projectDeleteProjectAvatar = exports.projectRequestProjectAvatarUpload = exports.projectDeclineProjectInvite = exports.projectCreateProject = void 0;
|
|
8
8
|
exports.userVerifyRegistration = exports.userVerifyPhoneNumber = exports.userVerifyEmail = exports.userSupportCodeRequest = exports.userResendVerificationEmail = exports.userRemoveAvatar = exports.userRequestAvatarUpload = exports.userRegister = exports.userLogout = exports.userTerminateAllSessions = exports.userListSessions = exports.userListFeedback = exports.userInitPasswordReset = exports.userInitMfa = exports.userUpdatePersonalInformation = exports.userGetUser = exports.userTerminateSession = exports.userGetSession = exports.userUpdatePersonalizedSettings = exports.userGetPersonalizedSettings = exports.userGetPasswordUpdatedAt = exports.userUpdateAccount = exports.userGetOwnAccount = exports.userDeleteUser = exports.userDeleteSshKey = exports.userEditSshKey = exports.userGetSshKey = exports.userDeleteApiToken = exports.userEditApiToken = exports.userGetApiToken = exports.userCreateSshKey = exports.userListSshKeys = exports.userCreateFeedback = exports.userCreateApiToken = exports.userListApiTokens = exports.userConfirmPasswordReset = exports.userDisableMfa = exports.userConfirmMfa = exports.userResetRecoverycodes = exports.userGetMfaStatus = exports.userCheckToken = exports.userChangePassword = void 0;
|
|
9
|
-
/**
|
|
9
|
+
/** execute a runtime concerning action on a specific `AppInstallation` */
|
|
10
10
|
exports.appExecuteAction = {
|
|
11
11
|
path: "/v2/appinstallations/{appInstallationId}/actions/{action}",
|
|
12
12
|
method: "POST",
|
|
13
13
|
operationId: "app-execute-action",
|
|
14
14
|
};
|
|
15
|
-
/**
|
|
15
|
+
/** get a specific `App` */
|
|
16
16
|
exports.appGetApp = {
|
|
17
17
|
path: "/v2/apps/{appId}",
|
|
18
18
|
method: "GET",
|
|
19
19
|
operationId: "app-get-app",
|
|
20
20
|
};
|
|
21
|
-
/**
|
|
21
|
+
/** get a specific `AppInstallation` */
|
|
22
22
|
exports.appGetAppinstallation = {
|
|
23
23
|
path: "/v2/appinstallations/{appInstallationId}",
|
|
24
24
|
method: "GET",
|
|
25
25
|
operationId: "app-get-appinstallation",
|
|
26
26
|
};
|
|
27
|
-
/**
|
|
27
|
+
/** start uninstallation process for a specific `AppInstallation` */
|
|
28
28
|
exports.appUninstallAppinstallation = {
|
|
29
29
|
path: "/v2/appinstallations/{appInstallationId}",
|
|
30
30
|
method: "DELETE",
|
|
31
31
|
operationId: "app-uninstall-appinstallation",
|
|
32
32
|
};
|
|
33
|
-
/**
|
|
33
|
+
/** patch desired properties of a specific `AppInstallation` */
|
|
34
34
|
exports.appPatchAppinstallation = {
|
|
35
35
|
path: "/v2/appinstallations/{appInstallationId}",
|
|
36
36
|
method: "PATCH",
|
|
37
37
|
operationId: "app-patch-appinstallation",
|
|
38
38
|
};
|
|
39
|
-
/**
|
|
39
|
+
/** get a specific `AppVersion` */
|
|
40
40
|
exports.appGetAppversion = {
|
|
41
41
|
path: "/v2/apps/{appId}/versions/{appVersionId}",
|
|
42
42
|
method: "GET",
|
|
43
43
|
operationId: "app-get-appversion",
|
|
44
44
|
};
|
|
45
|
-
/**
|
|
45
|
+
/** get the missing requirements of an appInstallation for a specific target AppVersion */
|
|
46
46
|
exports.appGetMissingDependenciesForAppinstallation = {
|
|
47
47
|
path: "/v2/appinstallations/{appInstallationId}/missing-dependencies",
|
|
48
48
|
method: "GET",
|
|
49
49
|
operationId: "app-get-missing-dependencies-for-appinstallation",
|
|
50
50
|
};
|
|
51
|
-
/**
|
|
51
|
+
/** get a specific `SystemSoftware` */
|
|
52
52
|
exports.appGetSystemsoftware = {
|
|
53
53
|
path: "/v2/systemsoftwares/{systemSoftwareId}",
|
|
54
54
|
method: "GET",
|
|
55
55
|
operationId: "app-get-systemsoftware",
|
|
56
56
|
};
|
|
57
|
-
/**
|
|
57
|
+
/** get a specific `SystemSoftwareVersion` */
|
|
58
58
|
exports.appGetSystemsoftwareversion = {
|
|
59
59
|
path: "/v2/systemsoftware/{systemSoftwareId}/versions/{systemSoftwareVersionId}",
|
|
60
60
|
method: "GET",
|
|
61
61
|
operationId: "app-get-systemsoftwareversion",
|
|
62
62
|
};
|
|
63
|
-
/**
|
|
63
|
+
/** create linkage between an `AppInstallation` and a `Database` */
|
|
64
64
|
exports.appLinkDatabase = {
|
|
65
65
|
path: "/v2/appinstallations/{appInstallationId}/databases",
|
|
66
66
|
method: "PUT",
|
|
67
67
|
operationId: "app-link-database",
|
|
68
68
|
};
|
|
69
|
-
/**
|
|
69
|
+
/** get all `AppInstallations` inside a specific `Project` */
|
|
70
70
|
exports.appListAppinstallations = {
|
|
71
71
|
path: "/v2/projects/{projectId}/appinstallations",
|
|
72
72
|
method: "GET",
|
|
73
73
|
operationId: "app-list-appinstallations",
|
|
74
74
|
};
|
|
75
|
-
/**
|
|
75
|
+
/** request a new `AppInstallation` */
|
|
76
76
|
exports.appRequestAppinstallation = {
|
|
77
77
|
path: "/v2/projects/{projectId}/appinstallations",
|
|
78
78
|
method: "POST",
|
|
79
79
|
operationId: "app-request-appinstallation",
|
|
80
80
|
};
|
|
81
|
-
/**
|
|
81
|
+
/** get all available `Apps` */
|
|
82
82
|
exports.appListApps = {
|
|
83
83
|
path: "/v2/apps",
|
|
84
84
|
method: "GET",
|
|
85
85
|
operationId: "app-list-apps",
|
|
86
86
|
};
|
|
87
|
-
/**
|
|
87
|
+
/** get all `AppVersions` of a specific `App` */
|
|
88
88
|
exports.appListAppversions = {
|
|
89
89
|
path: "/v2/apps/{appId}/versions",
|
|
90
90
|
method: "GET",
|
|
91
91
|
operationId: "app-list-appversions",
|
|
92
92
|
};
|
|
93
|
-
/**
|
|
93
|
+
/** get all available `SystemSoftware` */
|
|
94
94
|
exports.appListSystemsoftwares = {
|
|
95
95
|
path: "/v2/systemsoftwares",
|
|
96
96
|
method: "GET",
|
|
97
97
|
operationId: "app-list-systemsoftwares",
|
|
98
98
|
};
|
|
99
|
-
/**
|
|
99
|
+
/** get all available `SystemSoftwareVersions` of a specific `SystemSoftware` */
|
|
100
100
|
exports.appListSystemsoftwareversions = {
|
|
101
101
|
path: "/v2/systemsoftware/{systemSoftwareId}/versions",
|
|
102
102
|
method: "GET",
|
|
103
103
|
operationId: "app-list-systemsoftwareversions",
|
|
104
104
|
};
|
|
105
|
-
/**
|
|
105
|
+
/** get all update candidates for a specific `AppVersion` */
|
|
106
106
|
exports.appListUpdateCandidatesForAppversion = {
|
|
107
107
|
path: "/v2/apps/{appId}/versions/{baseAppVersionId}/update-candidates",
|
|
108
108
|
method: "GET",
|
|
109
109
|
operationId: "app-list-update-candidates-for-appversion",
|
|
110
110
|
};
|
|
111
|
-
/**
|
|
111
|
+
/** request a copy of an `AppInstallation` */
|
|
112
112
|
exports.appRequestAppinstallationCopy = {
|
|
113
113
|
path: "/v2/appinstallations/{id}/actions/copy",
|
|
114
114
|
method: "POST",
|
|
115
115
|
operationId: "app-request-appinstallation-copy",
|
|
116
116
|
};
|
|
117
|
-
/**
|
|
117
|
+
/** get runtime status of a specific `AppInstallation` */
|
|
118
118
|
exports.appRetrieveStatus = {
|
|
119
119
|
path: "/v2/appinstallations/{appInstallationId}/status",
|
|
120
120
|
method: "GET",
|
|
121
121
|
operationId: "app-retrieve-status",
|
|
122
122
|
};
|
|
123
|
-
/**
|
|
123
|
+
/** create linkage between an `AppInstallation` and `DatabaseUsers` */
|
|
124
124
|
exports.appSetDatabaseUsers = {
|
|
125
125
|
path: "/v2/appinstallations/{appInstallationId}/databases/{databaseId}",
|
|
126
126
|
method: "PUT",
|
|
127
127
|
operationId: "app-set-database-users",
|
|
128
128
|
};
|
|
129
|
-
/**
|
|
129
|
+
/** remove linkage between an `AppInstallation` and a `Database` */
|
|
130
130
|
exports.appUnlinkDatabase = {
|
|
131
131
|
path: "/v2/appinstallations/{appInstallationId}/databases/{databaseId}",
|
|
132
132
|
method: "DELETE",
|
|
@@ -1112,7 +1112,7 @@ exports.newsletterUnsubscribeUser = {
|
|
|
1112
1112
|
};
|
|
1113
1113
|
/** Get the counts for unread notifications of the user. */
|
|
1114
1114
|
exports.notificationsCountUnreadNotifications = {
|
|
1115
|
-
path: "/v2/
|
|
1115
|
+
path: "/v2/notifications/unread-counts",
|
|
1116
1116
|
method: "GET",
|
|
1117
1117
|
operationId: "notifications-count-unread-notifications",
|
|
1118
1118
|
};
|
|
@@ -1286,19 +1286,19 @@ exports.projectDeleteServerAvatar = {
|
|
|
1286
1286
|
};
|
|
1287
1287
|
/** List directories belonging to a Project. */
|
|
1288
1288
|
exports.projectFileSystemGetDirectories = {
|
|
1289
|
-
path: "/v2/projects/{projectId}/filesystem
|
|
1289
|
+
path: "/v2/projects/{projectId}/filesystem/directories",
|
|
1290
1290
|
method: "GET",
|
|
1291
1291
|
operationId: "project-file-system-get-directories",
|
|
1292
1292
|
};
|
|
1293
1293
|
/** Get a Project directory filesystem usage. */
|
|
1294
1294
|
exports.projectFileSystemGetDiskUsage = {
|
|
1295
|
-
path: "/v2/projects/{projectId}/filesystem
|
|
1295
|
+
path: "/v2/projects/{projectId}/filesystem/usages/disk",
|
|
1296
1296
|
method: "GET",
|
|
1297
1297
|
operationId: "project-file-system-get-disk-usage",
|
|
1298
1298
|
};
|
|
1299
1299
|
/** Get a Project file's content. */
|
|
1300
1300
|
exports.projectFileSystemGetFileContent = {
|
|
1301
|
-
path: "/v2/projects/{projectId}/filesystem
|
|
1301
|
+
path: "/v2/projects/{projectId}/filesystem/files/raw",
|
|
1302
1302
|
method: "GET",
|
|
1303
1303
|
operationId: "project-file-system-get-file-content",
|
|
1304
1304
|
};
|
|
@@ -1310,7 +1310,7 @@ exports.projectFileSystemGetJwt = {
|
|
|
1310
1310
|
};
|
|
1311
1311
|
/** Get a Project file's information. */
|
|
1312
1312
|
exports.projectFileSystemListFiles = {
|
|
1313
|
-
path: "/v2/projects/{projectId}/filesystem
|
|
1313
|
+
path: "/v2/projects/{projectId}/filesystem/files",
|
|
1314
1314
|
method: "GET",
|
|
1315
1315
|
operationId: "project-file-system-list-files",
|
|
1316
1316
|
};
|
|
@@ -3633,7 +3633,6 @@ export declare module MittwaldAPIV2 {
|
|
|
3633
3633
|
};
|
|
3634
3634
|
interface RequestBody {
|
|
3635
3635
|
description: string;
|
|
3636
|
-
targetProjectId?: string;
|
|
3637
3636
|
}
|
|
3638
3637
|
type Header = {};
|
|
3639
3638
|
type Query = {};
|
|
@@ -10634,8 +10633,7 @@ export declare module MittwaldAPIV2 {
|
|
|
10634
10633
|
}
|
|
10635
10634
|
}
|
|
10636
10635
|
}
|
|
10637
|
-
namespace V2NotificationsUnreadCounts {
|
|
10638
|
-
namespace V2NotificationUnreadCounts {
|
|
10636
|
+
namespace V2NotificationsUnreadCounts {
|
|
10639
10637
|
namespace Get {
|
|
10640
10638
|
namespace Parameters {
|
|
10641
10639
|
type Path = {};
|
|
@@ -11700,7 +11698,6 @@ export declare module MittwaldAPIV2 {
|
|
|
11700
11698
|
}
|
|
11701
11699
|
}
|
|
11702
11700
|
}
|
|
11703
|
-
namespace V2ProjectsProjectIdFilesystemDirectories { }
|
|
11704
11701
|
namespace V2ProjectsProjectIdFilesystemDirectories {
|
|
11705
11702
|
namespace Get {
|
|
11706
11703
|
namespace Parameters {
|
|
@@ -11754,8 +11751,7 @@ export declare module MittwaldAPIV2 {
|
|
|
11754
11751
|
}
|
|
11755
11752
|
}
|
|
11756
11753
|
}
|
|
11757
|
-
namespace V2ProjectsProjectIdFilesystemUsagesDisk {
|
|
11758
|
-
namespace V2ProjectsProjectIdFilesystemDiskUsage {
|
|
11754
|
+
namespace V2ProjectsProjectIdFilesystemUsagesDisk {
|
|
11759
11755
|
namespace Get {
|
|
11760
11756
|
namespace Parameters {
|
|
11761
11757
|
type Path = {
|
|
@@ -11803,8 +11799,7 @@ export declare module MittwaldAPIV2 {
|
|
|
11803
11799
|
}
|
|
11804
11800
|
}
|
|
11805
11801
|
}
|
|
11806
|
-
namespace V2ProjectsProjectIdFilesystemFilesRaw {
|
|
11807
|
-
namespace V2ProjectsProjectIdFilesystemFileContent {
|
|
11802
|
+
namespace V2ProjectsProjectIdFilesystemFilesRaw {
|
|
11808
11803
|
namespace Get {
|
|
11809
11804
|
namespace Parameters {
|
|
11810
11805
|
type Path = {
|
|
@@ -11892,7 +11887,6 @@ export declare module MittwaldAPIV2 {
|
|
|
11892
11887
|
}
|
|
11893
11888
|
}
|
|
11894
11889
|
}
|
|
11895
|
-
namespace V2ProjectsProjectIdFilesystemFiles { }
|
|
11896
11890
|
namespace V2ProjectsProjectIdFilesystemFiles {
|
|
11897
11891
|
namespace Get {
|
|
11898
11892
|
namespace Parameters {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import MittwaldAPIV2Client from "./client.js";
|
|
2
2
|
export * from "@mittwald/react-use-promise/types";
|
|
3
3
|
declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
4
|
-
/**
|
|
4
|
+
/** get a specific `App` */
|
|
5
5
|
getApp: (conf: {
|
|
6
6
|
appId: string;
|
|
7
7
|
headers?: {
|
|
@@ -14,7 +14,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
14
14
|
name: string;
|
|
15
15
|
tags: string[];
|
|
16
16
|
}>;
|
|
17
|
-
/**
|
|
17
|
+
/** get a specific `AppInstallation` */
|
|
18
18
|
getAppinstallation: (conf: {
|
|
19
19
|
appInstallationId: string;
|
|
20
20
|
headers?: {
|
|
@@ -39,7 +39,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
39
39
|
updatePolicy?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppUpdatePolicy | undefined;
|
|
40
40
|
userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSavedUserInput[] | undefined;
|
|
41
41
|
}>;
|
|
42
|
-
/**
|
|
42
|
+
/** get a specific `AppVersion` */
|
|
43
43
|
getAppversion: (conf: {
|
|
44
44
|
appId: string;
|
|
45
45
|
appVersionId: string;
|
|
@@ -60,7 +60,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
60
60
|
systemSoftwareDependencies?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[] | undefined;
|
|
61
61
|
userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppUserInput[] | undefined;
|
|
62
62
|
}>;
|
|
63
|
-
/**
|
|
63
|
+
/** get the missing requirements of an appInstallation for a specific target AppVersion */
|
|
64
64
|
getMissingDependenciesForAppinstallation: (conf: {
|
|
65
65
|
queryParameters: {
|
|
66
66
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
@@ -74,7 +74,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
74
74
|
missingSystemSoftwareDependencies?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[] | undefined;
|
|
75
75
|
missingUserInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppUserInput[] | undefined;
|
|
76
76
|
}>;
|
|
77
|
-
/**
|
|
77
|
+
/** get a specific `SystemSoftware` */
|
|
78
78
|
getSystemsoftware: (conf: {
|
|
79
79
|
systemSoftwareId: string;
|
|
80
80
|
headers?: {
|
|
@@ -86,7 +86,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
86
86
|
name: string;
|
|
87
87
|
tags: string[];
|
|
88
88
|
}>;
|
|
89
|
-
/**
|
|
89
|
+
/** get a specific `SystemSoftwareVersion` */
|
|
90
90
|
getSystemsoftwareversion: (conf: {
|
|
91
91
|
systemSoftwareId: string;
|
|
92
92
|
systemSoftwareVersionId: string;
|
|
@@ -102,7 +102,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
102
102
|
systemSoftwareDependencies?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[] | undefined;
|
|
103
103
|
userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppUserInput[] | undefined;
|
|
104
104
|
}>;
|
|
105
|
-
/**
|
|
105
|
+
/** get all `AppInstallations` inside a specific `Project` */
|
|
106
106
|
listAppinstallations: (conf: {
|
|
107
107
|
projectId: string;
|
|
108
108
|
headers?: {
|
|
@@ -116,7 +116,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
116
116
|
skip?: number | undefined;
|
|
117
117
|
} | undefined;
|
|
118
118
|
}) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppInstallation[]>;
|
|
119
|
-
/**
|
|
119
|
+
/** get all available `Apps` */
|
|
120
120
|
listApps: (conf?: {
|
|
121
121
|
headers?: {
|
|
122
122
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
@@ -129,7 +129,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
129
129
|
skip?: number | undefined;
|
|
130
130
|
} | undefined;
|
|
131
131
|
} | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppApp[]>;
|
|
132
|
-
/**
|
|
132
|
+
/** get all `AppVersions` of a specific `App` */
|
|
133
133
|
listAppversions: (conf: {
|
|
134
134
|
appId: string;
|
|
135
135
|
headers?: {
|
|
@@ -137,7 +137,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
137
137
|
"x-access-token"?: string | undefined;
|
|
138
138
|
} | undefined;
|
|
139
139
|
}) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppVersion[]>;
|
|
140
|
-
/**
|
|
140
|
+
/** get all available `SystemSoftware` */
|
|
141
141
|
listSystemsoftwares: (conf?: {
|
|
142
142
|
headers?: {
|
|
143
143
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
@@ -150,7 +150,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
150
150
|
skip?: number | undefined;
|
|
151
151
|
} | undefined;
|
|
152
152
|
} | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftware[]>;
|
|
153
|
-
/**
|
|
153
|
+
/** get all available `SystemSoftwareVersions` of a specific `SystemSoftware` */
|
|
154
154
|
listSystemsoftwareversions: (conf: {
|
|
155
155
|
systemSoftwareId: string;
|
|
156
156
|
headers?: {
|
|
@@ -162,7 +162,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
162
162
|
versionRange?: string | undefined;
|
|
163
163
|
} | undefined;
|
|
164
164
|
}) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareVersion[]>;
|
|
165
|
-
/**
|
|
165
|
+
/** get all update candidates for a specific `AppVersion` */
|
|
166
166
|
listUpdateCandidatesForAppversion: (conf: {
|
|
167
167
|
appId: string;
|
|
168
168
|
baseAppVersionId: string;
|
|
@@ -171,7 +171,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
171
171
|
"x-access-token"?: string | undefined;
|
|
172
172
|
} | undefined;
|
|
173
173
|
}) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppVersion[]>;
|
|
174
|
-
/**
|
|
174
|
+
/** get runtime status of a specific `AppInstallation` */
|
|
175
175
|
retrieveStatus: (conf: {
|
|
176
176
|
appInstallationId: string;
|
|
177
177
|
headers?: {
|
|
@@ -2,31 +2,31 @@ import { ApiCallAsyncResourceFactory } from "@mittwald/api-client-commons/react"
|
|
|
2
2
|
import * as descriptors from "./descriptors.js";
|
|
3
3
|
export * from "@mittwald/react-use-promise/types";
|
|
4
4
|
const buildAppApi = (baseClient) => ({
|
|
5
|
-
/**
|
|
5
|
+
/** get a specific `App` */
|
|
6
6
|
getApp: new ApiCallAsyncResourceFactory(descriptors.appGetApp, baseClient.app.getApp).getApiResource,
|
|
7
|
-
/**
|
|
7
|
+
/** get a specific `AppInstallation` */
|
|
8
8
|
getAppinstallation: new ApiCallAsyncResourceFactory(descriptors.appGetAppinstallation, baseClient.app.getAppinstallation).getApiResource,
|
|
9
|
-
/**
|
|
9
|
+
/** get a specific `AppVersion` */
|
|
10
10
|
getAppversion: new ApiCallAsyncResourceFactory(descriptors.appGetAppversion, baseClient.app.getAppversion).getApiResource,
|
|
11
|
-
/**
|
|
11
|
+
/** get the missing requirements of an appInstallation for a specific target AppVersion */
|
|
12
12
|
getMissingDependenciesForAppinstallation: new ApiCallAsyncResourceFactory(descriptors.appGetMissingDependenciesForAppinstallation, baseClient.app.getMissingDependenciesForAppinstallation).getApiResource,
|
|
13
|
-
/**
|
|
13
|
+
/** get a specific `SystemSoftware` */
|
|
14
14
|
getSystemsoftware: new ApiCallAsyncResourceFactory(descriptors.appGetSystemsoftware, baseClient.app.getSystemsoftware).getApiResource,
|
|
15
|
-
/**
|
|
15
|
+
/** get a specific `SystemSoftwareVersion` */
|
|
16
16
|
getSystemsoftwareversion: new ApiCallAsyncResourceFactory(descriptors.appGetSystemsoftwareversion, baseClient.app.getSystemsoftwareversion).getApiResource,
|
|
17
|
-
/**
|
|
17
|
+
/** get all `AppInstallations` inside a specific `Project` */
|
|
18
18
|
listAppinstallations: new ApiCallAsyncResourceFactory(descriptors.appListAppinstallations, baseClient.app.listAppinstallations).getApiResource,
|
|
19
|
-
/**
|
|
19
|
+
/** get all available `Apps` */
|
|
20
20
|
listApps: new ApiCallAsyncResourceFactory(descriptors.appListApps, baseClient.app.listApps).getApiResource,
|
|
21
|
-
/**
|
|
21
|
+
/** get all `AppVersions` of a specific `App` */
|
|
22
22
|
listAppversions: new ApiCallAsyncResourceFactory(descriptors.appListAppversions, baseClient.app.listAppversions).getApiResource,
|
|
23
|
-
/**
|
|
23
|
+
/** get all available `SystemSoftware` */
|
|
24
24
|
listSystemsoftwares: new ApiCallAsyncResourceFactory(descriptors.appListSystemsoftwares, baseClient.app.listSystemsoftwares).getApiResource,
|
|
25
|
-
/**
|
|
25
|
+
/** get all available `SystemSoftwareVersions` of a specific `SystemSoftware` */
|
|
26
26
|
listSystemsoftwareversions: new ApiCallAsyncResourceFactory(descriptors.appListSystemsoftwareversions, baseClient.app.listSystemsoftwareversions).getApiResource,
|
|
27
|
-
/**
|
|
27
|
+
/** get all update candidates for a specific `AppVersion` */
|
|
28
28
|
listUpdateCandidatesForAppversion: new ApiCallAsyncResourceFactory(descriptors.appListUpdateCandidatesForAppversion, baseClient.app.listUpdateCandidatesForAppversion).getApiResource,
|
|
29
|
-
/**
|
|
29
|
+
/** get runtime status of a specific `AppInstallation` */
|
|
30
30
|
retrieveStatus: new ApiCallAsyncResourceFactory(descriptors.appRetrieveStatus, baseClient.app.retrieveStatus).getApiResource,
|
|
31
31
|
});
|
|
32
32
|
const buildArticleApi = (baseClient) => ({
|
|
@@ -2,7 +2,7 @@ import { ApiClientBase } from "@mittwald/api-client-commons";
|
|
|
2
2
|
export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
3
3
|
/** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
|
|
4
4
|
readonly app: {
|
|
5
|
-
/**
|
|
5
|
+
/** execute a runtime concerning action on a specific `AppInstallation` */
|
|
6
6
|
executeAction: (request: {
|
|
7
7
|
appInstallationId: string;
|
|
8
8
|
action: import("./types.js").MittwaldAPIV2.Components.Schemas.AppAction;
|
|
@@ -21,7 +21,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
21
21
|
}, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
|
|
22
22
|
[x: string]: unknown;
|
|
23
23
|
}, 404, "application/json">>>;
|
|
24
|
-
/**
|
|
24
|
+
/** get a specific `App` */
|
|
25
25
|
getApp: (request: {
|
|
26
26
|
appId: string;
|
|
27
27
|
headers?: {
|
|
@@ -50,7 +50,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
50
50
|
}, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
51
51
|
[x: string]: unknown;
|
|
52
52
|
}, 404, "application/json">>>;
|
|
53
|
-
/**
|
|
53
|
+
/** get a specific `AppInstallation` */
|
|
54
54
|
getAppinstallation: (request: {
|
|
55
55
|
appInstallationId: string;
|
|
56
56
|
headers?: {
|
|
@@ -91,7 +91,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
91
91
|
}, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
92
92
|
[x: string]: unknown;
|
|
93
93
|
}, 404, "application/json">>>;
|
|
94
|
-
/**
|
|
94
|
+
/** start uninstallation process for a specific `AppInstallation` */
|
|
95
95
|
uninstallAppinstallation: (request: {
|
|
96
96
|
appInstallationId: string;
|
|
97
97
|
headers?: {
|
|
@@ -115,7 +115,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
115
115
|
}, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
|
|
116
116
|
[x: string]: unknown;
|
|
117
117
|
}, 404, "application/json">>>;
|
|
118
|
-
/**
|
|
118
|
+
/** patch desired properties of a specific `AppInstallation` */
|
|
119
119
|
patchAppinstallation: (request: {
|
|
120
120
|
appInstallationId: string;
|
|
121
121
|
data?: {
|
|
@@ -159,7 +159,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
159
159
|
}, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
|
|
160
160
|
[x: string]: unknown;
|
|
161
161
|
}, 404, "application/json">>>;
|
|
162
|
-
/**
|
|
162
|
+
/** get a specific `AppVersion` */
|
|
163
163
|
getAppversion: (request: {
|
|
164
164
|
appId: string;
|
|
165
165
|
appVersionId: string;
|
|
@@ -197,7 +197,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
197
197
|
}, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
198
198
|
[x: string]: unknown;
|
|
199
199
|
}, 404, "application/json">>>;
|
|
200
|
-
/**
|
|
200
|
+
/** get the missing requirements of an appInstallation for a specific target AppVersion */
|
|
201
201
|
getMissingDependenciesForAppinstallation: (request: {
|
|
202
202
|
queryParameters: {
|
|
203
203
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
@@ -233,7 +233,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
233
233
|
}, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
234
234
|
[x: string]: unknown;
|
|
235
235
|
}, 404, "application/json">>>;
|
|
236
|
-
/**
|
|
236
|
+
/** get a specific `SystemSoftware` */
|
|
237
237
|
getSystemsoftware: (request: {
|
|
238
238
|
systemSoftwareId: string;
|
|
239
239
|
headers?: {
|
|
@@ -261,7 +261,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
261
261
|
}, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
262
262
|
[x: string]: unknown;
|
|
263
263
|
}, 404, "application/json">>>;
|
|
264
|
-
/**
|
|
264
|
+
/** get a specific `SystemSoftwareVersion` */
|
|
265
265
|
getSystemsoftwareversion: (request: {
|
|
266
266
|
systemSoftwareId: string;
|
|
267
267
|
systemSoftwareVersionId: string;
|
|
@@ -294,7 +294,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
294
294
|
}, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
295
295
|
[x: string]: unknown;
|
|
296
296
|
}, 404, "application/json">>>;
|
|
297
|
-
/**
|
|
297
|
+
/** create linkage between an `AppInstallation` and a `Database` */
|
|
298
298
|
linkDatabase: (request: {
|
|
299
299
|
data: {
|
|
300
300
|
databaseId: string;
|
|
@@ -333,7 +333,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
333
333
|
}, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
|
|
334
334
|
[x: string]: unknown;
|
|
335
335
|
}, 404, "application/json">>>;
|
|
336
|
-
/**
|
|
336
|
+
/** get all `AppInstallations` inside a specific `Project` */
|
|
337
337
|
listAppinstallations: (request: {
|
|
338
338
|
projectId: string;
|
|
339
339
|
headers?: {
|
|
@@ -369,7 +369,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
369
369
|
[TKey: string]: (string | number | boolean) | (string | number | boolean)[];
|
|
370
370
|
}>;
|
|
371
371
|
}, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppInstallation[], 200, "application/json">>>;
|
|
372
|
-
/**
|
|
372
|
+
/** request a new `AppInstallation` */
|
|
373
373
|
requestAppinstallation: (request: {
|
|
374
374
|
data: {
|
|
375
375
|
appVersionId: string;
|
|
@@ -402,7 +402,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
402
402
|
}, 201, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
403
403
|
[x: string]: unknown;
|
|
404
404
|
}, 404, "application/json">>>;
|
|
405
|
-
/**
|
|
405
|
+
/** get all available `Apps` */
|
|
406
406
|
listApps: (request?: {
|
|
407
407
|
headers?: {
|
|
408
408
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
@@ -433,7 +433,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
433
433
|
[TKey: string]: (string | number | boolean) | (string | number | boolean)[];
|
|
434
434
|
}>;
|
|
435
435
|
}, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.AppApp[], 200, "application/json">>>;
|
|
436
|
-
/**
|
|
436
|
+
/** get all `AppVersions` of a specific `App` */
|
|
437
437
|
listAppversions: (request: {
|
|
438
438
|
appId: string;
|
|
439
439
|
headers?: {
|
|
@@ -455,7 +455,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
455
455
|
[TKey: string]: (string | number | boolean) | (string | number | boolean)[];
|
|
456
456
|
}>;
|
|
457
457
|
}, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppVersion[], 200, "application/json">>>;
|
|
458
|
-
/**
|
|
458
|
+
/** get all available `SystemSoftware` */
|
|
459
459
|
listSystemsoftwares: (request?: {
|
|
460
460
|
headers?: {
|
|
461
461
|
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
@@ -486,7 +486,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
486
486
|
[TKey: string]: (string | number | boolean) | (string | number | boolean)[];
|
|
487
487
|
}>;
|
|
488
488
|
}, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftware[], 200, "application/json">>>;
|
|
489
|
-
/**
|
|
489
|
+
/** get all available `SystemSoftwareVersions` of a specific `SystemSoftware` */
|
|
490
490
|
listSystemsoftwareversions: (request: {
|
|
491
491
|
systemSoftwareId: string;
|
|
492
492
|
headers?: {
|
|
@@ -518,7 +518,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
518
518
|
[TKey: string]: (string | number | boolean) | (string | number | boolean)[];
|
|
519
519
|
}>;
|
|
520
520
|
}, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareVersion[], 200, "application/json">>>;
|
|
521
|
-
/**
|
|
521
|
+
/** get all update candidates for a specific `AppVersion` */
|
|
522
522
|
listUpdateCandidatesForAppversion: (request: {
|
|
523
523
|
appId: string;
|
|
524
524
|
baseAppVersionId: string;
|
|
@@ -542,11 +542,10 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
542
542
|
[TKey: string]: (string | number | boolean) | (string | number | boolean)[];
|
|
543
543
|
}>;
|
|
544
544
|
}, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppVersion[], 200, "application/json">>>;
|
|
545
|
-
/**
|
|
545
|
+
/** request a copy of an `AppInstallation` */
|
|
546
546
|
requestAppinstallationCopy: (request: {
|
|
547
547
|
data: {
|
|
548
548
|
description: string;
|
|
549
|
-
targetProjectId?: string | undefined;
|
|
550
549
|
};
|
|
551
550
|
id: string;
|
|
552
551
|
headers?: {
|
|
@@ -555,7 +554,6 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
555
554
|
}) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
|
|
556
555
|
data: {
|
|
557
556
|
description: string;
|
|
558
|
-
targetProjectId?: string | undefined;
|
|
559
557
|
};
|
|
560
558
|
} & {
|
|
561
559
|
pathParameters: {
|
|
@@ -570,7 +568,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
570
568
|
}, 201, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
571
569
|
[x: string]: unknown;
|
|
572
570
|
}, 404, "application/json">>>;
|
|
573
|
-
/**
|
|
571
|
+
/** get runtime status of a specific `AppInstallation` */
|
|
574
572
|
retrieveStatus: (request: {
|
|
575
573
|
appInstallationId: string;
|
|
576
574
|
headers?: {
|
|
@@ -592,7 +590,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
592
590
|
}, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
593
591
|
[x: string]: unknown;
|
|
594
592
|
}, 404, "application/json">>>;
|
|
595
|
-
/**
|
|
593
|
+
/** create linkage between an `AppInstallation` and `DatabaseUsers` */
|
|
596
594
|
setDatabaseUsers: (request: {
|
|
597
595
|
appInstallationId: string;
|
|
598
596
|
databaseId: string;
|
|
@@ -629,7 +627,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
629
627
|
}, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
|
|
630
628
|
[x: string]: unknown;
|
|
631
629
|
}, 404, "application/json">>>;
|
|
632
|
-
/**
|
|
630
|
+
/** remove linkage between an `AppInstallation` and a `Database` */
|
|
633
631
|
unlinkDatabase: (request: {
|
|
634
632
|
appInstallationId: string;
|
|
635
633
|
databaseId: string;
|