@mittwald/api-client 4.94.0 → 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,6 +160,8 @@ 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. */
@@ -168,8 +170,6 @@ const buildDomainApi = (baseClient) => ({
168
170
  getDomain: new ApiCallAsyncResourceFactory(descriptors.domainGetDomain, baseClient.domain.getDomain).getApiResource,
169
171
  /** Get the latest screenshot's FileReference belonging to a Domain. */
170
172
  getLatestScreenshot: new ApiCallAsyncResourceFactory(descriptors.domainGetLatestScreenshot, baseClient.domain.getLatestScreenshot).getApiResource,
171
- /** List Domains */
172
- listDomains: new ApiCallAsyncResourceFactory(descriptors.domainListDomains, baseClient.domain.listDomains).getApiResource,
173
173
  /** List the contact schemas for a TLD. */
174
174
  listTldContactSchemas: new ApiCallAsyncResourceFactory(descriptors.domainListTldContactSchemas, baseClient.domain.listTldContactSchemas).getApiResource,
175
175
  /** List TLDs. */
@@ -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. */
@@ -390,8 +381,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
390
381
  deleteDomain: this.requestFunctionFactory(descriptors.domainDeleteDomain),
391
382
  /** Get the latest screenshot's FileReference belonging to a Domain. */
392
383
  getLatestScreenshot: this.requestFunctionFactory(descriptors.domainGetLatestScreenshot),
393
- /** List Domains */
394
- listDomains: this.requestFunctionFactory(descriptors.domainListDomains),
395
384
  /** List the contact schemas for a TLD. */
396
385
  listTldContactSchemas: this.requestFunctionFactory(descriptors.domainListTldContactSchemas),
397
386
  /** List TLDs. */
@@ -404,8 +393,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
404
393
  updateDomainAuthCode: this.requestFunctionFactory(descriptors.domainUpdateDomainAuthCode),
405
394
  /** Update a contact of a Domain. */
406
395
  updateDomainContact: this.requestFunctionFactory(descriptors.domainUpdateDomainContact),
407
- /** Update the nameservers of a Domain. */
408
- updateDomainNameservers: this.requestFunctionFactory(descriptors.domainUpdateDomainNameservers),
409
396
  /** Update a Domain's project id. */
410
397
  updateDomainProjectId: this.requestFunctionFactory(descriptors.domainUpdateDomainProjectId),
411
398
  /** List Ingresses. */
@@ -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",
@@ -838,12 +892,6 @@ export const domainGetLatestScreenshot = {
838
892
  method: "GET",
839
893
  operationId: "domain-get-latest-screenshot",
840
894
  };
841
- /** List Domains */
842
- export const domainListDomains = {
843
- path: "/v2/domains",
844
- method: "GET",
845
- operationId: "domain-list-domains",
846
- };
847
895
  /** List the contact schemas for a TLD. */
848
896
  export const domainListTldContactSchemas = {
849
897
  path: "/v2/domain-tlds/{tld}/contact-schemas",
@@ -880,12 +928,6 @@ export const domainUpdateDomainContact = {
880
928
  method: "PATCH",
881
929
  operationId: "domain-update-domain-contact",
882
930
  };
883
- /** Update the nameservers of a Domain. */
884
- export const domainUpdateDomainNameservers = {
885
- path: "/v2/domains/{domainId}/nameservers",
886
- method: "PATCH",
887
- operationId: "domain-update-domain-nameservers",
888
- };
889
931
  /** Update a Domain's project id. */
890
932
  export const domainUpdateDomainProjectId = {
891
933
  path: "/v2/domains/{domainId}/project-id",
@@ -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.1';
1
+ export const MittwaldAPIClientVersion = '4.94.0';
@@ -1132,6 +1132,21 @@ declare const buildDatabaseApi: (baseClient: MittwaldAPIV2Client) => {
1132
1132
  } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DatabaseRedisVersion[]>;
1133
1133
  };
1134
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[]>;
1135
1150
  /** Get a DNSZone. */
1136
1151
  dnsGetDnsZone: (conf: {
1137
1152
  dnsZoneId: string;
@@ -1197,21 +1212,6 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
1197
1212
  }) => import("@mittwald/react-use-promise").AsyncResource<{
1198
1213
  reference?: string | undefined;
1199
1214
  }>;
1200
- /** List Domains */
1201
- listDomains: (conf?: {
1202
- headers?: {
1203
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1204
- "x-access-token"?: string | undefined;
1205
- } | undefined;
1206
- queryParameters?: {
1207
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1208
- projectId?: string | undefined;
1209
- page?: number | undefined;
1210
- limit?: number | undefined;
1211
- domainSearchName?: string | undefined;
1212
- contactHash?: string | undefined;
1213
- } | undefined;
1214
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DomainDomain[]>;
1215
1215
  /** List the contact schemas for a TLD. */
1216
1216
  listTldContactSchemas: (conf: {
1217
1217
  tld: string;