@mittwald/api-client 3.0.29 → 3.1.2

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.
@@ -1174,15 +1174,15 @@ export declare module MittwaldAPIV2 {
1174
1174
  namespace Components {
1175
1175
  namespace Schemas {
1176
1176
  /**
1177
- * An `Action` is a string that describes a runtime concerning action which can be executed on an `AppInstallation` or an `App` can be capable of
1177
+ * An `Action` is a string that describes a runtime concerning action which can be executed on an `AppInstallation` or an `App` can be capable of.
1178
1178
  */
1179
1179
  type AppAction = "start" | "stop" | "restart";
1180
1180
  /**
1181
- * `ActionCapabilities` is an array that contains supported actions of an `App`
1181
+ * `ActionCapabilities` is an array that contains supported actions of an `App`.
1182
1182
  */
1183
1183
  type AppActionCapabilities = MittwaldAPIV2.Components.Schemas.AppAction[];
1184
1184
  /**
1185
- * An `App` is to be understood as a manifest for `AppInstallations`. E.g. "WordPress" only exists inside our ecosystem, because there is an `App`-Manifest for it
1185
+ * An `App` is to be understood as a manifest for `AppInstallations`. E.g. 'WordPress' only exists inside our ecosystem, because there is an `App`-Manifest for it.
1186
1186
  */
1187
1187
  interface AppApp {
1188
1188
  actionCapabilities?: MittwaldAPIV2.Components.Schemas.AppActionCapabilities;
@@ -1191,7 +1191,7 @@ export declare module MittwaldAPIV2 {
1191
1191
  tags: string[];
1192
1192
  }
1193
1193
  /**
1194
- * `AppInstallationStatus` describes the overall runtime status of an `AppInstallation`
1194
+ * `AppInstallationStatus` describes the overall runtime status of an `AppInstallation`.
1195
1195
  */
1196
1196
  interface AppAppInstallationStatus {
1197
1197
  lastExitCode?: number;
@@ -1209,7 +1209,7 @@ export declare module MittwaldAPIV2 {
1209
1209
  upgradeImage: MittwaldAPIV2.Components.Schemas.AppAppJobImage;
1210
1210
  }
1211
1211
  /**
1212
- * `AppUpdatePolicy` describes which updates should be applied automatically by our systems
1212
+ * `AppUpdatePolicy` describes which updates should be applied automatically by our systems.
1213
1213
  */
1214
1214
  type AppAppUpdatePolicy = "none" | "patchLevel" | "all";
1215
1215
  /**
@@ -1234,11 +1234,11 @@ export declare module MittwaldAPIV2 {
1234
1234
  userInputs?: MittwaldAPIV2.Components.Schemas.AppSavedUserInput[];
1235
1235
  }
1236
1236
  /**
1237
- * The `AppInstallationLifecycle` can be used to express a specific point in the `AppInstallation` Lifecycle, e.g. while installing a new `AppInstallation`
1237
+ * The `AppInstallationLifecycle` can be used to express a specific point in the `AppInstallation` Lifecycle, e.g. while installing a new `AppInstallation`.
1238
1238
  */
1239
1239
  type AppAppInstallationLifecycle = "installation" | "update" | "reconfigure";
1240
1240
  /**
1241
- * An `AppVersion` is an officially supported version of an `App`, containing the necessary and recommended configuration und dependencies
1241
+ * An `AppVersion` is an officially supported version of an `App`, containing the necessary and recommended configuration und dependencies.
1242
1242
  */
1243
1243
  interface AppAppVersion {
1244
1244
  breakingNote?: MittwaldAPIV2.Components.Schemas.AppBreakingNote;
@@ -1254,13 +1254,13 @@ export declare module MittwaldAPIV2 {
1254
1254
  userInputs?: MittwaldAPIV2.Components.Schemas.AppUserInput[];
1255
1255
  }
1256
1256
  /**
1257
- * A `BreakingNote` is a hint that something serious has changed in the `AppVersion` containing it, so an automatic update is not possible
1257
+ * A `BreakingNote` is a hint that something serious has changed in the `AppVersion` containing it, so an automatic update is not possible.
1258
1258
  */
1259
1259
  interface AppBreakingNote {
1260
1260
  faqLink: string;
1261
1261
  }
1262
1262
  /**
1263
- * A ´DatabaseDependency` is a generic description of need for a database, used by `AppVersions`
1263
+ * A `DatabaseDependency` is a generic description of need for a database, used by `AppVersions`.
1264
1264
  */
1265
1265
  interface AppDatabaseDependency {
1266
1266
  description: string;
@@ -1275,7 +1275,7 @@ export declare module MittwaldAPIV2 {
1275
1275
  type: string;
1276
1276
  }
1277
1277
  /**
1278
- * `InstalledSystemSoftware` describes the currently configured and installed `SystemSoftwareVersion` of a `SystemSoftware` besides the desired `SystemSoftwareUpdatePolicy` inside an `AppInstallation`
1278
+ * `InstalledSystemSoftware` describes the currently configured and installed `SystemSoftwareVersion` of a `SystemSoftware` besides the desired `SystemSoftwareUpdatePolicy` inside an `AppInstallation`.
1279
1279
  */
1280
1280
  interface AppInstalledSystemSoftware {
1281
1281
  systemSoftwareId: string;
@@ -1283,7 +1283,7 @@ export declare module MittwaldAPIV2 {
1283
1283
  updatePolicy: MittwaldAPIV2.Components.Schemas.AppSystemSoftwareUpdatePolicy;
1284
1284
  }
1285
1285
  /**
1286
- * `LinkedDatabase` is a reference to a concrete `Database` and `DatabaseUsers`
1286
+ * `LinkedDatabase` is a reference to a concrete `Database` and `DatabaseUsers`.
1287
1287
  */
1288
1288
  interface AppLinkedDatabase {
1289
1289
  databaseId: string;
@@ -1294,7 +1294,7 @@ export declare module MittwaldAPIV2 {
1294
1294
  purpose: "primary" | "cache" | "custom";
1295
1295
  }
1296
1296
  /**
1297
- * `RequestHandlerRequirement` describes the necessary properties to internally resolve the request handler or process to start
1297
+ * `RequestHandlerRequirement` describes the necessary properties to internally resolve the request handler or process to start.
1298
1298
  */
1299
1299
  interface AppRequestHandlerRequirement {
1300
1300
  exampleValues?: MittwaldAPIV2.Components.Schemas.AppSavedUserInput[];
@@ -1303,7 +1303,7 @@ export declare module MittwaldAPIV2 {
1303
1303
  parametersTemplate: string;
1304
1304
  }
1305
1305
  /**
1306
- * A `SavedUserInput` is an entered value for a desired `UserInput` of an `AppVersion` or `SystemSoftwareVersion`
1306
+ * A `SavedUserInput` is an entered value for a desired `UserInput` of an `AppVersion` or `SystemSoftwareVersion`.
1307
1307
  */
1308
1308
  interface AppSavedUserInput {
1309
1309
  name: string;
@@ -1317,7 +1317,7 @@ export declare module MittwaldAPIV2 {
1317
1317
  versionRange: string;
1318
1318
  }
1319
1319
  /**
1320
- * `SystemSoftwareUpdatePolicy` describes which updates should be applied automatically by our systems
1320
+ * `SystemSoftwareUpdatePolicy` describes which updates should be applied automatically by our systems.
1321
1321
  */
1322
1322
  type AppSystemSoftwareUpdatePolicy = "none" | "inheritedFromApp" | "patchLevel" | "all";
1323
1323
  /**
@@ -1329,7 +1329,7 @@ export declare module MittwaldAPIV2 {
1329
1329
  tags: string[];
1330
1330
  }
1331
1331
  /**
1332
- * A `SystemSoftwareVersion` is an officially supported version of a `SystemSoftware`, containing the necessary and recommended configuration und dependencies
1332
+ * A `SystemSoftwareVersion` is an officially supported version of a `SystemSoftware`, containing the necessary and recommended configuration und dependencies.
1333
1333
  */
1334
1334
  interface AppSystemSoftwareVersion {
1335
1335
  externalVersion: string;
@@ -1340,11 +1340,11 @@ export declare module MittwaldAPIV2 {
1340
1340
  userInputs?: MittwaldAPIV2.Components.Schemas.AppUserInput[];
1341
1341
  }
1342
1342
  /**
1343
- * A `UserInput` is a description of an information which cannot be determined or estimated by mittwald, but has to be given by the person who is requesting an `AppInstallation` or `SystemSoftware`
1343
+ * A `UserInput` is a description of an information which cannot be determined or estimated by mittwald, but has to be given by the person who is requesting an `AppInstallation` or `SystemSoftware`.
1344
1344
  */
1345
1345
  interface AppUserInput {
1346
1346
  /**
1347
- * Optional field to tell the frontend, which data to put into the select
1347
+ * Optional field to tell the frontend, which data to put into the select.
1348
1348
  */
1349
1349
  dataSource?: string;
1350
1350
  dataType: MittwaldAPIV2.Components.Schemas.AppUserInputDataType;
@@ -1355,20 +1355,20 @@ export declare module MittwaldAPIV2 {
1355
1355
  positionMeta?: MittwaldAPIV2.Components.Schemas.AppUserInputPositionMeta;
1356
1356
  required: boolean;
1357
1357
  /**
1358
- * JSON Schema formatted (https://json-schema.org/)
1358
+ * JSON Schema formatted (https://json-schema.org/).
1359
1359
  */
1360
1360
  validationSchema: string;
1361
1361
  }
1362
1362
  /**
1363
- * `UserInputDataType` is an enum, describing the possible data types of a `UserInput`
1363
+ * `UserInputDataType` is an enum, describing the possible data types of a `UserInput`.
1364
1364
  */
1365
1365
  type AppUserInputDataType = "text" | "number" | "boolean" | "select";
1366
1366
  /**
1367
- * `UserInputFormat` is an enum, describing the possible data formats of a `UserInput`, the given values can be validated against
1367
+ * `UserInputFormat` is an enum, describing the possible data formats of a `UserInput`, the given values can be validated against.
1368
1368
  */
1369
1369
  type AppUserInputFormat = "email" | "password" | "url";
1370
1370
  /**
1371
- * `UserInputPositionMeta´ is a utility information, helping to position the `UserInput` properly on the frontend
1371
+ * `UserInputPositionMeta´ is a utility information, helping to position the `UserInput` properly on the frontend.
1372
1372
  */
1373
1373
  interface AppUserInputPositionMeta {
1374
1374
  index?: number;
@@ -1376,7 +1376,7 @@ export declare module MittwaldAPIV2 {
1376
1376
  step?: string;
1377
1377
  }
1378
1378
  /**
1379
- * `VersionStatus` describes the current and desired version of something like the `AppVersion` of an `AppInstallation`. If diverging, an internal process is going to assert, the `current` value will be aligned
1379
+ * `VersionStatus` describes the current and desired version of something like the `AppVersion` of an `AppInstallation`. If diverging, an internal process is going to assert, the `current` value will be aligned.
1380
1380
  */
1381
1381
  interface AppVersionStatus {
1382
1382
  current?: string;
@@ -2921,66 +2921,6 @@ export declare module MittwaldAPIV2 {
2921
2921
  location?: MittwaldAPIV2.Components.Schemas.SignupLocation;
2922
2922
  tokenId: string;
2923
2923
  }
2924
- interface VarnishConfigRevision {
2925
- expire?: number;
2926
- files: MittwaldAPIV2.Components.Schemas.VarnishConfigFileRef[];
2927
- note?: string;
2928
- revision: number;
2929
- updated: string;
2930
- }
2931
- interface VarnishConfigTemplate {
2932
- /**
2933
- * A set of config file references.
2934
- */
2935
- files: MittwaldAPIV2.Components.Schemas.VarnishConfigFileRef[];
2936
- isGlobal?: boolean;
2937
- note?: string;
2938
- projectId?: string;
2939
- softwareConfigTemplateId: string;
2940
- softwareTemplateId: string;
2941
- updatedAt?: string;
2942
- }
2943
- interface VarnishConfigFile {
2944
- content: string;
2945
- meta?: MittwaldAPIV2.Components.Schemas.VarnishConfigFileMetadata;
2946
- }
2947
- interface VarnishConfigFileMetadata {
2948
- name: string;
2949
- path?: string;
2950
- }
2951
- interface VarnishConfigFileRef {
2952
- meta?: MittwaldAPIV2.Components.Schemas.VarnishConfigFileMetadata;
2953
- refId?: string;
2954
- }
2955
- interface VarnishGlobalConfigTemplate {
2956
- data: string;
2957
- name: string;
2958
- updatedAt: string;
2959
- }
2960
- interface VarnishSoftware {
2961
- config: MittwaldAPIV2.Components.Schemas.VarnishSoftwareConfig;
2962
- projectId: string;
2963
- settings?: {
2964
- [k: string]: string;
2965
- };
2966
- softwareId: string;
2967
- softwareTemplateId: string;
2968
- softwareVersion: string;
2969
- updatedAt: string;
2970
- }
2971
- interface VarnishSoftwareConfig {
2972
- configExpiration?: MittwaldAPIV2.Components.Schemas.VarnishConfigExpiration;
2973
- latestConfigRevision?: number;
2974
- revisions?: MittwaldAPIV2.Components.Schemas.VarnishConfigRevision[];
2975
- }
2976
- interface VarnishConfigExpiration {
2977
- maxVersions?: number;
2978
- retentionTime?: number;
2979
- }
2980
- interface VarnishSoftwareSetting {
2981
- name: string;
2982
- value: string;
2983
- }
2984
2924
  interface CommonsAddress {
2985
2925
  street: string;
2986
2926
  houseNumber: string;
@@ -3693,6 +3633,7 @@ export declare module MittwaldAPIV2 {
3693
3633
  };
3694
3634
  interface RequestBody {
3695
3635
  description: string;
3636
+ targetProjectId?: string;
3696
3637
  }
3697
3638
  type Header = {};
3698
3639
  type Query = {};
@@ -10693,7 +10634,8 @@ export declare module MittwaldAPIV2 {
10693
10634
  }
10694
10635
  }
10695
10636
  }
10696
- namespace V2NotificationsUnreadCounts {
10637
+ namespace V2NotificationsUnreadCounts { }
10638
+ namespace V2NotificationUnreadCounts {
10697
10639
  namespace Get {
10698
10640
  namespace Parameters {
10699
10641
  type Path = {};
@@ -11758,6 +11700,7 @@ export declare module MittwaldAPIV2 {
11758
11700
  }
11759
11701
  }
11760
11702
  }
11703
+ namespace V2ProjectsProjectIdFilesystemDirectories { }
11761
11704
  namespace V2ProjectsProjectIdFilesystemDirectories {
11762
11705
  namespace Get {
11763
11706
  namespace Parameters {
@@ -11811,7 +11754,8 @@ export declare module MittwaldAPIV2 {
11811
11754
  }
11812
11755
  }
11813
11756
  }
11814
- namespace V2ProjectsProjectIdFilesystemUsagesDisk {
11757
+ namespace V2ProjectsProjectIdFilesystemUsagesDisk { }
11758
+ namespace V2ProjectsProjectIdFilesystemDiskUsage {
11815
11759
  namespace Get {
11816
11760
  namespace Parameters {
11817
11761
  type Path = {
@@ -11859,7 +11803,8 @@ export declare module MittwaldAPIV2 {
11859
11803
  }
11860
11804
  }
11861
11805
  }
11862
- namespace V2ProjectsProjectIdFilesystemFilesRaw {
11806
+ namespace V2ProjectsProjectIdFilesystemFilesRaw { }
11807
+ namespace V2ProjectsProjectIdFilesystemFileContent {
11863
11808
  namespace Get {
11864
11809
  namespace Parameters {
11865
11810
  type Path = {
@@ -11947,6 +11892,7 @@ export declare module MittwaldAPIV2 {
11947
11892
  }
11948
11893
  }
11949
11894
  }
11895
+ namespace V2ProjectsProjectIdFilesystemFiles { }
11950
11896
  namespace V2ProjectsProjectIdFilesystemFiles {
11951
11897
  namespace Get {
11952
11898
  namespace Parameters {
package/dist/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const MittwaldAPIClientVersion = '3.0.29';
1
+ export declare const MittwaldAPIClientVersion = '3.1.2';
package/dist/version.js CHANGED
@@ -1 +1 @@
1
- export const MittwaldAPIClientVersion = '3.0.29';
1
+ export const MittwaldAPIClientVersion = '3.1.2';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mittwald/api-client",
3
- "version": "3.0.29",
3
+ "version": "3.1.2",
4
4
  "description": "Auto-generated client for the mittwald API",
5
5
  "license": "MIT",
6
6
  "repository": "github:mittwald/api-client-js",