@mittwald/api-client 4.465.0 → 4.467.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2823,6 +2823,10 @@ export declare namespace MittwaldAPIV2 {
2823
2823
  */
2824
2824
  command?: string[];
2825
2825
  deploy?: MittwaldAPIV2.Components.Schemas.ContainerDeploy;
2826
+ /**
2827
+ * @deprecated
2828
+ * Deprecated by 'x-description' (which takes precedence). This field will be removed in a future version.
2829
+ */
2826
2830
  description?: string;
2827
2831
  /**
2828
2832
  * 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.
@@ -2858,12 +2862,25 @@ export declare namespace MittwaldAPIV2 {
2858
2862
  *
2859
2863
  */
2860
2864
  ports?: string[];
2865
+ /**
2866
+ * Restart policy for the container, matching the [Docker Compose `restart` field](https://docs.docker.com/reference/compose-file/services/#restart): `no`, `always`, `on-failure` (optionally `on-failure:<max-retries>`) or `unless-stopped`.
2867
+ *
2868
+ */
2869
+ restart?: string;
2870
+ /**
2871
+ * @deprecated
2872
+ * Deprecated by 'restart' (which takes precedence). This field will be removed in a future version.
2873
+ */
2861
2874
  restartPolicy?: string;
2862
2875
  /**
2863
2876
  * 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).
2864
2877
  *
2865
2878
  */
2866
2879
  volumes?: string[];
2880
+ /**
2881
+ * Human-readable description of this container.
2882
+ */
2883
+ "x-description"?: string;
2867
2884
  }
