@mittwald/api-client 3.0.20 → 3.0.21
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 +1 -0
- package/dist/cjs/generated/v2/client.d.ts +1 -32
- package/dist/cjs/generated/v2/client.js +0 -2
- package/dist/cjs/generated/v2/descriptors.d.ts +0 -2
- package/dist/cjs/generated/v2/descriptors.js +6 -12
- package/dist/cjs/generated/v2/types.d.ts +43 -43
- package/dist/esm/generated/v2/client-react.d.ts +1 -0
- package/dist/esm/generated/v2/client.d.ts +1 -32
- package/dist/esm/generated/v2/client.js +0 -2
- package/dist/esm/generated/v2/descriptors.d.ts +0 -2
- package/dist/esm/generated/v2/descriptors.js +0 -6
- package/dist/esm/generated/v2/types.d.ts +43 -43
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
|
@@ -34,6 +34,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
34
34
|
projectId?: string | undefined;
|
|
35
35
|
screenshotId?: string | undefined;
|
|
36
36
|
screenshotRef?: string | undefined;
|
|
37
|
+
shortId: string;
|
|
37
38
|
systemSoftware?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppInstalledSystemSoftware[] | undefined;
|
|
38
39
|
updatePolicy?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppUpdatePolicy | undefined;
|
|
39
40
|
userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSavedUserInput[] | undefined;
|
|
@@ -84,6 +84,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
84
84
|
projectId?: string | undefined;
|
|
85
85
|
screenshotId?: string | undefined;
|
|
86
86
|
screenshotRef?: string | undefined;
|
|
87
|
+
shortId: string;
|
|
87
88
|
systemSoftware?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppInstalledSystemSoftware[] | undefined;
|
|
88
89
|
updatePolicy?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppUpdatePolicy | undefined;
|
|
89
90
|
userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSavedUserInput[] | undefined;
|
|
@@ -541,38 +542,6 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
541
542
|
[TKey: string]: (string | number | boolean) | (string | number | boolean)[];
|
|
542
543
|
}>;
|
|
543
544
|
}, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppVersion[], 200, "application/json">>>;
|
|
544
|
-
/** reconcile detected apps to appInstallations of a project */
|
|
545
|
-
reconcileDetectedApps: (request: {
|
|
546
|
-
data: {
|
|
547
|
-
appName: string;
|
|
548
|
-
appVersionClusterVersion: string;
|
|
549
|
-
databaseHost?: string | undefined;
|
|
550
|
-
databaseUserName?: string | undefined;
|
|
551
|
-
installationDirectory: string;
|
|
552
|
-
}[];
|
|
553
|
-
projectShortId: string;
|
|
554
|
-
headers?: {
|
|
555
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
556
|
-
} | undefined;
|
|
557
|
-
}) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
|
|
558
|
-
data: {
|
|
559
|
-
appName: string;
|
|
560
|
-
appVersionClusterVersion: string;
|
|
561
|
-
databaseHost?: string | undefined;
|
|
562
|
-
databaseUserName?: string | undefined;
|
|
563
|
-
installationDirectory: string;
|
|
564
|
-
}[];
|
|
565
|
-
} & {
|
|
566
|
-
pathParameters: {
|
|
567
|
-
projectShortId: string;
|
|
568
|
-
};
|
|
569
|
-
} & {
|
|
570
|
-
headers?: Partial<{
|
|
571
|
-
[TKey: string]: (string | number | boolean) | (string | number | boolean)[];
|
|
572
|
-
}> | undefined;
|
|
573
|
-
}, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
|
|
574
|
-
[x: string]: unknown;
|
|
575
|
-
}, 404, "application/json">>>;
|
|
576
545
|
/** request a copy of an `AppInstallation` */
|
|
577
546
|
requestAppinstallationCopy: (request: {
|
|
578
547
|
data: {
|
|
@@ -68,8 +68,6 @@ class MittwaldAPIV2Client extends api_client_commons_1.ApiClientBase {
|
|
|
68
68
|
listSystemsoftwareversions: this.requestFunctionFactory(descriptors.appListSystemsoftwareversions),
|
|
69
69
|
/** get all update candidates for a specific `AppVersion` */
|
|
70
70
|
listUpdateCandidatesForAppversion: this.requestFunctionFactory(descriptors.appListUpdateCandidatesForAppversion),
|
|
71
|
-
/** reconcile detected apps to appInstallations of a project */
|
|
72
|
-
reconcileDetectedApps: this.requestFunctionFactory(descriptors.appReconcileDetectedApps),
|
|
73
71
|
/** request a copy of an `AppInstallation` */
|
|
74
72
|
requestAppinstallationCopy: this.requestFunctionFactory(descriptors.appRequestAppinstallationCopy),
|
|
75
73
|
/** get runtime status of a specific `AppInstallation` */
|
|
@@ -37,8 +37,6 @@ export declare const appListSystemsoftwares: OpenAPIOperation<RequestType<Simpli
|
|
|
37
37
|
export declare const appListSystemsoftwareversions: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
|
|
38
38
|
/** get all update candidates for a specific `AppVersion` */
|
|
39
39
|
export declare const appListUpdateCandidatesForAppversion: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
|
|
40
|
-
/** reconcile detected apps to appInstallations of a project */
|
|
41
|
-
export declare const appReconcileDetectedApps: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectShortIdAppinstallations.Put.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectShortIdAppinstallations.Put.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectShortIdAppinstallations.Put.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectShortIdAppinstallations.Put.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectShortIdAppinstallations.Put.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectShortIdAppinstallations.Put.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectShortIdAppinstallations.Put.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
|
|
42
40
|
/** request a copy of an `AppInstallation` */
|
|
43
41
|
export declare const appRequestAppinstallationCopy: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Responses.$201.Content.ApplicationJson>, 201, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
|
|
44
42
|
/** get runtime status of a specific `AppInstallation` */
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.conversationListConversations = exports.contractListContracts = exports.contractGetNextTerminationDateForItem = exports.contractGetDetailOfContract = exports.contractGetDetailOfContractItem = exports.contractGetDetailOfContractByServer = exports.contractGetDetailOfContractByProject = exports.contractGetDetailOfContractByDomain = exports.contractGetBaseItemOfContract = exports.contractCancelContractTermination = exports.contractTerminateContract = exports.contractCancelContractTariffChange = exports.contractCancelContractItemTermination = exports.contractTerminateContractItem = exports.backupUpdateProjectBackupDescription = exports.backupDeleteProjectBackup = exports.backupGetProjectBackup = exports.backupUpdateProjectBackupSchedule = exports.backupDeleteProjectBackupSchedule = exports.backupGetProjectBackupSchedule = exports.backupCreateProjectBackup = exports.backupListProjectBackups = exports.backupCreateProjectBackupSchedule = exports.backupListProjectBackupSchedules = exports.backupDeleteProjectBackupExport = exports.backupCreateProjectBackupExport = exports.articleListArticles = exports.articleGetArticle = exports.appUnlinkDatabase = exports.appSetDatabaseUsers = exports.appRetrieveStatus = exports.appRequestAppinstallationCopy = exports.
|
|
4
|
-
exports.databaseCreateMysqlDatabase = exports.databaseListMysqlDatabases = exports.customerResendCustomerInviteMail = exports.customerRemoveAvatar = exports.customerRequestAvatarUpload = exports.customerListMembershipsForCustomer = exports.customerListInvitesForCustomer = exports.customerListCustomerMemberships = exports.customerListCustomerInvites = exports.customerLeaveCustomer = exports.customerIsCustomerLegallyCompetent = exports.customerGetCustomerTokenInvite = exports.customerDeleteCustomer = exports.customerUpdateCustomer = exports.customerGetCustomer = exports.customerUpdateCustomerMembership = exports.customerDeleteCustomerMembership = exports.customerGetCustomerMembership = exports.customerDeleteCustomerInvite = exports.customerGetCustomerInvite = exports.customerDeleteCategory = exports.customerUpdateCategory = exports.customerGetCustomerCategory = exports.customerDeclineCustomerInvite = exports.customerCreateCustomer = exports.customerListCustomers = exports.customerCreateCustomerInvite = exports.customerCreateCategory = exports.customerListOfCustomerCategories = exports.customerAcceptCustomerInvite = exports.cronjobUpdateCronjobAppId = exports.cronjobGetExecution = exports.cronjobUpdateCronjob = exports.cronjobDeleteCronjob = exports.cronjobGetCronjob = exports.cronjobCreateExecution = exports.cronjobListExecutions = exports.cronjobCreateCronjob = exports.cronjobListCronjobs = exports.cronjobAbortExecution = exports.conversationUpdateMessage = exports.conversationSetConversationStatus = exports.conversationRequestFileUpload = exports.conversationListCategories = exports.conversationUpdateConversation = exports.conversationGetConversation = exports.conversationGetCategory = exports.conversationCreateMessage = exports.conversationListMessagesByConversation =
|
|
5
|
-
exports.domainListDomainOwnerships = exports.domainGetSupportedTlds = exports.domainVerifyDomainOwnership = exports.domainGetSpecificDomainOwnership = exports.domainGetScreenshotForDomain = exports.domainGetHandleFields = exports.domainDeleteDomain = exports.domainGetDomain = exports.domainDeclareProcessChangeHandles = exports.domainDeclareProcessChangeAuthcode = exports.domainDeclareNameservers = exports.domainCreateAuthcode2ForDomain = exports.domainCreateAuthcodeForDomain = exports.domainCheckDomainAvailability = exports.domainChangeProjectOfDomain = exports.domainChangeOwnercOfDomain = exports.domainAbortDeclareProcess = exports.dnsZonesForProject = exports.dnsZoneGetSpecific = exports.dnsSubZoneCreate = exports.dnsRecordTxtSet = exports.dnsRecordSrvSet = exports.dnsRecordMxSetManaged = exports.dnsRecordMxSetCustom = exports.dnsRecordCnameSet = exports.dnsRecordAsetManagedByIngress = exports.dnsRecordAsetCustom = exports.newsletterSubscribeUser = exports.databaseUpdateRedisDatabaseDescription = exports.databaseUpdateRedisDatabaseConfiguration = exports.databaseUpdateMysqlUserPassword = exports.databaseUpdateMysqlDatabaseDescription = exports.databaseUpdateMysqlDatabaseDefaultCharset = exports.databaseListRedisVersions = exports.databaseListMysqlVersions = exports.databaseListMysqlCharsets = exports.databaseGetMysqlUserPhpMyAdminUrl = exports.databaseEnableMysqlUser = exports.databaseDisableMysqlUser = exports.databaseDeleteRedisDatabase = exports.databaseGetRedisDatabase = exports.databaseDeleteMysqlUser = exports.databaseUpdateMysqlUser = exports.databaseGetMysqlUser = exports.databaseDeleteMysqlDatabase = exports.databaseGetMysqlDatabase = exports.databaseCreateRedisDatabase = exports.databaseListRedisDatabases = exports.databaseCreateMysqlUser =
|
|
6
|
-
exports.orderListProjectOrders = exports.orderListCustomerOrders = exports.orderGetOrder = exports.orderCreateTariffChange = exports.orderCreateOrder = exports.notificationsReadNotification = exports.notificationsReadAllNotifications = exports.notificationsListNotifications = exports.notificationsCountUnreadNotifications = exports.newsletterUnsubscribeUser = exports.newsletterGetInfo = exports.mailProjectsettingUpdateWhitelist = exports.mailProjectsettingUpdateBlacklist = exports.mailProjectsettingGetSpecific = exports.mailMailaddressUpdateSpamprotection = exports.mailMailaddressUpdateQuota = exports.mailMailaddressUpdatePassword = exports.mailMailaddressUpdateForwardaddresses = exports.mailMailaddressUpdateCatchall = exports.mailMailaddressUpdateAutoresponder = exports.mailMailaddressUpdateAddress = exports.mailMailaddressDelete = exports.mailMailaddressGetSpecific = exports.mailMailaddressCreate = exports.mailMailaddressList = exports.mailDeliveryboxUpdatePassword = exports.mailDeliveryboxUpdateDescription = exports.mailDeliveryboxDelete = exports.mailDeliveryboxGetSpecific = exports.mailDeliveryboxCreate = exports.mailDeliveryboxList = 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 = exports.fileGetFileTypeRules = exports.fileGetFileTokenRules = exports.fileGetFileMeta = exports.fileCreateFile = exports.domainResendDomainEmail =
|
|
7
|
-
exports.sshUserUpdateSshUser = exports.sshUserDeleteSshUser = exports.sshUserGetSshUser = exports.sshUserCreateSshUser = exports.sshUserListSshUsers = exports.sftpUserUpdateSftpUser = exports.sftpUserDeleteSftpUser = exports.sftpUserGetSftpUser = exports.sftpUserCreateSftpUser = exports.sftpUserListSftpUsers = exports.servicetokenAuthenticateService = 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 = exports.projectCreateProjectInvite = exports.projectAcceptProjectInvite = exports.passwordValidationGetPasswordPolicy = exports.pageinsightsListPerformanceDataForProject = exports.pageinsightsGetPerformanceData = exports.orderPreviewTariffChange =
|
|
8
|
-
exports.relocationCreateRelocation = 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 = exports.userChangeEmail = exports.userGetOwnEmail = exports.userAuthenticate = exports.userAuthenticateMfa = exports.userRemovePhoneNumber =
|
|
3
|
+
exports.conversationCreateConversation = exports.conversationListConversations = exports.contractListContracts = exports.contractGetNextTerminationDateForItem = exports.contractGetDetailOfContract = exports.contractGetDetailOfContractItem = exports.contractGetDetailOfContractByServer = exports.contractGetDetailOfContractByProject = exports.contractGetDetailOfContractByDomain = exports.contractGetBaseItemOfContract = exports.contractCancelContractTermination = exports.contractTerminateContract = exports.contractCancelContractTariffChange = exports.contractCancelContractItemTermination = exports.contractTerminateContractItem = exports.backupUpdateProjectBackupDescription = exports.backupDeleteProjectBackup = exports.backupGetProjectBackup = exports.backupUpdateProjectBackupSchedule = exports.backupDeleteProjectBackupSchedule = exports.backupGetProjectBackupSchedule = exports.backupCreateProjectBackup = exports.backupListProjectBackups = exports.backupCreateProjectBackupSchedule = exports.backupListProjectBackupSchedules = exports.backupDeleteProjectBackupExport = exports.backupCreateProjectBackupExport = exports.articleListArticles = exports.articleGetArticle = exports.appUnlinkDatabase = exports.appSetDatabaseUsers = exports.appRetrieveStatus = exports.appRequestAppinstallationCopy = exports.appListUpdateCandidatesForAppversion = exports.appListSystemsoftwareversions = exports.appListSystemsoftwares = exports.appListAppversions = exports.appListApps = exports.appRequestAppinstallation = exports.appListAppinstallations = exports.appLinkDatabase = exports.appGetSystemsoftwareversion = exports.appGetSystemsoftware = exports.appGetMissingDependenciesForAppinstallation = exports.appGetAppversion = exports.appPatchAppinstallation = exports.appUninstallAppinstallation = exports.appGetAppinstallation = exports.appGetApp = exports.appExecuteAction = void 0;
|
|
4
|
+
exports.databaseListMysqlUsers = exports.databaseCreateMysqlDatabase = exports.databaseListMysqlDatabases = exports.customerResendCustomerInviteMail = exports.customerRemoveAvatar = exports.customerRequestAvatarUpload = exports.customerListMembershipsForCustomer = exports.customerListInvitesForCustomer = exports.customerListCustomerMemberships = exports.customerListCustomerInvites = exports.customerLeaveCustomer = exports.customerIsCustomerLegallyCompetent = exports.customerGetCustomerTokenInvite = exports.customerDeleteCustomer = exports.customerUpdateCustomer = exports.customerGetCustomer = exports.customerUpdateCustomerMembership = exports.customerDeleteCustomerMembership = exports.customerGetCustomerMembership = exports.customerDeleteCustomerInvite = exports.customerGetCustomerInvite = exports.customerDeleteCategory = exports.customerUpdateCategory = exports.customerGetCustomerCategory = exports.customerDeclineCustomerInvite = exports.customerCreateCustomer = exports.customerListCustomers = exports.customerCreateCustomerInvite = exports.customerCreateCategory = exports.customerListOfCustomerCategories = exports.customerAcceptCustomerInvite = exports.cronjobUpdateCronjobAppId = exports.cronjobGetExecution = exports.cronjobUpdateCronjob = exports.cronjobDeleteCronjob = exports.cronjobGetCronjob = exports.cronjobCreateExecution = exports.cronjobListExecutions = exports.cronjobCreateCronjob = exports.cronjobListCronjobs = exports.cronjobAbortExecution = exports.conversationUpdateMessage = exports.conversationSetConversationStatus = exports.conversationRequestFileUpload = exports.conversationListCategories = exports.conversationUpdateConversation = exports.conversationGetConversation = exports.conversationGetCategory = exports.conversationCreateMessage = exports.conversationListMessagesByConversation = void 0;
|
|
5
|
+
exports.domainListDomains = exports.domainListDomainOwnerships = exports.domainGetSupportedTlds = exports.domainVerifyDomainOwnership = exports.domainGetSpecificDomainOwnership = exports.domainGetScreenshotForDomain = exports.domainGetHandleFields = exports.domainDeleteDomain = exports.domainGetDomain = exports.domainDeclareProcessChangeHandles = exports.domainDeclareProcessChangeAuthcode = exports.domainDeclareNameservers = exports.domainCreateAuthcode2ForDomain = exports.domainCreateAuthcodeForDomain = exports.domainCheckDomainAvailability = exports.domainChangeProjectOfDomain = exports.domainChangeOwnercOfDomain = exports.domainAbortDeclareProcess = exports.dnsZonesForProject = exports.dnsZoneGetSpecific = exports.dnsSubZoneCreate = exports.dnsRecordTxtSet = exports.dnsRecordSrvSet = exports.dnsRecordMxSetManaged = exports.dnsRecordMxSetCustom = exports.dnsRecordCnameSet = exports.dnsRecordAsetManagedByIngress = exports.dnsRecordAsetCustom = exports.newsletterSubscribeUser = exports.databaseUpdateRedisDatabaseDescription = exports.databaseUpdateRedisDatabaseConfiguration = exports.databaseUpdateMysqlUserPassword = exports.databaseUpdateMysqlDatabaseDescription = exports.databaseUpdateMysqlDatabaseDefaultCharset = exports.databaseListRedisVersions = exports.databaseListMysqlVersions = exports.databaseListMysqlCharsets = exports.databaseGetMysqlUserPhpMyAdminUrl = exports.databaseEnableMysqlUser = exports.databaseDisableMysqlUser = exports.databaseDeleteRedisDatabase = exports.databaseGetRedisDatabase = exports.databaseDeleteMysqlUser = exports.databaseUpdateMysqlUser = exports.databaseGetMysqlUser = exports.databaseDeleteMysqlDatabase = exports.databaseGetMysqlDatabase = exports.databaseCreateRedisDatabase = exports.databaseListRedisDatabases = exports.databaseCreateMysqlUser = void 0;
|
|
6
|
+
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.mailProjectsettingUpdateWhitelist = exports.mailProjectsettingUpdateBlacklist = exports.mailProjectsettingGetSpecific = exports.mailMailaddressUpdateSpamprotection = exports.mailMailaddressUpdateQuota = exports.mailMailaddressUpdatePassword = exports.mailMailaddressUpdateForwardaddresses = exports.mailMailaddressUpdateCatchall = exports.mailMailaddressUpdateAutoresponder = exports.mailMailaddressUpdateAddress = exports.mailMailaddressDelete = exports.mailMailaddressGetSpecific = exports.mailMailaddressCreate = exports.mailMailaddressList = exports.mailDeliveryboxUpdatePassword = exports.mailDeliveryboxUpdateDescription = exports.mailDeliveryboxDelete = exports.mailDeliveryboxGetSpecific = exports.mailDeliveryboxCreate = exports.mailDeliveryboxList = 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 = exports.fileGetFileTypeRules = exports.fileGetFileTokenRules = exports.fileGetFileMeta = exports.fileCreateFile = exports.domainResendDomainEmail = void 0;
|
|
7
|
+
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.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 = exports.projectCreateProjectInvite = exports.projectAcceptProjectInvite = exports.passwordValidationGetPasswordPolicy = exports.pageinsightsListPerformanceDataForProject = exports.pageinsightsGetPerformanceData = exports.orderPreviewTariffChange = void 0;
|
|
8
|
+
exports.relocationCreateRelocation = 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 = exports.userChangeEmail = exports.userGetOwnEmail = exports.userAuthenticate = exports.userAuthenticateMfa = exports.userRemovePhoneNumber = 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}",
|
|
@@ -108,12 +108,6 @@ exports.appListUpdateCandidatesForAppversion = {
|
|
|
108
108
|
method: "GET",
|
|
109
109
|
operationId: "app-list-update-candidates-for-appversion",
|
|
110
110
|
};
|
|
111
|
-
/** reconcile detected apps to appInstallations of a project */
|
|
112
|
-
exports.appReconcileDetectedApps = {
|
|
113
|
-
path: "/v2/projects/{projectShortId}/appinstallations",
|
|
114
|
-
method: "PUT",
|
|
115
|
-
operationId: "app-reconcile-detected-apps",
|
|
116
|
-
};
|
|
117
111
|
/** request a copy of an `AppInstallation` */
|
|
118
112
|
exports.appRequestAppinstallationCopy = {
|
|
119
113
|
path: "/v2/appinstallations/{id}/actions/copy",
|
|
@@ -70,10 +70,6 @@ export declare module MittwaldAPIV2 {
|
|
|
70
70
|
type RequestData = InferredRequestData<typeof descriptors.appListUpdateCandidatesForAppversion>;
|
|
71
71
|
type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.appListUpdateCandidatesForAppversion, TStatus>;
|
|
72
72
|
}
|
|
73
|
-
namespace AppReconcileDetectedApps {
|
|
74
|
-
type RequestData = InferredRequestData<typeof descriptors.appReconcileDetectedApps>;
|
|
75
|
-
type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.appReconcileDetectedApps, TStatus>;
|
|
76
|
-
}
|
|
77
73
|
namespace AppRequestAppinstallationCopy {
|
|
78
74
|
type RequestData = InferredRequestData<typeof descriptors.appRequestAppinstallationCopy>;
|
|
79
75
|
type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.appRequestAppinstallationCopy, TStatus>;
|
|
@@ -1256,6 +1252,7 @@ export declare module MittwaldAPIV2 {
|
|
|
1256
1252
|
projectId?: string;
|
|
1257
1253
|
screenshotId?: string;
|
|
1258
1254
|
screenshotRef?: string;
|
|
1255
|
+
shortId: string;
|
|
1259
1256
|
systemSoftware?: MittwaldAPIV2.Components.Schemas.AppInstalledSystemSoftware[];
|
|
1260
1257
|
updatePolicy?: MittwaldAPIV2.Components.Schemas.AppAppUpdatePolicy;
|
|
1261
1258
|
userInputs?: MittwaldAPIV2.Components.Schemas.AppSavedUserInput[];
|
|
@@ -1280,9 +1277,15 @@ export declare module MittwaldAPIV2 {
|
|
|
1280
1277
|
systemSoftwareDependencies?: MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[];
|
|
1281
1278
|
userInputs?: MittwaldAPIV2.Components.Schemas.AppUserInput[];
|
|
1282
1279
|
}
|
|
1280
|
+
/**
|
|
1281
|
+
* A `BreakingNote` is a hint that something serious has changed in the `AppVersion` containing it, so an automatic update is not possible
|
|
1282
|
+
*/
|
|
1283
1283
|
interface AppBreakingNote {
|
|
1284
1284
|
faqLink: string;
|
|
1285
1285
|
}
|
|
1286
|
+
/**
|
|
1287
|
+
* A ´DatabaseDependency` is a generic description of need for a database, used by `AppVersions`
|
|
1288
|
+
*/
|
|
1286
1289
|
interface AppDatabaseDependency {
|
|
1287
1290
|
description: string;
|
|
1288
1291
|
kind: "mysql";
|
|
@@ -1295,11 +1298,17 @@ export declare module MittwaldAPIV2 {
|
|
|
1295
1298
|
message: string;
|
|
1296
1299
|
type: string;
|
|
1297
1300
|
}
|
|
1301
|
+
/**
|
|
1302
|
+
* `InstalledSystemSoftware` describes the currently configured and installed `SystemSoftwareVersion` of a `SystemSoftware` besides the desired `SystemSoftwareUpdatePolicy` inside an `AppInstallation`
|
|
1303
|
+
*/
|
|
1298
1304
|
interface AppInstalledSystemSoftware {
|
|
1299
1305
|
systemSoftwareId: string;
|
|
1300
1306
|
systemSoftwareVersion: MittwaldAPIV2.Components.Schemas.AppVersionStatus;
|
|
1301
1307
|
updatePolicy: MittwaldAPIV2.Components.Schemas.AppSystemSoftwareUpdatePolicy;
|
|
1302
1308
|
}
|
|
1309
|
+
/**
|
|
1310
|
+
* `LinkedDatabase` is a reference to a concrete `Database` and `DatabaseUsers`
|
|
1311
|
+
*/
|
|
1303
1312
|
interface AppLinkedDatabase {
|
|
1304
1313
|
databaseId: string;
|
|
1305
1314
|
databaseUserIds?: {
|
|
@@ -1308,21 +1317,36 @@ export declare module MittwaldAPIV2 {
|
|
|
1308
1317
|
kind: "mysql" | "redis";
|
|
1309
1318
|
purpose: "primary" | "cache" | "custom";
|
|
1310
1319
|
}
|
|
1320
|
+
/**
|
|
1321
|
+
* `RequestHandlerRequirement` describes the necessary properties to internally resolve the request handler or process to start
|
|
1322
|
+
*/
|
|
1311
1323
|
interface AppRequestHandlerRequirement {
|
|
1312
1324
|
exampleValues?: MittwaldAPIV2.Components.Schemas.AppSavedUserInput[];
|
|
1313
1325
|
name: string;
|
|
1314
1326
|
namespace: string;
|
|
1315
1327
|
parametersTemplate: string;
|
|
1316
1328
|
}
|
|
1329
|
+
/**
|
|
1330
|
+
* A `SavedUserInput` is an entered value for a desired `UserInput` of an `AppVersion` or `SystemSoftwareVersion`
|
|
1331
|
+
*/
|
|
1317
1332
|
interface AppSavedUserInput {
|
|
1318
1333
|
name: string;
|
|
1319
1334
|
value: string;
|
|
1320
1335
|
}
|
|
1336
|
+
/**
|
|
1337
|
+
* A `SystemSoftwareDependency` is a description of a need for a specific `SystemSoftware` in a semver versionRange.
|
|
1338
|
+
*/
|
|
1321
1339
|
interface AppSystemSoftwareDependency {
|
|
1322
1340
|
systemSoftwareId: string;
|
|
1323
1341
|
versionRange: string;
|
|
1324
1342
|
}
|
|
1343
|
+
/**
|
|
1344
|
+
* `SystemSoftwareUpdatePolicy` describes which updates should be applied automatically by our systems
|
|
1345
|
+
*/
|
|
1325
1346
|
type AppSystemSoftwareUpdatePolicy = "none" | "inheritedFromApp" | "patchLevel" | "all";
|
|
1347
|
+
/**
|
|
1348
|
+
* A `SystemSoftware` is a software that can be installed for an `AppInstallation` but mostly is not itself externally reachable and/or deliverable.
|
|
1349
|
+
*/
|
|
1326
1350
|
interface AppSystemSoftware {
|
|
1327
1351
|
id: string;
|
|
1328
1352
|
name: string;
|
|
@@ -1339,6 +1363,9 @@ export declare module MittwaldAPIV2 {
|
|
|
1339
1363
|
systemSoftwareDependencies?: MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[];
|
|
1340
1364
|
userInputs?: MittwaldAPIV2.Components.Schemas.AppUserInput[];
|
|
1341
1365
|
}
|
|
1366
|
+
/**
|
|
1367
|
+
* A `UserInput` is a description of an information which cannot be determined or estimated by mittwald, but has to be given by the person who is requesting an `AppInstallation` or `SystemSoftware`
|
|
1368
|
+
*/
|
|
1342
1369
|
interface AppUserInput {
|
|
1343
1370
|
/**
|
|
1344
1371
|
* Optional field to tell the frontend, which data to put into the select
|
|
@@ -1356,13 +1383,25 @@ export declare module MittwaldAPIV2 {
|
|
|
1356
1383
|
*/
|
|
1357
1384
|
validationSchema: string;
|
|
1358
1385
|
}
|
|
1386
|
+
/**
|
|
1387
|
+
* `UserInputDataType` is an enum, describing the possible data types of a `UserInput`
|
|
1388
|
+
*/
|
|
1359
1389
|
type AppUserInputDataType = "text" | "number" | "boolean" | "select";
|
|
1390
|
+
/**
|
|
1391
|
+
* `UserInputFormat` is an enum, describing the possible data formats of a `UserInput`, the given values can be validated against
|
|
1392
|
+
*/
|
|
1360
1393
|
type AppUserInputFormat = "email" | "password" | "url";
|
|
1394
|
+
/**
|
|
1395
|
+
* `UserInputPositionMeta´ is a utility information, helping to position the `UserInput` properly on the frontend
|
|
1396
|
+
*/
|
|
1361
1397
|
interface AppUserInputPositionMeta {
|
|
1362
1398
|
index?: number;
|
|
1363
1399
|
section?: string;
|
|
1364
1400
|
step?: string;
|
|
1365
1401
|
}
|
|
1402
|
+
/**
|
|
1403
|
+
* `VersionStatus` describes the current and desired version of something like the `AppVersion` of an `AppInstallation`. If diverging, an internal process is going to assert, the `current` value will be aligned
|
|
1404
|
+
*/
|
|
1366
1405
|
interface AppVersionStatus {
|
|
1367
1406
|
current?: string;
|
|
1368
1407
|
desired: string;
|
|
@@ -3669,45 +3708,6 @@ export declare module MittwaldAPIV2 {
|
|
|
3669
3708
|
}
|
|
3670
3709
|
}
|
|
3671
3710
|
}
|
|
3672
|
-
namespace V2ProjectsProjectShortIdAppinstallations {
|
|
3673
|
-
namespace Put {
|
|
3674
|
-
namespace Parameters {
|
|
3675
|
-
type Path = {
|
|
3676
|
-
projectShortId: string;
|
|
3677
|
-
};
|
|
3678
|
-
type RequestBody = {
|
|
3679
|
-
appName: string;
|
|
3680
|
-
appVersionClusterVersion: string;
|
|
3681
|
-
databaseHost?: string;
|
|
3682
|
-
databaseUserName?: string;
|
|
3683
|
-
installationDirectory: string;
|
|
3684
|
-
}[];
|
|
3685
|
-
type Header = {};
|
|
3686
|
-
type Query = {};
|
|
3687
|
-
}
|
|
3688
|
-
namespace Responses {
|
|
3689
|
-
namespace $204 {
|
|
3690
|
-
namespace Content {
|
|
3691
|
-
type Empty = unknown;
|
|
3692
|
-
}
|
|
3693
|
-
}
|
|
3694
|
-
namespace $404 {
|
|
3695
|
-
namespace Content {
|
|
3696
|
-
interface ApplicationJson {
|
|
3697
|
-
[k: string]: unknown;
|
|
3698
|
-
}
|
|
3699
|
-
}
|
|
3700
|
-
}
|
|
3701
|
-
namespace Default {
|
|
3702
|
-
namespace Content {
|
|
3703
|
-
interface ApplicationJson {
|
|
3704
|
-
[k: string]: unknown;
|
|
3705
|
-
}
|
|
3706
|
-
}
|
|
3707
|
-
}
|
|
3708
|
-
}
|
|
3709
|
-
}
|
|
3710
|
-
}
|
|
3711
3711
|
namespace V2AppinstallationsIdActionsCopy {
|
|
3712
3712
|
namespace Post {
|
|
3713
3713
|
namespace Parameters {
|
|
@@ -34,6 +34,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
34
34
|
projectId?: string | undefined;
|
|
35
35
|
screenshotId?: string | undefined;
|
|
36
36
|
screenshotRef?: string | undefined;
|
|
37
|
+
shortId: string;
|
|
37
38
|
systemSoftware?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppInstalledSystemSoftware[] | undefined;
|
|
38
39
|
updatePolicy?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppUpdatePolicy | undefined;
|
|
39
40
|
userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSavedUserInput[] | undefined;
|
|
@@ -84,6 +84,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
84
84
|
projectId?: string | undefined;
|
|
85
85
|
screenshotId?: string | undefined;
|
|
86
86
|
screenshotRef?: string | undefined;
|
|
87
|
+
shortId: string;
|
|
87
88
|
systemSoftware?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppInstalledSystemSoftware[] | undefined;
|
|
88
89
|
updatePolicy?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppUpdatePolicy | undefined;
|
|
89
90
|
userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSavedUserInput[] | undefined;
|
|
@@ -541,38 +542,6 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
541
542
|
[TKey: string]: (string | number | boolean) | (string | number | boolean)[];
|
|
542
543
|
}>;
|
|
543
544
|
}, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppVersion[], 200, "application/json">>>;
|
|
544
|
-
/** reconcile detected apps to appInstallations of a project */
|
|
545
|
-
reconcileDetectedApps: (request: {
|
|
546
|
-
data: {
|
|
547
|
-
appName: string;
|
|
548
|
-
appVersionClusterVersion: string;
|
|
549
|
-
databaseHost?: string | undefined;
|
|
550
|
-
databaseUserName?: string | undefined;
|
|
551
|
-
installationDirectory: string;
|
|
552
|
-
}[];
|
|
553
|
-
projectShortId: string;
|
|
554
|
-
headers?: {
|
|
555
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
556
|
-
} | undefined;
|
|
557
|
-
}) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
|
|
558
|
-
data: {
|
|
559
|
-
appName: string;
|
|
560
|
-
appVersionClusterVersion: string;
|
|
561
|
-
databaseHost?: string | undefined;
|
|
562
|
-
databaseUserName?: string | undefined;
|
|
563
|
-
installationDirectory: string;
|
|
564
|
-
}[];
|
|
565
|
-
} & {
|
|
566
|
-
pathParameters: {
|
|
567
|
-
projectShortId: string;
|
|
568
|
-
};
|
|
569
|
-
} & {
|
|
570
|
-
headers?: Partial<{
|
|
571
|
-
[TKey: string]: (string | number | boolean) | (string | number | boolean)[];
|
|
572
|
-
}> | undefined;
|
|
573
|
-
}, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
|
|
574
|
-
[x: string]: unknown;
|
|
575
|
-
}, 404, "application/json">>>;
|
|
576
545
|
/** request a copy of an `AppInstallation` */
|
|
577
546
|
requestAppinstallationCopy: (request: {
|
|
578
547
|
data: {
|
|
@@ -40,8 +40,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
40
40
|
listSystemsoftwareversions: this.requestFunctionFactory(descriptors.appListSystemsoftwareversions),
|
|
41
41
|
/** get all update candidates for a specific `AppVersion` */
|
|
42
42
|
listUpdateCandidatesForAppversion: this.requestFunctionFactory(descriptors.appListUpdateCandidatesForAppversion),
|
|
43
|
-
/** reconcile detected apps to appInstallations of a project */
|
|
44
|
-
reconcileDetectedApps: this.requestFunctionFactory(descriptors.appReconcileDetectedApps),
|
|
45
43
|
/** request a copy of an `AppInstallation` */
|
|
46
44
|
requestAppinstallationCopy: this.requestFunctionFactory(descriptors.appRequestAppinstallationCopy),
|
|
47
45
|
/** get runtime status of a specific `AppInstallation` */
|
|
@@ -37,8 +37,6 @@ export declare const appListSystemsoftwares: OpenAPIOperation<RequestType<Simpli
|
|
|
37
37
|
export declare const appListSystemsoftwareversions: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
|
|
38
38
|
/** get all update candidates for a specific `AppVersion` */
|
|
39
39
|
export declare const appListUpdateCandidatesForAppversion: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
|
|
40
|
-
/** reconcile detected apps to appInstallations of a project */
|
|
41
|
-
export declare const appReconcileDetectedApps: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectShortIdAppinstallations.Put.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectShortIdAppinstallations.Put.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectShortIdAppinstallations.Put.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectShortIdAppinstallations.Put.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectShortIdAppinstallations.Put.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectShortIdAppinstallations.Put.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectShortIdAppinstallations.Put.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
|
|
42
40
|
/** request a copy of an `AppInstallation` */
|
|
43
41
|
export declare const appRequestAppinstallationCopy: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Responses.$201.Content.ApplicationJson>, 201, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
|
|
44
42
|
/** get runtime status of a specific `AppInstallation` */
|
|
@@ -100,12 +100,6 @@ export const appListUpdateCandidatesForAppversion = {
|
|
|
100
100
|
method: "GET",
|
|
101
101
|
operationId: "app-list-update-candidates-for-appversion",
|
|
102
102
|
};
|
|
103
|
-
/** reconcile detected apps to appInstallations of a project */
|
|
104
|
-
export const appReconcileDetectedApps = {
|
|
105
|
-
path: "/v2/projects/{projectShortId}/appinstallations",
|
|
106
|
-
method: "PUT",
|
|
107
|
-
operationId: "app-reconcile-detected-apps",
|
|
108
|
-
};
|
|
109
103
|
/** request a copy of an `AppInstallation` */
|
|
110
104
|
export const appRequestAppinstallationCopy = {
|
|
111
105
|
path: "/v2/appinstallations/{id}/actions/copy",
|
|
@@ -70,10 +70,6 @@ export declare module MittwaldAPIV2 {
|
|
|
70
70
|
type RequestData = InferredRequestData<typeof descriptors.appListUpdateCandidatesForAppversion>;
|
|
71
71
|
type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.appListUpdateCandidatesForAppversion, TStatus>;
|
|
72
72
|
}
|
|
73
|
-
namespace AppReconcileDetectedApps {
|
|
74
|
-
type RequestData = InferredRequestData<typeof descriptors.appReconcileDetectedApps>;
|
|
75
|
-
type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.appReconcileDetectedApps, TStatus>;
|
|
76
|
-
}
|
|
77
73
|
namespace AppRequestAppinstallationCopy {
|
|
78
74
|
type RequestData = InferredRequestData<typeof descriptors.appRequestAppinstallationCopy>;
|
|
79
75
|
type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.appRequestAppinstallationCopy, TStatus>;
|
|
@@ -1256,6 +1252,7 @@ export declare module MittwaldAPIV2 {
|
|
|
1256
1252
|
projectId?: string;
|
|
1257
1253
|
screenshotId?: string;
|
|
1258
1254
|
screenshotRef?: string;
|
|
1255
|
+
shortId: string;
|
|
1259
1256
|
systemSoftware?: MittwaldAPIV2.Components.Schemas.AppInstalledSystemSoftware[];
|
|
1260
1257
|
updatePolicy?: MittwaldAPIV2.Components.Schemas.AppAppUpdatePolicy;
|
|
1261
1258
|
userInputs?: MittwaldAPIV2.Components.Schemas.AppSavedUserInput[];
|
|
@@ -1280,9 +1277,15 @@ export declare module MittwaldAPIV2 {
|
|
|
1280
1277
|
systemSoftwareDependencies?: MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[];
|
|
1281
1278
|
userInputs?: MittwaldAPIV2.Components.Schemas.AppUserInput[];
|
|
1282
1279
|
}
|
|
1280
|
+
/**
|
|
1281
|
+
* A `BreakingNote` is a hint that something serious has changed in the `AppVersion` containing it, so an automatic update is not possible
|
|
1282
|
+
*/
|
|
1283
1283
|
interface AppBreakingNote {
|
|
1284
1284
|
faqLink: string;
|
|
1285
1285
|
}
|
|
1286
|
+
/**
|
|
1287
|
+
* A ´DatabaseDependency` is a generic description of need for a database, used by `AppVersions`
|
|
1288
|
+
*/
|
|
1286
1289
|
interface AppDatabaseDependency {
|
|
1287
1290
|
description: string;
|
|
1288
1291
|
kind: "mysql";
|
|
@@ -1295,11 +1298,17 @@ export declare module MittwaldAPIV2 {
|
|
|
1295
1298
|
message: string;
|
|
1296
1299
|
type: string;
|
|
1297
1300
|
}
|
|
1301
|
+
/**
|
|
1302
|
+
* `InstalledSystemSoftware` describes the currently configured and installed `SystemSoftwareVersion` of a `SystemSoftware` besides the desired `SystemSoftwareUpdatePolicy` inside an `AppInstallation`
|
|
1303
|
+
*/
|
|
1298
1304
|
interface AppInstalledSystemSoftware {
|
|
1299
1305
|
systemSoftwareId: string;
|
|
1300
1306
|
systemSoftwareVersion: MittwaldAPIV2.Components.Schemas.AppVersionStatus;
|
|
1301
1307
|
updatePolicy: MittwaldAPIV2.Components.Schemas.AppSystemSoftwareUpdatePolicy;
|
|
1302
1308
|
}
|
|
1309
|
+
/**
|
|
1310
|
+
* `LinkedDatabase` is a reference to a concrete `Database` and `DatabaseUsers`
|
|
1311
|
+
*/
|
|
1303
1312
|
interface AppLinkedDatabase {
|
|
1304
1313
|
databaseId: string;
|
|
1305
1314
|
databaseUserIds?: {
|
|
@@ -1308,21 +1317,36 @@ export declare module MittwaldAPIV2 {
|
|
|
1308
1317
|
kind: "mysql" | "redis";
|
|
1309
1318
|
purpose: "primary" | "cache" | "custom";
|
|
1310
1319
|
}
|
|
1320
|
+
/**
|
|
1321
|
+
* `RequestHandlerRequirement` describes the necessary properties to internally resolve the request handler or process to start
|
|
1322
|
+
*/
|
|
1311
1323
|
interface AppRequestHandlerRequirement {
|
|
1312
1324
|
exampleValues?: MittwaldAPIV2.Components.Schemas.AppSavedUserInput[];
|
|
1313
1325
|
name: string;
|
|
1314
1326
|
namespace: string;
|
|
1315
1327
|
parametersTemplate: string;
|
|
1316
1328
|
}
|
|
1329
|
+
/**
|
|
1330
|
+
* A `SavedUserInput` is an entered value for a desired `UserInput` of an `AppVersion` or `SystemSoftwareVersion`
|
|
1331
|
+
*/
|
|
1317
1332
|
interface AppSavedUserInput {
|
|
1318
1333
|
name: string;
|
|
1319
1334
|
value: string;
|
|
1320
1335
|
}
|
|
1336
|
+
/**
|
|
1337
|
+
* A `SystemSoftwareDependency` is a description of a need for a specific `SystemSoftware` in a semver versionRange.
|
|
1338
|
+
*/
|
|
1321
1339
|
interface AppSystemSoftwareDependency {
|
|
1322
1340
|
systemSoftwareId: string;
|
|
1323
1341
|
versionRange: string;
|
|
1324
1342
|
}
|
|
1343
|
+
/**
|
|
1344
|
+
* `SystemSoftwareUpdatePolicy` describes which updates should be applied automatically by our systems
|
|
1345
|
+
*/
|
|
1325
1346
|
type AppSystemSoftwareUpdatePolicy = "none" | "inheritedFromApp" | "patchLevel" | "all";
|
|
1347
|
+
/**
|
|
1348
|
+
* A `SystemSoftware` is a software that can be installed for an `AppInstallation` but mostly is not itself externally reachable and/or deliverable.
|
|
1349
|
+
*/
|
|
1326
1350
|
interface AppSystemSoftware {
|
|
1327
1351
|
id: string;
|
|
1328
1352
|
name: string;
|
|
@@ -1339,6 +1363,9 @@ export declare module MittwaldAPIV2 {
|
|
|
1339
1363
|
systemSoftwareDependencies?: MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[];
|
|
1340
1364
|
userInputs?: MittwaldAPIV2.Components.Schemas.AppUserInput[];
|
|
1341
1365
|
}
|
|
1366
|
+
/**
|
|
1367
|
+
* A `UserInput` is a description of an information which cannot be determined or estimated by mittwald, but has to be given by the person who is requesting an `AppInstallation` or `SystemSoftware`
|
|
1368
|
+
*/
|
|
1342
1369
|
interface AppUserInput {
|
|
1343
1370
|
/**
|
|
1344
1371
|
* Optional field to tell the frontend, which data to put into the select
|
|
@@ -1356,13 +1383,25 @@ export declare module MittwaldAPIV2 {
|
|
|
1356
1383
|
*/
|
|
1357
1384
|
validationSchema: string;
|
|
1358
1385
|
}
|
|
1386
|
+
/**
|
|
1387
|
+
* `UserInputDataType` is an enum, describing the possible data types of a `UserInput`
|
|
1388
|
+
*/
|
|
1359
1389
|
type AppUserInputDataType = "text" | "number" | "boolean" | "select";
|
|
1390
|
+
/**
|
|
1391
|
+
* `UserInputFormat` is an enum, describing the possible data formats of a `UserInput`, the given values can be validated against
|
|
1392
|
+
*/
|
|
1360
1393
|
type AppUserInputFormat = "email" | "password" | "url";
|
|
1394
|
+
/**
|
|
1395
|
+
* `UserInputPositionMeta´ is a utility information, helping to position the `UserInput` properly on the frontend
|
|
1396
|
+
*/
|
|
1361
1397
|
interface AppUserInputPositionMeta {
|
|
1362
1398
|
index?: number;
|
|
1363
1399
|
section?: string;
|
|
1364
1400
|
step?: string;
|
|
1365
1401
|
}
|
|
1402
|
+
/**
|
|
1403
|
+
* `VersionStatus` describes the current and desired version of something like the `AppVersion` of an `AppInstallation`. If diverging, an internal process is going to assert, the `current` value will be aligned
|
|
1404
|
+
*/
|
|
1366
1405
|
interface AppVersionStatus {
|
|
1367
1406
|
current?: string;
|
|
1368
1407
|
desired: string;
|
|
@@ -3669,45 +3708,6 @@ export declare module MittwaldAPIV2 {
|
|
|
3669
3708
|
}
|
|
3670
3709
|
}
|
|
3671
3710
|
}
|
|
3672
|
-
namespace V2ProjectsProjectShortIdAppinstallations {
|
|
3673
|
-
namespace Put {
|
|
3674
|
-
namespace Parameters {
|
|
3675
|
-
type Path = {
|
|
3676
|
-
projectShortId: string;
|
|
3677
|
-
};
|
|
3678
|
-
type RequestBody = {
|
|
3679
|
-
appName: string;
|
|
3680
|
-
appVersionClusterVersion: string;
|
|
3681
|
-
databaseHost?: string;
|
|
3682
|
-
databaseUserName?: string;
|
|
3683
|
-
installationDirectory: string;
|
|
3684
|
-
}[];
|
|
3685
|
-
type Header = {};
|
|
3686
|
-
type Query = {};
|
|
3687
|
-
}
|
|
3688
|
-
namespace Responses {
|
|
3689
|
-
namespace $204 {
|
|
3690
|
-
namespace Content {
|
|
3691
|
-
type Empty = unknown;
|
|
3692
|
-
}
|
|
3693
|
-
}
|
|
3694
|
-
namespace $404 {
|
|
3695
|
-
namespace Content {
|
|
3696
|
-
interface ApplicationJson {
|
|
3697
|
-
[k: string]: unknown;
|
|
3698
|
-
}
|
|
3699
|
-
}
|
|
3700
|
-
}
|
|
3701
|
-
namespace Default {
|
|
3702
|
-
namespace Content {
|
|
3703
|
-
interface ApplicationJson {
|
|
3704
|
-
[k: string]: unknown;
|
|
3705
|
-
}
|
|
3706
|
-
}
|
|
3707
|
-
}
|
|
3708
|
-
}
|
|
3709
|
-
}
|
|
3710
|
-
}
|
|
3711
3711
|
namespace V2AppinstallationsIdActionsCopy {
|
|
3712
3712
|
namespace Post {
|
|
3713
3713
|
namespace Parameters {
|
package/dist/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const MittwaldAPIClientVersion = '3.0.
|
|
1
|
+
export declare const MittwaldAPIClientVersion = '3.0.21';
|
package/dist/version.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const MittwaldAPIClientVersion = '3.0.
|
|
1
|
+
export const MittwaldAPIClientVersion = '3.0.21';
|