@mittwald/api-client 4.93.1 → 4.95.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -160,12 +160,12 @@ const buildDatabaseApi = (baseClient) => ({
160
160
  listRedisVersions: new ApiCallAsyncResourceFactory(descriptors.databaseListRedisVersions, baseClient.database.listRedisVersions).getApiResource,
161
161
  });
162
162
  const buildDomainApi = (baseClient) => ({
163
+ /** List Domains */
164
+ listDomains: new ApiCallAsyncResourceFactory(descriptors.domainListDomains, baseClient.domain.listDomains).getApiResource,
163
165
  /** Get a DNSZone. */
164
166
  dnsGetDnsZone: new ApiCallAsyncResourceFactory(descriptors.dnsGetDnsZone, baseClient.domain.dnsGetDnsZone).getApiResource,
165
167
  /** List DNSZones belonging to a Project. */
166
168
  dnsListDnsZones: new ApiCallAsyncResourceFactory(descriptors.dnsListDnsZones, baseClient.domain.dnsListDnsZones).getApiResource,
167
- /** List Domains */
168
- listDomains: new ApiCallAsyncResourceFactory(descriptors.domainListDomains, baseClient.domain.listDomains).getApiResource,
169
169
  /** Get a Domain. */
170
170
  getDomain: new ApiCallAsyncResourceFactory(descriptors.domainGetDomain, baseClient.domain.getDomain).getApiResource,
171
171
  /** Get the latest screenshot's FileReference belonging to a Domain. */
@@ -345,25 +345,16 @@ export class MittwaldAPIV2Client extends ApiClientBase {
345
345
  /** Update a RedisDatabase's description. */
346
346
  updateRedisDatabaseDescription: this.requestFunctionFactory(descriptors.databaseUpdateRedisDatabaseDescription),
347
347
  };
348
- /** The notification API allows you to manage your notifications. */
349
- notification = {
350
- /** Subscribe a user to the mStudio newsletter. */
351
- newsletterSubscribeUser: this.requestFunctionFactory(descriptors.newsletterSubscribeUser),
352
- /** Getting the subscription status of the subscription. */
353
- newsletterGetInfo: this.requestFunctionFactory(descriptors.newsletterGetInfo),
354
- /** Unsubscribe a user from the mStudio newsletter. */
355
- newsletterUnsubscribeUser: this.requestFunctionFactory(descriptors.newsletterUnsubscribeUser),
356
- /** Get the counts for unread notifications of the user. */
357
- scountUnreadNotifications: this.requestFunctionFactory(descriptors.notificationsCountUnreadNotifications),
358
- /** List all unread notifications. */
359
- slistNotifications: this.requestFunctionFactory(descriptors.notificationsListNotifications),
360
- /** Mark all notifications as read. */
361
- sreadAllNotifications: this.requestFunctionFactory(descriptors.notificationsReadAllNotifications),
362
- /** Mark notification as read. */
363
- sreadNotification: this.requestFunctionFactory(descriptors.notificationsReadNotification),
364
- };
365
348
  /** The domain API allows you to manage your domains, DNS records, SSL certificates and ingress resources. */
366
349
  domain = {
350
+ /** List Domains */
351
+ listDomains: this.requestFunctionFactory(descriptors.domainListDomains),
352
+ /** Update the nameservers of a Domain. */
353
+ updateDomainNameservers: this.requestFunctionFactory(descriptors.domainUpdateDomainNameservers),
354
+ /** Update the paths of an Ingress. */
355
+ ingressUpdateIngressPaths: this.requestFunctionFactory(descriptors.ingressUpdateIngressPaths),
356
+ /** Update the tls settings of an Ingress. */
357
+ ingressUpdateIngressTls: this.requestFunctionFactory(descriptors.ingressUpdateIngressTls),
367
358
  /** Create a DNSZone. */
368
359
  dnsCreateDnsZone: this.requestFunctionFactory(descriptors.dnsCreateDnsZone),
369
360
  /** Get a DNSZone. */
@@ -380,14 +371,10 @@ export class MittwaldAPIV2Client extends ApiClientBase {
380
371
  abortDomainDeclaration: this.requestFunctionFactory(descriptors.domainAbortDomainDeclaration),
381
372
  /** Check if a Domain is available to register. */
382
373
  checkDomainRegistrability: this.requestFunctionFactory(descriptors.domainCheckDomainRegistrability),
383
- /** List Domains */
384
- listDomains: this.requestFunctionFactory(descriptors.domainListDomains),
385
374
  /** Check if a Domain is available to transfer. */
386
375
  checkDomainTransferability: this.requestFunctionFactory(descriptors.domainCheckDomainTransferability),
387
376
  /** Create an auth code for a Domains transfer-out process. */
388
377
  createDomainAuthCode: this.requestFunctionFactory(descriptors.domainCreateDomainAuthCode),
389
- /** Update the nameservers of a Domain. */
390
- updateDomainNameservers: this.requestFunctionFactory(descriptors.domainUpdateDomainNameservers),
391
378
  /** Get a Domain. */
392
379
  getDomain: this.requestFunctionFactory(descriptors.domainGetDomain),
393
380
  /** Delete a Domain. */
@@ -420,12 +407,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
420
407
  ingressIngressVerifyOwnership: this.requestFunctionFactory(descriptors.ingressIngressVerifyOwnership),
421
408
  /** List Ingresses compatible with a certificate. */
422
409
  ingressListIngressesCompatibleWithCertificate: this.requestFunctionFactory(descriptors.ingressListIngressesCompatibleWithCertificate),
423
- /** Update the paths of an Ingress. */
424
- ingressUpdateIngressPaths: this.requestFunctionFactory(descriptors.ingressUpdateIngressPaths),
425
410
  /** Request the ACME certificate issuance of an Ingress. */
426
411
  ingressRequestIngressAcmeCertificateIssuance: this.requestFunctionFactory(descriptors.ingressRequestIngressAcmeCertificateIssuance),
427
- /** Update the tls settings of an Ingress. */
428
- ingressUpdateIngressTls: this.requestFunctionFactory(descriptors.ingressUpdateIngressTls),
429
412
  /** Check the replacement of a Certificate. */
430
413
  sslCheckReplaceCertificate: this.requestFunctionFactory(descriptors.sslCheckReplaceCertificate),
431
414
  /** List CertificateRequests belonging to a Project or an Ingress. */
@@ -445,23 +428,18 @@ export class MittwaldAPIV2Client extends ApiClientBase {
445
428
  /** List Certificates belonging to a Project or an Ingress. */
446
429
  sslListCertificates: this.requestFunctionFactory(descriptors.sslListCertificates),
447
430
  };
448
- /** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
449
- file = {
450
- /** Create a File. */
451
- createFile: this.requestFunctionFactory(descriptors.fileCreateFile),
452
- /** Get a File's meta. */
453
- getFileMeta: this.requestFunctionFactory(descriptors.fileGetFileMeta),
454
- /** Get a FileUploadToken's rules. */
455
- getFileUploadTokenRules: this.requestFunctionFactory(descriptors.fileGetFileUploadTokenRules),
456
- /** Get a FileUploadType's rules. */
457
- getFileUploadTypeRules: this.requestFunctionFactory(descriptors.fileGetFileUploadTypeRules),
458
- /** Get a File. */
459
- getFile: this.requestFunctionFactory(descriptors.fileGetFile),
460
- /** Get a File with user-friendly url. */
461
- getFileWithName: this.requestFunctionFactory(descriptors.fileGetFileWithName),
462
- };
463
431
  /** The mail API allows you to manage your mail accounts. */
464
432
  mail = {
433
+ /** Update the autoresponder of a MailAddress. */
434
+ updateMailAddressAutoresponder: this.requestFunctionFactory(descriptors.mailUpdateMailAddressAutoresponder),
435
+ /** Update the forward addresses of a MailAddresses. */
436
+ updateMailAddressForwardAddresses: this.requestFunctionFactory(descriptors.mailUpdateMailAddressForwardAddresses),
437
+ /** Update the password for a MailAddress. */
438
+ updateMailAddressPassword: this.requestFunctionFactory(descriptors.mailUpdateMailAddressPassword),
439
+ /** Update the quota of a MailAddress. */
440
+ updateMailAddressQuota: this.requestFunctionFactory(descriptors.mailUpdateMailAddressQuota),
441
+ /** Update the spam protection of a MailAddress. */
442
+ updateMailAddressSpamProtection: this.requestFunctionFactory(descriptors.mailUpdateMailAddressSpamProtection),
465
443
  /** List DeliveryBoxes belonging to a Project. */
466
444
  listDeliveryBoxes: this.requestFunctionFactory(descriptors.mailListDeliveryBoxes),
467
445
  /** Create a DeliveryBox. */
@@ -486,21 +464,43 @@ export class MittwaldAPIV2Client extends ApiClientBase {
486
464
  updateDeliveryBoxPassword: this.requestFunctionFactory(descriptors.mailUpdateDeliveryBoxPassword),
487
465
  /** Update a MailAddress. */
488
466
  updateMailAddressAddress: this.requestFunctionFactory(descriptors.mailUpdateMailAddressAddress),
489
- /** Update the autoresponder of a MailAddress. */
490
- updateMailAddressAutoresponder: this.requestFunctionFactory(descriptors.mailUpdateMailAddressAutoresponder),
491
467
  /** Update the catchall of a MailAddress. */
492
468
  updateMailAddressCatchAll: this.requestFunctionFactory(descriptors.mailUpdateMailAddressCatchAll),
493
- /** Update the forward addresses of a MailAddresses. */
494
- updateMailAddressForwardAddresses: this.requestFunctionFactory(descriptors.mailUpdateMailAddressForwardAddresses),
495
- /** Update the password for a MailAddress. */
496
- updateMailAddressPassword: this.requestFunctionFactory(descriptors.mailUpdateMailAddressPassword),
497
- /** Update the quota of a MailAddress. */
498
- updateMailAddressQuota: this.requestFunctionFactory(descriptors.mailUpdateMailAddressQuota),
499
- /** Update the spam protection of a MailAddress. */
500
- updateMailAddressSpamProtection: this.requestFunctionFactory(descriptors.mailUpdateMailAddressSpamProtection),
501
469
  /** Update a mail setting of a Project. */
502
470
  updateProjectMailSetting: this.requestFunctionFactory(descriptors.mailUpdateProjectMailSetting),
503
471
  };
472
+ /** The notification API allows you to manage your notifications. */
473
+ notification = {
474
+ /** Subscribe a user to the mStudio newsletter. */
475
+ newsletterSubscribeUser: this.requestFunctionFactory(descriptors.newsletterSubscribeUser),
476
+ /** Getting the subscription status of the subscription. */
477
+ newsletterGetInfo: this.requestFunctionFactory(descriptors.newsletterGetInfo),
478
+ /** Unsubscribe a user from the mStudio newsletter. */
479
+ newsletterUnsubscribeUser: this.requestFunctionFactory(descriptors.newsletterUnsubscribeUser),
480
+ /** Get the counts for unread notifications of the user. */
481
+ scountUnreadNotifications: this.requestFunctionFactory(descriptors.notificationsCountUnreadNotifications),
482
+ /** List all unread notifications. */
483
+ slistNotifications: this.requestFunctionFactory(descriptors.notificationsListNotifications),
484
+ /** Mark all notifications as read. */
485
+ sreadAllNotifications: this.requestFunctionFactory(descriptors.notificationsReadAllNotifications),
486
+ /** Mark notification as read. */
487
+ sreadNotification: this.requestFunctionFactory(descriptors.notificationsReadNotification),
488
+ };
489
+ /** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
490
+ file = {
491
+ /** Create a File. */
492
+ createFile: this.requestFunctionFactory(descriptors.fileCreateFile),
493
+ /** Get a File's meta. */
494
+ getFileMeta: this.requestFunctionFactory(descriptors.fileGetFileMeta),
495
+ /** Get a FileUploadToken's rules. */
496
+ getFileUploadTokenRules: this.requestFunctionFactory(descriptors.fileGetFileUploadTokenRules),
497
+ /** Get a FileUploadType's rules. */
498
+ getFileUploadTypeRules: this.requestFunctionFactory(descriptors.fileGetFileUploadTypeRules),
499
+ /** Get a File. */
500
+ getFile: this.requestFunctionFactory(descriptors.fileGetFile),
501
+ /** Get a File with user-friendly url. */
502
+ getFileWithName: this.requestFunctionFactory(descriptors.fileGetFileWithName),
503
+ };
504
504
  /** The page insights API allows you to get page insights information. */
505
505
  pageInsights = {
506
506
  /** Get detailed performance data for a given domain and path. */
@@ -754,6 +754,60 @@ export const databaseUpdateRedisDatabaseDescription = {
754
754
  method: "PATCH",
755
755
  operationId: "database-update-redis-database-description",
756
756
  };
757
+ /** List Domains */
758
+ export const domainListDomains = {
759
+ path: "/v2/domains",
760
+ method: "GET",
761
+ operationId: "domain-list-domains",
762
+ };
763
+ /** Update the nameservers of a Domain. */
764
+ export const domainUpdateDomainNameservers = {
765
+ path: "/v2/domains/{domainId}/nameservers",
766
+ method: "PATCH",
767
+ operationId: "domain-update-domain-nameservers",
768
+ };
769
+ /** Update the paths of an Ingress. */
770
+ export const ingressUpdateIngressPaths = {
771
+ path: "/v2/ingresses/{ingressId}/paths",
772
+ method: "PATCH",
773
+ operationId: "ingress-update-ingress-paths",
774
+ };
775
+ /** Update the tls settings of an Ingress. */
776
+ export const ingressUpdateIngressTls = {
777
+ path: "/v2/ingresses/{ingressId}/tls",
778
+ method: "PATCH",
779
+ operationId: "ingress-update-ingress-tls",
780
+ };
781
+ /** Update the autoresponder of a MailAddress. */
782
+ export const mailUpdateMailAddressAutoresponder = {
783
+ path: "/v2/mail-addresses/{mailAddressId}/autoresponder",
784
+ method: "PATCH",
785
+ operationId: "mail-update-mail-address-autoresponder",
786
+ };
787
+ /** Update the forward addresses of a MailAddresses. */
788
+ export const mailUpdateMailAddressForwardAddresses = {
789
+ path: "/v2/mail-addresses/{mailAddressId}/forward-addresses",
790
+ method: "PATCH",
791
+ operationId: "mail-update-mail-address-forward-addresses",
792
+ };
793
+ /** Update the password for a MailAddress. */
794
+ export const mailUpdateMailAddressPassword = {
795
+ path: "/v2/mail-addresses/{mailAddressId}/password",
796
+ method: "PATCH",
797
+ operationId: "mail-update-mail-address-password",
798
+ };
799
+ /** Update the quota of a MailAddress. */
800
+ export const mailUpdateMailAddressQuota = {
801
+ path: "/v2/mail-addresses/{mailAddressId}/quota",
802
+ method: "PATCH",
803
+ operationId: "mail-update-mail-address-quota",
804
+ };
805
+ /** Update the spam protection of a MailAddress. */
806
+ export const mailUpdateMailAddressSpamProtection = {
807
+ path: "/v2/mail-addresses/{mailAddressId}/spam-protection",
808
+ method: "PATCH",
809
+ operationId: "mail-update-mail-address-spam-protection",
810
+ };
757
811
  /** Subscribe a user to the mStudio newsletter. */
758
812
  export const newsletterSubscribeUser = {
759
813
  path: "/v2/newsletter-subscriptions",
@@ -808,12 +862,6 @@ export const domainCheckDomainRegistrability = {
808
862
  method: "POST",
809
863
  operationId: "domain-check-domain-registrability",
810
864
  };
811
- /** List Domains */
812
- export const domainListDomains = {
813
- path: "/v2/domains",
814
- method: "GET",
815
- operationId: "domain-list-domains",
816
- };
817
865
  /** Check if a Domain is available to transfer. */
818
866
  export const domainCheckDomainTransferability = {
819
867
  path: "/v2/domain-transferable",
@@ -826,12 +874,6 @@ export const domainCreateDomainAuthCode = {
826
874
  method: "POST",
827
875
  operationId: "domain-create-domain-auth-code",
828
876
  };
829
- /** Update the nameservers of a Domain. */
830
- export const domainUpdateDomainNameservers = {
831
- path: "/v2/domains/{domainId}/nameservers",
832
- method: "PATCH",
833
- operationId: "domain-update-domain-nameservers",
834
- };
835
877
  /** Get a Domain. */
836
878
  export const domainGetDomain = {
837
879
  path: "/v2/domains/{domainId}",
@@ -1072,24 +1114,12 @@ export const ingressListIngressesCompatibleWithCertificate = {
1072
1114
  method: "POST",
1073
1115
  operationId: "ingress-list-ingresses-compatible-with-certificate",
1074
1116
  };
1075
- /** Update the paths of an Ingress. */
1076
- export const ingressUpdateIngressPaths = {
1077
- path: "/v2/ingresses/{ingressId}/paths",
1078
- method: "PATCH",
1079
- operationId: "ingress-update-ingress-paths",
1080
- };
1081
1117
  /** Request the ACME certificate issuance of an Ingress. */
1082
1118
  export const ingressRequestIngressAcmeCertificateIssuance = {
1083
1119
  path: "/v2/ingresses/{ingressId}/actions/request-acme-certificate-issuance",
1084
1120
  method: "POST",
1085
1121
  operationId: "ingress-request-ingress-acme-certificate-issuance",
1086
1122
  };
1087
- /** Update the tls settings of an Ingress. */
1088
- export const ingressUpdateIngressTls = {
1089
- path: "/v2/ingresses/{ingressId}/tls",
1090
- method: "PATCH",
1091
- operationId: "ingress-update-ingress-tls",
1092
- };
1093
1123
  /** Get details of an Invoice. */
1094
1124
  export const invoiceDetail = {
1095
1125
  path: "/v2/invoices/{invoiceId}",
@@ -1192,42 +1222,12 @@ export const mailUpdateMailAddressAddress = {
1192
1222
  method: "PATCH",
1193
1223
  operationId: "mail-update-mail-address-address",
1194
1224
  };
1195
- /** Update the autoresponder of a MailAddress. */
1196
- export const mailUpdateMailAddressAutoresponder = {
1197
- path: "/v2/mail-addresses/{mailAddressId}/autoresponder",
1198
- method: "PATCH",
1199
- operationId: "mail-update-mail-address-autoresponder",
1200
- };
1201
1225
  /** Update the catchall of a MailAddress. */
1202
1226
  export const mailUpdateMailAddressCatchAll = {
1203
1227
  path: "/v2/mail-addresses/{mailAddressId}/catch-all",
1204
1228
  method: "PATCH",
1205
1229
  operationId: "mail-update-mail-address-catch-all",
1206
1230
  };
1207
- /** Update the forward addresses of a MailAddresses. */
1208
- export const mailUpdateMailAddressForwardAddresses = {
1209
- path: "/v2/mail-addresses/{mailAddressId}/forward-addresses",
1210
- method: "PATCH",
1211
- operationId: "mail-update-mail-address-forward-addresses",
1212
- };
1213
- /** Update the password for a MailAddress. */
1214
- export const mailUpdateMailAddressPassword = {
1215
- path: "/v2/mail-addresses/{mailAddressId}/password",
1216
- method: "PATCH",
1217
- operationId: "mail-update-mail-address-password",
1218
- };
1219
- /** Update the quota of a MailAddress. */
1220
- export const mailUpdateMailAddressQuota = {
1221
- path: "/v2/mail-addresses/{mailAddressId}/quota",
1222
- method: "PATCH",
1223
- operationId: "mail-update-mail-address-quota",
1224
- };
1225
- /** Update the spam protection of a MailAddress. */
1226
- export const mailUpdateMailAddressSpamProtection = {
1227
- path: "/v2/mail-addresses/{mailAddressId}/spam-protection",
1228
- method: "PATCH",
1229
- operationId: "mail-update-mail-address-spam-protection",
1230
- };
1231
1231
  /** Update a mail setting of a Project. */
1232
1232
  export const mailUpdateProjectMailSetting = {
1233
1233
  path: "/v2/projects/{projectId}/mail-settings/{mailSetting}",
@@ -1 +1 @@
1
- export const MittwaldAPIClientVersion = '4.93.0';
1
+ export const MittwaldAPIClientVersion = '4.94.0';
@@ -24,6 +24,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
24
24
  }) => import("@mittwald/react-use-promise").AsyncResource<{
25
25
  appId: string;
26
26
  appVersion: import("./types.js").MittwaldAPIV2.Components.Schemas.AppVersionStatus;
27
+ createdAt: string;
27
28
  customDocumentRoot?: string | undefined;
28
29
  description: string;
29
30
  disabled: boolean;
@@ -1030,6 +1031,7 @@ declare const buildDatabaseApi: (baseClient: MittwaldAPIV2Client) => {
1030
1031
  id: string;
1031
1032
  isReady: boolean;
1032
1033
  isShared: boolean;
1034
+ mainUser?: import("./types.js").MittwaldAPIV2.Components.Schemas.DatabaseMySqlUser | undefined;
1033
1035
  name: string;
1034
1036
  projectId: string;
1035
1037
  status: import("./types.js").MittwaldAPIV2.Components.Schemas.DatabaseDatabaseStatus;
@@ -1130,6 +1132,21 @@ declare const buildDatabaseApi: (baseClient: MittwaldAPIV2Client) => {
1130
1132
  } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DatabaseRedisVersion[]>;
1131
1133
  };
1132
1134
  declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
1135
+ /** List Domains */
1136
+ listDomains: (conf?: {
1137
+ headers?: {
1138
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1139
+ "x-access-token"?: string | undefined;
1140
+ } | undefined;
1141
+ queryParameters?: {
1142
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1143
+ projectId?: string | undefined;
1144
+ page?: number | undefined;
1145
+ limit?: number | undefined;
1146
+ domainSearchName?: string | undefined;
1147
+ contactHash?: string | undefined;
1148
+ } | undefined;
1149
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DomainDomain[]>;
1133
1150
  /** Get a DNSZone. */
1134
1151
  dnsGetDnsZone: (conf: {
1135
1152
  dnsZoneId: string;
@@ -1156,21 +1173,6 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
1156
1173
  "x-access-token"?: string | undefined;
1157
1174
  } | undefined;
1158
1175
  }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DnsZone[]>;
1159
- /** List Domains */
1160
- listDomains: (conf?: {
1161
- headers?: {
1162
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1163
- "x-access-token"?: string | undefined;
1164
- } | undefined;
1165
- queryParameters?: {
1166
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1167
- projectId?: string | undefined;
1168
- page?: number | undefined;
1169
- limit?: number | undefined;
1170
- domainSearchName?: string | undefined;
1171
- contactHash?: string | undefined;
1172
- } | undefined;
1173
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DomainDomain[]>;
1174
1176
  /** Get a Domain. */
1175
1177
  getDomain: (conf: {
1176
1178
  domainId: string;