@mittwald/api-client 2.0.11 → 2.0.13

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/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
@@ -5118,7 +5118,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
5118
5118
  cname: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordCNAME;
5119
5119
  combinedARecords: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordCombinedA;
5120
5120
  mx: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordMX;
5121
- txt: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordTXT; /** Get settings for a given project ID */
5121
+ txt: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordTXT;
5122
5122
  };
5123
5123
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
5124
5124
  [x: string]: unknown;
@@ -5553,6 +5553,43 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
5553
5553
  jsonSchemaAdminC?: {} | undefined;
5554
5554
  jsonSchemaOwnerC: {};
5555
5555
  }, 200, "application/json">>>;
5556
+ /** Get File Service Reference for a Screenshot of a domain. */
5557
+ getScreenshotForDomain: (request: {
5558
+ data: {
5559
+ domainName: string;
5560
+ path: string;
5561
+ };
5562
+ pathParameters: {
5563
+ domainId: string;
5564
+ };
5565
+ headers?: {
5566
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
5567
+ "x-access-token"?: string | undefined;
5568
+ } | undefined;
5569
+ }) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
5570
+ data: {
5571
+ domainName: string;
5572
+ path: string;
5573
+ };
5574
+ } & {
5575
+ pathParameters: {
5576
+ domainId: string;
5577
+ };
5578
+ } & {
5579
+ headers?: Partial<{
5580
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5581
+ }> | undefined;
5582
+ } & {
5583
+ headers: {
5584
+ "x-access-token"?: string | undefined;
5585
+ } & Partial<{
5586
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5587
+ }>;
5588
+ }, import("@mittwald/api-client-commons").Response<{
5589
+ references?: string[] | undefined;
5590
+ }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
5591
+ [x: string]: unknown;
5592
+ }, 404, "application/json">>>;
5556
5593
  /** Get a domain ownership. */
5557
5594
  getSpecificDomainOwnership: (request: {
5558
5595
  pathParameters: {
@@ -6077,7 +6114,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
6077
6114
  max?: {
6078
6115
  height?: number | undefined;
6079
6116
  width?: number | undefined;
6080
- } | undefined; /** Delete a ProjectMembership. */
6117
+ } | undefined;
6081
6118
  min?: {
6082
6119
  height?: number | undefined;
6083
6120
  width?: number | undefined;
@@ -6113,7 +6150,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
6113
6150
  max?: {
6114
6151
  height?: number | undefined;
6115
6152
  width?: number | undefined;
6116
- } | undefined; /** Delete a ProjectMembership. */
6153
+ } | undefined;
6117
6154
  min?: {
6118
6155
  height?: number | undefined;
6119
6156
  width?: number | undefined;
@@ -6474,7 +6511,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
6474
6511
  current: {
6475
6512
  updatedAt: string;
6476
6513
  value: number;
6477
- };
6514
+ }; /** Get a specific ApiToken. */
6478
6515
  limit: number;
6479
6516
  };
6480
6517
  } | undefined;
