@mittwald/api-client 4.308.0 → 4.310.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.
@@ -160,7 +160,7 @@ export class MittwaldAPIV2Client extends ApiClientBase {
160
160
  listStacks: this.requestFunctionFactory(descriptors.containerListStacks),
161
161
  /** List Volumes belonging to a Project. */
162
162
  listVolumes: this.requestFunctionFactory(descriptors.containerListVolumes),
163
- /** Pulls the latest version of the Service's image and optionally recreates the Service. */
163
+ /** Pull image and recreate */
164
164
  pullImageForService: this.requestFunctionFactory(descriptors.containerPullImageForService),
165
165
  /** Recreate a Service. */
166
166
  recreateService: this.requestFunctionFactory(descriptors.containerRecreateService),
@@ -174,6 +174,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
174
174
  validateContainerRegistryUri: this.requestFunctionFactory(descriptors.containerValidateContainerRegistryUri),
175
175
  /** Validate a Registries' credentials. */
176
176
  validateRegistryCredentials: this.requestFunctionFactory(descriptors.containerValidateRegistryCredentials),
177
+ /** Set an update schedule for a Stack. */
178
+ setStackUpdateSchedule: this.requestFunctionFactory(descriptors.containerSetStackUpdateSchedule),
177
179
  };
178
180
  /** The contract API allows you to manage your contracts and orders */
