@mittwald/api-client 4.450.0 → 4.452.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.
@@ -22,6 +22,8 @@ const buildAiHostingApi = (baseClient) => ({
22
22
  projectGetUsage: new ApiCallAsyncResourceFactory(descriptors.aiHostingProjectGetUsage, baseClient.aiHosting.projectGetUsage).getApiResource,
23
23
  });
24
24
  const buildAppApi = (baseClient) => ({
25
+ /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
26
+ getAppInstallationSystemSoftware: new ApiCallAsyncResourceFactory(descriptors.appGetAppInstallationSystemSoftware, baseClient.app.getAppInstallationSystemSoftware).getApiResource,
25
27
  /** Get an App. */
26
28
  getApp: new ApiCallAsyncResourceFactory(descriptors.appGetApp, baseClient.app.getApp).getApiResource,
27
29
  /** Get an AppInstallation. */
@@ -50,8 +52,6 @@ const buildAppApi = (baseClient) => ({
50
52
  listUpdateCandidatesForAppversion: new ApiCallAsyncResourceFactory(descriptors.appListUpdateCandidatesForAppversion, baseClient.app.listUpdateCandidatesForAppversion).getApiResource,
51
53
  /** Get runtime status belonging to an AppInstallation. */
52
54
  retrieveStatus: new ApiCallAsyncResourceFactory(descriptors.appRetrieveStatus, baseClient.app.retrieveStatus).getApiResource,
53
- /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
54
- getAppInstallationSystemSoftware: new ApiCallAsyncResourceFactory(descriptors.appGetAppInstallationSystemSoftware, baseClient.app.getAppInstallationSystemSoftware).getApiResource,
55
55
  });
56
56
  const buildArticleApi = (baseClient) => ({
57
57
  /** Get an Article. */
@@ -43,6 +43,10 @@ export class MittwaldAPIV2Client extends ApiClientBase {
43
43
  };
44
44
  /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
45
45
  app = {
46
+ /** Detach a staging AppInstallation from its source. */
47
+ detachAppinstallationStaging: this.requestFunctionFactory(descriptors.appDetachAppinstallationStaging),
48
+ /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
49
+ getAppInstallationSystemSoftware: this.requestFunctionFactory(descriptors.appGetAppInstallationSystemSoftware),
46
50
  /** Get an App. */
47
51
  getApp: this.requestFunctionFactory(descriptors.appGetApp),
48
52
  /** Get an AppInstallation. */
@@ -75,20 +79,16 @@ export class MittwaldAPIV2Client extends ApiClientBase {
75
79
  listSystemsoftwareversions: this.requestFunctionFactory(descriptors.appListSystemsoftwareversions),
76
80
  /** List update candidates belonging to an AppVersion. */
77
81
  listUpdateCandidatesForAppversion: this.requestFunctionFactory(descriptors.appListUpdateCandidatesForAppversion),
82
+ /** Promote a staging AppInstallation. */
83
+ promoteAppinstallationStaging: this.requestFunctionFactory(descriptors.appPromoteAppinstallationStaging),
78
84
  /** Request a copy of an AppInstallation. */
79
85
  requestAppinstallationCopy: this.requestFunctionFactory(descriptors.appRequestAppinstallationCopy),
86
+ /** Request a staging for an AppInstallation. */
87
+ requestAppinstallationStaging: this.requestFunctionFactory(descriptors.appRequestAppinstallationStaging),
80
88
  /** Get runtime status belonging to an AppInstallation. */
81
89
  retrieveStatus: this.requestFunctionFactory(descriptors.appRetrieveStatus),
82
90
  /** Remove linkage between an AppInstallation and a Database. */
83
91
  unlinkDatabase: this.requestFunctionFactory(descriptors.appUnlinkDatabase),
84
- /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
85
- getAppInstallationSystemSoftware: this.requestFunctionFactory(descriptors.appGetAppInstallationSystemSoftware),
86
- /** Detach a staging AppInstallation from its source. */
87
- detachAppinstallationStaging: this.requestFunctionFactory(descriptors.appDetachAppinstallationStaging),
88
- /** Promote a staging AppInstallation. */
89
- promoteAppinstallationStaging: this.requestFunctionFactory(descriptors.appPromoteAppinstallationStaging),
90
- /** Request a staging for an AppInstallation. */
91
- requestAppinstallationStaging: this.requestFunctionFactory(descriptors.appRequestAppinstallationStaging),
92
92
  };
93
93
  /** The article API allows you to read article information. */
94
94
  article = {
@@ -100,6 +100,18 @@ export const aiHostingProjectLinkContainer = {
100
100
  method: "POST",
101
101
  operationId: "ai-hosting-project-link-container",
102
102
  };
103
+ /** Detach a staging AppInstallation from its source. */
104
+ export const appDetachAppinstallationStaging = {
105
+ path: "/v2/app-installations/{appInstallationId}/actions/detach-staging",
106
+ method: "POST",
107
+ operationId: "app-detach-appinstallation-staging",
108
+ };
109
+ /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
110
+ export const appGetAppInstallationSystemSoftware = {
111
+ path: "/v2/app-installations/{appInstallationId}/system-software",
112
+ method: "GET",
113
+ operationId: "app-get-app-installation-system-software",
114
+ };
103
115
  /** Get an App. */
104
116
  export const appGetApp = {
105
117
  path: "/v2/apps/{appId}",
@@ -196,12 +208,24 @@ export const appListUpdateCandidatesForAppversion = {
196
208
  method: "GET",
197
209
  operationId: "app-list-update-candidates-for-appversion",
198
210
  };
211
+ /** Promote a staging AppInstallation. */
212
+ export const appPromoteAppinstallationStaging = {
213
+ path: "/v2/app-installations/{appInstallationId}/actions/promote-staging",
214
+ method: "POST",
215
+ operationId: "app-promote-appinstallation-staging",
216
+ };
199
217
  /** Request a copy of an AppInstallation. */
200
218
  export const appRequestAppinstallationCopy = {
201
219
  path: "/v2/app-installations/{appInstallationId}/actions/copy",
202
220
  method: "POST",
203
221
  operationId: "app-request-appinstallation-copy",
204
222
  };
223
+ /** Request a staging for an AppInstallation. */
224
+ export const appRequestAppinstallationStaging = {
225
+ path: "/v2/app-installations/{appInstallationId}/actions/staging",
226
+ method: "POST",
227
+ operationId: "app-request-appinstallation-staging",
228
+ };
205
229
  /** Get runtime status belonging to an AppInstallation. */
206
230
  export const appRetrieveStatus = {
207
231
  path: "/v2/app-installations/{appInstallationId}/status",
@@ -2794,27 +2818,3 @@ export const verificationVerifyCompany = {
2794
2818
  method: "POST",
2795
2819
  operationId: "verification-verify-company",
2796
2820
  };
2797
- /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
2798
- export const appGetAppInstallationSystemSoftware = {
2799
- path: "/v2/app-installations/{appInstallationId}/system-software",
2800
- method: "GET",
2801
- operationId: "app-get-app-installation-system-software",
2802
- };
2803
- /** Detach a staging AppInstallation from its source. */
2804
- export const appDetachAppinstallationStaging = {
2805
- path: "/v2/app-installations/{appInstallationId}/actions/detach-staging",
2806
- method: "POST",
2807
- operationId: "app-detach-appinstallation-staging",
2808
- };
2809
- /** Promote a staging AppInstallation. */
2810
- export const appPromoteAppinstallationStaging = {
2811
- path: "/v2/app-installations/{appInstallationId}/actions/promote-staging",
2812
- method: "POST",
2813
- operationId: "app-promote-appinstallation-staging",
2814
- };
2815
- /** Request a staging for an AppInstallation. */
2816
- export const appRequestAppinstallationStaging = {
2817
- path: "/v2/app-installations/{appInstallationId}/actions/staging",
2818
- method: "POST",
2819
- operationId: "app-request-appinstallation-staging",
2820
- };
@@ -22,6 +22,8 @@ const buildAiHostingApi = (baseClient) => ({
22
22
  projectGetUsage: new ApiCallAsyncResourceFactory(descriptors.aiHostingProjectGetUsage, baseClient.aiHosting.projectGetUsage).getApiResource,
23
23
  });
24
24
  const buildAppApi = (baseClient) => ({
25
+ /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
26
+ getAppInstallationSystemSoftware: new ApiCallAsyncResourceFactory(descriptors.appGetAppInstallationSystemSoftware, baseClient.app.getAppInstallationSystemSoftware).getApiResource,
25
27
  /** Get an App. */
26
28
  getApp: new ApiCallAsyncResourceFactory(descriptors.appGetApp, baseClient.app.getApp).getApiResource,
27
29
  /** Get an AppInstallation. */
@@ -50,8 +52,6 @@ const buildAppApi = (baseClient) => ({
50
52
  listUpdateCandidatesForAppversion: new ApiCallAsyncResourceFactory(descriptors.appListUpdateCandidatesForAppversion, baseClient.app.listUpdateCandidatesForAppversion).getApiResource,
51
53
  /** Get runtime status belonging to an AppInstallation. */
52
54
  retrieveStatus: new ApiCallAsyncResourceFactory(descriptors.appRetrieveStatus, baseClient.app.retrieveStatus).getApiResource,
53
- /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
54
- getAppInstallationSystemSoftware: new ApiCallAsyncResourceFactory(descriptors.appGetAppInstallationSystemSoftware, baseClient.app.getAppInstallationSystemSoftware).getApiResource,
55
55
  });
56
56
  const buildArticleApi = (baseClient) => ({
57
57
  /** Get an Article. */
@@ -43,6 +43,10 @@ export class MittwaldAPIV3NextClient extends ApiClientBase {
43
43
  };
44
44
  /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
45
45
  app = {
46
+ /** Detach a staging AppInstallation from its source. */
47
+ detachAppinstallationStaging: this.requestFunctionFactory(descriptors.appDetachAppinstallationStaging),
48
+ /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
49
+ getAppInstallationSystemSoftware: this.requestFunctionFactory(descriptors.appGetAppInstallationSystemSoftware),
46
50
  /** Get an App. */
47
51
  getApp: this.requestFunctionFactory(descriptors.appGetApp),
48
52
  /** Get an AppInstallation. */
@@ -75,20 +79,16 @@ export class MittwaldAPIV3NextClient extends ApiClientBase {
75
79
  listSystemsoftwareversions: this.requestFunctionFactory(descriptors.appListSystemsoftwareversions),
76
80
  /** List update candidates belonging to an AppVersion. */
77
81
  listUpdateCandidatesForAppversion: this.requestFunctionFactory(descriptors.appListUpdateCandidatesForAppversion),
82
+ /** Promote a staging AppInstallation. */
83
+ promoteAppinstallationStaging: this.requestFunctionFactory(descriptors.appPromoteAppinstallationStaging),
78
84
  /** Request a copy of an AppInstallation. */
79
85
  requestAppinstallationCopy: this.requestFunctionFactory(descriptors.appRequestAppinstallationCopy),
86
+ /** Request a staging for an AppInstallation. */
87
+ requestAppinstallationStaging: this.requestFunctionFactory(descriptors.appRequestAppinstallationStaging),
80
88
  /** Get runtime status belonging to an AppInstallation. */
81
89
  retrieveStatus: this.requestFunctionFactory(descriptors.appRetrieveStatus),
82
90
  /** Remove linkage between an AppInstallation and a Database. */
83
91
  unlinkDatabase: this.requestFunctionFactory(descriptors.appUnlinkDatabase),
84
- /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
85
- getAppInstallationSystemSoftware: this.requestFunctionFactory(descriptors.appGetAppInstallationSystemSoftware),
86
- /** Detach a staging AppInstallation from its source. */
87
- detachAppinstallationStaging: this.requestFunctionFactory(descriptors.appDetachAppinstallationStaging),
88
- /** Promote a staging AppInstallation. */
89
- promoteAppinstallationStaging: this.requestFunctionFactory(descriptors.appPromoteAppinstallationStaging),
90
- /** Request a staging for an AppInstallation. */
91
- requestAppinstallationStaging: this.requestFunctionFactory(descriptors.appRequestAppinstallationStaging),
92
92
  };
93
93
  /** The article API allows you to read article information. */
94
94
  article = {
@@ -100,6 +100,18 @@ export const aiHostingProjectLinkContainer = {
100
100
  method: "POST",
101
101
  operationId: "ai-hosting-project-link-container",
102
102
  };
103
+ /** Detach a staging AppInstallation from its source. */
104
+ export const appDetachAppinstallationStaging = {
105
+ path: "/v3-next/app-installations/{appInstallationId}/actions/detach-staging",
106
+ method: "POST",
107
+ operationId: "app-detach-appinstallation-staging",
108
+ };
109
+ /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
110
+ export const appGetAppInstallationSystemSoftware = {
111
+ path: "/v3-next/app-installations/{appInstallationId}/system-software",
112
+ method: "GET",
113
+ operationId: "app-get-app-installation-system-software",
114
+ };
103
115
  /** Get an App. */
104
116
  export const appGetApp = {
105
117
  path: "/v3-next/apps/{appId}",
@@ -196,12 +208,24 @@ export const appListUpdateCandidatesForAppversion = {
196
208
  method: "GET",
197
209
  operationId: "app-list-update-candidates-for-appversion",
198
210
  };
211
+ /** Promote a staging AppInstallation. */
212
+ export const appPromoteAppinstallationStaging = {
213
+ path: "/v3-next/app-installations/{appInstallationId}/actions/promote-staging",
214
+ method: "POST",
215
+ operationId: "app-promote-appinstallation-staging",
216
+ };
199
217
  /** Request a copy of an AppInstallation. */
200
218
  export const appRequestAppinstallationCopy = {
201
219
  path: "/v3-next/app-installations/{appInstallationId}/actions/copy",
202
220
  method: "POST",
203
221
  operationId: "app-request-appinstallation-copy",
204
222
  };
223
+ /** Request a staging for an AppInstallation. */
224
+ export const appRequestAppinstallationStaging = {
225
+ path: "/v3-next/app-installations/{appInstallationId}/actions/staging",
226
+ method: "POST",
227
+ operationId: "app-request-appinstallation-staging",
228
+ };
205
229
  /** Get runtime status belonging to an AppInstallation. */
206
230
  export const appRetrieveStatus = {
207
231
  path: "/v3-next/app-installations/{appInstallationId}/status",
@@ -2794,27 +2818,3 @@ export const verificationVerifyCompany = {
2794
2818
  method: "POST",
2795
2819
  operationId: "verification-verify-company",
2796
2820
  };
2797
- /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
2798
- export const appGetAppInstallationSystemSoftware = {
2799
- path: "/v3-next/app-installations/{appInstallationId}/system-software",
2800
- method: "GET",
2801
- operationId: "app-get-app-installation-system-software",
2802
- };
2803
- /** Detach a staging AppInstallation from its source. */
2804
- export const appDetachAppinstallationStaging = {
2805
- path: "/v3-next/app-installations/{appInstallationId}/actions/detach-staging",
2806
- method: "POST",
2807
- operationId: "app-detach-appinstallation-staging",
2808
- };
2809
- /** Promote a staging AppInstallation. */
2810
- export const appPromoteAppinstallationStaging = {
2811
- path: "/v3-next/app-installations/{appInstallationId}/actions/promote-staging",
2812
- method: "POST",
2813
- operationId: "app-promote-appinstallation-staging",
2814
- };
2815
- /** Request a staging for an AppInstallation. */
2816
- export const appRequestAppinstallationStaging = {
2817
- path: "/v3-next/app-installations/{appInstallationId}/actions/staging",
2818
- method: "POST",
2819
- operationId: "app-request-appinstallation-staging",
2820
- };
@@ -1 +1 @@
1
- export const MittwaldAPIClientVersion = '4.449.0';
1
+ export const MittwaldAPIClientVersion = '4.451.0';
@@ -112,6 +112,18 @@ declare const buildAiHostingApi: (baseClient: MittwaldAPIV2Client) => {
112
112
  }>;
113
113
  };
114
114
  declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
115
+ /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
116
+ getAppInstallationSystemSoftware: (conf: {
117
+ appInstallationId: string;
118
+ headers?: {
119
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
120
+ "x-access-token"?: string | undefined;
121
+ } | undefined;
122
+ queryParameters?: {
123
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
124
+ tagFilter?: string | undefined;
125
+ } | undefined;
126
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftware[]>;
115
127
  /** Get an App. */
116
128
  getApp: (conf: {
117
129
  appId: string;
@@ -137,6 +149,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
137
149
  appId: string;
138
150
  appName: string;
139
151
  appVersion: import("./types.js").MittwaldAPIV2.Components.Schemas.AppVersionStatus;
152
+ autoUpdatesActivated?: boolean | undefined;
140
153
  createdAt: string;
141
154
  customDocumentRoot?: string | undefined;
142
155
  deletionRequested?: boolean | undefined;
@@ -348,18 +361,6 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
348
361
  state: "running" | "stopped" | "exited";
349
362
  uptimeSeconds?: number | undefined;
350
363
  }>;
351
- /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
352
- getAppInstallationSystemSoftware: (conf: {
353
- appInstallationId: string;
354
- headers?: {
355
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
356
- "x-access-token"?: string | undefined;
357
- } | undefined;
358
- queryParameters?: {
359
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
360
- tagFilter?: string | undefined;
361
- } | undefined;
362
- }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftware[]>;
363
364
  };
364
365
  declare const buildArticleApi: (baseClient: MittwaldAPIV2Client) => {
365
366
  /** Get an Article. */
@@ -640,6 +641,8 @@ declare const buildContainerApi: (baseClient: MittwaldAPIV2Client) => {
640
641
  serviceId: string;
641
642
  headers?: {
642
643
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
644
+ Range?: string | undefined;
645
+ "If-Range"?: string | undefined;
643
646
  "x-access-token"?: string | undefined;
644
647
  } | undefined;
645
648
  queryParameters?: {
@@ -1861,6 +1864,7 @@ declare const buildCronjobApi: (baseClient: MittwaldAPIV2Client) => {
1861
1864
  } | undefined;
1862
1865
  }) => import("@mittwald/react-use-promise").AsyncResource<{
1863
1866
  message: string;
1867
+ recommendation?: string | undefined;
1864
1868
  }>;
1865
1869
  /** Get a CronjobExecution. */
1866
1870
  getExecution: (conf: {
@@ -3708,6 +3712,8 @@ declare const buildProjectFileSystemApi: (baseClient: MittwaldAPIV2Client) => {
3708
3712
  projectId: string;
3709
3713
  headers?: {
3710
3714
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3715
+ Range?: string | undefined;
3716
+ "If-Range"?: string | undefined;
3711
3717
  "x-access-token"?: string | undefined;
3712
3718
  } | undefined;
3713
3719
  queryParameters?: {