@@ -339,6 +339,8 @@ class MittwaldAPIV2Client extends api_client_commons_1.ApiClientBase {
339
339
  deleteDomain: this.requestFunctionFactory(descriptors.domainDeleteDomain),
340
340
  /** Get a HandleSchema. */
341
341
  getHandleFields: this.requestFunctionFactory(descriptors.domainGetHandleFields),
342
+ /** Get File Service Reference for a Screenshot of a domain. */
343
+ getScreenshotForDomain: this.requestFunctionFactory(descriptors.domainGetScreenshotForDomain),
342
344
  /** Get a domain ownership. */
343
345
  getSpecificDomainOwnership: this.requestFunctionFactory(descriptors.domainGetSpecificDomainOwnership),
344
346
  /** Verify a domain ownership. */
@@ -285,6 +285,8 @@ export declare const domainGetDomain: OpenAPIOperation<RequestType<Simplify<null
285
285
  export declare const domainDeleteDomain: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
286
286
  /** Get a HandleSchema. */
287
287
  export declare const domainGetHandleFields: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2DomainsHandleSchemaDomainName.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DomainsHandleSchemaDomainName.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DomainsHandleSchemaDomainName.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DomainsHandleSchemaDomainName.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsHandleSchemaDomainName.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
288
+ /** Get File Service Reference for a Screenshot of a domain. */
289
+ export declare const domainGetScreenshotForDomain: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdScreenshotsNewest.Get.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdScreenshotsNewest.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdScreenshotsNewest.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdScreenshotsNewest.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdScreenshotsNewest.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdScreenshotsNewest.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdScreenshotsNewest.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
288
290
  /** Get a domain ownership. */
289
291
  export declare const domainGetSpecificDomainOwnership: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2DomainOwnershipsDomainOwnershipId.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DomainOwnershipsDomainOwnershipId.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DomainOwnershipsDomainOwnershipId.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DomainOwnershipsDomainOwnershipId.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainOwnershipsDomainOwnershipId.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainOwnershipsDomainOwnershipId.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainOwnershipsDomainOwnershipId.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
290
292
  /** Verify a domain ownership. */
@@ -399,6 +401,10 @@ export declare const orderListProjectOrders: OpenAPIOperation<RequestType<Simpli
399
401
  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
402
  /** Preview TariffChange. */
401
403
  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">>;
404
+ /** Get detailed performance data for a given domain and path. */
405
+ 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">>;
406
+ /** List websites (specified as domain and path) from a project where performance data is available. */
407
+ 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
408
  /** Get a password policy. */
403
409
  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
410
  /** Accept a ProjectInvite. */
@@ -2,10 +2,10 @@
2
2
  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
- 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;
5
+ exports.fileCreateFile = exports.domainResendDomainEmail = exports.domainListToplevelDomains = exports.domainListDomains = exports.domainListDomainOwnerships = exports.domainGetToplevelDomain = 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.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.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 = exports.fileGetFileMeta = void 0;
7
+ 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 = exports.pageinsightsListPerformanceDataForProject = 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 = exports.userAuthenticateMfa = 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}",
@@ -852,6 +852,12 @@ exports.domainGetHandleFields = {
852
852
  method: "GET",
853
853
  operationId: "domain-get-handle-fields",
854
854
  };
855
+ /** Get File Service Reference for a Screenshot of a domain. */
856
+ exports.domainGetScreenshotForDomain = {
857
+ path: "/v2/domains/{domainId}/screenshots/newest",
858
+ method: "GET",
859
+ operationId: "domain-get-screenshot-for-domain",
860
+ };
855
861
  /** Get a domain ownership. */
