@mittwald/api-client 2.0.10 → 2.0.12

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.
Files changed (18) hide show
  1. package/README.md +9 -0
  2. package/dist/cjs/generated/v2/client.d.ts +13 -8
  3. package/dist/cjs/generated/v2/descriptors.d.ts +5 -1
  4. package/dist/cjs/generated/v2/descriptors.js +15 -3
  5. package/dist/cjs/generated/v2/types.d.ts +120 -6
  6. package/dist/cjs/v2.js +5 -0
  7. package/dist/cjs/version.d.ts +1 -0
  8. package/dist/cjs/version.js +4 -0
  9. package/dist/esm/generated/v2/client.d.ts +13 -8
  10. package/dist/esm/generated/v2/descriptors.d.ts +5 -1
  11. package/dist/esm/generated/v2/descriptors.js +12 -0
  12. package/dist/esm/generated/v2/types.d.ts +120 -6
  13. package/dist/esm/v2.js +5 -0
  14. package/dist/esm/version.d.ts +1 -0
  15. package/dist/esm/version.js +1 -0
  16. package/dist/version.d.ts +1 -0
  17. package/dist/version.js +1 -0
  18. package/package.json +1 -1
package/README.md CHANGED
@@ -58,6 +58,15 @@ find the operation ID on the right side of each operation.
58
58
  The client uses the popular [Axios HTTP client](https://axios-http.com) under
59
59
  the hood. You may access the Axios instance with the clients `axios` property.
60
60
 
61
+ ### Adding custom HTTP headers
62
+
63
+ To add custom HTTP headers to all requests you can use Axios' `defaults.headers`
64
+ property:
65
+
66
+ ```typescript
67
+ client.axios.defaults.headers["User-Agent"] = `your-tool/v1.2.3`;
68
+ ```
69
+
61
70
  ### Intercepting requests or responses
62
71
 
63
72
  To intercept requests or responses you can use
package/dist/cjs/generated/v2/client.d.ts CHANGED
@@ -1787,6 +1787,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
1787
1787
  date: string;
1788
1788
  groups: {
1789
1789
  contractId?: string | undefined;
1790
+ /** Delete an SFTPUser. */
1790
1791
  description: string;
1791
1792
  items: import("./types.js").MittwaldAPIV2.Components.Schemas.InvoiceInvoiceItem[];
1792
1793
  }[];
@@ -5118,7 +5119,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
5118
5119
  cname: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordCNAME;
5119
5120
  combinedARecords: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordCombinedA;
5120
5121
  mx: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordMX;
5121
- txt: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordTXT; /** Get settings for a given project ID */
5122
+ txt: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordTXT;
5122
5123
  };
5123
5124
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
5124
5125
  [x: string]: unknown;
@@ -5834,7 +5835,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
5834
5835
  hostname: string;
5835
5836
  id: string;
5836
5837
  ips: {
5837
- v4: string[];
5838
+ v4: string[]; /** Get a ProjectInvite by token. */
5838
5839
  };
5839
5840
  isDefault: boolean;
5840
5841
  isEnabled: boolean;
@@ -6077,11 +6078,11 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
6077
6078
  max?: {
6078
6079
  height?: number | undefined;
6079
6080
  width?: number | undefined;
6080
- } | undefined; /** Delete a ProjectMembership. */
6081
+ } | undefined;
6081
6082
  min?: {
6082
6083
  height?: number | undefined;
6083
6084
  width?: number | undefined;
6084
- } | undefined;
6085
+ } | undefined; /** Delete a Project. */
6085
6086
  } | undefined;
6086
6087
  } | undefined;
6087
6088
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
@@ -6113,11 +6114,11 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
6113
6114
  max?: {
6114
6115
  height?: number | undefined;
6115
6116
  width?: number | undefined;
6116
- } | undefined; /** Delete a ProjectMembership. */
6117
+ } | undefined;
6117
6118
  min?: {
6118
6119
  height?: number | undefined;
6119
6120
  width?: number | undefined;
6120
- } | undefined;
6121
+ } | undefined; /** Delete a Project. */
6121
6122
  } | undefined;
6122
6123
  } | undefined;
6123
6124
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
@@ -6465,6 +6466,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
6465
6466
  passwordUpdatedAt: string;
6466
6467
  sendingEnabled: boolean;
