@mittwald/api-client 3.1.3 → 3.1.4

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.
Files changed (17) hide show
  1. package/dist/cjs/generated/v2/client-react.d.ts +13 -13
  2. package/dist/cjs/generated/v2/client-react.js +13 -13
  3. package/dist/cjs/generated/v2/client.d.ts +23 -21
  4. package/dist/cjs/generated/v2/client.js +21 -21
  5. package/dist/cjs/generated/v2/descriptors.d.ts +24 -24
  6. package/dist/cjs/generated/v2/descriptors.js +26 -26
  7. package/dist/cjs/generated/v2/types.d.ts +9 -3
  8. package/dist/esm/generated/v2/client-react.d.ts +13 -13
  9. package/dist/esm/generated/v2/client-react.js +13 -13
  10. package/dist/esm/generated/v2/client.d.ts +23 -21
  11. package/dist/esm/generated/v2/client.js +21 -21
  12. package/dist/esm/generated/v2/descriptors.d.ts +24 -24
  13. package/dist/esm/generated/v2/descriptors.js +26 -26
  14. package/dist/esm/generated/v2/types.d.ts +9 -3
  15. package/dist/version.d.ts +1 -1
  16. package/dist/version.js +1 -1
  17. package/package.json +1 -1
package/dist/cjs/generated/v2/client-react.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import MittwaldAPIV2Client from "./client.js";
2
2
  export * from "@mittwald/react-use-promise/types";
3
3
  declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