856
862
  exports.domainGetSpecificDomainOwnership = {
857
863
  path: "/v2/domain-ownerships/{domainOwnershipId}",
@@ -1194,6 +1200,18 @@ exports.orderPreviewTariffChange = {
1194
1200
  method: "POST",
1195
1201
  operationId: "order-preview-tariff-change",
1196
1202
  };
1203
+ /** Get detailed performance data for a given domain and path. */
1204
+ exports.pageinsightsGetPerformanceData = {
1205
+ path: "/v2/pageinsights",
1206
+ method: "GET",
1207
+ operationId: "pageinsights-get-performance-data",
1208
+ };
1209
+ /** List websites (specified as domain and path) from a project where performance data is available. */
1210
+ exports.pageinsightsListPerformanceDataForProject = {
1211
+ path: "/v2/projects/{id}/pageinsights",
1212
+ method: "GET",
1213
+ operationId: "pageinsights-list-performance-data-for-project",
1214
+ };
1197
1215
  /** Get a password policy. */
1198
1216
  exports.passwordValidationGetPasswordPolicy = {
1199
1217
  path: "/v2/password/policies/{path}",
@@ -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
  /**
@@ -1497,6 +1497,28 @@ export declare module MittwaldAPIV2 {
1497
1497
  domainOwnerData?: string;
1498
1498
  name: string;
1499
1499
  }
1500
+ interface ScreenshotTarget {
1501
+ domain: string;
1502
+ path?: string;
1503
+ scheme: "http" | "https";
1504
+ }
1505
+ interface ScreenshotTask {
1506
+ executedAt?: string;
1507
+ fileReference?: string;
1508
+ id: string;
1509
+ priority: number;
1510
+ settings: MittwaldAPIV2.Components.Schemas.ScreenshotScreenshotSettings;
1511
+ target: MittwaldAPIV2.Components.Schemas.ScreenshotTarget;
1512
+ taskState?: MittwaldAPIV2.Components.Schemas.ScreenshotLifecycleState | MittwaldAPIV2.Components.Schemas.CommonsError;
1513
+ }
1514
+ type ScreenshotLifecycleState = string;
1515
+ interface ScreenshotScreenshotSettings {
1516
+ dataType: "jpeg" | "png" | "webp";
1517
+ delay: number;
1518
+ height: number;
1519
+ quality: number;
1520
+ width: number;
1521
+ }
1500
1522
  interface DomainEmptyResponse {
1501
1523
  error_props: {};
1502
1524
  error_reason: string;
@@ -6562,8 +6584,10 @@ export declare module MittwaldAPIV2 {
6562
6584
  namespace V2NewsletterSubscriptionsEmail { }
6563
6585
  namespace V2NewsletterSubscriptions { }
6564
6586
  namespace V2SignupEmail { }
6587
+ namespace V2SignupPasswordResetConfirm { }
6565
6588
  namespace V2SignupTokenApiApiTokenId { }
6566
6589
  namespace V2SignupSshSshKeyId { }
6590
+ namespace V2SignupPasswordReset { }
6567
6591
  namespace V2SignupLogout { }
6568
6592
  namespace V2SignupEmailResend { }
6569
6593
  namespace V2UserUserIdAvatar { }
@@ -7346,6 +7370,44 @@ export declare module MittwaldAPIV2 {
7346
7370
  }
7347
7371
  }
7348
7372
  }
7373
+ namespace V2DomainsDomainIdScreenshotsNewest {
7374
+ namespace Get {
7375
+ namespace Parameters {
7376
+ type Path = {
7377
+ domainId: string;
7378
+ };
7379
+ interface RequestBody {
7380
+ domainName: string;
7381
+ path: string;
7382
+ }
7383
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
7384
+ type Query = {};
7385
+ }
7386
+ namespace Responses {
7387
+ namespace $200 {
7388
+ namespace Content {
7389
+ interface ApplicationJson {
7390
+ references?: string[];
7391
+ }
7392
+ }
7393
+ }
7394
+ namespace $404 {
7395
+ namespace Content {
7396
+ interface ApplicationJson {
7397
+ [k: string]: unknown;
7398
+ }
7399
+ }
7400
+ }
7401
+ namespace Default {
7402
+ namespace Content {
7403
+ interface ApplicationJson {
7404
+ [k: string]: unknown;
7405
+ }
7406
+ }
7407
+ }
7408
+ }
7409
+ }
7410
+ }
7349
7411
  namespace V2DomainOwnershipsDomainOwnershipId {
7350
7412
  namespace Get {
7351
7413
  namespace Parameters {
@@ -9478,6 +9540,112 @@ export declare module MittwaldAPIV2 {
9478
9540
  }
9479
9541
  }
9480
9542
  }
9543
+ namespace V2Pageinsights {
9544
+ namespace Get {
9545
+ namespace Parameters {
9546
+ type Path = {};
9547
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
9548
+ type Query = {
9549
+ domain: string;
9550
+ path: string;
9551
+ date?: string;
9552
+ };
9553
+ }
9554
+ namespace Responses {
9555
+ namespace $200 {
9556
+ namespace Content {
9557
+ interface ApplicationJson {
9558
+ createdAt?: string;
9559
+ domain: string;
9560
+ metrics?: {
9561
+ createdAt: string;
9562
+ name: string;
9563
+ score: number;
9564
+ value: number;
9565
+ }[];
9566
+ moreDataAvailable?: string[];
9567
+ path: string;
9568
+ performanceScore: number;
9569
+ screenshot?: {
9570
+ createdAt: string;
9571
+ fileRef: string;
9572
+ };
9573
+ }
9574
+ }
9575
+ }
9576
+ namespace $400 {
9577
+ namespace Content {
9578
+ interface ApplicationJson {
9579
+ [k: string]: unknown;
9580
+ }
9581
+ }
9582
+ }
9583
+ namespace $403 {
9584
+ namespace Content {
9585
+ interface ApplicationJson {
9586
+ [k: string]: unknown;
9587
+ }
9588
+ }
9589
+ }
9590
+ namespace Default {
9591
+ namespace Content {
9592
+ interface ApplicationJson {
9593
+ [k: string]: unknown;
9594
+ }
9595
+ }
9596
+ }
9597
+ }
9598
+ }
9599
+ }
9600
+ namespace V2ProjectsIdPageinsights {
9601
+ namespace Get {
9602
+ namespace Parameters {
9603
+ type Path = {
9604
+ id: string;
9605
+ };
9606
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
9607
+ type Query = {
9608
+ domain?: string;
9609
+ };
9610
+ }
9611
+ namespace Responses {
9612
+ namespace $200 {
9613
+ namespace Content {
9614
+ type ApplicationJson = {
9615
+ domain: string;
9616
+ paths: {
9617
+ createdAt: string;
9618
+ path: string;
9619
+ performanceScore: number;
9620
+ screenshotFileRef?: string;
9621
+ }[];
9622
+ }[];
9623
+ }
9624
+ }
9625
+ namespace $400 {
9626
+ namespace Content {
9627
+ interface ApplicationJson {
9628
+ [k: string]: unknown;
9629
+ }
9630
+ }
9631
+ }
9632
+ namespace $403 {
9633
+ namespace Content {
9634
+ interface ApplicationJson {
9635
+ [k: string]: unknown;
9636
+ }
9637
+ }
9638
+ }
9639
+ namespace Default {
9640
+ namespace Content {
9641
+ interface ApplicationJson {
9642
+ [k: string]: unknown;
9643
+ }
9644
+ }
9645
+ }
9646
+ }
9647
+ }
9648
+ }
9481
9649
  namespace V2PasswordPoliciesPath {
9482
9650
  namespace Get {
9483
9651
  namespace Parameters {
@@ -11761,7 +11929,6 @@ export declare module MittwaldAPIV2 {
11761
11929
  }
11762
11930
  }
11763
11931
  }
11764
- namespace V2SignupPasswordResetConfirm { }
11765
11932
  namespace V2UsersSelfCredentialsPasswordConfirmReset {
11766
11933
  namespace Post {
11767
11934
  namespace Parameters {
@@ -12588,7 +12755,6 @@ export declare module MittwaldAPIV2 {
12588
12755
  }
12589
12756
  }
12590
12757
  }
12591
- namespace V2SignupPasswordReset { }
12592
12758
  namespace V2UsersSelfCredentialsActionsInitPasswordReset {
12593
12759
  namespace Post {
12594
12760
  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();
@@ -0,0 +1 @@
1
+ export declare const MittwaldAPIClientVersion = "0.0.0-development";
@@ -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";
@@ -5118,7 +5118,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
5118
5118
  cname: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordCNAME;
5119
5119
  combinedARecords: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordCombinedA;
5120
5120
  mx: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordMX;
5121
- txt: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordTXT; /** Get settings for a given project ID */
5121
+ txt: import("./types.js").MittwaldAPIV2.Components.Schemas.DnsRecordTXT;
5122
5122
  };
5123
5123
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
5124
5124
  [x: string]: unknown;
@@ -5553,6 +5553,43 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
5553
5553
  jsonSchemaAdminC?: {} | undefined;
5554
5554
  jsonSchemaOwnerC: {};
5555
5555
  }, 200, "application/json">>>;
