@mittwald/api-client 4.413.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,8 +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 icon. */
96
- getTemplateIcon: new ApiCallAsyncResourceFactory(descriptors.containerGetTemplateIcon, baseClient.container.getTemplateIcon).getApiResource,
95
+ /** Get a Container Template asset. */
96
+ getTemplateAsset: new ApiCallAsyncResourceFactory(descriptors.containerGetTemplateAsset, baseClient.container.getTemplateAsset).getApiResource,
97
97
  /** Get a Container Template by ID. */
98
98
  getTemplate: new ApiCallAsyncResourceFactory(descriptors.containerGetTemplate, baseClient.container.getTemplate).getApiResource,
99
99
  /** List Stacks belonging to the executing user. */
@@ -106,8 +106,6 @@ const buildContainerApi = (baseClient) => ({
106
106
  listTemplates: new ApiCallAsyncResourceFactory(descriptors.containerListTemplates, baseClient.container.listTemplates).getApiResource,
107
107
  /** List Volumes belonging to a Project. */
108
108
  listVolumes: new ApiCallAsyncResourceFactory(descriptors.containerListVolumes, baseClient.container.listVolumes).getApiResource,
109
- /** List Container Template statistics. */
110
- listTemplateStatistics: new ApiCallAsyncResourceFactory(descriptors.containerListTemplateStatistics, baseClient.container.listTemplateStatistics).getApiResource,
111
109
  });
