@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 MittwaldAPIV3Next {
2823
2823
  */
2824
2824
  command?: string[];
2825
2825
  deploy?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldContainerDeploy;
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 MittwaldAPIV3Next {
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 DeMittwaldContainerDeploy {
2869
2886
  resources?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldContainerResources;
@@ -2889,6 +2906,10 @@ export declare namespace MittwaldAPIV3Next {
2889
2906
  */
2890
2907
  command?: string[];
2891
2908
  deploy?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldContainerDeploy;
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 MittwaldAPIV3Next {
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 DeMittwaldContainerResourceSpec {
2935
2969
  /**
@@ -4759,7 +4793,7 @@ export declare namespace MittwaldAPIV3Next {
4759
4793
  * @deprecated
4760
4794
  */
4761
4795
  blocked: boolean;
4762
- context: MittwaldAPIV3Next.Components.Schemas.DeMittwaldMarketplaceContext;
4796
+ context?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldMarketplaceContext;
4763
4797
  contributorId: string;
4764
4798
  deletionDeadline?: string;
4765
4799
  deprecation?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldMarketplaceExtensionDeprecation;
@@ -7391,6 +7425,78 @@ export declare namespace MittwaldAPIV3Next {
7391
7425
  validationErrors: MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsValidationErrorSchema[];
7392
7426
  }
7393
7427
  }
7428
+ namespace RequestSchemas {
7429
+ /**
7430
+ * PricePlan with Variants.
7431
+ */
7432
+ interface DeMittwaldExtensionPricePlan {
7433
+ /**
7434
+ * Indicates whether downgrading between variants is allowed.
7435
+ */
7436
+ isDowngradeAllowed?: boolean;
7437
+ /**
7438
+ * Indicates whether upgrading between variants is allowed.
7439
+ */
7440
+ isUpgradeAllowed?: boolean;
7441
+ variants: MittwaldAPIV3Next.Components.RequestSchemas.DeMittwaldExtensionVariant[];
7442
+ }
7443
+ interface DeMittwaldExtensionVariant {
7444
+ /**
7445
+ * deadline for scheduled deletion of extension variant
7446
+ */
7447
+ deletionDeadline?: string | Date;
7448
+ /**
7449
+ * Description of Variant.
7450
+ */
7451
+ description?: string;
7452
+ /**
7453
+ * DescriptionChangeType defines how the description change should be handled. Values:
7454
+ * - FEATURE_SET_MODIFIED: The users have to confirm to the new contract details equal as price changes.
7455
+ * - FEATURE_SET_UNCHANGED: The changes are only wording updates and do not impact the contract details, so no confirm is required.
7456
+ *
7457
+ */
7458
+ descriptionChangeType?: "FEATURE_SET_MODIFIED" | "FEATURE_SET_UNCHANGED";
7459
+ /**
7460
+ * stop extension variant from being booked
7461
+ */
7462
+ isBookingStopped?: boolean;
7463
+ /**
7464
+ * deletion of extension variant is scheduled
7465
+ */
7466
+ isDeletionScheduled?: boolean;
7467
+ /**
7468
+ * Key that needs to be unique in Variant.
7469
+ */
7470
+ key: string;
7471
+ /**
7472
+ * Name of Variant.
7473
+ */
7474
+ name?: string;
7475
+ /**
7476
+ * Price in cents.
7477
+ */
7478
+ priceInCents: number;
7479
+ }
7480
+ /**
7481
+ * The Extension is deprecated by the contributor and will expire at the given date.
7482
+ */
7483
+ interface DeMittwaldMarketplaceExtensionDeprecation {
7484
+ deprecatedAt: string | Date;
7485
+ note?: string;
7486
+ /**
7487
+ * The ID of the successor extension.
7488
+ */
7489
+ successorId?: string;
7490
+ }
7491
+ interface DeMittwaldIngressTlsAcme {
7492
+ /**
7493
+ * Has to be `true`, as ssl cannot be deactivated.
7494
+ */
7495
+ acme: boolean;
7496
+ isCreated: boolean;
7497
+ requestDeadline?: string | Date;
7498
+ }
7499
+ }
7394
7500
  namespace Parameters { }
7395
7501
  namespace RequestBodies { }
7396
7502
  namespace Responses {
@@ -10198,7 +10304,7 @@ export declare namespace MittwaldAPIV3Next {
10198
10304
  /**
10199
10305
  * Time when to expire the Backup. Must be at least 7 days and no more than one year in the future.
10200
10306
  */
10201
- expirationTime: string;
10307
+ expirationTime: string | Date;
10202
10308
  }
10203
10309
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
10204
10310
  type Query = {};
@@ -10497,7 +10603,7 @@ export declare namespace MittwaldAPIV3Next {
10497
10603
  /**
10498
10604
  * Time when to expire the Backup. Must be no more than one year in the future.
10499
10605
  */
10500
- expirationTime?: string;
10606
+ expirationTime?: string | Date;
10501
10607
  }
10502
10608
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
10503
10609
  type Query = {};
@@ -11331,6 +11437,10 @@ export declare namespace MittwaldAPIV3Next {
11331
11437
  stackId: string;
11332
11438
  };
11333
11439
  interface RequestBody {
11440
+ /**
11441
+ * @deprecated
11442
+ * Deprecated by 'x-description' (which takes precedence). This field will be removed in a future version.
11443
+ */
11334
11444
  description?: string;
11335
11445
  /**
11336
11446
  * A set of containers that should be started in this stack. The key is relevant for
@@ -11348,8 +11458,9 @@ export declare namespace MittwaldAPIV3Next {
11348
11458
  [k: string]: MittwaldAPIV3Next.Components.Schemas.DeMittwaldContainerServiceRequest;
11349
11459
  };
11350
11460
  /**
11351
- * Schedule for automatic image updates of this stack. Set to `null` to remove the
11352
- * schedule; omit the property to leave it unchanged.
11461
+ * @deprecated
11462
+ * Deprecated by 'x-update-schedule' (which takes precedence). This field will be
11463
+ * removed in a future version.
11353
11464
  *
11354
11465
  */
11355
11466
  updateSchedule?: {
@@ -11368,6 +11479,22 @@ export declare namespace MittwaldAPIV3Next {
11368
11479
  volumes?: {
11369
11480
  [k: string]: MittwaldAPIV3Next.Components.Schemas.DeMittwaldContainerVolumeRequest;
11370
11481
  };
11482
+ /**
11483
+ * Description of the stack.
11484
+ */
11485
+ "x-description"?: string;
11486
+ /**
11487
+ * Schedule for automatic image updates of this stack. Set to `null` to remove the
11488
+ * schedule; omit the property to leave it unchanged.
11489
+ *
11490
+ */
11491
+ "x-update-schedule"?: {
11492
+ cron: string;
11493
+ /**
11494
+ * Valid timezones can be retrieved via GET /v2/time-zones
11495
+ */
11496
+ timezone?: string;
11497
+ };
11371
11498
  }
11372
11499
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
11373
11500
  type Query = {
@@ -11733,7 +11860,9 @@ export declare namespace MittwaldAPIV3Next {
11733
11860
  namespace Get {
11734
11861
  namespace Parameters {
11735
11862
  type Path = {};
11736
- type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
11863
+ type Header = {
11864
+ "Accept-Language"?: "de" | "en";
11865
+ } & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
11737
11866
  type Query = {
11738
11867
  imageReference: string;
11739
11868
  useCredentialsForProjectId?: string;
@@ -11806,7 +11935,9 @@ export declare namespace MittwaldAPIV3Next {
11806
11935
  stackId: string;
11807
11936
  serviceId: string;
11808
11937
  };
11809
- type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
11938
+ type Header = {
11939
+ "Accept-Language"?: "de" | "en";
11940
+ } & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
11810
11941
  type Query = {};
11811
11942
  }
11812
11943
  namespace Responses {
@@ -12914,7 +13045,7 @@ export declare namespace MittwaldAPIV3Next {
12914
13045
  /**
12915
13046
  * 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.
12916
13047
  */
12917
- terminationTargetDate?: string;
13048
+ terminationTargetDate?: string | Date;
12918
13049
  }
12919
13050
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
12920
13051
  type Query = {};
@@ -13077,7 +13208,7 @@ export declare namespace MittwaldAPIV3Next {
13077
13208
  /**
13078
13209
  * 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.
13079
13210
  */
13080
- terminationTargetDate?: string;
13211
+ terminationTargetDate?: string | Date;
13081
13212
  }
13082
13213
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
13083
13214
  type Query = {};
@@ -15385,8 +15516,8 @@ export declare namespace MittwaldAPIV3Next {
15385
15516
  };
15386
15517
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
15387
15518
  type Query = {
15388
- since?: string;
15389
- until?: string;
15519
+ since?: string | Date;
15520
+ until?: string | Date;
15390
15521
  status?: string;
15391
15522
  triggeredByUser?: boolean;
15392
15523
  sortOrder?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldCronjobCronjobExecutionSortOrder;
@@ -15839,7 +15970,7 @@ export declare namespace MittwaldAPIV3Next {
15839
15970
  /**
15840
15971
  * Time the resulting CustomerMembership should expire at.
15841
15972
  */
15842
- membershipExpiresAt?: string;
15973
+ membershipExpiresAt?: string | Date;
15843
15974
  /**
15844
15975
  * Message contained in the CustomerInvite.
15845
15976
  */
@@ -16350,7 +16481,7 @@ export declare namespace MittwaldAPIV3Next {
16350
16481
  /**
16351
16482
  * Time the CustomerMembership should expire at.
16352
16483
  */
16353
- expiresAt?: string;
16484
+ expiresAt?: string | Date;
16354
16485
  role: MittwaldAPIV3Next.Components.Schemas.DeMittwaldMembershipCustomerRoles;
16355
16486
  }
16356
16487
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
@@ -18245,7 +18376,7 @@ export declare namespace MittwaldAPIV3Next {
18245
18376
  * @deprecated
18246
18377
  * Was added by mistake. Never did anything.
18247
18378
  */
18248
- requestDeadline?: string;
18379
+ requestDeadline?: string | Date;
18249
18380
  } | {
18250
18381
  certificateId: string;
18251
18382
  };
@@ -18312,9 +18443,9 @@ export declare namespace MittwaldAPIV3Next {
18312
18443
  interface RequestBody {
18313
18444
  autoResponder: {
18314
18445
  active: boolean;
18315
- expiresAt?: string;
18446
+ expiresAt?: string | Date;
18316
18447
  message: string;
18317
- startsAt?: string;
18448
+ startsAt?: string | Date;
18318
18449
  };
18319
18450
  }
18320
18451
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
@@ -19210,7 +19341,7 @@ export declare namespace MittwaldAPIV3Next {
19210
19341
  * Whether to also delete the corresponding Ingress and subdomain Ingresses.
19211
19342
  */
19212
19343
  deleteIngresses?: boolean;
19213
- deletionDate: string;
19344
+ deletionDate: string | Date;
19214
19345
  }
19215
19346
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
19216
19347
  type Query = {};
@@ -20911,7 +21042,7 @@ export declare namespace MittwaldAPIV3Next {
20911
21042
  * Used to patch asset order.
20912
21043
  */
20913
21044
  assets?: string[];
20914
- deprecation?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldMarketplaceExtensionDeprecation;
21045
+ deprecation?: MittwaldAPIV3Next.Components.RequestSchemas.DeMittwaldMarketplaceExtensionDeprecation;
20915
21046
  description?: string;
20916
21047
  detailedDescriptions?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldMarketplaceDetailedDescriptions;
20917
21048
  externalFrontends?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldMarketplaceExternalComponent[];
@@ -21025,7 +21156,7 @@ export declare namespace MittwaldAPIV3Next {
21025
21156
  contextId?: string;
21026
21157
  scopes?: string[];
21027
21158
  instanceDisabled?: boolean;
21028
- createdAt?: string;
21159
+ createdAt?: string | Date;
21029
21160
  secret?: string;
21030
21161
  };
21031
21162
  }
@@ -22342,7 +22473,7 @@ export declare namespace MittwaldAPIV3Next {
22342
22473
  * If set to true, the request will be validated but not executed.
22343
22474
  */
22344
22475
  dryRun?: boolean;
22345
- pricePlan: MittwaldAPIV3Next.Components.Schemas.DeMittwaldExtensionPricePlan;
22476
+ pricePlan: MittwaldAPIV3Next.Components.RequestSchemas.DeMittwaldExtensionPricePlan;
22346
22477
  };
22347
22478
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
22348
22479
  type Query = {};
@@ -26929,7 +27060,7 @@ export declare namespace MittwaldAPIV3Next {
26929
27060
  /**
26930
27061
  * Time the resulting ProjectMembership should expire at.
26931
27062
  */
26932
- membershipExpiresAt?: string;
27063
+ membershipExpiresAt?: string | Date;
26933
27064
  /**
26934
27065
  * Message contained in the ProjectInvite.
26935
27066
  */
@@ -27308,7 +27439,7 @@ export declare namespace MittwaldAPIV3Next {
27308
27439
  /**
27309
27440
  * Time the ProjectMembership should expire at.
27310
27441
  */
27311
- expiresAt?: string;
27442
+ expiresAt?: string | Date;
27312
27443
  role: MittwaldAPIV3Next.Components.Schemas.DeMittwaldMembershipProjectRoles;
27313
27444
  }
27314
27445
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
@@ -28193,8 +28324,8 @@ export declare namespace MittwaldAPIV3Next {
28193
28324
  aggregateName?: string;
28194
28325
  aggregateDomain?: string;
28195
28326
  aggregateId?: string;
28196
- startTime?: string;
28197
- endTime?: string;
28327
+ startTime?: string | Date;
28328
+ endTime?: string | Date;
28198
28329
  fulltextSearch?: string;
28199
28330
  limit?: number;
28200
28331
  skip?: number;
@@ -28698,7 +28829,7 @@ export declare namespace MittwaldAPIV3Next {
28698
28829
  * @minItems 1
28699
28830
  */
28700
28831
  directories: [string, ...string[]];
28701
- expiresAt?: string;
28832
+ expiresAt?: string | Date;
28702
28833
  }
28703
28834
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
28704
28835
  type Query = {};
@@ -28835,7 +28966,7 @@ export declare namespace MittwaldAPIV3Next {
28835
28966
  * @minItems 1
28836
28967
  */
28837
28968
  directories?: [string, ...string[]];
28838
- expiresAt?: string;
28969
+ expiresAt?: string | Date;
28839
28970
  password?: string;
28840
28971
  publicKeys?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSshuserPublicKey[];
28841
28972
  }
@@ -28936,7 +29067,7 @@ export declare namespace MittwaldAPIV3Next {
28936
29067
  interface RequestBody {
28937
29068
  authentication: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSshuserAuthentication;
28938
29069
  description: string;
28939
- expiresAt?: string;
29070
+ expiresAt?: string | Date;
28940
29071
  }
28941
29072
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
28942
29073
  type Query = {};
@@ -29068,7 +29199,7 @@ export declare namespace MittwaldAPIV3Next {
29068
29199
  interface RequestBody {
29069
29200
  active?: boolean;
29070
29201
  description?: string;
29071
- expiresAt?: string;
29202
+ expiresAt?: string | Date;
29072
29203
  password?: string;
29073
29204
  publicKeys?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSshuserPublicKey[];
29074
29205
  }
@@ -30450,7 +30581,7 @@ export declare namespace MittwaldAPIV3Next {
30450
30581
  type Path = {};
30451
30582
  interface RequestBody {
30452
30583
  description: string;
30453
- expiresAt?: string;
30584
+ expiresAt?: string | Date;
30454
30585
  /**
30455
30586
  * Determines the access rights of the ApiToken.
30456
30587
  *
@@ -30602,7 +30733,7 @@ export declare namespace MittwaldAPIV3Next {
30602
30733
  namespace Parameters {
30603
30734
  type Path = {};
30604
30735
  interface RequestBody {
30605
- expiresAt?: string;
30736
+ expiresAt?: string | Date;
30606
30737
  publicKey: string;
30607
30738
  }
30608
30739
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
@@ -30684,7 +30815,7 @@ export declare namespace MittwaldAPIV3Next {
30684
30815
  };
30685
30816
  interface RequestBody {
30686
30817
  description: string;
30687
- expiresAt?: string;
30818
+ expiresAt?: string | Date;
30688
30819
  }
30689
30820
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
30690
30821
  type Query = {};
@@ -30803,7 +30934,7 @@ export declare namespace MittwaldAPIV3Next {
30803
30934
  };
30804
30935
  interface RequestBody {
30805
30936
  comment: string;
30806
- expiresAt?: string;
30937
+ expiresAt?: string | Date;
30807
30938
  }
30808
30939
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
30809
30940
  type Query = {};
@@ -1 +1 @@
1
- export declare const MittwaldAPIClientVersion = '4.464.0';
1
+ export declare const MittwaldAPIClientVersion = '4.466.0';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mittwald/api-client",
3
- "version": "4.465.0",
3
+ "version": "4.467.0",
4
4
  "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
5
5
  "type": "module",
6
6
  "description": "Auto-generated client for the mittwald API",
@@ -72,11 +72,11 @@
72
72
  "test:compile": "run tsc --noEmit"
73
73
  },
74
74
  "dependencies": {
75
- "@mittwald/api-client-commons": "^4.465.0",
75
+ "@mittwald/api-client-commons": "^4.467.0",
76
76
  "browser-or-node": "^3.0.0"
77
77
  },
78
78
  "devDependencies": {
79
- "@mittwald/api-code-generator": "^4.465.0",
79
+ "@mittwald/api-code-generator": "^4.467.0",
80
80
  "@mittwald/react-use-promise": "^4.2.3",
81
81
  "@types/node": "^22.18.11",
82
82
  "@types/react": "^18.3.26",
@@ -106,5 +106,5 @@
106
106
  "optional": true
107
107
  }
108
108
  },
109
- "gitHead": "74fd5453c0bd37dfdaf67f198cc9cf9850993c39"
109
+ "gitHead": "431a6868c29f099dd308451100c59d41f0745eb7"
110
110
  }