5556
+ /** Get File Service Reference for a Screenshot of a domain. */
5557
+ getScreenshotForDomain: (request: {
5558
+ data: {
5559
+ domainName: string;
5560
+ path: string;
5561
+ };
5562
+ pathParameters: {
5563
+ domainId: string;
5564
+ };
5565
+ headers?: {
5566
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
5567
+ "x-access-token"?: string | undefined;
5568
+ } | undefined;
5569
+ }) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
5570
+ data: {
5571
+ domainName: string;
5572
+ path: string;
5573
+ };
5574
+ } & {
5575
+ pathParameters: {
5576
+ domainId: string;
5577
+ };
5578
+ } & {
5579
+ headers?: Partial<{
5580
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5581
+ }> | undefined;
5582
+ } & {
5583
+ headers: {
5584
+ "x-access-token"?: string | undefined;
5585
+ } & Partial<{
5586
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5587
+ }>;
5588
+ }, import("@mittwald/api-client-commons").Response<{
5589
+ references?: string[] | undefined;
5590
+ }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
5591
+ [x: string]: unknown;
5592
+ }, 404, "application/json">>>;
5556
5593
  /** Get a domain ownership. */
5557
5594
  getSpecificDomainOwnership: (request: {
5558
5595
  pathParameters: {
@@ -6077,7 +6114,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
6077
6114
  max?: {
6078
6115
  height?: number | undefined;
6079
6116
  width?: number | undefined;
6080
- } | undefined; /** Delete a ProjectMembership. */
6117
+ } | undefined;
6081
6118
  min?: {
6082
6119
  height?: number | undefined;
6083
6120
  width?: number | undefined;
@@ -6113,7 +6150,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
6113
6150
  max?: {
6114
6151
  height?: number | undefined;
6115
6152
  width?: number | undefined;
6116
- } | undefined; /** Delete a ProjectMembership. */
6153
+ } | undefined;
6117
6154
  min?: {
6118
6155
  height?: number | undefined;
6119
6156
  width?: number | undefined;
@@ -6474,7 +6511,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
6474
6511
  current: {
6475
6512
  updatedAt: string;
6476
6513
  value: number;
6477
- };
6514
+ }; /** Get a specific ApiToken. */
6478
6515
  limit: number;
6479
6516
  };
6480
6517
  } | undefined;