6467
6468
  spamProtection: {
6469
+ /** Store a new ssh-key. */
6468
6470
  active: boolean;
6469
6471
  autoDeleteSpam: boolean;
6470
6472
  folder: "spam" | "inbox";
@@ -7595,10 +7597,11 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
7595
7597
  [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
7596
7598
  }>;
7597
7599
  }, import("@mittwald/api-client-commons").Response<{
7600
+ clusterName: string;
7598
7601
  createdAt: string;
7599
7602
  customerId: string;
7600
7603
  description: string;
7601
- disabledReason?: "nonPayment" | undefined;
7604
+ disabledReason?: "suspended" | undefined;
7602
7605
  id: string;
7603
7606
  imageRefId?: string | undefined;
7604
7607
  isReady: boolean;
@@ -7857,7 +7860,9 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
7857
7860
  } & Partial<{
7858
7861
  [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
7859
7862
  }>;
7860
- }, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectServer[], 200, "application/json">>>;
7863
+ }, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectServer[], 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
7864
+ [x: string]: unknown;
7865
+ }, 403, "application/json">>>;
7861
7866
  /** Resend the mail for a ProjectInvite. */
7862
7867
  resendProjectInviteMail: (request: {
7863
7868
  pathParameters: {
package/dist/cjs/generated/v2/descriptors.d.ts CHANGED
@@ -399,6 +399,10 @@ export declare const orderListProjectOrders: OpenAPIOperation<RequestType<Simpli
399
399
  export declare const orderPreviewOrder: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2OrderPreviews.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2OrderPreviews.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2OrderPreviews.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2OrderPreviews.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2OrderPreviews.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2OrderPreviews.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2OrderPreviews.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
400
400
  /** Preview TariffChange. */
401
401
  export declare const orderPreviewTariffChange: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2TariffChangePreviews.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2TariffChangePreviews.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2TariffChangePreviews.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2TariffChangePreviews.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2TariffChangePreviews.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2TariffChangePreviews.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2TariffChangePreviews.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
402
+ /** Get detailed performance data for a given domain and path. */
403
+ export declare const pageinsightsGetPerformanceData: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2Pageinsights.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2Pageinsights.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2Pageinsights.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2Pageinsights.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Pageinsights.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Pageinsights.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Pageinsights.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
404
+ /** List websites (specified as domain and path) from a project where performance data is available. */
405
+ export declare const pageinsightsListPerformanceDataForProject: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ProjectsIdPageinsights.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsIdPageinsights.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsIdPageinsights.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsIdPageinsights.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsIdPageinsights.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsIdPageinsights.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsIdPageinsights.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
402
406
  /** Get a password policy. */
403
407
  export declare const passwordValidationGetPasswordPolicy: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2PasswordPoliciesPath.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2PasswordPoliciesPath.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2PasswordPoliciesPath.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2PasswordPoliciesPath.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2PasswordPoliciesPath.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
404
408
  /** Accept a ProjectInvite. */
@@ -460,7 +464,7 @@ export declare const projectListProjectMemberships: OpenAPIOperation<RequestType
460
464
  /** List Project's for an Organization or Server. */
461
465
  export declare const projectListProjects: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2Projects.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2Projects.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2Projects.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2Projects.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Projects.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Projects.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
462
466
  /** List Servers for an Organization or User. */
463
- export declare const projectListServers: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
467
+ export declare const projectListServers: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
464
468
  /** Resend the mail for a ProjectInvite. */
465
469
  export declare const projectResendProjectInviteMail: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2ProjectInvitesInviteIdActionsResend.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2ProjectInvitesInviteIdActionsResend.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectInvitesInviteIdActionsResend.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectInvitesInviteIdActionsResend.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectInvitesInviteIdActionsResend.Post.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectInvitesInviteIdActionsResend.Post.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectInvitesInviteIdActionsResend.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
466
470
  /** Update a Project's description. */
package/dist/cjs/generated/v2/descriptors.js CHANGED
@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
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.appUpdateStatus = exports.appUnlinkDatabase = exports.appSetDatabaseUsers = exports.appRetrieveStatus = exports.appRequestAppinstallationCopy = exports.appReconcileDetectedApps = exports.appListUpdateCandidatesForAppversion = exports.appListSystemsoftwareversions = exports.appListSystemsoftwares = exports.appListAppversions = exports.appListApps = exports.appRequestAppinstallation = exports.appListAppinstallations = exports.appLinkDatabase = exports.appGetSystemsoftwareversion = exports.appGetSystemsoftware = exports.appGetAppversion = exports.appPatchAppinstallation = exports.appUninstallAppinstallation = exports.appGetAppinstallation = exports.appGetApp = exports.appExecuteAction = void 0;
4
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 = exports.conversationCreateConversation = void 0;
5
5
  exports.fileGetFileMeta = exports.fileCreateFile = exports.domainResendDomainEmail = exports.domainListToplevelDomains = exports.domainListDomains = exports.domainListDomainOwnerships = exports.domainGetToplevelDomain = exports.domainVerifyDomainOwnership = exports.domainGetSpecificDomainOwnership = 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.dnsRecordTxtSet = exports.dnsRecordMxSetManaged = exports.dnsRecordMxSetCustom = exports.dnsRecordCnameSet = exports.dnsRecordAsetManagedByIngress = exports.dnsRecordAsetCustom = exports.databaseUpdateRedisDatabaseDescription = 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 = exports.databaseListMysqlUsers = void 0;
6
- exports.projectAcceptProjectInvite = exports.passwordValidationGetPasswordPolicy = exports.orderPreviewTariffChange = exports.orderPreviewOrder = exports.orderListProjectOrders = exports.orderListCustomerOrders = exports.orderGetOrder = exports.orderCreateTariffChange = exports.orderCreateOrder = exports.notificationsReadNotification = exports.notificationsReadAllNotifications = exports.notificationsListNotifications = exports.notificationsCountUnreadNotifications = exports.newsletterSubscribeUser = 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.ingressPaths = exports.ingressListForProject = exports.ingressListAccessible = exports.ingressDelete = exports.ingressGetSpecific = exports.ingressCreate = exports.fileGetFile = exports.fileGetFileTypeRules = exports.fileGetFileTokenRules = void 0;
7
- 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.relocationCreateLegacyTariffChange = exports.redirectusCreateRelocation = 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.projectGetProject = exports.projectGetProjectTokenInvite = exports.projectFileSystemListFiles = exports.projectFileSystemGetJwt = exports.projectFileSystemGetFileContent = exports.projectFileSystemGetDiskUsage = exports.projectFileSystemGetDirectories = exports.projectDeleteServerAvatar = exports.projectRequestServerAvatarUpload = exports.projectDeleteProject = exports.projectUpdateProjectMembership = exports.projectDeleteProjectMembership = exports.projectGetProjectMembership = exports.projectDeleteProjectInvite = exports.projectGetProjectInvite = exports.projectDeleteProjectAvatar = exports.projectRequestProjectAvatarUpload = exports.projectDeclineProjectInvite = exports.projectCreateProject = exports.projectCreateProjectInvite = void 0;
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.userCreateIssue = exports.userCreateFeedback = exports.userCreateApiToken = exports.userListApiTokens = exports.userConfirmPasswordReset = exports.userDisableMfa = exports.userConfirmMfa = exports.userResetRecoverycodes = exports.userGetMfaStatus = exports.userCheckToken = exports.userChangePassword = exports.userChangeEmail = void 0;
6
+ 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.newsletterSubscribeUser = 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.ingressPaths = exports.ingressListForProject = exports.ingressListAccessible = exports.ingressDelete = exports.ingressGetSpecific = exports.ingressCreate = exports.fileGetFile = exports.fileGetFileTypeRules = exports.fileGetFileTokenRules = void 0;
7
+ 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.relocationCreateLegacyTariffChange = exports.redirectusCreateRelocation = 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.projectGetProject = exports.projectGetProjectTokenInvite = exports.projectFileSystemListFiles = exports.projectFileSystemGetJwt = exports.projectFileSystemGetFileContent = exports.projectFileSystemGetDiskUsage = exports.projectFileSystemGetDirectories = exports.projectDeleteServerAvatar = exports.projectRequestServerAvatarUpload = exports.projectDeleteProject = exports.projectUpdateProjectMembership = exports.projectDeleteProjectMembership = exports.projectGetProjectMembership = exports.projectDeleteProjectInvite = exports.projectGetProjectInvite = exports.projectDeleteProjectAvatar = exports.projectRequestProjectAvatarUpload = exports.projectDeclineProjectInvite = exports.projectCreateProject = exports.projectCreateProjectInvite = exports.projectAcceptProjectInvite = exports.passwordValidationGetPasswordPolicy = void 0;
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.userCreateIssue = 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 = 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}",
@@ -1194,6 +1194,18 @@ exports.orderPreviewTariffChange = {
1194
1194
  method: "POST",
1195
1195
  operationId: "order-preview-tariff-change",
1196
1196
  };
1197
+ /** Get detailed performance data for a given domain and path. */
1198
+ exports.pageinsightsGetPerformanceData = {
1199
+ path: "/v2/pageinsights",
1200
+ method: "GET",
1201
+ operationId: "pageinsights-get-performance-data",
1202
+ };
1203
+ /** List websites (specified as domain and path) from a project where performance data is available. */
1204
+ exports.pageinsightsListPerformanceDataForProject = {
1205
+ path: "/v2/projects/{id}/pageinsights",
1206
+ method: "GET",
1207
+ operationId: "pageinsights-list-performance-data-for-project",
1208
+ };
1197
1209
  /** Get a password policy. */
1198
1210
  exports.passwordValidationGetPasswordPolicy = {
1199
1211
  path: "/v2/password/policies/{path}",
package/dist/cjs/generated/v2/types.d.ts CHANGED
@@ -664,11 +664,11 @@ export declare module MittwaldAPIV2 {
664
664
  */
665
665
  additionalFlags?: string[];
666
666
  /**
667
- * The database's maximum memory.
667
+ * The database's maximum memory. This may be a number, optionally suffixed by one of the IEC binary suffixes `Ki`, `Mi` or `Gi`.
668
668
  */
669
669
  maxMemory?: string;
670
670
  /**
671
- * The database's key eviction policy.
671
+ * The database's key eviction policy. See the [Redis documentation on key evictions](https://redis.io/docs/reference/eviction/) for more information.
672
672
  */
673
673
  maxMemoryPolicy?: string;
674
674
  /**
@@ -1412,7 +1412,7 @@ export declare module MittwaldAPIV2 {
1412
1412
  };
1413
1413
  };
1414
1414
  }
1415
- type ProjectDisableReason = "maliciousCode" | "illegalContent" | "maliciousConduct";
1415
+ type ProjectDisableReason = "maliciousCode" | "illegalContent" | "maliciousConduct" | "suspended";
1416
1416
  interface ProjectFilesystemDirectoryListing {
1417
1417
  absolutePath: string;
1418
1418
  isDirectory?: boolean;
@@ -1467,8 +1467,9 @@ export declare module MittwaldAPIV2 {
1467
1467
  spec?: MittwaldAPIV2.Components.Schemas.ProjectVisitorSpec | MittwaldAPIV2.Components.Schemas.ProjectHardwareSpec;
1468
1468
  }
1469
1469
  type ProjectProjectReadinessStatus = "creating" | "ready" | "unready";
1470
- type ProjectServerDisableReason = "nonPayment";
1470
+ type ProjectServerDisableReason = "suspended";
1471
1471
  interface ProjectServer {
1472
+ clusterName: string;
1472
1473
  createdAt: string;
1473
1474
  customerId: string;
1474
1475
  description: string;
@@ -6561,8 +6562,10 @@ export declare module MittwaldAPIV2 {
6561
6562
  namespace V2NewsletterSubscriptionsEmail { }
6562
6563
  namespace V2NewsletterSubscriptions { }
6563
6564
  namespace V2SignupEmail { }
6565
+ namespace V2SignupPasswordResetConfirm { }
6564
6566
  namespace V2SignupTokenApiApiTokenId { }
6565
6567
  namespace V2SignupSshSshKeyId { }
6568
+ namespace V2SignupPasswordReset { }
6566
6569
  namespace V2SignupLogout { }
6567
6570
  namespace V2SignupEmailResend { }
6568
6571
  namespace V2UserUserIdAvatar { }
@@ -9477,6 +9480,112 @@ export declare module MittwaldAPIV2 {
9477
9480
  }
9478
9481
  }
9479
9482
  }
9483
+ namespace V2Pageinsights {
9484
+ namespace Get {
9485
+ namespace Parameters {
9486
+ type Path = {};
9487
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
9488
+ type Query = {
9489
+ domain: string;
9490
+ path: string;
9491
+ date?: string;
9492
+ };
9493
+ }
9494
+ namespace Responses {
9495
+ namespace $200 {
9496
+ namespace Content {
9497
+ interface ApplicationJson {
9498
+ createdAt?: string;
9499
+ domain: string;
9500
+ metrics?: {
9501
+ createdAt: string;
9502
+ name: string;
9503
+ score: number;
9504
+ value: number;
9505
+ }[];
9506
+ moreDataAvailable?: string[];
9507
+ path: string;
9508
+ performanceScore: number;
9509
+ screenshot?: {
9510
+ createdAt: string;
9511
+ fileRef: string;
9512
+ };
9513
+ }
9514
+ }
9515
+ }
9516
+ namespace $400 {
9517
+ namespace Content {
9518
+ interface ApplicationJson {
9519
+ [k: string]: unknown;
9520
+ }
9521
+ }
9522
+ }
9523
+ namespace $403 {
9524
+ namespace Content {
9525
+ interface ApplicationJson {
9526
+ [k: string]: unknown;
9527
+ }
9528
+ }
9529
+ }
9530
+ namespace Default {
9531
+ namespace Content {
9532
+ interface ApplicationJson {
9533
+ [k: string]: unknown;
9534
+ }
9535
+ }
9536
+ }
9537
+ }
9538
+ }
9539
+ }
9540
+ namespace V2ProjectsIdPageinsights {
9541
+ namespace Get {
9542
+ namespace Parameters {
9543
+ type Path = {
9544
+ id: string;
9545
+ };
9546
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
9547
+ type Query = {
9548
+ domain?: string;
9549
+ };
9550
+ }
9551
+ namespace Responses {
9552
+ namespace $200 {
9553
+ namespace Content {
9554
+ type ApplicationJson = {
9555
+ domain: string;
9556
+ paths: {
9557
+ createdAt: string;
9558
+ path: string;
9559
+ performanceScore: number;
9560
+ screenshotFileRef?: string;
9561
+ }[];
9562
+ }[];
9563
+ }
9564
+ }
9565
+ namespace $400 {
9566
+ namespace Content {
9567
+ interface ApplicationJson {
9568
+ [k: string]: unknown;
9569
+ }
9570
+ }
9571
+ }
9572
+ namespace $403 {
9573
+ namespace Content {
9574
+ interface ApplicationJson {
9575
+ [k: string]: unknown;
9576
+ }
9577
+ }
9578
+ }
9579
+ namespace Default {
9580
+ namespace Content {
9581
+ interface ApplicationJson {
9582
+ [k: string]: unknown;
9583
+ }
9584
+ }
9585
+ }
9586
+ }
9587
+ }
9588
+ }
9480
9589
  namespace V2PasswordPoliciesPath {
9481
9590
  namespace Get {
9482
9591
  namespace Parameters {
@@ -10604,6 +10713,13 @@ export declare module MittwaldAPIV2 {
10604
10713
  type ApplicationJson = MittwaldAPIV2.Components.Schemas.ProjectServer[];
10605
10714
  }
10606
10715
  }
10716
+ namespace $403 {
10717
+ namespace Content {
10718
+ interface ApplicationJson {
10719
+ [k: string]: unknown;
10720
+ }
10721
+ }
10722
+ }
10607
10723
  namespace Default {
10608
10724
  namespace Content {
10609
10725
  interface ApplicationJson {
@@ -11753,7 +11869,6 @@ export declare module MittwaldAPIV2 {
11753
11869
  }
11754
11870
  }
11755
11871
  }
11756
- namespace V2SignupPasswordResetConfirm { }
11757
11872
  namespace V2UsersSelfCredentialsPasswordConfirmReset {
11758
11873
  namespace Post {
11759
11874
  namespace Parameters {
@@ -12580,7 +12695,6 @@ export declare module MittwaldAPIV2 {
12580
12695
  }
12581
12696
  }
12582
12697
  }
12583
- namespace V2SignupPasswordReset { }
12584
12698
  namespace V2UsersSelfCredentialsActionsInitPasswordReset {
12585
12699
  namespace Post {
12586
12700
  namespace Parameters {
package/dist/cjs/v2.js CHANGED
@@ -12,10 +12,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
12
12
  exports.MittwaldAPIClient = void 0;
13
13
  const api_client_commons_1 = require("@mittwald/api-client-commons");
14
14
  const client_js_1 = require("./generated/v2/client.js");
15
+ const version_js_1 = require("./version.js");
16
+ const defaultUserAgent = "mittwald-api-client/" + version_js_1.MittwaldAPIClientVersion;
15
17
  class MittwaldAPIClient extends client_js_1.default {
16
18
  constructor(apiToken) {
17
19
  super({
18
20
  baseURL: "https://api.mittwald.de/",
21
+ headers: {
22
+ "User-Agent": defaultUserAgent,
23
+ },
19
24
  });
20
25
  this.apiToken = apiToken;
21
26
  this.setupInterceptors();
package/dist/cjs/version.d.ts ADDED
@@ -0,0 +1 @@
1
+ export declare const MittwaldAPIClientVersion = "0.0.0-development";
package/dist/cjs/version.js ADDED
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.MittwaldAPIClientVersion = void 0;
4
+ exports.MittwaldAPIClientVersion = "0.0.0-development";
package/dist/esm/generated/v2/client.d.ts CHANGED
@@ -1787,6 +1787,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
1787
1787
  date: string;
1788
1788
  groups: {
1789
1789
  contractId?: string | undefined;
1790
+ /** Delete an SFTPUser. */
1790
1791
  description: string;
1791
1792
  items: import("./types.js").MittwaldAPIV2.Components.Schemas.InvoiceInvoiceItem[];
1792
1793
  }[];
@@ -5118,7 +5119,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
5118
5119
  cname: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordCNAME;
5119
5120
  combinedARecords: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordCombinedA;
5120
5121
  mx: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordMX;
5121
- txt: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordTXT; /** Get settings for a given project ID */
5122
+ txt: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordTXT;
5122
5123
  };
5123
5124
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
5124
5125
  [x: string]: unknown;
@@ -5834,7 +5835,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
5834
5835
  hostname: string;
5835
5836
  id: string;
5836
5837
  ips: {
5837
- v4: string[];
5838
+ v4: string[]; /** Get a ProjectInvite by token. */
5838
5839
  };
5839
5840
  isDefault: boolean;
5840
5841
  isEnabled: boolean;
@@ -6077,11 +6078,11 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
6077
6078
  max?: {
6078
6079
  height?: number | undefined;
6079
6080
  width?: number | undefined;
6080
- } | undefined; /** Delete a ProjectMembership. */
6081
+ } | undefined;
6081
6082
  min?: {
6082
6083
  height?: number | undefined;
6083
6084
  width?: number | undefined;
6084
- } | undefined;
6085
+ } | undefined; /** Delete a Project. */
6085
6086
  } | undefined;