4
- /** get a specific `App` */
4
+ /** Get a specific `App`. */
5
5
  getApp: (conf: {
6
6
  appId: string;
7
7
  headers?: {
@@ -14,7 +14,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
14
14
  name: string;
15
15
  tags: string[];
16
16
  }>;
17
- /** get a specific `AppInstallation` */
17
+ /** Get a specific `AppInstallation`. */
18
18
  getAppinstallation: (conf: {
19
19
  appInstallationId: string;
20
20
  headers?: {
@@ -39,7 +39,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
39
39
  updatePolicy?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppUpdatePolicy | undefined;
40
40
  userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSavedUserInput[] | undefined;
41
41
  }>;
42
- /** get a specific `AppVersion` */
42
+ /** Get a specific `AppVersion`. */
43
43
  getAppversion: (conf: {
44
44
  appId: string;
45
45
  appVersionId: string;
@@ -60,7 +60,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
60
60
  systemSoftwareDependencies?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[] | undefined;
61
61
  userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppUserInput[] | undefined;
62
62
  }>;
63
- /** get the missing requirements of an appInstallation for a specific target AppVersion */
63
+ /** Get the missing requirements of an appInstallation for a specific target AppVersion. */
64
64
  getMissingDependenciesForAppinstallation: (conf: {
65
65
  queryParameters: {
66
66
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
@@ -74,7 +74,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
74
74
  missingSystemSoftwareDependencies?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[] | undefined;
75
75
  missingUserInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppUserInput[] | undefined;
76
76
  }>;
77
- /** get a specific `SystemSoftware` */
77
+ /** Get a specific `SystemSoftware`. */
78
78
  getSystemsoftware: (conf: {
79
79
  systemSoftwareId: string;
80
80
  headers?: {
@@ -86,7 +86,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
86
86
  name: string;
87
87
  tags: string[];
88
88
  }>;
89
- /** get a specific `SystemSoftwareVersion` */
89
+ /** Get a specific `SystemSoftwareVersion`. */
90
90
  getSystemsoftwareversion: (conf: {
91
91
  systemSoftwareId: string;
92
92
  systemSoftwareVersionId: string;
@@ -102,7 +102,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
102
102
  systemSoftwareDependencies?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareDependency[] | undefined;
103
103
  userInputs?: import("./types.js").MittwaldAPIV2.Components.Schemas.AppUserInput[] | undefined;
104
104
  }>;
105
- /** get all `AppInstallations` inside a specific `Project` */
105
+ /** Get all `AppInstallations` inside a specific `Project`. */
106
106
  listAppinstallations: (conf: {
107
107
  projectId: string;
108
108
  headers?: {
@@ -116,7 +116,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
116
116
  skip?: number | undefined;
117
117
  } | undefined;
118
118
  }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppInstallation[]>;
119
- /** get all available `Apps` */
119
+ /** Get all available `Apps`. */
120
120
  listApps: (conf?: {
121
121
  headers?: {
122
122
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
@@ -129,7 +129,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
129
129
  skip?: number | undefined;
130
130
  } | undefined;
131
131
  } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppApp[]>;
132
- /** get all `AppVersions` of a specific `App` */
132
+ /** Get all `AppVersions` of a specific `App`. */
133
133
  listAppversions: (conf: {
134
134
  appId: string;
135
135
  headers?: {
@@ -137,7 +137,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
137
137
  "x-access-token"?: string | undefined;
138
138
  } | undefined;
139
139
  }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppVersion[]>;
140
- /** get all available `SystemSoftware` */
140
+ /** Get all available `SystemSoftware`. */
141
141
  listSystemsoftwares: (conf?: {
142
142
  headers?: {
143
143
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
@@ -150,7 +150,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
150
150
  skip?: number | undefined;
151
151
  } | undefined;
152
152
  } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftware[]>;
153
- /** get all available `SystemSoftwareVersions` of a specific `SystemSoftware` */
153
+ /** Get all available `SystemSoftwareVersions` of a specific `SystemSoftware`. */
154
154
  listSystemsoftwareversions: (conf: {
155
155
  systemSoftwareId: string;
156
156
  headers?: {
@@ -162,7 +162,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
162
162
  versionRange?: string | undefined;
163
163
  } | undefined;
164
164
  }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareVersion[]>;
165
- /** get all update candidates for a specific `AppVersion` */
165
+ /** Get all update candidates for a specific `AppVersion`. */
166
166
  listUpdateCandidatesForAppversion: (conf: {
167
167
  appId: string;
168
168
  baseAppVersionId: string;
@@ -171,7 +171,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
171
171
  "x-access-token"?: string | undefined;
172
172
  } | undefined;
173
173
  }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppVersion[]>;
174
- /** get runtime status of a specific `AppInstallation` */
174
+ /** Get runtime status of a specific `AppInstallation`. */
175
175
  retrieveStatus: (conf: {
176
176
  appInstallationId: string;
177
177
  headers?: {
package/dist/cjs/generated/v2/client-react.js CHANGED
@@ -31,31 +31,31 @@ const react_1 = require("@mittwald/api-client-commons/react");
31
31
  const descriptors = __importStar(require("./descriptors.js"));
32
32
  __exportStar(require("@mittwald/react-use-promise/types"), exports);
33
33
  const buildAppApi = (baseClient) => ({
34
- /** get a specific `App` */
34
+ /** Get a specific `App`. */
35
35
  getApp: new react_1.ApiCallAsyncResourceFactory(descriptors.appGetApp, baseClient.app.getApp).getApiResource,
36
- /** get a specific `AppInstallation` */
36
+ /** Get a specific `AppInstallation`. */
37
37
  getAppinstallation: new react_1.ApiCallAsyncResourceFactory(descriptors.appGetAppinstallation, baseClient.app.getAppinstallation).getApiResource,
38
- /** get a specific `AppVersion` */
38
+ /** Get a specific `AppVersion`. */
39
39
  getAppversion: new react_1.ApiCallAsyncResourceFactory(descriptors.appGetAppversion, baseClient.app.getAppversion).getApiResource,
40
- /** get the missing requirements of an appInstallation for a specific target AppVersion */
40
+ /** Get the missing requirements of an appInstallation for a specific target AppVersion. */
41
41
  getMissingDependenciesForAppinstallation: new react_1.ApiCallAsyncResourceFactory(descriptors.appGetMissingDependenciesForAppinstallation, baseClient.app.getMissingDependenciesForAppinstallation).getApiResource,
42
- /** get a specific `SystemSoftware` */
42
+ /** Get a specific `SystemSoftware`. */
43
43
  getSystemsoftware: new react_1.ApiCallAsyncResourceFactory(descriptors.appGetSystemsoftware, baseClient.app.getSystemsoftware).getApiResource,
44
- /** get a specific `SystemSoftwareVersion` */
44
+ /** Get a specific `SystemSoftwareVersion`. */
45
45
  getSystemsoftwareversion: new react_1.ApiCallAsyncResourceFactory(descriptors.appGetSystemsoftwareversion, baseClient.app.getSystemsoftwareversion).getApiResource,
46
- /** get all `AppInstallations` inside a specific `Project` */
46
+ /** Get all `AppInstallations` inside a specific `Project`. */
47
47
  listAppinstallations: new react_1.ApiCallAsyncResourceFactory(descriptors.appListAppinstallations, baseClient.app.listAppinstallations).getApiResource,
48
- /** get all available `Apps` */
48
+ /** Get all available `Apps`. */
49
49
  listApps: new react_1.ApiCallAsyncResourceFactory(descriptors.appListApps, baseClient.app.listApps).getApiResource,
50
- /** get all `AppVersions` of a specific `App` */
50
+ /** Get all `AppVersions` of a specific `App`. */
51
51
  listAppversions: new react_1.ApiCallAsyncResourceFactory(descriptors.appListAppversions, baseClient.app.listAppversions).getApiResource,
52
- /** get all available `SystemSoftware` */
52
+ /** Get all available `SystemSoftware`. */
53
53
  listSystemsoftwares: new react_1.ApiCallAsyncResourceFactory(descriptors.appListSystemsoftwares, baseClient.app.listSystemsoftwares).getApiResource,
54
- /** get all available `SystemSoftwareVersions` of a specific `SystemSoftware` */
54
+ /** Get all available `SystemSoftwareVersions` of a specific `SystemSoftware`. */
55
55
  listSystemsoftwareversions: new react_1.ApiCallAsyncResourceFactory(descriptors.appListSystemsoftwareversions, baseClient.app.listSystemsoftwareversions).getApiResource,
56
- /** get all update candidates for a specific `AppVersion` */
56
+ /** Get all update candidates for a specific `AppVersion`. */
57
57
  listUpdateCandidatesForAppversion: new react_1.ApiCallAsyncResourceFactory(descriptors.appListUpdateCandidatesForAppversion, baseClient.app.listUpdateCandidatesForAppversion).getApiResource,
58
- /** get runtime status of a specific `AppInstallation` */
58
+ /** Get runtime status of a specific `AppInstallation`. */
59
59
  retrieveStatus: new react_1.ApiCallAsyncResourceFactory(descriptors.appRetrieveStatus, baseClient.app.retrieveStatus).getApiResource,
60
60
  });
61
61
  const buildArticleApi = (baseClient) => ({
package/dist/cjs/generated/v2/client.d.ts CHANGED
@@ -2,7 +2,7 @@ import { ApiClientBase } from "@mittwald/api-client-commons";
2
2
  export declare class MittwaldAPIV2Client extends ApiClientBase {
3
3
  /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
4
4
  readonly app: {
5
- /** execute a runtime concerning action on a specific `AppInstallation` */
5
+ /** Execute a runtime concerning action on a specific `AppInstallation`. */
6
6
  executeAction: (request: {
7
7
  appInstallationId: string;
8
8
  action: import("./types.js").MittwaldAPIV2.Components.Schemas.AppAction;
@@ -21,7 +21,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
21
21
  }, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
22
22
  [x: string]: unknown;
23
23
  }, 404, "application/json">>>;
24
- /** get a specific `App` */
24
+ /** Get a specific `App`. */
25
25
  getApp: (request: {
26
26
  appId: string;
27
27
  headers?: {
@@ -50,7 +50,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
50
50
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
51
51
  [x: string]: unknown;
52
52
  }, 404, "application/json">>>;
53
- /** get a specific `AppInstallation` */
53
+ /** Get a specific `AppInstallation`. */
54
54
  getAppinstallation: (request: {
55
55
  appInstallationId: string;
56
56
  headers?: {
@@ -91,7 +91,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
91
91
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
92
92
  [x: string]: unknown;
93
93
  }, 404, "application/json">>>;
94
- /** start uninstallation process for a specific `AppInstallation` */
94
+ /** Start uninstallation process for a specific `AppInstallation`. */
95
95
  uninstallAppinstallation: (request: {
96
96
  appInstallationId: string;
97
97
  headers?: {
@@ -115,7 +115,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
115
115
  }, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
116
116
  [x: string]: unknown;
117
117
  }, 404, "application/json">>>;
118
- /** patch desired properties of a specific `AppInstallation` */
118
+ /** Patch desired properties of a specific `AppInstallation`. */
119
119
  patchAppinstallation: (request: {
120
120
  appInstallationId: string;
121
121
  data?: {
@@ -159,7 +159,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
159
159
  }, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
160
160
  [x: string]: unknown;
161
161
  }, 404, "application/json">>>;
162
- /** get a specific `AppVersion` */
162
+ /** Get a specific `AppVersion`. */
163
163
  getAppversion: (request: {
164
164
  appId: string;
165
165
  appVersionId: string;
@@ -197,7 +197,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
197
197
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
198
198
  [x: string]: unknown;
199
199
  }, 404, "application/json">>>;
200
- /** get the missing requirements of an appInstallation for a specific target AppVersion */
200
+ /** Get the missing requirements of an appInstallation for a specific target AppVersion. */
201
201
  getMissingDependenciesForAppinstallation: (request: {
202
202
  queryParameters: {
203
203
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
@@ -233,7 +233,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
233
233
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
234
234
  [x: string]: unknown;
235
235
  }, 404, "application/json">>>;
236
- /** get a specific `SystemSoftware` */
236
+ /** Get a specific `SystemSoftware`. */
237
237
  getSystemsoftware: (request: {
238
238
  systemSoftwareId: string;
239
239
  headers?: {
@@ -261,7 +261,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
261
261
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
262
262
  [x: string]: unknown;
263
263
  }, 404, "application/json">>>;
264
- /** get a specific `SystemSoftwareVersion` */
264
+ /** Get a specific `SystemSoftwareVersion`. */
265
265
  getSystemsoftwareversion: (request: {
266
266
  systemSoftwareId: string;
267
267
  systemSoftwareVersionId: string;
@@ -294,7 +294,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
294
294
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
295
295
  [x: string]: unknown;
296
296
  }, 404, "application/json">>>;
297
- /** create linkage between an `AppInstallation` and a `Database` */
297
+ /** Create linkage between an `AppInstallation` and a MySql-`Database`. */
298
298
  linkDatabase: (request: {
299
299
  data: {
300
300
  databaseId: string;
@@ -333,7 +333,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
333
333
  }, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
334
334
  [x: string]: unknown;
335
335
  }, 404, "application/json">>>;
336
- /** get all `AppInstallations` inside a specific `Project` */
336
+ /** Get all `AppInstallations` inside a specific `Project`. */
337
337
  listAppinstallations: (request: {
338
338
  projectId: string;
339
339
  headers?: {
@@ -369,7 +369,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
369
369
  [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
370
370
  }>;
371
371
  }, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppInstallation[], 200, "application/json">>>;
372
- /** request a new `AppInstallation` */
372
+ /** Request a new `AppInstallation`. */
373
373
  requestAppinstallation: (request: {
374
374
  data: {
375
375
  appVersionId: string;
@@ -402,7 +402,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
402
402
  }, 201, "application/json"> | import("@mittwald/api-client-commons").Response<{
403
403
  [x: string]: unknown;
404
404
  }, 404, "application/json">>>;
405
- /** get all available `Apps` */
405
+ /** Get all available `Apps`. */
406
406
  listApps: (request?: {
407
407
  headers?: {
408
408
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
@@ -433,7 +433,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
433
433
  [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
434
434
  }>;
435
435
  }, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.AppApp[], 200, "application/json">>>;
436
- /** get all `AppVersions` of a specific `App` */
436
+ /** Get all `AppVersions` of a specific `App`. */
437
437
  listAppversions: (request: {
438
438
  appId: string;
439
439
  headers?: {
@@ -455,7 +455,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
455
455
  [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
456
456
  }>;
457
457
  }, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppVersion[], 200, "application/json">>>;
458
- /** get all available `SystemSoftware` */
458
+ /** Get all available `SystemSoftware`. */
459
459
  listSystemsoftwares: (request?: {
460
460
  headers?: {
461
461
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
@@ -486,7 +486,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
486
486
  [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
487
487
  }>;
488
488
  }, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftware[], 200, "application/json">>>;
489
- /** get all available `SystemSoftwareVersions` of a specific `SystemSoftware` */
489
+ /** Get all available `SystemSoftwareVersions` of a specific `SystemSoftware`. */
490
490
  listSystemsoftwareversions: (request: {
491
491
  systemSoftwareId: string;
492
492
  headers?: {
@@ -518,7 +518,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
518
518
  [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
519
519
  }>;
520
520
  }, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.AppSystemSoftwareVersion[], 200, "application/json">>>;
521
- /** get all update candidates for a specific `AppVersion` */
521
+ /** Get all update candidates for a specific `AppVersion`. */
522
522
  listUpdateCandidatesForAppversion: (request: {
523
523
  appId: string;
524
524
  baseAppVersionId: string;
@@ -542,10 +542,11 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
542
542
  [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
543
543
  }>;
544
544
  }, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.AppAppVersion[], 200, "application/json">>>;
545
- /** request a copy of an `AppInstallation` */
545
+ /** Request a copy of an `AppInstallation`. */
546
546
  requestAppinstallationCopy: (request: {
547
547
  data: {
548
548
  description: string;
549
+ targetProjectId?: string | undefined;
549
550
  };
550
551
  id: string;
551
552
  headers?: {
@@ -554,6 +555,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
554
555
  }) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
555
556
  data: {
556
557
  description: string;
558
+ targetProjectId?: string | undefined;
557
559
  };
558
560
  } & {
559
561
  pathParameters: {
@@ -568,7 +570,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
568
570
  }, 201, "application/json"> | import("@mittwald/api-client-commons").Response<{
569
571
  [x: string]: unknown;
570
572
  }, 404, "application/json">>>;
571
- /** get runtime status of a specific `AppInstallation` */
573
+ /** Get runtime status of a specific `AppInstallation`. */
572
574
  retrieveStatus: (request: {
573
575
  appInstallationId: string;
574
576
  headers?: {
@@ -590,7 +592,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
590
592
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
591
593
  [x: string]: unknown;
592
594
  }, 404, "application/json">>>;
593
- /** create linkage between an `AppInstallation` and `DatabaseUsers` */
595
+ /** Create linkage between an `AppInstallation` and `DatabaseUsers`. */
594
596
  setDatabaseUsers: (request: {
595
597
  appInstallationId: string;
596
598
  databaseId: string;
@@ -627,7 +629,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
627
629
  }, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
628
630
  [x: string]: unknown;
629
631
  }, 404, "application/json">>>;
630
- /** remove linkage between an `AppInstallation` and a `Database` */
632
+ /** Remove linkage between an `AppInstallation` and a `Database`. */
631
633
  unlinkDatabase: (request: {
632
634
  appInstallationId: string;
633
635
  databaseId: string;
package/dist/cjs/generated/v2/client.js CHANGED
@@ -34,47 +34,47 @@ class MittwaldAPIV2Client extends api_client_commons_1.ApiClientBase {
34
34
  super(...arguments);
35
35
  /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
36
36
  this.app = {
37
- /** execute a runtime concerning action on a specific `AppInstallation` */
37
+ /** Execute a runtime concerning action on a specific `AppInstallation`. */
38
38
  executeAction: this.requestFunctionFactory(descriptors.appExecuteAction),
39
- /** get a specific `App` */
39
+ /** Get a specific `App`. */
40
40
  getApp: this.requestFunctionFactory(descriptors.appGetApp),
41
- /** get a specific `AppInstallation` */
41
+ /** Get a specific `AppInstallation`. */
42
42
  getAppinstallation: this.requestFunctionFactory(descriptors.appGetAppinstallation),
43
- /** start uninstallation process for a specific `AppInstallation` */
43
+ /** Start uninstallation process for a specific `AppInstallation`. */
44
44
  uninstallAppinstallation: this.requestFunctionFactory(descriptors.appUninstallAppinstallation),
45
- /** patch desired properties of a specific `AppInstallation` */
45
+ /** Patch desired properties of a specific `AppInstallation`. */
46
46
  patchAppinstallation: this.requestFunctionFactory(descriptors.appPatchAppinstallation),
47
- /** get a specific `AppVersion` */
47
+ /** Get a specific `AppVersion`. */
48
48
  getAppversion: this.requestFunctionFactory(descriptors.appGetAppversion),
49
- /** get the missing requirements of an appInstallation for a specific target AppVersion */
49
+ /** Get the missing requirements of an appInstallation for a specific target AppVersion. */
50
50
  getMissingDependenciesForAppinstallation: this.requestFunctionFactory(descriptors.appGetMissingDependenciesForAppinstallation),
51
- /** get a specific `SystemSoftware` */
51
+ /** Get a specific `SystemSoftware`. */
52
52
  getSystemsoftware: this.requestFunctionFactory(descriptors.appGetSystemsoftware),
53
- /** get a specific `SystemSoftwareVersion` */
53
+ /** Get a specific `SystemSoftwareVersion`. */
54
54
  getSystemsoftwareversion: this.requestFunctionFactory(descriptors.appGetSystemsoftwareversion),
55
- /** create linkage between an `AppInstallation` and a `Database` */
55
+ /** Create linkage between an `AppInstallation` and a MySql-`Database`. */
56
56
  linkDatabase: this.requestFunctionFactory(descriptors.appLinkDatabase),
57
- /** get all `AppInstallations` inside a specific `Project` */
57
+ /** Get all `AppInstallations` inside a specific `Project`. */
58
58
  listAppinstallations: this.requestFunctionFactory(descriptors.appListAppinstallations),
59
- /** request a new `AppInstallation` */
59
+ /** Request a new `AppInstallation`. */
60
60
  requestAppinstallation: this.requestFunctionFactory(descriptors.appRequestAppinstallation),
61
- /** get all available `Apps` */
61
+ /** Get all available `Apps`. */
62
62
  listApps: this.requestFunctionFactory(descriptors.appListApps),
63
- /** get all `AppVersions` of a specific `App` */
63
+ /** Get all `AppVersions` of a specific `App`. */
64
64
  listAppversions: this.requestFunctionFactory(descriptors.appListAppversions),
65
- /** get all available `SystemSoftware` */
65
+ /** Get all available `SystemSoftware`. */
66
66
  listSystemsoftwares: this.requestFunctionFactory(descriptors.appListSystemsoftwares),
67
- /** get all available `SystemSoftwareVersions` of a specific `SystemSoftware` */
67
+ /** Get all available `SystemSoftwareVersions` of a specific `SystemSoftware`. */
68
68
  listSystemsoftwareversions: this.requestFunctionFactory(descriptors.appListSystemsoftwareversions),
69
- /** get all update candidates for a specific `AppVersion` */
69
+ /** Get all update candidates for a specific `AppVersion`. */
70
70
  listUpdateCandidatesForAppversion: this.requestFunctionFactory(descriptors.appListUpdateCandidatesForAppversion),
71
- /** request a copy of an `AppInstallation` */
71
+ /** Request a copy of an `AppInstallation`. */
72
72
  requestAppinstallationCopy: this.requestFunctionFactory(descriptors.appRequestAppinstallationCopy),
73
- /** get runtime status of a specific `AppInstallation` */
73
+ /** Get runtime status of a specific `AppInstallation`. */
74
74
  retrieveStatus: this.requestFunctionFactory(descriptors.appRetrieveStatus),
75
- /** create linkage between an `AppInstallation` and `DatabaseUsers` */
75
+ /** Create linkage between an `AppInstallation` and `DatabaseUsers`. */
76
76
  setDatabaseUsers: this.requestFunctionFactory(descriptors.appSetDatabaseUsers),
77
- /** remove linkage between an `AppInstallation` and a `Database` */
77
+ /** Remove linkage between an `AppInstallation` and a `Database`. */
78
78
  unlinkDatabase: this.requestFunctionFactory(descriptors.appUnlinkDatabase),
79
79
  };
80
80
  /** The article API allows you to read article information. */
package/dist/cjs/generated/v2/descriptors.d.ts CHANGED
@@ -3,47 +3,47 @@ import { RequestType } from "@mittwald/api-client-commons";
3
3
  import { Response } from "@mittwald/api-client-commons";
4
4
  import { OpenAPIOperation } from "@mittwald/api-client-commons";
5
5
  import { MittwaldAPIV2 } from "./types.js";
6
- /** execute a runtime concerning action on a specific `AppInstallation` */
6
+ /** Execute a runtime concerning action on a specific `AppInstallation`. */
7
7
  export declare const appExecuteAction: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdActionsAction.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdActionsAction.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdActionsAction.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdActionsAction.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdActionsAction.Post.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdActionsAction.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdActionsAction.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
8
- /** get a specific `App` */
8
+ /** Get a specific `App`. */
9
9
  export declare const appGetApp: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2AppsAppId.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppsAppId.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppsAppId.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppsAppId.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppsAppId.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppsAppId.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
10
- /** get a specific `AppInstallation` */
10
+ /** Get a specific `AppInstallation`. */
11
11
  export declare const appGetAppinstallation: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
12
- /** start uninstallation process for a specific `AppInstallation` */
12
+ /** Start uninstallation process for a specific `AppInstallation`. */
13
13
  export declare const appUninstallAppinstallation: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Delete.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Delete.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Delete.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Delete.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Delete.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Delete.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
14
- /** patch desired properties of a specific `AppInstallation` */
14
+ /** Patch desired properties of a specific `AppInstallation`. */
15
15
  export declare const appPatchAppinstallation: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Patch.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Patch.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Patch.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Patch.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Patch.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Patch.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationId.Patch.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
16
- /** get a specific `AppVersion` */
16
+ /** Get a specific `AppVersion`. */
17
17
  export declare const appGetAppversion: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsAppVersionId.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsAppVersionId.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsAppVersionId.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsAppVersionId.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsAppVersionId.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsAppVersionId.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
18
- /** get the missing requirements of an appInstallation for a specific target AppVersion */
18
+ /** Get the missing requirements of an appInstallation for a specific target AppVersion. */
19
19
  export declare const appGetMissingDependenciesForAppinstallation: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdMissingDependencies.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdMissingDependencies.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdMissingDependencies.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdMissingDependencies.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdMissingDependencies.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdMissingDependencies.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
20
- /** get a specific `SystemSoftware` */
20
+ /** Get a specific `SystemSoftware`. */
21
21
  export declare const appGetSystemsoftware: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwaresSystemSoftwareId.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwaresSystemSoftwareId.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwaresSystemSoftwareId.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2SystemsoftwaresSystemSoftwareId.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2SystemsoftwaresSystemSoftwareId.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2SystemsoftwaresSystemSoftwareId.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
22
- /** get a specific `SystemSoftwareVersion` */
22
+ /** Get a specific `SystemSoftwareVersion`. */
23
23
  export declare const appGetSystemsoftwareversion: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersionsSystemSoftwareVersionId.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersionsSystemSoftwareVersionId.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersionsSystemSoftwareVersionId.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersionsSystemSoftwareVersionId.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersionsSystemSoftwareVersionId.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersionsSystemSoftwareVersionId.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
24
- /** create linkage between an `AppInstallation` and a `Database` */
24
+ /** Create linkage between an `AppInstallation` and a MySql-`Database`. */
25
25
  export declare const appLinkDatabase: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabases.Put.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabases.Put.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabases.Put.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabases.Put.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabases.Put.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabases.Put.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabases.Put.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
26
- /** get all `AppInstallations` inside a specific `Project` */
26
+ /** Get all `AppInstallations` inside a specific `Project`. */
27
27
  export declare const appListAppinstallations: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdAppinstallations.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdAppinstallations.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdAppinstallations.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdAppinstallations.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdAppinstallations.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
28
- /** request a new `AppInstallation` */
28
+ /** Request a new `AppInstallation`. */
29
29
  export declare const appRequestAppinstallation: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdAppinstallations.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdAppinstallations.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdAppinstallations.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdAppinstallations.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdAppinstallations.Post.Responses.$201.Content.ApplicationJson>, 201, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdAppinstallations.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdAppinstallations.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
30
- /** get all available `Apps` */
30
+ /** Get all available `Apps`. */
31
31
  export declare const appListApps: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2Apps.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2Apps.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2Apps.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2Apps.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Apps.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
32
- /** get all `AppVersions` of a specific `App` */
32
+ /** Get all `AppVersions` of a specific `App`. */
33
33
  export declare const appListAppversions: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersions.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersions.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersions.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersions.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersions.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
34
- /** get all available `SystemSoftware` */
34
+ /** Get all available `SystemSoftware`. */
35
35
  export declare const appListSystemsoftwares: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2Systemsoftwares.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2Systemsoftwares.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2Systemsoftwares.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2Systemsoftwares.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Systemsoftwares.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
36
- /** get all available `SystemSoftwareVersions` of a specific `SystemSoftware` */
36
+ /** Get all available `SystemSoftwareVersions` of a specific `SystemSoftware`. */
37
37
  export declare const appListSystemsoftwareversions: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2SystemsoftwareSystemSoftwareIdVersions.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
38
- /** get all update candidates for a specific `AppVersion` */
38
+ /** Get all update candidates for a specific `AppVersion`. */
39
39
  export declare const appListUpdateCandidatesForAppversion: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppsAppIdVersionsBaseAppVersionIdUpdateCandidates.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
40
- /** request a copy of an `AppInstallation` */
40
+ /** Request a copy of an `AppInstallation`. */
41
41
  export declare const appRequestAppinstallationCopy: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Responses.$201.Content.ApplicationJson>, 201, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsIdActionsCopy.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
42
- /** get runtime status of a specific `AppInstallation` */
42
+ /** Get runtime status of a specific `AppInstallation`. */
43
43
  export declare const appRetrieveStatus: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdStatus.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdStatus.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdStatus.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdStatus.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdStatus.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdStatus.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
44
- /** create linkage between an `AppInstallation` and `DatabaseUsers` */
44
+ /** Create linkage between an `AppInstallation` and `DatabaseUsers`. */
45
45
  export declare const appSetDatabaseUsers: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabasesDatabaseId.Put.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabasesDatabaseId.Put.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabasesDatabaseId.Put.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabasesDatabaseId.Put.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabasesDatabaseId.Put.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabasesDatabaseId.Put.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabasesDatabaseId.Put.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
46
- /** remove linkage between an `AppInstallation` and a `Database` */
46
+ /** Remove linkage between an `AppInstallation` and a `Database`. */
47
47
  export declare const appUnlinkDatabase: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabasesDatabaseId.Delete.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabasesDatabaseId.Delete.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabasesDatabaseId.Delete.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabasesDatabaseId.Delete.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabasesDatabaseId.Delete.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2AppinstallationsAppInstallationIdDatabasesDatabaseId.Delete.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
48
48
  /** Get an Article. */
49
49
  export declare const articleGetArticle: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ArticlesArticleId.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ArticlesArticleId.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ArticlesArticleId.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ArticlesArticleId.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ArticlesArticleId.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ArticlesArticleId.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
@@ -372,7 +372,7 @@ export declare const newsletterGetInfo: OpenAPIOperation<RequestType<Simplify<nu
372
372
  /** Unsubscribe a user from the mStudio newsletter. */
373
373
  export declare const newsletterUnsubscribeUser: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2NewsletterSubscriptionsSelf.Delete.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2NewsletterSubscriptionsSelf.Delete.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2NewsletterSubscriptionsSelf.Delete.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2NewsletterSubscriptionsSelf.Delete.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2NewsletterSubscriptionsSelf.Delete.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
374
374
  /** Get the counts for unread notifications of the user. */
375
- export declare const notificationsCountUnreadNotifications: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2NotificationsUnreadCounts.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2NotificationsUnreadCounts.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2NotificationsUnreadCounts.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2NotificationsUnreadCounts.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2NotificationsUnreadCounts.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
375
+ export declare const notificationsCountUnreadNotifications: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2NotificationUnreadCounts.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2NotificationUnreadCounts.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2NotificationUnreadCounts.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2NotificationUnreadCounts.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2NotificationUnreadCounts.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
376
376
  /** List all unread notifications. */
377
377
  export declare const notificationsListNotifications: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2Notifications.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2Notifications.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2Notifications.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2Notifications.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Notifications.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
378
378
  /** Mark all notifications as read. */
@@ -432,9 +432,9 @@ export declare const projectDeleteServerAvatar: OpenAPIOperation<RequestType<Sim
432
432
  /** List directories belonging to a Project. */
433
433
  export declare const projectFileSystemGetDirectories: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDirectories.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDirectories.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDirectories.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDirectories.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDirectories.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDirectories.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDirectories.Get.Responses.$503.Content.ApplicationJson>, 503, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDirectories.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
434
434
  /** Get a Project directory filesystem usage. */
435
- export declare const projectFileSystemGetDiskUsage: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemUsagesDisk.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemUsagesDisk.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemUsagesDisk.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemUsagesDisk.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemUsagesDisk.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemUsagesDisk.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemUsagesDisk.Get.Responses.$503.Content.ApplicationJson>, 503, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemUsagesDisk.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
435
+ export declare const projectFileSystemGetDiskUsage: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDiskUsage.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDiskUsage.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDiskUsage.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDiskUsage.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDiskUsage.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDiskUsage.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDiskUsage.Get.Responses.$503.Content.ApplicationJson>, 503, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemDiskUsage.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
436
436
  /** Get a Project file's content. */
437
- export declare const projectFileSystemGetFileContent: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFilesRaw.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFilesRaw.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFilesRaw.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFilesRaw.Get.Responses.$200.Content.TextPlain>, 200, "text/plain"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFilesRaw.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFilesRaw.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFilesRaw.Get.Responses.$503.Content.ApplicationJson>, 503, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFilesRaw.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
437
+ export declare const projectFileSystemGetFileContent: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFileContent.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFileContent.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFileContent.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFileContent.Get.Responses.$200.Content.TextPlain>, 200, "text/plain"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFileContent.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFileContent.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFileContent.Get.Responses.$503.Content.ApplicationJson>, 503, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdFilesystemFileContent.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
438
438
  /** Get a Project's file/filesystem authorization token. */
439
439
  export declare const projectFileSystemGetJwt: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdJwt.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdJwt.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdJwt.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdJwt.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdJwt.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdJwt.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdJwt.Get.Responses.$503.Content.ApplicationJson>, 503, "application/json">>;
440
440
  /** Get a Project file's information. */