@@ -334,6 +334,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
334
334
  deleteDomain: this.requestFunctionFactory(descriptors.domainDeleteDomain),
335
335
  /** Get a HandleSchema. */
336
336
  getHandleFields: this.requestFunctionFactory(descriptors.domainGetHandleFields),
337
+ /** Get File Service Reference for a Screenshot of a domain. */
338
+ getScreenshotForDomain: this.requestFunctionFactory(descriptors.domainGetScreenshotForDomain),
337
339
  /** Get a domain ownership. */
338
340
  getSpecificDomainOwnership: this.requestFunctionFactory(descriptors.domainGetSpecificDomainOwnership),
339
341
  /** Verify a domain ownership. */
@@ -285,6 +285,8 @@ export declare const domainGetDomain: OpenAPIOperation<RequestType<Simplify<null
285
285
  export declare const domainDeleteDomain: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainId.Delete.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
286
286
  /** Get a HandleSchema. */
287
287
  export declare const domainGetHandleFields: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2DomainsHandleSchemaDomainName.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DomainsHandleSchemaDomainName.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DomainsHandleSchemaDomainName.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DomainsHandleSchemaDomainName.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsHandleSchemaDomainName.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
288
+ /** Get File Service Reference for a Screenshot of a domain. */
289
+ export declare const domainGetScreenshotForDomain: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdScreenshotsNewest.Get.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdScreenshotsNewest.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdScreenshotsNewest.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdScreenshotsNewest.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdScreenshotsNewest.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdScreenshotsNewest.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainsDomainIdScreenshotsNewest.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
288
290
  /** Get a domain ownership. */
289
291
  export declare const domainGetSpecificDomainOwnership: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2DomainOwnershipsDomainOwnershipId.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DomainOwnershipsDomainOwnershipId.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DomainOwnershipsDomainOwnershipId.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DomainOwnershipsDomainOwnershipId.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainOwnershipsDomainOwnershipId.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainOwnershipsDomainOwnershipId.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DomainOwnershipsDomainOwnershipId.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
290
292
  /** Verify a domain ownership. */
@@ -399,6 +401,10 @@ export declare const orderListProjectOrders: OpenAPIOperation<RequestType<Simpli
399
401
  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
402
  /** Preview TariffChange. */
401
403
  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">>;
404
+ /** Get detailed performance data for a given domain and path. */
405
+ 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">>;
406
+ /** List websites (specified as domain and path) from a project where performance data is available. */
407
+ 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
408
  /** Get a password policy. */
403
409
  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
410
  /** Accept a ProjectInvite. */
@@ -844,6 +844,12 @@ export const domainGetHandleFields = {
844
844
  method: "GET",
845
845
  operationId: "domain-get-handle-fields",
846
846
  };
847
+ /** Get File Service Reference for a Screenshot of a domain. */
848
+ export const domainGetScreenshotForDomain = {
849
+ path: "/v2/domains/{domainId}/screenshots/newest",
850
+ method: "GET",
851
+ operationId: "domain-get-screenshot-for-domain",
852
+ };
847
853
  /** Get a domain ownership. */
