@mittwald/api-client 4.414.0 → 4.415.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.
@@ -92,6 +92,8 @@ const buildContainerApi = (baseClient) => ({
92
92
  getServiceLogs: new ApiCallAsyncResourceFactory(descriptors.containerGetServiceLogs, baseClient.container.getServiceLogs).getApiResource,
93
93
  /** Get a Service belonging to a Stack. */
94
94
  getService: new ApiCallAsyncResourceFactory(descriptors.containerGetService, baseClient.container.getService).getApiResource,
95
+ /** Get a Container Template asset. */
96
+ getTemplateAsset: new ApiCallAsyncResourceFactory(descriptors.containerGetTemplateAsset, baseClient.container.getTemplateAsset).getApiResource,
95
97
  /** Get a Container Template by ID. */
96
98
  getTemplate: new ApiCallAsyncResourceFactory(descriptors.containerGetTemplate, baseClient.container.getTemplate).getApiResource,
97
99
  /** List Stacks belonging to the executing user. */
@@ -104,8 +106,6 @@ const buildContainerApi = (baseClient) => ({
104
106
  listTemplates: new ApiCallAsyncResourceFactory(descriptors.containerListTemplates, baseClient.container.listTemplates).getApiResource,
105
107
  /** List Volumes belonging to a Project. */
106
108
  listVolumes: new ApiCallAsyncResourceFactory(descriptors.containerListVolumes, baseClient.container.listVolumes).getApiResource,
107
- /** Get a Container Template asset. */
108
- getTemplateAsset: new ApiCallAsyncResourceFactory(descriptors.containerGetTemplateAsset, baseClient.container.getTemplateAsset).getApiResource,
109
109
  });
110
110
  const buildContractApi = (baseClient) => ({
111
111
  /** Return the BaseItem of the Contract with the given ID. */
@@ -362,16 +362,16 @@ const buildMailApi = (baseClient) => ({
362
362
  getDeliveryBox: new ApiCallAsyncResourceFactory(descriptors.mailGetDeliveryBox, baseClient.mail.getDeliveryBox).getApiResource,
363
363
  /** Get a MailAddress. */
364
364
  getMailAddress: new ApiCallAsyncResourceFactory(descriptors.mailGetMailAddress, baseClient.mail.getMailAddress).getApiResource,
365
+ /** Get a Mail RateLimit. */
366
+ getMailRateLimit: new ApiCallAsyncResourceFactory(descriptors.mailGetMailRateLimit, baseClient.mail.getMailRateLimit).getApiResource,
365
367
  /** List backups belonging to a MailAddress. */
366
368
  listBackupsForMailAddress: new ApiCallAsyncResourceFactory(descriptors.mailListBackupsForMailAddress, baseClient.mail.listBackupsForMailAddress).getApiResource,
367
369
  /** List MailAddresses. */
368
370
  listMailAddressesForUser: new ApiCallAsyncResourceFactory(descriptors.mailListMailAddressesForUser, baseClient.mail.listMailAddressesForUser).getApiResource,
369
- /** List mail settings of a Project. */
370
- listProjectMailSettings: new ApiCallAsyncResourceFactory(descriptors.mailListProjectMailSettings, baseClient.mail.listProjectMailSettings).getApiResource,
371
- /** Get a Mail RateLimit. */
372
- getMailRateLimit: new ApiCallAsyncResourceFactory(descriptors.mailGetMailRateLimit, baseClient.mail.getMailRateLimit).getApiResource,
373
371
  /** List Mail RateLimits. */
374
372
  listMailRateLimits: new ApiCallAsyncResourceFactory(descriptors.mailListMailRateLimits, baseClient.mail.listMailRateLimits).getApiResource,
373
+ /** List mail settings of a Project. */
374
+ listProjectMailSettings: new ApiCallAsyncResourceFactory(descriptors.mailListProjectMailSettings, baseClient.mail.listProjectMailSettings).getApiResource,
375
375
  });
376
376
  const buildMiscApi = (baseClient) => ({
377
377
  /** List valid time zones. */
@@ -168,6 +168,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
168
168
  getServiceLogs: this.requestFunctionFactory(descriptors.containerGetServiceLogs),
169
169
  /** Get a Service belonging to a Stack. */
170
170
  getService: this.requestFunctionFactory(descriptors.containerGetService),
171
+ /** Get a Container Template asset. */
172
+ getTemplateAsset: this.requestFunctionFactory(descriptors.containerGetTemplateAsset),
171
173
  /** Get a Container Template by ID. */
172
174
  getTemplate: this.requestFunctionFactory(descriptors.containerGetTemplate),
173
175
  /** List Stacks belonging to the executing user. */
@@ -194,8 +196,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
194
196
  startService: this.requestFunctionFactory(descriptors.containerStartService),
195
197
  /** Stop a started Service. */
196
198
  stopService: this.requestFunctionFactory(descriptors.containerStopService),
197
- /** Get a Container Template asset. */
198
- getTemplateAsset: this.requestFunctionFactory(descriptors.containerGetTemplateAsset),
199
199
  };
200
200
  /** The contract API allows you to manage your contracts and orders */
201
201
  contract = {
@@ -686,14 +686,20 @@ export class MittwaldAPIV2Client extends ApiClientBase {
686
686
  deleteMailAddress: this.requestFunctionFactory(descriptors.mailDeleteMailAddress),
687
687
  /** Disable the mail-archive of a MailAddress. */
688
688
  disableMailArchive: this.requestFunctionFactory(descriptors.mailDisableMailArchive),
689
+ /** Get a Mail RateLimit. */
690
+ getMailRateLimit: this.requestFunctionFactory(descriptors.mailGetMailRateLimit),
689
691
  /** List backups belonging to a MailAddress. */
690
692
  listBackupsForMailAddress: this.requestFunctionFactory(descriptors.mailListBackupsForMailAddress),
691
693
  /** List MailAddresses. */
692
694
  listMailAddressesForUser: this.requestFunctionFactory(descriptors.mailListMailAddressesForUser),
695
+ /** List Mail RateLimits. */
696
+ listMailRateLimits: this.requestFunctionFactory(descriptors.mailListMailRateLimits),
693
697
  /** List mail settings of a Project. */
694
698
  listProjectMailSettings: this.requestFunctionFactory(descriptors.mailListProjectMailSettings),
695
699
  /** Recover emails for a MailAddress from a backup. */
696
700
  recoverMailAddressEmails: this.requestFunctionFactory(descriptors.mailRecoverMailAddressEmails),
701
+ /** Request a rate limit change for a MailAddress. */
702
+ requestMailAddressRateLimitChange: this.requestFunctionFactory(descriptors.mailRequestMailAddressRateLimitChange),
697
703
  /** Update the description of a DeliveryBox. */
698
704
  updateDeliveryBoxDescription: this.requestFunctionFactory(descriptors.mailUpdateDeliveryBoxDescription),
699
705
  /** Update the password of a DeliveryBox. */
@@ -702,12 +708,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
702
708
  updateMailAddressAddress: this.requestFunctionFactory(descriptors.mailUpdateMailAddressAddress),
703
709
  /** Update the catch-all of a MailAddress. */
704
710
  updateMailAddressCatchAll: this.requestFunctionFactory(descriptors.mailUpdateMailAddressCatchAll),
705
- /** Get a Mail RateLimit. */
706
- getMailRateLimit: this.requestFunctionFactory(descriptors.mailGetMailRateLimit),
707
- /** List Mail RateLimits. */
708
- listMailRateLimits: this.requestFunctionFactory(descriptors.mailListMailRateLimits),
709
- /** Request a rate limit change for a MailAddress. */
710
- requestMailAddressRateLimitChange: this.requestFunctionFactory(descriptors.mailRequestMailAddressRateLimitChange),
711
711
  };
712
712
  /** The notification API allows you to manage your notifications. */
713
713
  notification = {
@@ -448,6 +448,12 @@ export const containerGetService = {
448
448
  method: "GET",
449
449
  operationId: "container-get-service",
450
450
  };
451
+ /** Get a Container Template asset. */
452
+ export const containerGetTemplateAsset = {
453
+ path: "/v2/container-templates/{templateId}/assets/{assetPath}",
454
+ method: "GET",
455
+ operationId: "container-get-template-asset",
456
+ };
451
457
  /** Get a Container Template by ID. */
452
458
  export const containerGetTemplate = {
453
459
  path: "/v2/container-templates/{templateId}",
@@ -1966,6 +1972,12 @@ export const mailDisableMailArchive = {
1966
1972
  method: "DELETE",
1967
1973
  operationId: "mail-disable-mail-archive",
1968
1974
  };
1975
+ /** Get a Mail RateLimit. */
1976
+ export const mailGetMailRateLimit = {
1977
+ path: "/v2/mail-rate-limits/{mailRateLimitId}",
1978
+ method: "GET",
1979
+ operationId: "mail-get-mail-rate-limit",
1980
+ };
1969
1981
  /** List backups belonging to a MailAddress. */
1970
1982
  export const mailListBackupsForMailAddress = {
1971
1983
  path: "/v2/mail-addresses/{mailAddressId}/backups",
@@ -1978,6 +1990,12 @@ export const mailListMailAddressesForUser = {
1978
1990
  method: "GET",
1979
1991
  operationId: "mail-list-mail-addresses-for-user",
1980
1992
  };
1993
+ /** List Mail RateLimits. */
1994
+ export const mailListMailRateLimits = {
1995
+ path: "/v2/mail-rate-limits",
1996
+ method: "GET",
1997
+ operationId: "mail-list-mail-rate-limits",
1998
+ };
1981
1999
  /** List mail settings of a Project. */
1982
2000
  export const mailListProjectMailSettings = {
1983
2001
  path: "/v2/projects/{projectId}/mail-settings",
@@ -1990,6 +2008,12 @@ export const mailRecoverMailAddressEmails = {
1990
2008
  method: "POST",
1991
2009
  operationId: "mail-recover-mail-address-emails",
1992
2010
  };
2011
+ /** Request a rate limit change for a MailAddress. */
2012
+ export const mailRequestMailAddressRateLimitChange = {
2013
+ path: "/v2/mail-addresses/{mailAddressId}/actions/request-rate-limit-change",
2014
+ method: "POST",
2015
+ operationId: "mail-request-mail-address-rate-limit-change",
2016
+ };
1993
2017
  /** Update the description of a DeliveryBox. */
1994
2018
  export const mailUpdateDeliveryBoxDescription = {
1995
2019
  path: "/v2/delivery-boxes/{deliveryBoxId}/description",
@@ -2830,27 +2854,3 @@ export const verificationVerifyCompany = {
2830
2854
  method: "POST",
2831
2855
  operationId: "verification-verify-company",
2832
2856
  };
2833
- /** Get a Mail RateLimit. */
2834
- export const mailGetMailRateLimit = {
2835
- path: "/v2/mail-rate-limits/{mailRateLimitId}",
2836
- method: "GET",
2837
- operationId: "mail-get-mail-rate-limit",
2838
- };
2839
- /** List Mail RateLimits. */
2840
- export const mailListMailRateLimits = {
2841
- path: "/v2/mail-rate-limits",
2842
- method: "GET",
2843
- operationId: "mail-list-mail-rate-limits",
2844
- };
2845
- /** Request a rate limit change for a MailAddress. */
2846
- export const mailRequestMailAddressRateLimitChange = {
2847
- path: "/v2/mail-addresses/{mailAddressId}/actions/request-rate-limit-change",
2848
- method: "POST",
2849
- operationId: "mail-request-mail-address-rate-limit-change",
2850
- };
2851
- /** Get a Container Template asset. */
2852
- export const containerGetTemplateAsset = {
2853
- path: "/v2/container-templates/{templateId}/assets/{assetPath}",
2854
- method: "GET",
2855
- operationId: "container-get-template-asset",
2856
- };
@@ -1 +1 @@
1
- export const MittwaldAPIClientVersion = '4.413.0';
1
+ export const MittwaldAPIClientVersion = '4.414.0';
@@ -669,6 +669,14 @@ declare const buildContainerApi: (baseClient: MittwaldAPIV2Client) => {
669
669
  status: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceStatus;
670
670
  statusSetAt: string;
671
671
  }>;
672
+ /** Get a Container Template asset. */
673
+ getTemplateAsset: (conf: {
674
+ templateId: string;
675
+ assetPath: string;
676
+ headers?: {
677
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
678
+ } | undefined;
679
+ }) => import("@mittwald/react-use-promise").AsyncResource<string>;
672
680
  /** Get a Container Template by ID. */
673
681
  getTemplate: (conf: {
674
682
  templateId: string;
@@ -807,14 +815,6 @@ declare const buildContainerApi: (baseClient: MittwaldAPIV2Client) => {
807
815
  page?: number | undefined;
808
816
  } | undefined;
809
817
  }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[]>;
810
- /** Get a Container Template asset. */
811
- getTemplateAsset: (conf: {
812
- templateId: string;
813
- assetPath: string;
814
- headers?: {
815
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
816
- } | undefined;
817
- }) => import("@mittwald/react-use-promise").AsyncResource<string>;
818
818
  };
819
819
  declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
820
820
  /** Return the BaseItem of the Contract with the given ID. */
@@ -2896,6 +2896,17 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
2896
2896
  receivingDisabled: boolean;
2897
2897
  updatedAt: string;
2898
2898
  }>;
2899
+ /** Get a Mail RateLimit. */
2900
+ getMailRateLimit: (conf: {
2901
+ mailRateLimitId: string;
2902
+ headers?: {
2903
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2904
+ "x-access-token"?: string | undefined;
2905
+ } | undefined;
2906
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2907
+ id: string;
2908
+ rateLimit: number;
2909
+ }>;
2899
2910
  /** List backups belonging to a MailAddress. */
2900
2911
  listBackupsForMailAddress: (conf: {
2901
2912
  mailAddressId: string;
@@ -2925,6 +2936,13 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
2925
2936
  order?: ("asc" | "desc")[] | undefined;
2926
2937
  } | undefined;
2927
2938
  } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MailMailAddress[]>;
2939
+ /** List Mail RateLimits. */
2940
+ listMailRateLimits: (conf?: {
2941
+ headers?: {
2942
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2943
+ "x-access-token"?: string | undefined;
2944
+ } | undefined;
2945
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MailsystemRateLimit[]>;
2928
2946
  /** List mail settings of a Project. */
2929
2947
  listProjectMailSettings: (conf: {
2930
2948
  projectId: string;
@@ -2937,24 +2955,6 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
2937
2955
  projectId: string;
2938
2956
  whitelist: string[];
2939
2957
  }>;
2940
- /** Get a Mail RateLimit. */
2941
- getMailRateLimit: (conf: {
2942
- mailRateLimitId: string;
2943
- headers?: {
2944
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2945
- "x-access-token"?: string | undefined;
2946
- } | undefined;
2947
- }) => import("@mittwald/react-use-promise").AsyncResource<{
2948
- id: string;
2949
- rateLimit: number;
2950
- }>;
2951
- /** List Mail RateLimits. */
2952
- listMailRateLimits: (conf?: {
2953
- headers?: {
2954
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2955
- "x-access-token"?: string | undefined;
2956
- } | undefined;
2957
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MailsystemRateLimit[]>;
2958
2958
  };
2959
2959
  declare const buildMiscApi: (baseClient: MittwaldAPIV2Client) => {
2960
2960
  /** List valid time zones. */