6086
6087
  } | undefined;
6087
6088
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
@@ -6113,11 +6114,11 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
6113
6114
  max?: {
6114
6115
  height?: number | undefined;
6115
6116
  width?: number | undefined;
6116
- } | undefined; /** Delete a ProjectMembership. */
6117
+ } | undefined;
6117
6118
  min?: {
6118
6119
  height?: number | undefined;
6119
6120
  width?: number | undefined;
6120
- } | undefined;
6121
+ } | undefined; /** Delete a Project. */
6121
6122
  } | undefined;
6122
6123
  } | undefined;
6123
6124
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
@@ -6465,6 +6466,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
6465
6466
  passwordUpdatedAt: string;
6466
6467
  sendingEnabled: boolean;
6467
6468
  spamProtection: {
6469
+ /** Store a new ssh-key. */
6468
6470
  active: boolean;
6469
6471
  autoDeleteSpam: boolean;
6470
6472
  folder: "spam" | "inbox";
@@ -7595,10 +7597,11 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
7595
7597
  [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
7596
7598
  }>;
7597
7599
  }, import("@mittwald/api-client-commons").Response<{
7600
+ clusterName: string;
7598
7601
  createdAt: string;
7599
7602
  customerId: string;
7600
7603
  description: string;
7601
- disabledReason?: "nonPayment" | undefined;
7604
+ disabledReason?: "suspended" | undefined;
7602
7605
  id: string;
7603
7606
  imageRefId?: string | undefined;
7604
7607
  isReady: boolean;
@@ -7857,7 +7860,9 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
7857
7860
  } & Partial<{
7858
7861
  [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
7859
7862
  }>;
7860
- }, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectServer[], 200, "application/json">>>;
7863
+ }, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.ProjectServer[], 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
7864
+ [x: string]: unknown;
7865
+ }, 403, "application/json">>>;
7861
7866
  /** Resend the mail for a ProjectInvite. */