848
854
  export const domainGetSpecificDomainOwnership = {
849
855
  path: "/v2/domain-ownerships/{domainOwnershipId}",
@@ -1186,6 +1192,18 @@ export const orderPreviewTariffChange = {
1186
1192
  method: "POST",
1187
1193
  operationId: "order-preview-tariff-change",
1188
1194
  };
1195
+ /** Get detailed performance data for a given domain and path. */
1196
+ export const pageinsightsGetPerformanceData = {
1197
+ path: "/v2/pageinsights",
1198
+ method: "GET",
1199
+ operationId: "pageinsights-get-performance-data",
1200
+ };
1201
+ /** List websites (specified as domain and path) from a project where performance data is available. */
1202
+ export const pageinsightsListPerformanceDataForProject = {
1203
+ path: "/v2/projects/{id}/pageinsights",
1204
+ method: "GET",
1205
+ operationId: "pageinsights-list-performance-data-for-project",
1206
+ };
1189
1207
  /** Get a password policy. */
1190
1208
  export const passwordValidationGetPasswordPolicy = {
1191
1209
  path: "/v2/password/policies/{path}",
@@ -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
  /**
@@ -1497,6 +1497,28 @@ export declare module MittwaldAPIV2 {
1497
1497
  domainOwnerData?: string;
1498
1498
  name: string;
1499
1499
  }
1500
+ interface ScreenshotTarget {
1501
+ domain: string;
1502
+ path?: string;
1503
+ scheme: "http" | "https";
1504
+ }
1505
+ interface ScreenshotTask {
1506
+ executedAt?: string;
1507
+ fileReference?: string;
1508
+ id: string;
1509
+ priority: number;
1510
+ settings: MittwaldAPIV2.Components.Schemas.ScreenshotScreenshotSettings;
1511
+ target: MittwaldAPIV2.Components.Schemas.ScreenshotTarget;
1512
+ taskState?: MittwaldAPIV2.Components.Schemas.ScreenshotLifecycleState | MittwaldAPIV2.Components.Schemas.CommonsError;
1513
+ }
1514
+ type ScreenshotLifecycleState = string;
1515
+ interface ScreenshotScreenshotSettings {
1516
+ dataType: "jpeg" | "png" | "webp";
1517
+ delay: number;
1518
+ height: number;
1519
+ quality: number;
1520
+ width: number;
1521
+ }
1500
1522
  interface DomainEmptyResponse {
1501
1523
  error_props: {};
1502
1524
  error_reason: string;
@@ -6562,8 +6584,10 @@ export declare module MittwaldAPIV2 {
6562
6584
  namespace V2NewsletterSubscriptionsEmail { }
6563
6585
  namespace V2NewsletterSubscriptions { }
6564
6586
  namespace V2SignupEmail { }
6587
+ namespace V2SignupPasswordResetConfirm { }
6565
6588
  namespace V2SignupTokenApiApiTokenId { }
6566
6589
  namespace V2SignupSshSshKeyId { }
6590
+ namespace V2SignupPasswordReset { }
6567
6591
  namespace V2SignupLogout { }
6568
6592
  namespace V2SignupEmailResend { }
6569
6593
  namespace V2UserUserIdAvatar { }
@@ -7346,6 +7370,44 @@ export declare module MittwaldAPIV2 {
7346
7370
  }
7347
7371
  }
7348
7372
  }
7373
+ namespace V2DomainsDomainIdScreenshotsNewest {
7374
+ namespace Get {
7375
+ namespace Parameters {
7376
+ type Path = {
7377
+ domainId: string;
7378
+ };
7379
+ interface RequestBody {
7380
+ domainName: string;
7381
+ path: string;
7382
+ }
7383
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
7384
+ type Query = {};
7385
+ }
7386
+ namespace Responses {
7387
+ namespace $200 {
7388
+ namespace Content {
7389
+ interface ApplicationJson {
7390
+ references?: string[];
7391
+ }
7392
+ }
7393
+ }
7394
+ namespace $404 {
7395
+ namespace Content {
7396
+ interface ApplicationJson {
7397
+ [k: string]: unknown;
7398
+ }
7399
+ }
7400
+ }
7401
+ namespace Default {
7402
+ namespace Content {
7403
+ interface ApplicationJson {
7404
+ [k: string]: unknown;
7405
+ }
7406
+ }
7407
+ }
7408
+ }
7409
+ }
7410
+ }
7349
7411
  namespace V2DomainOwnershipsDomainOwnershipId {
7350
7412
  namespace Get {
7351
7413
  namespace Parameters {
@@ -9478,6 +9540,112 @@ export declare module MittwaldAPIV2 {
9478
9540
  }
9479
9541
  }
9480
9542
  }
9543
+ namespace V2Pageinsights {
9544
+ namespace Get {
9545
+ namespace Parameters {
9546
+ type Path = {};
9547
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
9548
+ type Query = {
9549
+ domain: string;
9550
+ path: string;
9551
+ date?: string;
9552
+ };
9553
+ }
9554
+ namespace Responses {
9555
+ namespace $200 {
9556
+ namespace Content {
9557
+ interface ApplicationJson {
9558
+ createdAt?: string;
9559
+ domain: string;
9560
+ metrics?: {
9561
+ createdAt: string;
9562
+ name: string;
9563
+ score: number;
9564
+ value: number;
9565
+ }[];
9566
+ moreDataAvailable?: string[];
9567
+ path: string;
9568
+ performanceScore: number;
9569
+ screenshot?: {
9570
+ createdAt: string;
9571
+ fileRef: string;
9572
+ };
9573
+ }
9574
+ }
9575
+ }
9576
+ namespace $400 {
9577
+ namespace Content {
9578
+ interface ApplicationJson {
9579
+ [k: string]: unknown;
9580
+ }
9581
+ }
9582
+ }
9583
+ namespace $403 {
9584
+ namespace Content {
9585
+ interface ApplicationJson {
9586
+ [k: string]: unknown;
9587
+ }
9588
+ }
9589
+ }
9590
+ namespace Default {
9591
+ namespace Content {
9592
+ interface ApplicationJson {
9593
+ [k: string]: unknown;
9594
+ }
9595
+ }
9596
+ }
9597
+ }
9598
+ }
9599
+ }
9600
+ namespace V2ProjectsIdPageinsights {
9601
+ namespace Get {
9602
+ namespace Parameters {
9603
+ type Path = {
9604
+ id: string;
9605
+ };
9606
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
9607
+ type Query = {
9608
+ domain?: string;
9609
+ };
9610
+ }
9611
+ namespace Responses {
9612
+ namespace $200 {
9613
+ namespace Content {
9614
+ type ApplicationJson = {
9615
+ domain: string;
9616
+ paths: {
9617
+ createdAt: string;
9618
+ path: string;
9619
+ performanceScore: number;
9620
+ screenshotFileRef?: string;
9621
+ }[];
9622
+ }[];
9623
+ }
9624
+ }
9625
+ namespace $400 {
9626
+ namespace Content {
9627
+ interface ApplicationJson {
9628
+ [k: string]: unknown;
9629
+ }
9630
+ }
9631
+ }
9632
+ namespace $403 {
9633
+ namespace Content {
9634
+ interface ApplicationJson {
9635
+ [k: string]: unknown;
9636
+ }
9637
+ }
9638
+ }
9639
+ namespace Default {
9640
+ namespace Content {
9641
+ interface ApplicationJson {
9642
+ [k: string]: unknown;
9643
+ }
9644
+ }
9645
+ }
9646
+ }
9647
+ }
9648
+ }
9481
9649
  namespace V2PasswordPoliciesPath {
9482
9650
  namespace Get {
9483
9651
  namespace Parameters {
@@ -11761,7 +11929,6 @@ export declare module MittwaldAPIV2 {
11761
11929
  }
11762
11930
  }
11763
11931
  }
11764
- namespace V2SignupPasswordResetConfirm { }
11765
11932
  namespace V2UsersSelfCredentialsPasswordConfirmReset {
11766
11933
  namespace Post {
11767
11934
  namespace Parameters {
@@ -12588,7 +12755,6 @@ export declare module MittwaldAPIV2 {
12588
12755
  }
12589
12756
  }
12590
12757
  }
12591
- namespace V2SignupPasswordReset { }
12592
12758
  namespace V2UsersSelfCredentialsActionsInitPasswordReset {
12593
12759
  namespace Post {
12594
12760
  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();
@@ -0,0 +1 @@
1
+ export declare const MittwaldAPIClientVersion = "0.0.0-development";
@@ -0,0 +1 @@
1
+ export const MittwaldAPIClientVersion = "0.0.0-development";
@@ -0,0 +1 @@
1
+ export declare const MittwaldAPIClientVersion = '2.0.13';
@@ -0,0 +1 @@
1
+ export const MittwaldAPIClientVersion = '2.0.13';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mittwald/api-client",
3
- "version": "2.0.11",
3
+ "version": "2.0.13",
4
4
  "description": "Auto-generated client for the mittwald API",
5
5
  "license": "MIT",
6
6
  "repository": "github:mittwald/api-client-js",