@mittwald/api-client 0.0.0-development-2f042ce-20260202 → 0.0.0-development-137cd36-20260225

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.
@@ -298,6 +298,10 @@ export declare namespace MittwaldAPIV2 {
298
298
  type RequestData = InferredRequestData<typeof descriptors.containerRestartService>;
299
299
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.containerRestartService, TStatus>;
300
300
  }
301
+ namespace ContainerSetStackUpdateSchedule {
302
+ type RequestData = InferredRequestData<typeof descriptors.containerSetStackUpdateSchedule>;
303
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.containerSetStackUpdateSchedule, TStatus>;
304
+ }
301
305
  namespace ContainerStartService {
302
306
  type RequestData = InferredRequestData<typeof descriptors.containerStartService>;
303
307
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.containerStartService, TStatus>;
@@ -1726,14 +1730,6 @@ export declare namespace MittwaldAPIV2 {
1726
1730
  type RequestData = InferredRequestData<typeof descriptors.userUpdatePersonalizedSettings>;
1727
1731
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.userUpdatePersonalizedSettings, TStatus>;
1728
1732
  }
1729
- namespace UserGetPollStatus {
1730
- type RequestData = InferredRequestData<typeof descriptors.userGetPollStatus>;
1731
- type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.userGetPollStatus, TStatus>;
1732
- }
1733
- namespace UserPostPollStatus {
1734
- type RequestData = InferredRequestData<typeof descriptors.userPostPollStatus>;
1735
- type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.userPostPollStatus, TStatus>;
1736
- }
1737
1733
  namespace UserGetSession {
1738
1734
  type RequestData = InferredRequestData<typeof descriptors.userGetSession>;
1739
1735
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.userGetSession, TStatus>;
@@ -1830,6 +1826,10 @@ export declare namespace MittwaldAPIV2 {
1830
1826
  type RequestData = InferredRequestData<typeof descriptors.verificationVerifyCompany>;
1831
1827
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.verificationVerifyCompany, TStatus>;
1832
1828
  }
1829
+ namespace ContractGetDetailOfContractByLicense {
1830
+ type RequestData = InferredRequestData<typeof descriptors.contractGetDetailOfContractByLicense>;
1831
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.contractGetDetailOfContractByLicense, TStatus>;
1832
+ }
1833
1833
  }
1834
1834
  namespace Components {
1835
1835
  namespace Schemas {
@@ -1973,6 +1973,10 @@ export declare namespace MittwaldAPIV2 {
1973
1973
  disabled: boolean;
1974
1974
  id: string;
1975
1975
  installationPath: string;
1976
+ /**
1977
+ * The last error that occurred during an update. Resets on success.
1978
+ */
1979
+ lastError?: string;
1976
1980
  linkedDatabases: MittwaldAPIV2.Components.Schemas.AppLinkedDatabase[];
1977
1981
  lockedBy?: {
1978
1982
  [k: string]: MittwaldAPIV2.Components.Schemas.AppLockPurpose;
@@ -2491,15 +2495,21 @@ export declare namespace MittwaldAPIV2 {
2491
2495
  }
2492
2496
  interface ContainerServiceDeclareRequest {
2493
2497
  /**
2494
- * Defaults to image config on empty
2498
+ * The container command (equivalent to the [Docker cmd](https://docs.docker.com/reference/dockerfile/#cmd)). When omitted, this defaults to the command defined in the image.
2499
+ *
2495
2500
  */
2496
2501
  command?: string[];
2497
2502
  deploy?: MittwaldAPIV2.Components.Schemas.ContainerDeploy;
2498
2503
  description?: string;
2499
2504
  /**
2500
- * Defaults to image config on empty
2505
+ * The container entrypoint (equivalent to the [Docker entrypoint](https://docs.docker.com/reference/dockerfile/#entrypoint)). When omitted, this defaults to the entrypoint defined in the image.
2506
+ *
2501
2507
  */
2502
2508
  entrypoint?: string[];
2509
+ /**
2510
+ * Key-value map of environment variables that should be passed into the container.
2511
+ *
2512
+ */
2503
2513
  environment?: {
2504
2514
  [k: string]: string;
2505
2515
  };
@@ -2510,8 +2520,20 @@ export declare namespace MittwaldAPIV2 {
2510
2520
  envs?: {
2511
2521
  [k: string]: string;
2512
2522
  };
2523
+ /**
2524
+ * The image to run, in the usual format also used by `docker run` and `docker compose`. When the image is pulled from a private registry, make sure to create it first, using the `container-create-registry` endpoint. The appropriate registry is matched by hostname.
2525
+ *
2526
+ */
2513
2527
  image: string;
2528
+ /**
2529
+ * Exposed ports. Follows the format `<public-port>:<container-port>/<protocol>`. Exposed ports can be accessed from other containers (or managed apps) within the same project. To expose a port publicly, connect it with an ingress resource.
2530
+ *
2531
+ */
2514
2532
  ports?: string[];
2533
+ /**
2534
+ * Volume mounts for this container. These items always follow the format `<volume>:<mountpoint>`. The `<volume>` may either be a named volume, or a file path in the (always present) project file system (which is shared among containers and managed apps within a project).
2535
+ *
2536
+ */
2515
2537
  volumes?: string[];
2516
2538
  }
2517
2539
  interface ContainerDeploy {
@@ -2519,15 +2541,21 @@ export declare namespace MittwaldAPIV2 {
2519
2541
  }
2520
2542
  interface ContainerServiceRequest {
2521
2543
  /**
2522
- * Defaults to image config on empty
2544
+ * The container command (equivalent to the [Docker cmd](https://docs.docker.com/reference/dockerfile/#cmd)). When omitted, this defaults to the command defined in the image.
2545
+ *
2523
2546
  */
2524
2547
  command?: string[];
2525
2548
  deploy?: MittwaldAPIV2.Components.Schemas.ContainerDeploy;
2526
2549
  description?: string;
2527
2550
  /**
2528
- * Defaults to image config on empty
2551
+ * The container entrypoint (equivalent to the [Docker entrypoint](https://docs.docker.com/reference/dockerfile/#entrypoint)). When omitted, this defaults to the entrypoint defined in the image.
2552
+ *
2529
2553
  */
2530
2554
  entrypoint?: string[];
2555
+ /**
2556
+ * Key-value map of environment variables that should be passed into the container.
2557
+ *
2558
+ */
2531
2559
  environment?: {
2532
2560
  [k: string]: string;
2533
2561
  };
@@ -2538,12 +2566,39 @@ export declare namespace MittwaldAPIV2 {
2538
2566
  envs?: {
2539
2567
  [k: string]: string;
2540
2568
  };
2569
+ /**
2570
+ * The image to run, in the usual format also used by `docker run` and `docker compose`. When the image is pulled from a private registry, make sure to create it first, using the `container-create-registry` endpoint. The appropriate registry is matched by hostname.
2571
+ *
2572
+ */
2541
2573
  image?: string;
2574
+ /**
2575
+ * Exposed ports. Follows the format `<public-port>:<container-port>/<protocol>`. Exposed ports can be accessed from other containers (or managed apps) within the same project. To expose a port publicly, connect it with an ingress resource.
2576
+ *
2577
+ */
2542
2578
  ports?: string[];
2579
+ /**
2580
+ * Volume mounts for this container. These items always follow the format `<volume>:<mountpoint>`. The `<volume>` may either be a named volume, or a file path in the (always present) project file system (which is shared among containers and managed apps within a project).
2581
+ *
2582
+ */
2543
2583
  volumes?: string[];
2544
2584
  }
2545
2585
  interface ContainerResourceSpec {
2586
+ /**
2587
+ * CPU limit for the container. The value can be specified as a decimal number, where `1` corresponds to
2588
+ * one full CPU core. For example, `0.5` means that the container is limited to using half of a CPU core.
2589
+ *
2590
+ */
2546
2591
  cpus?: string;
2592
+ /**
2593
+ * Memory limit for the container. The value can be specified in bytes or using a suffix to indicate
2594
+ * the unit.
2595
+ *
2596
+ * The format matches the one [used by Docker Compose](https://docs.docker.com/reference/compose-file/extension/#specifying-byte-values):
2597
+ *
2598
+ * > Values express a byte value as a string in `{amount}{byte unit}` format: The supported units are
2599
+ * `b` (bytes), `k` or `kb` (kilo bytes), `m` or `mb` (mega bytes) and `g` or `gb` (giga bytes).
2600
+ *
2601
+ */
2547
2602
  memory?: string;
2548
2603
  }
2549
2604
  interface ContainerResources {
@@ -2554,25 +2609,61 @@ export declare namespace MittwaldAPIV2 {
2554
2609
  deployedState: MittwaldAPIV2.Components.Schemas.ContainerServiceState;
2555
2610
  description: string;
2556
2611
  id: string;
2612
+ /**
2613
+ * Message explaining the current state of the container. This may contain information about the current state of the container, or errors that occurred during deployment.
2614
+ *
2615
+ */
2557
2616
  message?: string;
2558
2617
  pendingState: MittwaldAPIV2.Components.Schemas.ContainerServiceState;
2559
2618
  projectId: string;
2560
2619
  requiresRecreate: boolean;
2561
2620
  serviceName: string;
2621
+ /**
2622
+ * A short ID of the container. This is a unique identifier for the container within the project, and can be used to reference it in other API calls, or for SSH connections.
2623
+ *
2624
+ */
2562
2625
  shortId: string;
2563
2626
  stackId: string;
2564
2627
  status: MittwaldAPIV2.Components.Schemas.ContainerServiceStatus;
2565
2628
  statusSetAt: string;
2566
2629
  }
2567
2630
  interface ContainerServiceState {
2631
+ /**
2632
+ * The container command (equivalent to the [Docker cmd](https://docs.docker.com/reference/dockerfile/#cmd)). When omitted, this defaults to the command defined in the image.
2633
+ *
2634
+ */
2568
2635
  command?: string[];
2636
+ /**
2637
+ * The container entrypoint (equivalent to the [Docker entrypoint](https://docs.docker.com/reference/dockerfile/#entrypoint)). When omitted, this defaults to the entrypoint defined in the image.
2638
+ *
2639
+ */
2569
2640
  entrypoint?: string[];
2641
+ /**
2642
+ * Key-value map of environment variables that should be passed into the container.
2643
+ *
2644
+ */
2570
2645
  envs?: {
2571
2646
  [k: string]: string;
2572
2647
  };
2648
+ /**
2649
+ * The image to run, in the usual format also used by `docker run` and `docker compose`. When the image is pulled from a private registry, make sure to create it first, using the `container-create-registry` endpoint. The appropriate registry is matched by hostname.
2650
+ *
2651
+ */
2573
2652
  image: string;
2653
+ /**
2654
+ * The digest of the image that is currently deployed.
2655
+ *
2656
+ */
2574
2657
  imageDigest?: string;
2658
+ /**
2659
+ * Exposed ports. Follows the format `<public-port>:<container-port>/<protocol>`. Exposed ports can be accessed from other containers (or managed apps) within the same project. To expose a port publicly, connect it with an ingress resource.
2660
+ *
2661
+ */
2575
2662
  ports?: string[];
2663
+ /**
2664
+ * Volume mounts for this container. These items always follow the format `<volume>:<mountpoint>`. The `<volume>` may either be a named volume, or a file path in the (always present) project file system (which is shared among containers and managed apps within a project).
2665
+ *
2666
+ */
2576
2667
  volumes?: string[];
2577
2668
  }
2578
2669
  type ContainerServiceStatus = "running" | "stopped" | "restarting" | "error" | "creating" | "starting";
@@ -2597,6 +2688,10 @@ export declare namespace MittwaldAPIV2 {
2597
2688
  prefix: string;
2598
2689
  projectId: string;
2599
2690
  services?: MittwaldAPIV2.Components.Schemas.ContainerServiceResponse[];
2691
+ updateSchedule?: {
2692
+ cron: string;
2693
+ timezone?: string;
2694
+ } | null;
2600
2695
  volumes?: MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[];
2601
2696
  }
2602
2697
  interface ContainerUpdateRegistry {
@@ -3125,21 +3220,56 @@ export declare namespace MittwaldAPIV2 {
3125
3220
  }
3126
3221
  interface DatabaseCreateMySqlDatabase {
3127
3222
  characterSettings?: MittwaldAPIV2.Components.Schemas.DatabaseCharacterSettings;
3223
+ /**
3224
+ * A description of the MySQLDatabase. This is for your own reference and has no effect on the database itself.
3225
+ *
3226
+ */
3128
3227
  description: string;
3129
3228
  projectId: string;
3229
+ /**
3230
+ * The MySQL version to use for this database, in `<major>.<minor>` format. Use the `GET /v2/mysql-versions` endpoint to query available versions.
3231
+ *
3232
+ */
3130
3233
  version: string;
3131
3234
  }
3132
3235
  interface DatabaseCreateMySqlUser {
3236
+ /**
3237
+ * An IP range (in CIDR notation) for which access should be allowed.
3238
+ */
3133
3239
  accessIpMask?: string;
3240
+ /**
3241
+ * The access level that this MySQLUser should have for the database. The `full` access level grants the user read/write privileges on the database.
3242
+ *
3243
+ */
3134
3244
  accessLevel: "full" | "readonly";
3135
3245
  databaseId: string;
3136
3246
  description: string;
3247
+ /**
3248
+ * Describes if users should be able to connection to this database from external
3249
+ * sources. Defaults to `false` when not set.
3250
+ *
3251
+ * To find out how to connect to your database from external sources, refer to the `externalHostname` field of the `GET /v2/mysql-databases/{id}` endpoint.
3252
+ *
3253
+ */
3137
3254
  externalAccess?: boolean;
3138
3255
  password: string;
3139
3256
  }
3140
3257
  interface DatabaseCreateMySqlUserWithDatabase {
3141
3258
  accessIpMask?: string;
3259
+ /**
3260
+ * The access level that this MySQLUser should have for the database. The `full` access level grants the user read/write privileges on the database.
3261
+ *
3262
+ * For MySQLUsers that are created in the same step as the database itself, `full` is the only available option.
3263
+ *
3264
+ */
3142
3265
  accessLevel: "full";
3266
+ /**
3267
+ * Describes if users should be able to connection to this database from external
3268
+ * sources. Defaults to `false` when not set.
3269
+ *
3270
+ * To find out how to connect to your database from external sources, refer to the `externalHostname` field of the `GET /v2/mysql-databases/{id}` endpoint.
3271
+ *
3272
+ */
3143
3273
  externalAccess?: boolean;
3144
3274
  password: string;
3145
3275
  }
@@ -3151,20 +3281,46 @@ export declare namespace MittwaldAPIV2 {
3151
3281
  versionId: string;
3152
3282
  }
3153
3283
  interface DatabaseCharacterSettings {
3284
+ /**
3285
+ * A valid MySQL character set. Refer to https://dev.mysql.com/doc/refman/8.4/en/charset-mysql.html for more information and available character sets.
3286
+ *
3287
+ */
3154
3288
  characterSet: string;
3289
+ /**
3290
+ * A valid MySQL collation. Refer to https://dev.mysql.com/doc/refman/8.4/en/charset-mysql.html for more information and available collations.
3291
+ *
3292
+ */
3155
3293
  collation: string;
3156
3294
  }
3157
3295
  interface DatabaseMySqlDatabase {
3158
3296
  characterSettings: MittwaldAPIV2.Components.Schemas.DatabaseCharacterSettings;
3159
3297
  createdAt: string;
3298
+ /**
3299
+ * A description of the MySQLDatabase. This is for your own reference and has no effect on the database itself.
3300
+ *
3301
+ */
3160
3302
  description: string;
3303
+ /**
3304
+ * The hostname that you can use to connect to this MySQLDatabase from external sources, like your local machine or services running outside the mittwald cloud platform.
3305
+ *
3306
+ * Note that you still need a database user with `externalAccess` enabled to connect via this hostname.
3307
+ *
3308
+ */
3161
3309
  externalHostname: string;
3162
3310
  finalizers?: string[];
3311
+ /**
3312
+ * The hostname that you can use to connect to this MySQLDatabase from _within_ the hosting environment.
3313
+ *
3314
+ */
3163
3315
  hostname: string;
3164
3316
  id: string;
3165
3317
  isReady: boolean;
3166
3318
  isShared: boolean;
3167
3319
  mainUser?: MittwaldAPIV2.Components.Schemas.DatabaseMySqlUser;
3320
+ /**
3321
+ * The name of the MySQLDatabase. This is also the name of the database that you can use when connecting to it. It is automatically generated and cannot be changed.
3322
+ *
3323
+ */
3168
3324
  name: string;
3169
3325
  projectId: string;
3170
3326
  status: MittwaldAPIV2.Components.Schemas.DatabaseDatabaseStatus;
@@ -3172,21 +3328,51 @@ export declare namespace MittwaldAPIV2 {
3172
3328
  storageUsageInBytes: number;
3173
3329
  storageUsageInBytesSetAt: string;
3174
3330
  updatedAt: string;
3331
+ /**
3332
+ * The MySQL version that this database is running, in `<major>.<minor>` format. Use the `GET /v2/mysql-versions` endpoint to query available versions.
3333
+ *
3334
+ */
3175
3335
  version: string;
3176
3336
  }
3177
3337
  interface DatabasePhpMyAdminURL {
3178
3338
  url: string;
3179
3339
  }
3180
3340
  interface DatabaseMySqlUser {
3341
+ /**
3342
+ * An IP range (in CIDR notation) for which access should be allowed.
3343
+ */
3181
3344
  accessIpMask?: string;
3345
+ /**
3346
+ * The access level that this MySQLUser should have for the database. The `full` access level grants
3347
+ * the user read/write privileges on the database.
3348
+ *
3349
+ */
3182
3350
  accessLevel: "full" | "readonly";
3183
3351
  createdAt: string;
3184
3352
  databaseId: string;
3185
3353
  description?: string;
3186
3354
  disabled: boolean;
3355
+ /**
3356
+ * Describes if users should be able to connection to this database from external sources.
3357
+ * Defaults to `false` when not set.
3358
+ *
3359
+ * To find out how to connect to your database from external sources, refer to the `externalHostname`
3360
+ * field of the `GET /v2/mysql-databases/{id}` endpoint.
3361
+ *
3362
+ */
3187
3363
  externalAccess: boolean;
3188
3364
  id: string;
3365
+ /**
3366
+ * Indicates whether this MySQL user is the main user of the database. The main user is created by
3367
+ * default when a new MySQL database is provisioned. It can neither be deleted nor disabled,
3368
+ * but its password can be updated.
3369
+ *
3370
+ */
3189
3371
  mainUser: boolean;
3372
+ /**
3373
+ * The name of the MySQL user. This can be used as the username when connecting to the database.
3374
+ *
3375
+ */
3190
3376
  name: string;
3191
3377
  passwordUpdatedAt: string;
3192
3378
  status: MittwaldAPIV2.Components.Schemas.DatabaseDatabaseUserStatus;
@@ -4036,6 +4222,23 @@ export declare namespace MittwaldAPIV2 {
4036
4222
  projectId: string;
4037
4223
  tls: MittwaldAPIV2.Components.Schemas.IngressTlsAcmeDeprecated | MittwaldAPIV2.Components.Schemas.IngressTlsCertificate;
4038
4224
  }
4225
+ interface IngressListIngressesCompatibleWithCertificateIDRequest {
4226
+ /**
4227
+ * The certificates UUID.
4228
+ */
4229
+ certificateId: string;
4230
+ }
4231
+ interface IngressListIngressesCompatibleWithCertificateRequest {
4232
+ /**
4233
+ * PEM-encoded certificate. Linebreaks have to be escaped with
4234
+ * .
4235
+ */
4236
+ certificate: string;
4237
+ /**
4238
+ * The projects UUID.
4239
+ */
4240
+ projectId: string;
4241
+ }
4039
4242
  interface IngressOwnership {
4040
4243
  txtRecord?: string;
4041
4244
  /**
@@ -4651,7 +4854,7 @@ export declare namespace MittwaldAPIV2 {
4651
4854
  type MembershipCustomerInheritedRoles = "notset" | "owner" | "member" | "accountant";
4652
4855
  interface MembershipCustomerInvite {
4653
4856
  /**
4654
- * Reference to the Project's avatar.
4857
+ * Reference to the Customer's avatar.
4655
4858
  */
4656
4859
  avatarRefId?: string;
4657
4860
  /**
@@ -4738,10 +4941,6 @@ export declare namespace MittwaldAPIV2 {
4738
4941
  * ID of the user that created the invite.
4739
4942
  */
4740
4943
  invitedBy: string;
4741
- /**
4742
- * ID of the user this invite is for.
4743
- */
4744
- userId?: string;
4745
4944
  }
4746
4945
  interface MembershipProjectInvite {
4747
4946
  /**
@@ -4950,29 +5149,6 @@ export declare namespace MittwaldAPIV2 {
4950
5149
  reservationLimit: number;
4951
5150
  unlockLimit: number;
4952
5151
  }
4953
- type OrderLicenseOrderPreview = {
4954
- /**
4955
- * Describe for which typo3 instance the license will be used.
4956
- */
4957
- description?: string;
4958
- licenseType: "typo3";
4959
- /**
4960
- * The major version for which a license should be purchased.
4961
- */
4962
- majorVersion: number;
4963
- };
4964
- type OrderLicenseOrder = {
4965
- /**
4966
- * Describe for which typo3 instance the license will be used.
4967
- */
4968
- description: string;
4969
- licenseType: "typo3";
4970
- /**
4971
- * The major version for which a license should be purchased.
4972
- */
4973
- majorVersion: number;
4974
- projectId: string;
4975
- };
4976
5152
  interface OrderMachineTypeSpec {
4977
5153
  machineType?: string;
4978
5154
  }
@@ -5022,9 +5198,6 @@ export declare namespace MittwaldAPIV2 {
5022
5198
  interface OrderLeadFyndrOrderPreviewResponse {
5023
5199
  totalPrice: number;
5024
5200
  }
5025
- interface OrderLicenseOrderPreviewResponse {
5026
- totalPrice: number;
5027
- }
5028
5201
  interface OrderDomainOrderPreviewResponse {
5029
5202
  /**
5030
5203
  * Contract duration in months.
@@ -5292,7 +5465,7 @@ export declare namespace MittwaldAPIV2 {
5292
5465
  webStorageUsageInBytesSetAt: string;
5293
5466
  }
5294
5467
  type ProjectServerDisableReason = "suspended";
5295
- type ProjectServerStatus = "pending" | "ready" | "unready" | "suspended";
5468
+ type ProjectServerStatus = "pending" | "ready" | "unready" | "suspended" | "migrating";
5296
5469
  interface ProjectServer {
5297
5470
  clusterName: string;
5298
5471
  createdAt: string;
@@ -5789,6 +5962,32 @@ export declare namespace MittwaldAPIV2 {
5789
5962
  }
5790
5963
  type VerificationEmailOrigin = "IS_MITTWALD" | "IS_NOT_MITTWALD" | "COULD_BE_MITTWALD";
5791
5964
  type ContainerVolumeSortOrder = "nameAsc" | "nameDesc" | "storageAsc" | "storageDesc";
5965
+ type OrderLicenseOrderPreview = {
5966
+ /**
5967
+ * Describe for which typo3 instance the license will be used.
5968
+ */
5969
+ description?: string;
5970
+ licenseType: "typo3";
5971
+ /**
5972
+ * The major version for which a license should be purchased.
5973
+ */
5974
+ majorVersion: number;
5975
+ };
5976
+ interface OrderLicenseOrderPreviewResponse {
5977
+ totalPrice: number;
5978
+ }
5979
+ type OrderLicenseOrder = {
5980
+ /**
5981
+ * Describe for which typo3 instance the license will be used.
5982
+ */
5983
+ description: string;
5984
+ licenseType: "typo3";
5985
+ /**
5986
+ * The major version for which a license should be purchased.
5987
+ */
5988
+ majorVersion: number;
5989
+ projectId: string;
5990
+ };
5792
5991
  interface CommonsAddress {
5793
5992
  street: string;
5794
5993
  houseNumber: string;
@@ -5923,19 +6122,6 @@ export declare namespace MittwaldAPIV2 {
5923
6122
  name?: "NoAccessTokenProvided";
5924
6123
  };
5925
6124
  }
5926
- namespace SignupRemovingLastOwnerNotAllowedError {
5927
- interface ApplicationJson {
5928
- /**
5929
- * A json object, given further information about the error
5930
- */
5931
- info?: {};
5932
- /**
5933
- * more information about the error
5934
- */
5935
- message: string;
5936
- name: "RemovingLastOwnerNotAllowedError";
5937
- }
5938
- }
5939
6125
  namespace SignupSecondFactorRequiredError {
5940
6126
  type ApplicationJson = MittwaldAPIV2.Components.Schemas.SignupDomainError & {
5941
6127
  name: "SecondFactorRequired";
@@ -6784,6 +6970,13 @@ export declare namespace MittwaldAPIV2 {
6784
6970
  type Empty = unknown;
6785
6971
  }
6786
6972
  }
6973
+ namespace $400 {
6974
+ namespace Content {
6975
+ interface ApplicationJson {
6976
+ [k: string]: unknown;
6977
+ }
6978
+ }
6979
+ }
6787
6980
  namespace $404 {
6788
6981
  namespace Content {
6789
6982
  interface ApplicationJson {
@@ -6791,6 +6984,13 @@ export declare namespace MittwaldAPIV2 {
6791
6984
  }
6792
6985
  }
6793
6986
  }
6987
+ namespace $412 {
6988
+ namespace Content {
6989
+ interface ApplicationJson {
6990
+ [k: string]: unknown;
6991
+ }
6992
+ }
6993
+ }
6794
6994
  namespace $429 {
6795
6995
  namespace Content {
6796
6996
  interface ApplicationJson {
@@ -7406,6 +7606,7 @@ export declare namespace MittwaldAPIV2 {
7406
7606
  };
7407
7607
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
7408
7608
  type Query = {
7609
+ versionRange?: string;
7409
7610
  recommended?: boolean;
7410
7611
  };
7411
7612
  }
@@ -8810,11 +9011,24 @@ export declare namespace MittwaldAPIV2 {
8810
9011
  stackId: string;
8811
9012
  };
8812
9013
  interface RequestBody {
9014
+ /**
9015
+ * A set of containers that should be started in this stack. The key is relevant for
9016
+ * network connectivity between containers, because you can use it as DNS name to
9017
+ * resolve this containers from other containers running in the same project (or from
9018
+ * managed apps running in the same project).
9019
+ *
9020
+ * To **delete** an existing container from a stack using a `PUT` request, simply omit
9021
+ * it from the request body. Using a `PATCH` request, set it to an empty object `{}`.
9022
+ *
9023
+ */
8813
9024
  services?: {
8814
9025
  [k: string]: MittwaldAPIV2.Components.Schemas.ContainerServiceDeclareRequest;
8815
9026
  };
8816
9027
  /**
8817
- * Volumes belonging to a Stack. Removing results in a detach, delete must be explicit.
9028
+ * A set of named volumes that should be created for this stack. Removing a volume
9029
+ * from this set will not delete the volume (for safety), but only detach it from the
9030
+ * stack. To delete a volume, use the `DELETE /stacks/{stackId}/volumes/{volumeId}` endpoint.
9031
+ *
8818
9032
  */
8819
9033
  volumes?: {
8820
9034
  [k: string]: MittwaldAPIV2.Components.Schemas.ContainerVolumeDeclareRequest;
@@ -9901,6 +10115,82 @@ export declare namespace MittwaldAPIV2 {
9901
10115
  }
9902
10116
  }
9903
10117
  }
10118
+ namespace V2StacksStackIdUpdateSchedule {
10119
+ namespace Put {
10120
+ namespace Parameters {
10121
+ type Path = {
10122
+ stackId: string;
10123
+ };
10124
+ interface RequestBody {
10125
+ updateSchedule?: {
10126
+ cron: string;
10127
+ /**
10128
+ * Valid timezones can be retrieved via GET /v2/time-zones
10129
+ */
10130
+ timezone?: string;
10131
+ };
10132
+ }
10133
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
10134
+ type Query = {};
10135
+ }
10136
+ namespace Responses {
10137
+ namespace $204 {
10138
+ namespace Content {
10139
+ type Empty = unknown;
10140
+ }
10141
+ }
10142
+ namespace $400 {
10143
+ namespace Content {
10144
+ interface ApplicationJson {
10145
+ [k: string]: unknown;
10146
+ }
10147
+ }
10148
+ }
10149
+ namespace $403 {
10150
+ namespace Content {
10151
+ interface ApplicationJson {
10152
+ [k: string]: unknown;
10153
+ }
10154
+ }
10155
+ }
10156
+ namespace $404 {
10157
+ namespace Content {
10158
+ interface ApplicationJson {
10159
+ [k: string]: unknown;
10160
+ }
10161
+ }
10162
+ }
10163
+ namespace $412 {
10164
+ namespace Content {
10165
+ interface ApplicationJson {
10166
+ [k: string]: unknown;
10167
+ }
10168
+ }
10169
+ }
10170
+ namespace $429 {
10171
+ namespace Content {
10172
+ interface ApplicationJson {
10173
+ [k: string]: unknown;
10174
+ }
10175
+ }
10176
+ }
10177
+ namespace $500 {
10178
+ namespace Content {
10179
+ interface ApplicationJson {
10180
+ [k: string]: unknown;
10181
+ }
10182
+ }
10183
+ }
10184
+ namespace Default {
10185
+ namespace Content {
10186
+ interface ApplicationJson {
10187
+ [k: string]: unknown;
10188
+ }
10189
+ }
10190
+ }
10191
+ }
10192
+ }
10193
+ }
9904
10194
  namespace V2StacksStackIdServicesServiceIdActionsStart {
9905
10195
  namespace Post {
9906
10196
  namespace Parameters {
@@ -11405,6 +11695,13 @@ export declare namespace MittwaldAPIV2 {
11405
11695
  }
11406
11696
  }
11407
11697
  }
11698
+ namespace $403 {
11699
+ namespace Content {
11700
+ interface ApplicationJson {
11701
+ [k: string]: unknown;
11702
+ }
11703
+ }
11704
+ }
11408
11705
  namespace $404 {
11409
11706
  namespace Content {
11410
11707
  interface ApplicationJson {
@@ -16192,6 +16489,13 @@ export declare namespace MittwaldAPIV2 {
16192
16489
  }
16193
16490
  }
16194
16491
  }
16492
+ namespace $409 {
16493
+ namespace Content {
16494
+ interface ApplicationJson {
16495
+ [k: string]: unknown;
16496
+ }
16497
+ }
16498
+ }
16195
16499
  namespace $429 {
16196
16500
  namespace Content {
16197
16501
  interface ApplicationJson {
@@ -17101,6 +17405,10 @@ export declare namespace MittwaldAPIV2 {
17101
17405
  contact: "owner";
17102
17406
  };
17103
17407
  interface RequestBody {
17408
+ /**
17409
+ * Whether to avoid the email confirmation if possible. If set to true, a transfer lock of 60 days might be applied to the domain.
17410
+ */
17411
+ avoidEmailConfirmation?: boolean;
17104
17412
  /**
17105
17413
  * @minItems 1
17106
17414
  */
@@ -20113,17 +20421,7 @@ export declare namespace MittwaldAPIV2 {
20113
20421
  namespace Post {
20114
20422
  namespace Parameters {
20115
20423
  type Path = {};
20116
- interface RequestBody {
20117
- /**
20118
- * PEM-encoded certificate. Linebreaks have to be escaped with
20119
- * .
20120
- */
20121
- certificate: string;
20122
- /**
20123
- * The projects UUID.
20124
- */
20125
- projectId: string;
20126
- }
20424
+ type RequestBody = MittwaldAPIV2.Components.Schemas.IngressListIngressesCompatibleWithCertificateRequest | MittwaldAPIV2.Components.Schemas.IngressListIngressesCompatibleWithCertificateIDRequest;
20127
20425
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
20128
20426
  type Query = {
20129
20427
  limit?: number;
@@ -28071,100 +28369,6 @@ export declare namespace MittwaldAPIV2 {
28071
28369
  }
28072
28370
  }
28073
28371
  }
28074
- namespace V2PollSettingsUserId {
28075
- namespace Get {
28076
- namespace Parameters {
28077
- type Path = {
28078
- userId: string;
28079
- };
28080
- type Header = {};
28081
- type Query = {};
28082
- }
28083
- namespace Responses {
28084
- namespace $200 {
28085
- namespace Content {
28086
- type ApplicationJson = MittwaldAPIV2.Components.Schemas.PollUserPollSettings;
28087
- }
28088
- }
28089
- namespace $400 {
28090
- namespace Content {
28091
- interface ApplicationJson {
28092
- [k: string]: unknown;
28093
- }
28094
- }
28095
- }
28096
- namespace $404 {
28097
- namespace Content {
28098
- interface ApplicationJson {
28099
- [k: string]: unknown;
28100
- }
28101
- }
28102
- }
28103
- namespace $429 {
28104
- namespace Content {
28105
- interface ApplicationJson {
28106
- [k: string]: unknown;
28107
- }
28108
- }
28109
- }
28110
- namespace Default {
28111
- namespace Content {
28112
- interface ApplicationJson {
28113
- [k: string]: unknown;
28114
- }
28115
- }
28116
- }
28117
- }
28118
- }
28119
- namespace Post {
28120
- namespace Parameters {
28121
- type Path = {
28122
- userId: string;
28123
- };
28124
- interface RequestBody {
28125
- status: "completed" | "muted" | "ignored";
28126
- userId: string;
28127
- }
28128
- type Header = {};
28129
- type Query = {};
28130
- }
28131
- namespace Responses {
28132
- namespace $200 {
28133
- namespace Content {
28134
- type ApplicationJson = MittwaldAPIV2.Components.Schemas.PollUserPollSettings;
28135
- }
28136
- }
28137
- namespace $400 {
28138
- namespace Content {
28139
- interface ApplicationJson {
28140
- [k: string]: unknown;
28141
- }
28142
- }
28143
- }
28144
- namespace $403 {
28145
- namespace Content {
28146
- interface ApplicationJson {
28147
- [k: string]: unknown;
28148
- }
28149
- }
28150
- }
28151
- namespace $429 {
28152
- namespace Content {
28153
- interface ApplicationJson {
28154
- [k: string]: unknown;
28155
- }
28156
- }
28157
- }
28158
- namespace Default {
28159
- namespace Content {
28160
- interface ApplicationJson {
28161
- [k: string]: unknown;
28162
- }
28163
- }
28164
- }
28165
- }
28166
- }
28167
- }
28168
28372
  namespace V2UsersSelfSessionsTokenId {
28169
28373
  namespace Get {
28170
28374
  namespace Parameters {
@@ -29208,11 +29412,6 @@ export declare namespace MittwaldAPIV2 {
29208
29412
  }
29209
29413
  }
29210
29414
  }
29211
- namespace $500 {
29212
- namespace Content {
29213
- type Empty = unknown;
29214
- }
29215
- }
29216
29415
  namespace Default {
29217
29416
  namespace Content {
29218
29417
  interface ApplicationJson {
@@ -29253,9 +29452,50 @@ export declare namespace MittwaldAPIV2 {
29253
29452
  }
29254
29453
  }
29255
29454
  }
29256
- namespace $500 {
29455
+ namespace Default {
29257
29456
  namespace Content {
29258
- type Empty = unknown;
29457
+ interface ApplicationJson {
29458
+ [k: string]: unknown;
29459
+ }
29460
+ }
29461
+ }
29462
+ }
29463
+ }
29464
+ }
29465
+ namespace V2LicensesLicenseIdContract {
29466
+ namespace Get {
29467
+ namespace Parameters {
29468
+ type Path = {
29469
+ licenseId: string;
29470
+ };
29471
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
29472
+ type Query = {};
29473
+ }
29474
+ namespace Responses {
29475
+ namespace $200 {
29476
+ namespace Content {
29477
+ type ApplicationJson = MittwaldAPIV2.Components.Schemas.ContractContract;
29478
+ }
29479
+ }
29480
+ namespace $400 {
29481
+ namespace Content {
29482
+ interface ApplicationJson {
29483
+ [k: string]: unknown;
29484
+ }
29485
+ }
29486
+ }
29487
+ namespace $404 {
29488
+ namespace Content {
29489
+ interface ApplicationJson {
29490
+ [k: string]: unknown;
29491
+ }
29492
+ }
29493
+ }
29494
+ namespace $429 {
29495
+ namespace Content {
29496
+ interface ApplicationJson {
29497
+ [k: string]: unknown;
29498
+ }
29259
29499
  }
29260
29500
  }
29261
29501
  namespace Default {