179
181
  contract = {
@@ -424,7 +424,7 @@ export const containerListVolumes = {
424
424
  method: "GET",
425
425
  operationId: "container-list-volumes",
426
426
  };
427
- /** Pulls the latest version of the Service's image and optionally recreates the Service. */
427
+ /** Pull image and recreate */
428
428
  export const containerPullImageForService = {
429
429
  path: "/v2/stacks/{stackId}/services/{serviceId}/actions/pull",
430
430
  method: "POST",
@@ -2722,3 +2722,9 @@ export const licenseValidateLicenseKeyForProject = {
2722
2722
  method: "POST",
2723
2723
  operationId: "license-validate-license-key-for-project",
2724
2724
  };
2725
+ /** Set an update schedule for a Stack. */
2726
+ export const containerSetStackUpdateSchedule = {
2727
+ path: "/v2/stacks/{stackId}/update-schedule",
2728
+ method: "PUT",
2729
+ operationId: "container-set-stack-update-schedule",
2730
+ };
@@ -1 +1 @@
1
- export const MittwaldAPIClientVersion = '4.307.0';
1
+ export const MittwaldAPIClientVersion = '4.309.0';
@@ -509,6 +509,10 @@ declare const buildContainerApi: (baseClient: MittwaldAPIV2Client) => {
509
509
  prefix: string;
510
510
  projectId: string;
511
511
  services?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceResponse[] | undefined;
512
+ updateSchedule?: {
513
+ cron: string;
514
+ timezone?: string;
515
+ } | null | undefined;
512
516
  volumes?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[] | undefined;
513
517
  }>;
514
518
  /** Get a Registry. */
@@ -3582,6 +3582,10 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
3582
3582
  prefix: string;
3583
3583
  projectId: string;
3584
3584
  services?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceResponse[] | undefined;
3585
+ updateSchedule?: {
3586
+ cron: string;
3587
+ timezone?: string;
3588
+ } | null | undefined;
3585
3589
  volumes?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[] | undefined;
3586
3590
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
3587
3591
  [x: string]: unknown;
@@ -3612,6 +3616,10 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
3612
3616
  prefix: string;
3613
3617
  projectId: string;
3614
3618
  services?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceResponse[] | undefined;
3619
+ updateSchedule?: {
3620
+ cron: string;
3621
+ timezone?: string;
3622
+ } | null | undefined;
3615
3623
  volumes?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[] | undefined;
3616
3624
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
3617
3625
  [x: string]: unknown;
@@ -3690,6 +3698,10 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
3690
3698
  prefix: string;
3691
3699
  projectId: string;
3692
3700
  services?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceResponse[] | undefined;
3701
+ updateSchedule?: {
3702
+ cron: string;
3703
+ timezone?: string;
3704
+ } | null | undefined;
3693
3705
  volumes?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[] | undefined;
3694
3706
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
3695
3707
  [x: string]: unknown;
@@ -3731,6 +3743,10 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
3731
3743
  prefix: string;
3732
3744
  projectId: string;
3733
3745
  services?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceResponse[] | undefined;
3746
+ updateSchedule?: {
3747
+ cron: string;
3748
+ timezone?: string;
3749
+ } | null | undefined;
3734
3750
  volumes?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[] | undefined;
3735
3751
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
3736
3752
  [x: string]: unknown;
@@ -3817,6 +3833,10 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
3817
3833
  prefix: string;
3818
3834
  projectId: string;
3819
3835
  services?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceResponse[] | undefined;
3836
+ updateSchedule?: {
3837
+ cron: string;
3838
+ timezone?: string;
3839
+ } | null | undefined;
3820
3840
  volumes?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[] | undefined;
3821
3841
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
3822
3842
  [x: string]: unknown;
@@ -3860,6 +3880,10 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
3860
3880
  prefix: string;
3861
3881
  projectId: string;
3862
3882
  services?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceResponse[] | undefined;
3883
+ updateSchedule?: {
3884
+ cron: string;
3885
+ timezone?: string;
3886
+ } | null | undefined;
3863
3887
  volumes?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[] | undefined;
3864
3888
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
3865
3889
  [x: string]: unknown;
@@ -4808,7 +4832,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
4808
4832
  }, 429, "application/json"> | import("@mittwald/api-client-commons").Response<{
4809
4833
  [x: string]: unknown;
4810
4834
  }, 500, "application/json">>>;
4811
- /** Pulls the latest version of the Service's image and optionally recreates the Service. */
4835
+ /** Pull image and recreate */
4812
4836
  pullImageForService: (request: {
4813
4837
  stackId: string;
4814
4838
  serviceId: string;
@@ -5271,6 +5295,86 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
5271
5295
  }, 429, "application/json"> | import("@mittwald/api-client-commons").Response<{
5272
5296
  [x: string]: unknown;
5273
5297
  }, 500, "application/json">>>;
5298
+ /** Set an update schedule for a Stack. */
5299
+ setStackUpdateSchedule: (request: {
5300
+ stackId: string;
5301
+ data?: {
5302
+ updateSchedule?: {
5303
+ cron: string;
5304
+ timezone?: string | undefined;
5305
+ } | undefined;
5306
+ } | undefined;
5307
+ headers?: {
5308
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
5309
+ "x-access-token"?: string | undefined;
5310
+ } | undefined;
5311
+ }, opts?: import("@mittwald/api-client-commons").RequestOptions<import("@mittwald/api-client-commons").OpenAPIOperation<{
5312
+ data: {
5313
+ updateSchedule?: {
5314
+ cron: string;
5315
+ timezone?: string;
5316
+ } | undefined;
5317
+ };
5318
+ } & {
5319
+ pathParameters: {
5320
+ stackId: string;
5321
+ };
5322
+ } & {
5323
+ headers?: Partial<{
5324
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5325
+ }>;
5326
+ } & {
5327
+ headers: {
5328
+ "x-access-token"?: string | undefined;
5329
+ } & Partial<{
5330
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5331
+ }>;
5332
+ }, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
5333
+ [x: string]: unknown;
5334
+ }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
5335
+ [x: string]: unknown;
5336
+ }, 403, "application/json"> | import("@mittwald/api-client-commons").Response<{
5337
+ [x: string]: unknown;
5338
+ }, 404, "application/json"> | import("@mittwald/api-client-commons").Response<{
5339
+ [x: string]: unknown;
5340
+ }, 412, "application/json"> | import("@mittwald/api-client-commons").Response<{
5341
+ [x: string]: unknown;
5342
+ }, 429, "application/json"> | import("@mittwald/api-client-commons").Response<{
5343
+ [x: string]: unknown;
5344
+ }, 500, "application/json">>> | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
5345
+ data: {
5346
+ updateSchedule?: {
5347
+ cron: string;
5348
+ timezone?: string;
5349
+ } | undefined;
5350
+ };
5351
+ } & {
5352
+ pathParameters: {
5353
+ stackId: string;
5354
+ };
5355
+ } & {
5356
+ headers?: Partial<{
5357
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5358
+ }>;
5359
+ } & {
5360
+ headers: {
5361
+ "x-access-token"?: string | undefined;
5362
+ } & Partial<{
5363
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5364
+ }>;
5365
+ }, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
5366
+ [x: string]: unknown;
5367
+ }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
5368
+ [x: string]: unknown;
5369
+ }, 403, "application/json"> | import("@mittwald/api-client-commons").Response<{
5370
+ [x: string]: unknown;
5371
+ }, 404, "application/json"> | import("@mittwald/api-client-commons").Response<{
5372
+ [x: string]: unknown;
5373
+ }, 412, "application/json"> | import("@mittwald/api-client-commons").Response<{
5374
+ [x: string]: unknown;
5375
+ }, 429, "application/json"> | import("@mittwald/api-client-commons").Response<{
5376
+ [x: string]: unknown;
5377
+ }, 500, "application/json">>>;
5274
5378
  };