112
110
  const buildContractApi = (baseClient) => ({
113
111
  /** Return the BaseItem of the Contract with the given ID. */
@@ -364,16 +362,16 @@ const buildMailApi = (baseClient) => ({
364
362
  getDeliveryBox: new ApiCallAsyncResourceFactory(descriptors.mailGetDeliveryBox, baseClient.mail.getDeliveryBox).getApiResource,
365
363
  /** Get a MailAddress. */
366
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,
367
367
  /** List backups belonging to a MailAddress. */
368
368
  listBackupsForMailAddress: new ApiCallAsyncResourceFactory(descriptors.mailListBackupsForMailAddress, baseClient.mail.listBackupsForMailAddress).getApiResource,
369
369
  /** List MailAddresses. */
370
370
  listMailAddressesForUser: new ApiCallAsyncResourceFactory(descriptors.mailListMailAddressesForUser, baseClient.mail.listMailAddressesForUser).getApiResource,
371
- /** List mail settings of a Project. */
372
- listProjectMailSettings: new ApiCallAsyncResourceFactory(descriptors.mailListProjectMailSettings, baseClient.mail.listProjectMailSettings).getApiResource,
373
- /** Get a Mail RateLimit. */
374
- getMailRateLimit: new ApiCallAsyncResourceFactory(descriptors.mailGetMailRateLimit, baseClient.mail.getMailRateLimit).getApiResource,
375
371
  /** List Mail RateLimits. */
376
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,
377
375
  });
378
376
  const buildMiscApi = (baseClient) => ({
379
377
  /** List valid time zones. */
@@ -168,8 +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 icon. */
172
- getTemplateIcon: this.requestFunctionFactory(descriptors.containerGetTemplateIcon),
171
+ /** Get a Container Template asset. */
172
+ getTemplateAsset: this.requestFunctionFactory(descriptors.containerGetTemplateAsset),
173
173
  /** Get a Container Template by ID. */
174
174
  getTemplate: this.requestFunctionFactory(descriptors.containerGetTemplate),
175
175
  /** List Stacks belonging to the executing user. */
@@ -196,8 +196,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
196
196
  startService: this.requestFunctionFactory(descriptors.containerStartService),
197
197
  /** Stop a started Service. */
198
198
  stopService: this.requestFunctionFactory(descriptors.containerStopService),
199
- /** List Container Template statistics. */
200
- listTemplateStatistics: this.requestFunctionFactory(descriptors.containerListTemplateStatistics),
201
199
  };
202
200
  /** The contract API allows you to manage your contracts and orders */
203
201
  contract = {
@@ -688,14 +686,20 @@ export class MittwaldAPIV2Client extends ApiClientBase {
688
686
  deleteMailAddress: this.requestFunctionFactory(descriptors.mailDeleteMailAddress),
689
687
  /** Disable the mail-archive of a MailAddress. */
690
688
  disableMailArchive: this.requestFunctionFactory(descriptors.mailDisableMailArchive),
689
+ /** Get a Mail RateLimit. */
690
+ getMailRateLimit: this.requestFunctionFactory(descriptors.mailGetMailRateLimit),
691
691
  /** List backups belonging to a MailAddress. */
692
692
  listBackupsForMailAddress: this.requestFunctionFactory(descriptors.mailListBackupsForMailAddress),
693
693
  /** List MailAddresses. */
694
694
  listMailAddressesForUser: this.requestFunctionFactory(descriptors.mailListMailAddressesForUser),
695
+ /** List Mail RateLimits. */
696
+ listMailRateLimits: this.requestFunctionFactory(descriptors.mailListMailRateLimits),
695
697
  /** List mail settings of a Project. */
696
698
  listProjectMailSettings: this.requestFunctionFactory(descriptors.mailListProjectMailSettings),
697
699
  /** Recover emails for a MailAddress from a backup. */
698
700
  recoverMailAddressEmails: this.requestFunctionFactory(descriptors.mailRecoverMailAddressEmails),
701
+ /** Request a rate limit change for a MailAddress. */
702
+ requestMailAddressRateLimitChange: this.requestFunctionFactory(descriptors.mailRequestMailAddressRateLimitChange),
699
703
  /** Update the description of a DeliveryBox. */
700
704
  updateDeliveryBoxDescription: this.requestFunctionFactory(descriptors.mailUpdateDeliveryBoxDescription),
701
705
  /** Update the password of a DeliveryBox. */
@@ -704,12 +708,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
704
708
  updateMailAddressAddress: this.requestFunctionFactory(descriptors.mailUpdateMailAddressAddress),
705
709
  /** Update the catch-all of a MailAddress. */
706
710
  updateMailAddressCatchAll: this.requestFunctionFactory(descriptors.mailUpdateMailAddressCatchAll),
707
- /** Get a Mail RateLimit. */
708
- getMailRateLimit: this.requestFunctionFactory(descriptors.mailGetMailRateLimit),
709
- /** List Mail RateLimits. */
710
- listMailRateLimits: this.requestFunctionFactory(descriptors.mailListMailRateLimits),
711
- /** Request a rate limit change for a MailAddress. */
712
- requestMailAddressRateLimitChange: this.requestFunctionFactory(descriptors.mailRequestMailAddressRateLimitChange),
713
711
  };
714
712
  /** The notification API allows you to manage your notifications. */
715
713
  notification = {
@@ -448,11 +448,11 @@ export const containerGetService = {
448
448
  method: "GET",
449
449
  operationId: "container-get-service",
450
450
  };
451
- /** Get a Container Template icon. */
452
- export const containerGetTemplateIcon = {
453
- path: "/v2/container-templates/{templateId}/icon",
451
+ /** Get a Container Template asset. */
452
+ export const containerGetTemplateAsset = {
453
+ path: "/v2/container-templates/{templateId}/assets/{assetPath}",
454
454
  method: "GET",
455
- operationId: "container-get-template-icon",
455
+ operationId: "container-get-template-asset",
456
456
  };
457
457
  /** Get a Container Template by ID. */
458
458
  export const containerGetTemplate = {
@@ -1972,6 +1972,12 @@ export const mailDisableMailArchive = {
1972
1972
  method: "DELETE",
1973
1973
  operationId: "mail-disable-mail-archive",
1974
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
+ };
1975
1981
  /** List backups belonging to a MailAddress. */
1976
1982
  export const mailListBackupsForMailAddress = {
1977
1983
  path: "/v2/mail-addresses/{mailAddressId}/backups",
@@ -1984,6 +1990,12 @@ export const mailListMailAddressesForUser = {
1984
1990
  method: "GET",
1985
1991
  operationId: "mail-list-mail-addresses-for-user",
1986
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
+ };
1987
1999
  /** List mail settings of a Project. */
1988
2000
  export const mailListProjectMailSettings = {
1989
2001
  path: "/v2/projects/{projectId}/mail-settings",
@@ -1996,6 +2008,12 @@ export const mailRecoverMailAddressEmails = {
1996
2008
  method: "POST",
1997
2009
  operationId: "mail-recover-mail-address-emails",
1998
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
+ };
1999
2017
  /** Update the description of a DeliveryBox. */
2000
2018
  export const mailUpdateDeliveryBoxDescription = {
2001
2019
  path: "/v2/delivery-boxes/{deliveryBoxId}/description",
@@ -2836,27 +2854,3 @@ export const verificationVerifyCompany = {
2836
2854
  method: "POST",
2837
2855
  operationId: "verification-verify-company",
2838
2856
  };
2839
- /** List Container Template statistics. */
2840
- export const containerListTemplateStatistics = {
2841
- path: "/v2/container-template-statistics",
2842
- method: "GET",
2843
- operationId: "container-list-template-statistics",
2844
- };
2845
- /** Get a Mail RateLimit. */
2846
- export const mailGetMailRateLimit = {
2847
- path: "/v2/mail-rate-limits/{mailRateLimitId}",
2848
- method: "GET",
2849
- operationId: "mail-get-mail-rate-limit",
2850
- };
2851
- /** List Mail RateLimits. */
2852
- export const mailListMailRateLimits = {
2853
- path: "/v2/mail-rate-limits",
2854
- method: "GET",
2855
- operationId: "mail-list-mail-rate-limits",
2856
- };
2857
- /** Request a rate limit change for a MailAddress. */
2858
- export const mailRequestMailAddressRateLimitChange = {
2859
- path: "/v2/mail-addresses/{mailAddressId}/actions/request-rate-limit-change",
2860
- method: "POST",
2861
- operationId: "mail-request-mail-address-rate-limit-change",
2862
- };
@@ -92,8 +92,6 @@ 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 icon. */
96
- getTemplateIcon: new ApiCallAsyncResourceFactory(descriptors.containerGetTemplateIcon, baseClient.container.getTemplateIcon).getApiResource,
97
95
  /** Get a Container Template by ID. */
98
96
  getTemplate: new ApiCallAsyncResourceFactory(descriptors.containerGetTemplate, baseClient.container.getTemplate).getApiResource,
99
97
  /** List Stacks belonging to the executing user. */
@@ -106,8 +104,8 @@ const buildContainerApi = (baseClient) => ({
106
104
  listTemplates: new ApiCallAsyncResourceFactory(descriptors.containerListTemplates, baseClient.container.listTemplates).getApiResource,
107
105
  /** List Volumes belonging to a Project. */
108
106
  listVolumes: new ApiCallAsyncResourceFactory(descriptors.containerListVolumes, baseClient.container.listVolumes).getApiResource,
109
- /** List Container Template statistics. */
110
- listTemplateStatistics: new ApiCallAsyncResourceFactory(descriptors.containerListTemplateStatistics, baseClient.container.listTemplateStatistics).getApiResource,
107
+ /** Get a Container Template asset. */
108
+ getTemplateAsset: new ApiCallAsyncResourceFactory(descriptors.containerGetTemplateAsset, baseClient.container.getTemplateAsset).getApiResource,
111
109
  });
112
110
  const buildContractApi = (baseClient) => ({
113
111
  /** Return the BaseItem of the Contract with the given ID. */
@@ -168,8 +168,6 @@ export class MittwaldAPIV3NextClient 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 icon. */
172
- getTemplateIcon: this.requestFunctionFactory(descriptors.containerGetTemplateIcon),
173
171
  /** Get a Container Template by ID. */
174
172
  getTemplate: this.requestFunctionFactory(descriptors.containerGetTemplate),
175
173
  /** List Stacks belonging to the executing user. */
@@ -196,8 +194,8 @@ export class MittwaldAPIV3NextClient extends ApiClientBase {
196
194
  startService: this.requestFunctionFactory(descriptors.containerStartService),
197
195
  /** Stop a started Service. */
198
196
  stopService: this.requestFunctionFactory(descriptors.containerStopService),
199
- /** List Container Template statistics. */
200
- listTemplateStatistics: this.requestFunctionFactory(descriptors.containerListTemplateStatistics),
197
+ /** Get a Container Template asset. */
198
+ getTemplateAsset: this.requestFunctionFactory(descriptors.containerGetTemplateAsset),
201
199
  };
202
200
  /** The contract API allows you to manage your contracts and orders */
203
201
  contract = {
@@ -448,12 +448,6 @@ export const containerGetService = {
448
448
  method: "GET",
449
449
  operationId: "container-get-service",
450
450
  };
451
- /** Get a Container Template icon. */
452
- export const containerGetTemplateIcon = {
453
- path: "/v3-next/container-templates/{templateId}/icon",
454
- method: "GET",
455
- operationId: "container-get-template-icon",
456
- };
457
451
  /** Get a Container Template by ID. */
458
452
  export const containerGetTemplate = {
459
453
  path: "/v3-next/container-templates/{templateId}",
@@ -2836,12 +2830,6 @@ export const verificationVerifyCompany = {
2836
2830
  method: "POST",
2837
2831
  operationId: "verification-verify-company",
2838
2832
  };
2839
- /** List Container Template statistics. */
2840
- export const containerListTemplateStatistics = {
2841
- path: "/v3-next/container-template-statistics",
2842
- method: "GET",
2843
- operationId: "container-list-template-statistics",
2844
- };
2845
2833
  /** Get a Mail RateLimit. */
2846
2834
  export const mailGetMailRateLimit = {
2847
2835
  path: "/v3-next/mail-rate-limits/{mailRateLimitId}",
@@ -2860,3 +2848,9 @@ export const mailRequestMailAddressRateLimitChange = {
2860
2848
  method: "POST",
2861
2849
  operationId: "mail-request-mail-address-rate-limit-change",
2862
2850
  };
2851
+ /** Get a Container Template asset. */
2852
+ export const containerGetTemplateAsset = {
2853
+ path: "/v3-next/container-templates/{templateId}/assets/{assetPath}",
2854
+ method: "GET",
2855
+ operationId: "container-get-template-asset",
2856
+ };
@@ -1 +1 @@
1
- export const MittwaldAPIClientVersion = '4.412.0';
1
+ export const MittwaldAPIClientVersion = '4.414.0';
@@ -669,9 +669,10 @@ 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 icon. */
673
- getTemplateIcon: (conf: {
672
+ /** Get a Container Template asset. */
673
+ getTemplateAsset: (conf: {
674
674
  templateId: string;
675
+ assetPath: string;
675
676
  headers?: {
676
677
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
677
678
  } | undefined;
@@ -714,6 +715,11 @@ declare const buildContainerApi: (baseClient: MittwaldAPIV2Client) => {
714
715
  manifestVersion: string;
715
716
  name: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerTemplateTranslatedString;
716
717
  repository?: string | undefined;
718
+ screenshots?: {
719
+ bg: string;
720
+ screenshot: string;
721
+ text: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerTemplateTranslatedString;
722
+ }[] | undefined;
717
723
  supportLink?: string | undefined;
718
724
  tagline: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerTemplateTranslatedString;
719
725
  userInputs?: {
@@ -786,6 +792,7 @@ declare const buildContainerApi: (baseClient: MittwaldAPIV2Client) => {
786
792
  category?: string | undefined;
787
793
  searchTerm?: string | undefined;
788
794
  type?: "component" | "standalone" | undefined;
795
+ sortOrder?: "trend30days" | "trendAll" | undefined;
789
796
  limit?: number | undefined;
790
797
  skip?: number | undefined;
791
798
  page?: number | undefined;
@@ -808,20 +815,6 @@ declare const buildContainerApi: (baseClient: MittwaldAPIV2Client) => {
808
815
  page?: number | undefined;
809
816
  } | undefined;
810
817
  }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[]>;
811
- /** List Container Template statistics. */
812
- listTemplateStatistics: (conf?: {
813
- headers?: {
814
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
815
- } | undefined;
816
- queryParameters?: {
817
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
818
- templateId?: string | undefined;
819
- category?: string | undefined;
820
- } | undefined;
821
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
822
- category?: string | undefined;
823
- templates?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerTemplateStatsResponse[] | undefined;
824
- }>;
825
818
  };
826
819
  declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
827
820
  /** Return the BaseItem of the Contract with the given ID. */
@@ -2903,6 +2896,17 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
2903
2896
  receivingDisabled: boolean;
2904
2897
  updatedAt: string;
2905
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
+ }>;
2906
2910
  /** List backups belonging to a MailAddress. */
2907
2911
  listBackupsForMailAddress: (conf: {
2908
2912
  mailAddressId: string;
@@ -2932,6 +2936,13 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
2932
2936
  order?: ("asc" | "desc")[] | undefined;
2933
2937
  } | undefined;
2934
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[]>;
2935
2946
  /** List mail settings of a Project. */
2936
2947
  listProjectMailSettings: (conf: {
2937
2948
  projectId: string;
@@ -2944,24 +2955,6 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
2944
2955
  projectId: string;
2945
2956
  whitelist: string[];
2946
2957
  }>;
2947
- /** Get a Mail RateLimit. */
2948
- getMailRateLimit: (conf: {
2949
- mailRateLimitId: string;
2950
- headers?: {
2951
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2952
- "x-access-token"?: string | undefined;
2953
- } | undefined;
2954
- }) => import("@mittwald/react-use-promise").AsyncResource<{
2955
- id: string;
2956
- rateLimit: number;
2957
- }>;
2958
- /** List Mail RateLimits. */
2959
- listMailRateLimits: (conf?: {
2960
- headers?: {
2961
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2962
- "x-access-token"?: string | undefined;
2963
- } | undefined;
2964
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MailsystemRateLimit[]>;
2965
2958
  };
2966
2959
  declare const buildMiscApi: (baseClient: MittwaldAPIV2Client) => {
2967
2960
  /** List valid time zones. */