2868
2885
  interface ContainerDeploy {
2869
2886
  resources?: MittwaldAPIV2.Components.Schemas.ContainerResources;
@@ -2889,6 +2906,10 @@ export declare namespace MittwaldAPIV2 {
2889
2906
  */
2890
2907
  command?: string[];
2891
2908
  deploy?: MittwaldAPIV2.Components.Schemas.ContainerDeploy;
2909
+ /**
2910
+ * @deprecated
2911
+ * Deprecated by 'x-description' (which takes precedence). This field will be removed in a future version.
2912
+ */
2892
2913
  description?: string;
2893
2914
  /**
2894
2915
  * 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.
@@ -2924,12 +2945,25 @@ export declare namespace MittwaldAPIV2 {
2924
2945
  *
2925
2946
  */
2926
2947
  ports?: string[];
2948
+ /**
2949
+ * Restart policy for the container, matching the [Docker Compose `restart` field](https://docs.docker.com/reference/compose-file/services/#restart): `no`, `always`, `on-failure` (optionally `on-failure:<max-retries>`) or `unless-stopped`.
2950
+ *
2951
+ */
2952
+ restart?: string;
2953
+ /**
2954
+ * @deprecated
2955
+ * Deprecated by 'restart' (which takes precedence). This field will be removed in a future version.
2956
+ */
2927
2957
  restartPolicy?: string;
2928
2958
  /**
2929
2959
  * 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).
2930
2960
  *
2931
2961
  */
2932
2962
  volumes?: string[];
2963
+ /**
2964
+ * Human-readable description of this container.
2965
+ */
2966
+ "x-description"?: string;
2933
2967
  }
2934
2968
  interface ContainerResourceSpec {
2935
2969
  /**
@@ -4755,7 +4789,7 @@ export declare namespace MittwaldAPIV2 {
4755
4789
  * @deprecated
4756
4790
  */
4757
4791
  blocked: boolean;
4758
- context: MittwaldAPIV2.Components.Schemas.MarketplaceContext;
4792
+ context?: MittwaldAPIV2.Components.Schemas.MarketplaceContext;
4759
4793
  contributorId: string;
4760
4794
  deletionDeadline?: string;
4761
4795
  deprecation?: MittwaldAPIV2.Components.Schemas.MarketplaceExtensionDeprecation;
@@ -7387,6 +7421,78 @@ export declare namespace MittwaldAPIV2 {
7387
7421
  validationErrors: MittwaldAPIV2.Components.Schemas.CommonsValidationErrorSchema[];
7388
7422
  }
7389
7423
  }
7424
+ namespace RequestSchemas {
7425
+ /**
7426
+ * PricePlan with Variants.
7427
+ */
7428
+ interface ExtensionPricePlan {
7429
+ /**
7430
+ * Indicates whether downgrading between variants is allowed.
7431
+ */
7432
+ isDowngradeAllowed?: boolean;
7433
+ /**
7434
+ * Indicates whether upgrading between variants is allowed.
7435
+ */
7436
+ isUpgradeAllowed?: boolean;
7437
+ variants: MittwaldAPIV2.Components.RequestSchemas.ExtensionVariant[];
7438
+ }
7439
+ interface ExtensionVariant {
7440
+ /**
7441
+ * deadline for scheduled deletion of extension variant
7442
+ */
7443
+ deletionDeadline?: string | Date;
7444
+ /**
7445
+ * Description of Variant.
7446
+ */
7447
+ description?: string;
7448
+ /**
7449
+ * DescriptionChangeType defines how the description change should be handled. Values:
7450
+ * - FEATURE_SET_MODIFIED: The users have to confirm to the new contract details equal as price changes.
7451
+ * - FEATURE_SET_UNCHANGED: The changes are only wording updates and do not impact the contract details, so no confirm is required.
7452
+ *
7453
+ */
7454
+ descriptionChangeType?: "FEATURE_SET_MODIFIED" | "FEATURE_SET_UNCHANGED";
7455
+ /**
7456
+ * stop extension variant from being booked
7457
+ */
7458
+ isBookingStopped?: boolean;
7459
+ /**
7460
+ * deletion of extension variant is scheduled
7461
+ */
7462
+ isDeletionScheduled?: boolean;
7463
+ /**
7464
+ * Key that needs to be unique in Variant.
7465
+ */
7466
+ key: string;
7467
+ /**
7468
+ * Name of Variant.
7469
+ */
7470
+ name?: string;
7471
+ /**
7472
+ * Price in cents.
7473
+ */
7474
+ priceInCents: number;
7475
+ }
7476
+ /**
7477
+ * The Extension is deprecated by the contributor and will expire at the given date.
7478
+ */
7479
+ interface MarketplaceExtensionDeprecation {
7480
+ deprecatedAt: string | Date;
7481
+ note?: string;
7482
+ /**
7483
+ * The ID of the successor extension.
7484
+ */
7485
+ successorId?: string;
7486
+ }
7487
+ interface IngressTlsAcme {
7488
+ /**
7489
+ * Has to be `true`, as ssl cannot be deactivated.
7490
+ */
7491
+ acme: boolean;
7492
+ isCreated: boolean;
7493
+ requestDeadline?: string | Date;
7494
+ }
7495
+ }
7390
7496
  namespace Parameters { }
7391
7497
  namespace RequestBodies { }
7392
7498
  namespace Responses {
@@ -10206,7 +10312,7 @@ export declare namespace MittwaldAPIV2 {
10206
10312
  /**
10207
10313
  * Time when to expire the Backup. Must be at least 7 days and no more than one year in the future.
10208
10314
  */
10209
- expirationTime: string;
10315
+ expirationTime: string | Date;
10210
10316
  }
10211
10317
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
10212
10318
  type Query = {};
@@ -10505,7 +10611,7 @@ export declare namespace MittwaldAPIV2 {
10505
10611
  /**
10506
10612
  * Time when to expire the Backup. Must be no more than one year in the future.
10507
10613
  */
10508
- expirationTime?: string;
10614
+ expirationTime?: string | Date;
10509
10615
  }
10510
10616
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
10511
10617
  type Query = {};
@@ -11339,6 +11445,10 @@ export declare namespace MittwaldAPIV2 {
11339
11445
  stackId: string;
11340
11446
  };
11341
11447
  interface RequestBody {
11448
+ /**
11449
+ * @deprecated
11450
+ * Deprecated by 'x-description' (which takes precedence). This field will be removed in a future version.
11451
+ */
11342
11452
  description?: string;
11343
11453
  /**
11344
11454
  * A set of containers that should be started in this stack. The key is relevant for
@@ -11356,8 +11466,9 @@ export declare namespace MittwaldAPIV2 {
11356
11466
  [k: string]: MittwaldAPIV2.Components.Schemas.ContainerServiceRequest;
11357
11467
  };
11358
11468
  /**
11359
- * Schedule for automatic image updates of this stack. Set to `null` to remove the
11360
- * schedule; omit the property to leave it unchanged.
11469
+ * @deprecated
11470
+ * Deprecated by 'x-update-schedule' (which takes precedence). This field will be
11471
+ * removed in a future version.
11361
11472
  *
11362
11473
  */
11363
11474
  updateSchedule?: {
@@ -11376,6 +11487,22 @@ export declare namespace MittwaldAPIV2 {
11376
11487
  volumes?: {
11377
11488
  [k: string]: MittwaldAPIV2.Components.Schemas.ContainerVolumeRequest;
11378
11489
  };
11490
+ /**
11491
+ * Description of the stack.
11492
+ */
11493
+ "x-description"?: string;
11494
+ /**
11495
+ * Schedule for automatic image updates of this stack. Set to `null` to remove the
11496
+ * schedule; omit the property to leave it unchanged.
11497
+ *
11498
+ */
11499
+ "x-update-schedule"?: {
11500
+ cron: string;
11501
+ /**
11502
+ * Valid timezones can be retrieved via GET /v2/time-zones
11503
+ */
11504
+ timezone?: string;
11505
+ };
11379
11506
  }
11380
11507
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
11381
11508
  type Query = {
@@ -11741,7 +11868,9 @@ export declare namespace MittwaldAPIV2 {
11741
11868
  namespace Get {
11742
11869
  namespace Parameters {
11743
11870
  type Path = {};
11744
- type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
11871
+ type Header = {
11872
+ "Accept-Language"?: "de" | "en";
11873
+ } & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
11745
11874
  type Query = {
11746
11875
  imageReference: string;
11747
11876
  useCredentialsForProjectId?: string;
@@ -11814,7 +11943,9 @@ export declare namespace MittwaldAPIV2 {
11814
11943
  stackId: string;
11815
11944
  serviceId: string;
11816
11945
  };
11817
- type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
11946
+ type Header = {
11947
+ "Accept-Language"?: "de" | "en";
11948
+ } & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
11818
11949
  type Query = {};
11819
11950
  }
11820
11951
  namespace Responses {
@@ -12922,7 +13053,7 @@ export declare namespace MittwaldAPIV2 {
12922
13053
  /**
12923
13054
  * The termination date has to be a valid date according to activation and contract period of the ContractItem. If none given, the next possible termination date will be used.
12924
13055
  */
12925
- terminationTargetDate?: string;
13056
+ terminationTargetDate?: string | Date;
12926
13057
  }
12927
13058
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
12928
13059
  type Query = {};
@@ -13085,7 +13216,7 @@ export declare namespace MittwaldAPIV2 {
13085
13216
  /**
13086
13217
  * The termination date has to be a valid date according to activation and contract period of the base ContractItem. If none given, the next possible termination date will be used.
13087
13218
  */
13088
- terminationTargetDate?: string;
13219
+ terminationTargetDate?: string | Date;
13089
13220
  }
13090
13221
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
13091
13222
  type Query = {};
@@ -15393,8 +15524,8 @@ export declare namespace MittwaldAPIV2 {
15393
15524
  };
15394
15525
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
15395
15526
  type Query = {
15396
- since?: string;
15397
- until?: string;
15527
+ since?: string | Date;
15528
+ until?: string | Date;
15398
15529
  status?: string;
15399
15530
  triggeredByUser?: boolean;
15400
15531
  sortOrder?: MittwaldAPIV2.Components.Schemas.CronjobCronjobExecutionSortOrder;
@@ -15848,7 +15979,7 @@ export declare namespace MittwaldAPIV2 {
15848
15979
  /**
15849
15980
  * Time the resulting CustomerMembership should expire at.
15850
15981
  */
15851
- membershipExpiresAt?: string;
15982
+ membershipExpiresAt?: string | Date;
15852
15983
  /**
15853
15984
  * Message contained in the CustomerInvite.
15854
15985
  */
@@ -16359,7 +16490,7 @@ export declare namespace MittwaldAPIV2 {
16359
16490
  /**
16360
16491
  * Time the CustomerMembership should expire at.
16361
16492
  */
16362
- expiresAt?: string;
16493
+ expiresAt?: string | Date;
16363
16494
  role: MittwaldAPIV2.Components.Schemas.MembershipCustomerRoles;
16364
16495
  }
16365
16496
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
@@ -18257,7 +18388,7 @@ export declare namespace MittwaldAPIV2 {
18257
18388
  * @deprecated
18258
18389
  * Was added by mistake. Never did anything.
18259
18390
  */
18260
- requestDeadline?: string;
18391
+ requestDeadline?: string | Date;
18261
18392
  } | {
18262
18393
  certificateId: string;
18263
18394
  };
@@ -18325,9 +18456,9 @@ export declare namespace MittwaldAPIV2 {
18325
18456
  interface RequestBody {
18326
18457
  autoResponder: {
18327
18458
  active: boolean;
18328
- expiresAt?: string;
18459
+ expiresAt?: string | Date;
18329
18460
  message: string;
18330
- startsAt?: string;
18461
+ startsAt?: string | Date;
18331
18462
  };
18332
18463
  }
18333
18464
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
@@ -19233,7 +19364,7 @@ export declare namespace MittwaldAPIV2 {
19233
19364
  * Whether to also delete the corresponding Ingress and subdomain Ingresses.
19234
19365
  */
19235
19366
  deleteIngresses?: boolean;
19236
- deletionDate: string;
19367
+ deletionDate: string | Date;
19237
19368
  }
19238
19369
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
19239
19370
  type Query = {};
@@ -20937,7 +21068,7 @@ export declare namespace MittwaldAPIV2 {
20937
21068
  * Used to patch asset order.
20938
21069
  */
20939
21070
  assets?: string[];
20940
- deprecation?: MittwaldAPIV2.Components.Schemas.MarketplaceExtensionDeprecation;
21071
+ deprecation?: MittwaldAPIV2.Components.RequestSchemas.MarketplaceExtensionDeprecation;
20941
21072
  description?: string;
20942
21073
  detailedDescriptions?: MittwaldAPIV2.Components.Schemas.MarketplaceDetailedDescriptions;
20943
21074
  externalFrontends?: MittwaldAPIV2.Components.Schemas.MarketplaceExternalComponent[];
@@ -21051,7 +21182,7 @@ export declare namespace MittwaldAPIV2 {
21051
21182
  contextId?: string;
21052
21183
  scopes?: string[];
21053
21184
  instanceDisabled?: boolean;
21054
- createdAt?: string;
21185
+ createdAt?: string | Date;
21055
21186
  secret?: string;
21056
21187
  };
21057
21188
  }
@@ -22369,7 +22500,7 @@ export declare namespace MittwaldAPIV2 {
22369
22500
  * If set to true, the request will be validated but not executed.
22370
22501
  */
22371
22502
  dryRun?: boolean;
22372
- pricePlan: MittwaldAPIV2.Components.Schemas.ExtensionPricePlan;
22503
+ pricePlan: MittwaldAPIV2.Components.RequestSchemas.ExtensionPricePlan;
22373
22504
  };
22374
22505
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
22375
22506
  type Query = {};
@@ -26987,7 +27118,7 @@ export declare namespace MittwaldAPIV2 {
26987
27118
  /**
26988
27119
  * Time the resulting ProjectMembership should expire at.
26989
27120
  */
26990
- membershipExpiresAt?: string;
27121
+ membershipExpiresAt?: string | Date;
26991
27122
  /**
26992
27123
  * Message contained in the ProjectInvite.
26993
27124
  */
@@ -27366,7 +27497,7 @@ export declare namespace MittwaldAPIV2 {
27366
27497
  /**
27367
27498
  * Time the ProjectMembership should expire at.
27368
27499
  */
27369
- expiresAt?: string;
27500
+ expiresAt?: string | Date;
27370
27501
  role: MittwaldAPIV2.Components.Schemas.MembershipProjectRoles;
27371
27502
  }
27372
27503
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
@@ -28255,8 +28386,8 @@ export declare namespace MittwaldAPIV2 {
28255
28386
  aggregateName?: string;
28256
28387
  aggregateDomain?: string;
28257
28388
  aggregateId?: string;
28258
- startTime?: string;
28259
- endTime?: string;
28389
+ startTime?: string | Date;
28390
+ endTime?: string | Date;
28260
28391
  fulltextSearch?: string;
28261
28392
  limit?: number;
28262
28393
  skip?: number;
@@ -28760,7 +28891,7 @@ export declare namespace MittwaldAPIV2 {
28760
28891
  * @minItems 1
28761
28892
  */
28762
28893
  directories: [string, ...string[]];
28763
- expiresAt?: string;
28894
+ expiresAt?: string | Date;
28764
28895
  }
28765
28896
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
28766
28897
  type Query = {};
@@ -28897,7 +29028,7 @@ export declare namespace MittwaldAPIV2 {
28897
29028
  * @minItems 1
28898
29029
  */
28899
29030
  directories?: [string, ...string[]];
28900
- expiresAt?: string;
29031
+ expiresAt?: string | Date;
28901
29032
  password?: string;
28902
29033
  publicKeys?: MittwaldAPIV2.Components.Schemas.SshuserPublicKey[];
28903
29034
  }
@@ -28999,7 +29130,7 @@ export declare namespace MittwaldAPIV2 {
28999
29130
  interface RequestBody {
29000
29131
  authentication: MittwaldAPIV2.Components.Schemas.SshuserAuthentication;
29001
29132
  description: string;
29002
- expiresAt?: string;
29133
+ expiresAt?: string | Date;
29003
29134
  }
29004
29135
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
29005
29136
  type Query = {};
@@ -29131,7 +29262,7 @@ export declare namespace MittwaldAPIV2 {
29131
29262
  interface RequestBody {
29132
29263
  active?: boolean;
29133
29264
  description?: string;
29134
- expiresAt?: string;
29265
+ expiresAt?: string | Date;
29135
29266
  password?: string;
29136
29267
  publicKeys?: MittwaldAPIV2.Components.Schemas.SshuserPublicKey[];
29137
29268
  }
@@ -30519,7 +30650,7 @@ export declare namespace MittwaldAPIV2 {
30519
30650
  type Path = {};
30520
30651
  interface RequestBody {
30521
30652
  description: string;
30522
- expiresAt?: string;
30653
+ expiresAt?: string | Date;
30523
30654
  /**
30524
30655
  * Determines the access rights of the ApiToken.
30525
30656
  *
@@ -30672,7 +30803,7 @@ export declare namespace MittwaldAPIV2 {
30672
30803
  namespace Parameters {
30673
30804
  type Path = {};
30674
30805
  interface RequestBody {
30675
- expiresAt?: string;
30806
+ expiresAt?: string | Date;
30676
30807
  publicKey: string;
30677
30808
  }
30678
30809
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
@@ -30754,7 +30885,7 @@ export declare namespace MittwaldAPIV2 {
30754
30885
  };
30755
30886
  interface RequestBody {
30756
30887
  description: string;
30757
- expiresAt?: string;
30888
+ expiresAt?: string | Date;
30758
30889
  }
30759
30890
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
30760
30891
  type Query = {};
@@ -30873,7 +31004,7 @@ export declare namespace MittwaldAPIV2 {
30873
31004
  };
30874
31005
  interface RequestBody {
30875
31006
  comment: string;
30876
- expiresAt?: string;
31007
+ expiresAt?: string | Date;
30877
31008
  }
30878
31009
  type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
30879
31010
  type Query = {};