5275
5379
  /** The contract API allows you to manage your contracts and orders */
5276
5380
  readonly contract: {
@@ -145,7 +145,7 @@ export declare const containerListStackVolumes: OpenAPIOperation<RequestType<Sim
145
145
  export declare const containerListStacks: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdStacks.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdStacks.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdStacks.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdStacks.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdStacks.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdStacks.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdStacks.Get.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdStacks.Get.Responses.$500.Content.ApplicationJson>, 500, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdStacks.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
146
146
  /** List Volumes belonging to a Project. */
147
147
  export declare const containerListVolumes: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdVolumes.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdVolumes.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdVolumes.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdVolumes.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdVolumes.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdVolumes.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdVolumes.Get.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdVolumes.Get.Responses.$500.Content.ApplicationJson>, 500, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdVolumes.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
148
- /** Pulls the latest version of the Service's image and optionally recreates the Service. */
148
+ /** Pull image and recreate */
149
149
  export declare const containerPullImageForService: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsPull.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsPull.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsPull.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsPull.Post.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsPull.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsPull.Post.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsPull.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsPull.Post.Responses.$412.Content.ApplicationJson>, 412, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsPull.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsPull.Post.Responses.$500.Content.ApplicationJson>, 500, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsPull.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
150
150
  /** Recreate a Service. */
151
151
  export declare const containerRecreateService: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsRecreate.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsRecreate.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsRecreate.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsRecreate.Post.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsRecreate.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsRecreate.Post.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsRecreate.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsRecreate.Post.Responses.$412.Content.ApplicationJson>, 412, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsRecreate.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsRecreate.Post.Responses.$500.Content.ApplicationJson>, 500, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdServicesServiceIdActionsRecreate.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
@@ -911,3 +911,5 @@ export declare const licenseListLicensesForProject: OpenAPIOperation<RequestType
911
911
  export declare const licenseRotateLicenseKey: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2LicensesLicenseIdActionsRotateKey.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2LicensesLicenseIdActionsRotateKey.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2LicensesLicenseIdActionsRotateKey.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2LicensesLicenseIdActionsRotateKey.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2LicensesLicenseIdActionsRotateKey.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2LicensesLicenseIdActionsRotateKey.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2LicensesLicenseIdActionsRotateKey.Post.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2LicensesLicenseIdActionsRotateKey.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2LicensesLicenseIdActionsRotateKey.Post.Responses.$412.Content.ApplicationJson>, 412, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2LicensesLicenseIdActionsRotateKey.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2LicensesLicenseIdActionsRotateKey.Post.Responses.$500.Content.ApplicationJson>, 500, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2LicensesLicenseIdActionsRotateKey.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
912
912
  /** Validate a License's key for a project. */
913
913
  export declare const licenseValidateLicenseKeyForProject: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActionsValidateLicenseKey.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActionsValidateLicenseKey.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActionsValidateLicenseKey.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActionsValidateLicenseKey.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActionsValidateLicenseKey.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActionsValidateLicenseKey.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActionsValidateLicenseKey.Post.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActionsValidateLicenseKey.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActionsValidateLicenseKey.Post.Responses.$412.Content.ApplicationJson>, 412, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActionsValidateLicenseKey.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActionsValidateLicenseKey.Post.Responses.$500.Content.ApplicationJson>, 500, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActionsValidateLicenseKey.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
914
+ /** Set an update schedule for a Stack. */
915
+ export declare const containerSetStackUpdateSchedule: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdUpdateSchedule.Put.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2StacksStackIdUpdateSchedule.Put.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2StacksStackIdUpdateSchedule.Put.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2StacksStackIdUpdateSchedule.Put.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdUpdateSchedule.Put.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdUpdateSchedule.Put.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdUpdateSchedule.Put.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdUpdateSchedule.Put.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdUpdateSchedule.Put.Responses.$412.Content.ApplicationJson>, 412, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdUpdateSchedule.Put.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdUpdateSchedule.Put.Responses.$500.Content.ApplicationJson>, 500, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2StacksStackIdUpdateSchedule.Put.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
@@ -1818,6 +1818,10 @@ export declare namespace MittwaldAPIV2 {
1818
1818
  type RequestData = InferredRequestData<typeof descriptors.licenseValidateLicenseKeyForProject>;
1819
1819
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.licenseValidateLicenseKeyForProject, TStatus>;
1820
1820
  }
1821
+ namespace ContainerSetStackUpdateSchedule {
1822
+ type RequestData = InferredRequestData<typeof descriptors.containerSetStackUpdateSchedule>;
1823
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.containerSetStackUpdateSchedule, TStatus>;
1824
+ }
1821
1825
  }