7862
7867
  resendProjectInviteMail: (request: {
7863
7868
  pathParameters: {
package/dist/esm/generated/v2/descriptors.d.ts CHANGED
@@ -399,6 +399,10 @@ export declare const orderListProjectOrders: OpenAPIOperation<RequestType<Simpli
399
399
  export declare const orderPreviewOrder: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2OrderPreviews.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2OrderPreviews.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2OrderPreviews.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2OrderPreviews.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2OrderPreviews.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2OrderPreviews.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2OrderPreviews.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
400
400
  /** Preview TariffChange. */
401
401
  export declare const orderPreviewTariffChange: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2TariffChangePreviews.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2TariffChangePreviews.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2TariffChangePreviews.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2TariffChangePreviews.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2TariffChangePreviews.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2TariffChangePreviews.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2TariffChangePreviews.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
402
+ /** Get detailed performance data for a given domain and path. */
403
+ export declare const pageinsightsGetPerformanceData: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2Pageinsights.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2Pageinsights.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2Pageinsights.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2Pageinsights.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Pageinsights.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Pageinsights.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Pageinsights.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
404
+ /** List websites (specified as domain and path) from a project where performance data is available. */
405
+ export declare const pageinsightsListPerformanceDataForProject: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ProjectsIdPageinsights.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsIdPageinsights.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsIdPageinsights.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsIdPageinsights.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsIdPageinsights.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsIdPageinsights.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsIdPageinsights.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
402
406
  /** Get a password policy. */
403
407
  export declare const passwordValidationGetPasswordPolicy: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2PasswordPoliciesPath.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2PasswordPoliciesPath.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2PasswordPoliciesPath.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2PasswordPoliciesPath.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2PasswordPoliciesPath.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
404
408
  /** Accept a ProjectInvite. */
@@ -460,7 +464,7 @@ export declare const projectListProjectMemberships: OpenAPIOperation<RequestType
460
464
  /** List Project's for an Organization or Server. */
461
465
  export declare const projectListProjects: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2Projects.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2Projects.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2Projects.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2Projects.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Projects.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Projects.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
462
466
  /** List Servers for an Organization or User. */
463
- export declare const projectListServers: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
467
+ export declare const projectListServers: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Servers.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
464
468
  /** Resend the mail for a ProjectInvite. */
465
469
  export declare const projectResendProjectInviteMail: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2ProjectInvitesInviteIdActionsResend.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2ProjectInvitesInviteIdActionsResend.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectInvitesInviteIdActionsResend.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectInvitesInviteIdActionsResend.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectInvitesInviteIdActionsResend.Post.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectInvitesInviteIdActionsResend.Post.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectInvitesInviteIdActionsResend.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
466
470
  /** Update a Project's description. */
package/dist/esm/generated/v2/descriptors.js CHANGED
@@ -1186,6 +1186,18 @@ export const orderPreviewTariffChange = {
1186
1186
  method: "POST",
1187
1187
  operationId: "order-preview-tariff-change",
1188
1188
  };
1189
+ /** Get detailed performance data for a given domain and path. */
1190
+ export const pageinsightsGetPerformanceData = {
1191
+ path: "/v2/pageinsights",
1192
+ method: "GET",
1193
+ operationId: "pageinsights-get-performance-data",
1194
+ };
1195
+ /** List websites (specified as domain and path) from a project where performance data is available. */
1196
+ export const pageinsightsListPerformanceDataForProject = {
1197
+ path: "/v2/projects/{id}/pageinsights",
1198
+ method: "GET",
1199
+ operationId: "pageinsights-list-performance-data-for-project",
1200
+ };
1189
1201
  /** Get a password policy. */
1190
1202
  export const passwordValidationGetPasswordPolicy = {
1191
1203
  path: "/v2/password/policies/{path}",
package/dist/esm/generated/v2/types.d.ts CHANGED
@@ -664,11 +664,11 @@ export declare module MittwaldAPIV2 {
664
664
  */
665
665
  additionalFlags?: string[];
666
666
  /**
667
- * The database's maximum memory.
667
+ * The database's maximum memory. This may be a number, optionally suffixed by one of the IEC binary suffixes `Ki`, `Mi` or `Gi`.
668
668
  */
669
669
  maxMemory?: string;
670
670
  /**
671
- * The database's key eviction policy.
671
+ * The database's key eviction policy. See the [Redis documentation on key evictions](https://redis.io/docs/reference/eviction/) for more information.
672
672
  */
673
673
  maxMemoryPolicy?: string;
674
674
  /**
@@ -1412,7 +1412,7 @@ export declare module MittwaldAPIV2 {
1412
1412
  };
1413
1413
  };
1414
1414
  }
1415
- type ProjectDisableReason = "maliciousCode" | "illegalContent" | "maliciousConduct";
1415
+ type ProjectDisableReason = "maliciousCode" | "illegalContent" | "maliciousConduct" | "suspended";
1416
1416
  interface ProjectFilesystemDirectoryListing {
1417
1417
  absolutePath: string;
1418
1418
  isDirectory?: boolean;
@@ -1467,8 +1467,9 @@ export declare module MittwaldAPIV2 {
1467
1467
  spec?: MittwaldAPIV2.Components.Schemas.ProjectVisitorSpec | MittwaldAPIV2.Components.Schemas.ProjectHardwareSpec;
1468
1468
  }
1469
1469
  type ProjectProjectReadinessStatus = "creating" | "ready" | "unready";
1470
- type ProjectServerDisableReason = "nonPayment";
1470
+ type ProjectServerDisableReason = "suspended";
1471
1471
  interface ProjectServer {
1472
+ clusterName: string;
1472
1473
  createdAt: string;
1473
1474
  customerId: string;
1474
1475
  description: string;
@@ -6561,8 +6562,10 @@ export declare module MittwaldAPIV2 {
6561
6562
  namespace V2NewsletterSubscriptionsEmail { }
6562
6563
  namespace V2NewsletterSubscriptions { }
6563
6564
  namespace V2SignupEmail { }
6565
+ namespace V2SignupPasswordResetConfirm { }
6564
6566
  namespace V2SignupTokenApiApiTokenId { }
6565
6567
  namespace V2SignupSshSshKeyId { }
6568
+ namespace V2SignupPasswordReset { }
6566
6569
  namespace V2SignupLogout { }
6567
6570
  namespace V2SignupEmailResend { }
6568
6571
  namespace V2UserUserIdAvatar { }
@@ -9477,6 +9480,112 @@ export declare module MittwaldAPIV2 {
9477
9480
  }
9478
9481
  }
9479
9482
  }
9483
+ namespace V2Pageinsights {
9484
+ namespace Get {
9485
+ namespace Parameters {
9486
+ type Path = {};
9487
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
9488
+ type Query = {
9489
+ domain: string;
9490
+ path: string;
9491
+ date?: string;
9492
+ };
9493
+ }
9494
+ namespace Responses {
9495
+ namespace $200 {
9496
+ namespace Content {
9497
+ interface ApplicationJson {
9498
+ createdAt?: string;
9499
+ domain: string;
9500
+ metrics?: {
9501
+ createdAt: string;
9502
+ name: string;
9503
+ score: number;
9504
+ value: number;
9505
+ }[];
9506
+ moreDataAvailable?: string[];
9507
+ path: string;
9508
+ performanceScore: number;
9509
+ screenshot?: {
9510
+ createdAt: string;
9511
+ fileRef: string;
9512
+ };
9513
+ }
9514
+ }
9515
+ }
9516
+ namespace $400 {
9517
+ namespace Content {
9518
+ interface ApplicationJson {
9519
+ [k: string]: unknown;
9520
+ }
9521
+ }
9522
+ }
9523
+ namespace $403 {
9524
+ namespace Content {
9525
+ interface ApplicationJson {
9526
+ [k: string]: unknown;
9527
+ }
9528
+ }
9529
+ }
9530
+ namespace Default {
9531
+ namespace Content {
9532
+ interface ApplicationJson {
9533
+ [k: string]: unknown;
9534
+ }
9535
+ }
9536
+ }
9537
+ }
9538
+ }
9539
+ }
9540
+ namespace V2ProjectsIdPageinsights {
9541
+ namespace Get {
9542
+ namespace Parameters {
9543
+ type Path = {
9544
+ id: string;
9545
+ };
9546
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
9547
+ type Query = {
9548
+ domain?: string;
9549
+ };
9550
+ }
9551
+ namespace Responses {
9552
+ namespace $200 {
9553
+ namespace Content {
9554
+ type ApplicationJson = {
9555
+ domain: string;
9556
+ paths: {
9557
+ createdAt: string;
9558
+ path: string;
9559
+ performanceScore: number;
9560
+ screenshotFileRef?: string;
9561
+ }[];
9562
+ }[];
9563
+ }
9564
+ }
9565
+ namespace $400 {
9566
+ namespace Content {
9567
+ interface ApplicationJson {
9568
+ [k: string]: unknown;
9569
+ }
9570
+ }
9571
+ }
9572
+ namespace $403 {
9573
+ namespace Content {
9574
+ interface ApplicationJson {
9575
+ [k: string]: unknown;
9576
+ }
9577
+ }
9578
+ }
9579
+ namespace Default {
9580
+ namespace Content {
9581
+ interface ApplicationJson {
9582
+ [k: string]: unknown;
9583
+ }
9584
+ }
9585
+ }
9586
+ }
9587
+ }
9588
+ }
9480
9589
  namespace V2PasswordPoliciesPath {
9481
9590
  namespace Get {
9482
9591
  namespace Parameters {
@@ -10604,6 +10713,13 @@ export declare module MittwaldAPIV2 {
10604
10713
  type ApplicationJson = MittwaldAPIV2.Components.Schemas.ProjectServer[];
10605
10714
  }
10606
10715
  }
10716
+ namespace $403 {
10717
+ namespace Content {
10718
+ interface ApplicationJson {
10719
+ [k: string]: unknown;
10720
+ }
10721
+ }
10722
+ }
10607
10723
  namespace Default {
10608
10724
  namespace Content {
10609
10725
  interface ApplicationJson {
@@ -11753,7 +11869,6 @@ export declare module MittwaldAPIV2 {
11753
11869
  }
11754
11870
  }
11755
11871
  }
11756
- namespace V2SignupPasswordResetConfirm { }
11757
11872
  namespace V2UsersSelfCredentialsPasswordConfirmReset {
11758
11873
  namespace Post {
11759
11874
  namespace Parameters {
@@ -12580,7 +12695,6 @@ export declare module MittwaldAPIV2 {
12580
12695
  }
12581
12696
  }
12582
12697
  }
12583
- namespace V2SignupPasswordReset { }
12584
12698
  namespace V2UsersSelfCredentialsActionsInitPasswordReset {
12585
12699
  namespace Post {
12586
12700
  namespace Parameters {
package/dist/esm/v2.js CHANGED
@@ -1,10 +1,15 @@
1
1
  import { ApiClientError } from "@mittwald/api-client-commons";
2
2
  import MittwaldApiV2Client from "./generated/v2/client.js";
3
+ import { MittwaldAPIClientVersion } from "./version.js";
4
+ const defaultUserAgent = "mittwald-api-client/" + MittwaldAPIClientVersion;
3
5
  export class MittwaldAPIClient extends MittwaldApiV2Client {
4
6
  apiToken;
5
7
  constructor(apiToken) {
6
8
  super({
7
9
  baseURL: "https://api.mittwald.de/",
10
+ headers: {
11
+ "User-Agent": defaultUserAgent,
12
+ },
8
13
  });
9
14
  this.apiToken = apiToken;
10
15
  this.setupInterceptors();
package/dist/esm/version.d.ts ADDED
@@ -0,0 +1 @@
1
+ export declare const MittwaldAPIClientVersion = "0.0.0-development";
package/dist/esm/version.js ADDED
@@ -0,0 +1 @@
1
+ export const MittwaldAPIClientVersion = "0.0.0-development";
package/dist/version.d.ts ADDED
@@ -0,0 +1 @@
1
+ export declare const MittwaldAPIClientVersion = '2.0.12';
package/dist/version.js ADDED
@@ -0,0 +1 @@
1
+ export const MittwaldAPIClientVersion = '2.0.12';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mittwald/api-client",
3
- "version": "2.0.10",
3
+ "version": "2.0.12",
4
4
  "description": "Auto-generated client for the mittwald API",
5
5
  "license": "MIT",
6
6
  "repository": "github:mittwald/api-client-js",