1822
1826
  namespace Components {
1823
1827
  namespace Schemas {
@@ -2483,15 +2487,21 @@ export declare namespace MittwaldAPIV2 {
2483
2487
  }
2484
2488
  interface ContainerServiceDeclareRequest {
2485
2489
  /**
2486
- * Defaults to image config on empty
2490
+ * 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.
2491
+ *
2487
2492
  */
2488
2493
  command?: string[];
2489
2494
  deploy?: MittwaldAPIV2.Components.Schemas.ContainerDeploy;
2490
2495
  description?: string;
2491
2496
  /**
2492
- * Defaults to image config on empty
2497
+ * 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.
2498
+ *
2493
2499
  */
2494
2500
  entrypoint?: string[];
2501
+ /**
2502
+ * Key-value map of environment variables that should be passed into the container.
2503
+ *
2504
+ */
2495
2505
  environment?: {
2496
2506
  [k: string]: string;
2497
2507
  };
@@ -2502,8 +2512,25 @@ export declare namespace MittwaldAPIV2 {
2502
2512
  envs?: {
2503
2513
  [k: string]: string;
2504
2514
  };
2515
+ /**
2516
+ * The image to run, in the usual format also used by `docker run` and `docker compose`. When
2517
+ * the image is pulled from a private registry, make sure to create the registry first
2518
+ * using the `container-create-registry` endpoint (you can push the image later, although
2519
+ * the container will remain in a pending state until the image is actually available).
2520
+ *
2521
+ * The appropriate registry is matched by hostname.
2522
+ *
2523
+ */
2505
2524
  image: string;
2525
+ /**
2526
+ * 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.
2527
+ *
2528
+ */
2506
2529
  ports?: string[];
2530
+ /**
2531
+ * 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).
2532
+ *
2533
+ */
2507
2534
  volumes?: string[];
2508
2535
  }
2509
2536
  interface ContainerDeploy {
@@ -2511,15 +2538,21 @@ export declare namespace MittwaldAPIV2 {
2511
2538
  }
2512
2539
  interface ContainerServiceRequest {
2513
2540
  /**
2514
- * Defaults to image config on empty
2541
+ * 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.
2542
+ *
2515
2543
  */
2516
2544
  command?: string[];
2517
2545
  deploy?: MittwaldAPIV2.Components.Schemas.ContainerDeploy;
2518
2546
  description?: string;
2519
2547
  /**
2520
- * Defaults to image config on empty
2548
+ * 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.
2549
+ *
2521
2550
  */
2522
2551
  entrypoint?: string[];
2552
+ /**
2553
+ * Key-value map of environment variables that should be passed into the container.
2554
+ *
2555
+ */
2523
2556
  environment?: {
2524
2557
  [k: string]: string;
2525
2558
  };
@@ -2530,12 +2563,44 @@ export declare namespace MittwaldAPIV2 {
2530
2563
  envs?: {
2531
2564
  [k: string]: string;
2532
2565
  };
2566
+ /**
2567
+ * The image to run, in the usual format also used by `docker run` and `docker compose`. When
2568
+ * the image is pulled from a private registry, make sure to create the registry first
2569
+ * using the `container-create-registry` endpoint (you can push the image later, although
2570
+ * the container will remain in a pending state until the image is actually available).
2571
+ *
2572
+ * The appropriate registry is matched by hostname.
2573
+ *
2574
+ */
2533
2575
  image?: string;
2576
+ /**
2577
+ * 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.
2578
+ *
2579
+ */
2534
2580
  ports?: string[];
2581
+ /**
2582
+ * 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).
2583
+ *
2584
+ */
2535
2585
  volumes?: string[];
2536
2586
  }
2537
2587
  interface ContainerResourceSpec {
2588
+ /**
2589
+ * CPU limit for the container. The value can be specified as a decimal number, where `1` corresponds to
2590
+ * one full CPU core. For example, `0.5` means that the container is limited to using half of a CPU core.
2591
+ *
2592
+ */
2538
2593
  cpus?: string;
2594
+ /**
2595
+ * Memory limit for the container. The value can be specified in bytes or using a suffix to indicate
2596
+ * the unit.
2597
+ *
2598
+ * The format matches the one [used by Docker Compose](https://docs.docker.com/reference/compose-file/extension/#specifying-byte-values):
2599
+ *
2600
+ * > Values express a byte value as a string in `{amount}{byte unit}` format: The supported units are
2601
+ * `b` (bytes), `k` or `kb` (kilo bytes), `m` or `mb` (mega bytes) and `g` or `gb` (giga bytes).
2602
+ *
2603
+ */
2539
2604
  memory?: string;
2540
2605
  }
2541
2606
  interface ContainerResources {
@@ -2546,25 +2611,66 @@ export declare namespace MittwaldAPIV2 {
2546
2611
  deployedState: MittwaldAPIV2.Components.Schemas.ContainerServiceState;
2547
2612
  description: string;
2548
2613
  id: string;
2614
+ /**
2615
+ * 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.
2616
+ *
2617
+ */
2549
2618
  message?: string;
2550
2619
  pendingState: MittwaldAPIV2.Components.Schemas.ContainerServiceState;
2551
2620
  projectId: string;
2552
2621
  requiresRecreate: boolean;
2553
2622
  serviceName: string;
2623
+ /**
2624
+ * 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.
2625
+ *
2626
+ */
2554
2627
  shortId: string;
2555
2628
  stackId: string;
2556
2629
  status: MittwaldAPIV2.Components.Schemas.ContainerServiceStatus;
2557
2630
  statusSetAt: string;
2558
2631
  }
2559
2632
  interface ContainerServiceState {
2633
+ /**
2634
+ * 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.
2635
+ *
2636
+ */
2560
2637
  command?: string[];
2638
+ /**
2639
+ * 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.
2640
+ *
2641
+ */
2561
2642
  entrypoint?: string[];
2643
+ /**
2644
+ * Key-value map of environment variables that should be passed into the container.
2645
+ *
2646
+ */
2562
2647
  envs?: {
2563
2648
  [k: string]: string;
2564
2649
  };
2650
+ /**
2651
+ * The image to run, in the usual format also used by `docker run` and `docker compose`. When
2652
+ * the image is pulled from a private registry, make sure to create the registry first
2653
+ * using the `container-create-registry` endpoint (you can push the image later, although
2654
+ * the container will remain in a pending state until the image is actually available).
2655
+ *
2656
+ * The appropriate registry is matched by hostname.
2657
+ *
2658
+ */
2565
2659
  image: string;
2660
+ /**
2661
+ * The digest of the image that is currently deployed.
2662
+ *
2663
+ */
2566
2664
  imageDigest?: string;
2665
+ /**
2666
+ * 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.
2667
+ *
2668
+ */
2567
2669
  ports?: string[];
2670
+ /**
2671
+ * 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).
2672
+ *
2673
+ */
2568
2674
  volumes?: string[];
2569
2675
  }
2570
2676
  type ContainerServiceStatus = "running" | "stopped" | "restarting" | "error" | "creating" | "starting";
@@ -2589,6 +2695,10 @@ export declare namespace MittwaldAPIV2 {
2589
2695
  prefix: string;
2590
2696
  projectId: string;
2591
2697
  services?: MittwaldAPIV2.Components.Schemas.ContainerServiceResponse[];
2698
+ updateSchedule?: {
2699
+ cron: string;
2700
+ timezone?: string;
2701
+ } | null;
2592
2702
  volumes?: MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[];
2593
2703
  }
2594
2704
  interface ContainerUpdateRegistry {
@@ -5831,13 +5941,18 @@ export declare namespace MittwaldAPIV2 {
5831
5941
  exists: boolean;
5832
5942
  }
5833
5943
  type ContainerVolumeSortOrder = "nameAsc" | "nameDesc" | "storageAsc" | "storageDesc";
5834
- interface LicenseKey {
5835
- key: string;
5836
- }
5837
5944
  interface LicenseAppVersionMeta {
5838
5945
  description: string;
5839
5946
  }
5840
5947
  type LicenseKind = "typo3-elts";
5948
+ interface LicenseMeta {
5949
+ appVersion?: MittwaldAPIV2.Components.Schemas.LicenseAppVersionMeta;
5950
+ }
5951
+ interface LicenseReference {
5952
+ aggregate: "project";
5953
+ domain: "project";
5954
+ id: string;
5955
+ }
5841
5956
  interface LicenseLicense {
5842
5957
  description: string;
5843
5958
  expiryDate?: string;
@@ -5848,20 +5963,15 @@ export declare namespace MittwaldAPIV2 {
5848
5963
  reference: MittwaldAPIV2.Components.Schemas.LicenseReference;
5849
5964
  volume?: number;
5850
5965
  }
5851
- interface LicenseReference {
5852
- aggregate: "project";
5853
- domain: "project";
5854
- id: string;
5966
+ interface LicenseExternalKey {
5967
+ externalKey: string;
5855
5968
  }
5856
- interface LicenseMeta {
5857
- appVersion?: MittwaldAPIV2.Components.Schemas.LicenseAppVersionMeta;
5969
+ interface LicenseKey {
5970
+ key: string;
5858
5971
  }
5859
5972
  interface LicenseKeyResponse {
5860
5973
  keyReference?: MittwaldAPIV2.Components.Schemas.LicenseKey | MittwaldAPIV2.Components.Schemas.LicenseExternalKey;
5861
5974
  }
5862
- interface LicenseExternalKey {
5863
- externalKey: string;
5864
- }
5865
5975
  type OrderLicenseOrder = {
5866
5976
  /**
5867
5977
  * Describe for which typo3 instance the license will be used.
@@ -8924,11 +9034,24 @@ export declare namespace MittwaldAPIV2 {
8924
9034
  stackId: string;
8925
9035
  };
8926
9036
  interface RequestBody {
9037
+ /**
9038
+ * A set of containers that should be started in this stack. The key is relevant for
9039
+ * network connectivity between containers, because you can use it as DNS name to
9040
+ * resolve this containers from other containers running in the same project (or from
9041
+ * managed apps running in the same project).
9042
+ *
9043
+ * To **delete** an existing container from a stack using a `PUT` request, simply omit
9044
+ * it from the request body. Using a `PATCH` request, set it to an empty object `{}`.
9045
+ *
9046
+ */
8927
9047
  services?: {
8928
9048
  [k: string]: MittwaldAPIV2.Components.Schemas.ContainerServiceDeclareRequest;
8929
9049
  };
8930
9050
  /**
8931
- * Volumes belonging to a Stack. Removing results in a detach, delete must be explicit.
9051
+ * A set of named volumes that should be created for this stack. Removing a volume
9052
+ * from this set will not delete the volume (for safety), but only detach it from the
9053
+ * stack. To delete a volume, use the `DELETE /stacks/{stackId}/volumes/{volumeId}` endpoint.
9054
+ *
8932
9055
  */
8933
9056
  volumes?: {
8934
9057
  [k: string]: MittwaldAPIV2.Components.Schemas.ContainerVolumeDeclareRequest;
@@ -29320,5 +29443,81 @@ export declare namespace MittwaldAPIV2 {
29320
29443
  }
29321
29444
  }
29322
29445
  }
29446
+ namespace V2StacksStackIdUpdateSchedule {
29447
+ namespace Put {
29448
+ namespace Parameters {
29449
+ type Path = {
29450
+ stackId: string;
29451
+ };
29452
+ interface RequestBody {
29453
+ updateSchedule?: {
29454
+ cron: string;
29455
+ /**
29456
+ * Valid timezones can be retrieved via GET /v2/time-zones
29457
+ */
29458
+ timezone?: string;
29459
+ };
29460
+ }
29461
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
29462
+ type Query = {};
29463
+ }
29464
+ namespace Responses {
29465
+ namespace $204 {
29466
+ namespace Content {
29467
+ type Empty = unknown;
29468
+ }
29469
+ }
29470
+ namespace $400 {
29471
+ namespace Content {
29472
+ interface ApplicationJson {
29473
+ [k: string]: unknown;
29474
+ }
29475
+ }
29476
+ }
29477
+ namespace $403 {
29478
+ namespace Content {
29479
+ interface ApplicationJson {
29480
+ [k: string]: unknown;
29481
+ }
29482
+ }
29483
+ }
29484
+ namespace $404 {
29485
+ namespace Content {
29486
+ interface ApplicationJson {
29487
+ [k: string]: unknown;
29488
+ }
29489
+ }
29490
+ }
29491
+ namespace $412 {
29492
+ namespace Content {
29493
+ interface ApplicationJson {
29494
+ [k: string]: unknown;
29495
+ }
29496
+ }
29497
+ }
29498
+ namespace $429 {
29499
+ namespace Content {
29500
+ interface ApplicationJson {
29501
+ [k: string]: unknown;
29502
+ }
29503
+ }
29504
+ }
29505
+ namespace $500 {
29506
+ namespace Content {
29507
+ interface ApplicationJson {
29508
+ [k: string]: unknown;
29509
+ }
29510
+ }
29511
+ }
29512
+ namespace Default {
29513
+ namespace Content {
29514
+ interface ApplicationJson {
29515
+ [k: string]: unknown;
29516
+ }
29517
+ }
29518
+ }
29519
+ }
29520
+ }
29521
+ }
29323
29522
  }
29324
29523
  }
@@ -1 +1 @@
1
- export declare const MittwaldAPIClientVersion = '4.307.0';
1
+ export declare const MittwaldAPIClientVersion = '4.309.0';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mittwald/api-client",
3
- "version": "4.308.0",
3
+ "version": "4.310.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",
@@ -46,11 +46,11 @@
46
46
  "test:compile": "run tsc --noEmit"
47
47
  },
48
48
  "dependencies": {
49
- "@mittwald/api-client-commons": "^4.308.0",
49
+ "@mittwald/api-client-commons": "^4.310.0",
50
50
  "browser-or-node": "^3.0.0"
51
51
  },
52
52
  "devDependencies": {
53
- "@mittwald/api-code-generator": "^4.308.0",
53
+ "@mittwald/api-code-generator": "^4.310.0",
54
54
  "@mittwald/react-use-promise": "^2.6.2",
55
55
  "@types/node": "^22.18.11",
56
56
  "@types/react": "^18.3.26",
@@ -80,5 +80,5 @@
80
80
  "optional": true
81
81
  }
82
82
  },
83
- "gitHead": "ef05b54f646c8f784e5f4c867298f4f2ab54737a"
83
+ "gitHead": "19406e4cc0a5279f9c21f2ce83a0a53d12f1b2f7"
84
84
  }