@mittwald/api-client 4.248.0 → 4.249.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.
@@ -186,6 +186,8 @@ const buildCronjobApi = (baseClient) => ({
186
186
  getCronjob: new ApiCallAsyncResourceFactory(descriptors.cronjobGetCronjob, baseClient.cronjob.getCronjob).getApiResource,
187
187
  /** Get a CronjobExecution. */
188
188
  getExecution: new ApiCallAsyncResourceFactory(descriptors.cronjobGetExecution, baseClient.cronjob.getExecution).getApiResource,
189
+ /** Get a CronjobExecution analysis for failed executions. */
190
+ getExecutionAnalysis: new ApiCallAsyncResourceFactory(descriptors.cronjobGetExecutionAnalysis, baseClient.cronjob.getExecutionAnalysis).getApiResource,
189
191
  });
190
192
  const buildCustomerApi = (baseClient) => ({
191
193
  /** List Invites belonging to a Customer. */
@@ -377,6 +377,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
377
377
  getExecution: this.requestFunctionFactory(descriptors.cronjobGetExecution),
378
378
  /** Update a Cronjob's app id. */
379
379
  updateCronjobAppId: this.requestFunctionFactory(descriptors.cronjobUpdateCronjobAppId),
380
+ /** Get a CronjobExecution analysis for failed executions. */
381
+ getExecutionAnalysis: this.requestFunctionFactory(descriptors.cronjobGetExecutionAnalysis),
380
382
  };
381
383
  /** The customer API allows you to manage your own organizations and users. */
382
384
  customer = {
@@ -2590,3 +2590,9 @@ export const verificationVerifyCompany = {
2590
2590
  method: "POST",
2591
2591
  operationId: "verification-verify-company",
2592
2592
  };
2593
+ /** Get a CronjobExecution analysis for failed executions. */
2594
+ export const cronjobGetExecutionAnalysis = {
2595
+ path: "/v2/cronjobs/{cronjobId}/executions/{executionId}/analysis",
2596
+ method: "GET",
2597
+ operationId: "cronjob-get-execution-analysis",
2598
+ };
@@ -1 +1 @@
1
- export const MittwaldAPIClientVersion = '4.247.0';
1
+ export const MittwaldAPIClientVersion = '4.248.0';
@@ -1463,6 +1463,19 @@ declare const buildCronjobApi: (baseClient: MittwaldAPIV2Client) => {
1463
1463
  id?: string;
1464
1464
  } | undefined;
1465
1465
  }>;
1466
+ /** Get a CronjobExecution analysis for failed executions. */
1467
+ getExecutionAnalysis: (conf: {
1468
+ executionId: string;
1469
+ cronjobId: string;
1470
+ headers?: {
1471
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1472
+ "x-access-token"?: string | undefined;
1473
+ } | undefined;
1474
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1475
+ issues?: string[] | undefined;
1476
+ message: string;
1477
+ recommendation?: string | undefined;
1478
+ }>;
1466
1479
  };
1467
1480
  declare const buildCustomerApi: (baseClient: MittwaldAPIV2Client) => {
1468
1481
  /** List Invites belonging to a Customer. */
@@ -11964,6 +11964,77 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
11964
11964
  }, 412, "application/json"> | import("@mittwald/api-client-commons").Response<{
11965
11965
  [x: string]: unknown;
11966
11966
  }, 429, "application/json">>>;
11967
+ /** Get a CronjobExecution analysis for failed executions. */
11968
+ getExecutionAnalysis: (request: {
11969
+ executionId: string;
11970
+ cronjobId: string;
11971
+ headers?: {
11972
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
11973
+ "x-access-token"?: string | undefined;
11974
+ } | undefined;
11975
+ }, opts?: import("@mittwald/api-client-commons").RequestOptions<import("@mittwald/api-client-commons").OpenAPIOperation<{
11976
+ headers?: Partial<{
11977
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
11978
+ }>;
11979
+ } & {
11980
+ pathParameters: {
11981
+ executionId: string;
11982
+ cronjobId: string;
11983
+ };
11984
+ } & {
11985
+ headers: {
11986
+ "x-access-token"?: string | undefined;
11987
+ } & Partial<{
11988
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
11989
+ }>;
11990
+ }, import("@mittwald/api-client-commons").Response<{
11991
+ issues?: string[] | undefined;
11992
+ message: string;
11993
+ recommendation?: string | undefined;
11994
+ }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
11995
+ [x: string]: unknown;
11996
+ }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
11997
+ [x: string]: unknown;
11998
+ }, 403, "application/json"> | import("@mittwald/api-client-commons").Response<{
11999
+ [x: string]: unknown;
12000
+ }, 404, "application/json"> | import("@mittwald/api-client-commons").Response<{
12001
+ [x: string]: unknown;
12002
+ }, 412, "application/json"> | import("@mittwald/api-client-commons").Response<{
12003
+ [x: string]: unknown;
12004
+ }, 429, "application/json"> | import("@mittwald/api-client-commons").Response<{
12005
+ [x: string]: unknown;
12006
+ }, 500, "application/json">>> | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
12007
+ headers?: Partial<{
12008
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
12009
+ }>;
12010
+ } & {
12011
+ pathParameters: {
12012
+ executionId: string;
12013
+ cronjobId: string;
12014
+ };
12015
+ } & {
12016
+ headers: {
12017
+ "x-access-token"?: string | undefined;
12018
+ } & Partial<{
12019
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
12020
+ }>;
12021
+ }, import("@mittwald/api-client-commons").Response<{
12022
+ issues?: string[] | undefined;
12023
+ message: string;
12024
+ recommendation?: string | undefined;
12025
+ }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
12026
+ [x: string]: unknown;
12027
+ }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
12028
+ [x: string]: unknown;
12029
+ }, 403, "application/json"> | import("@mittwald/api-client-commons").Response<{
12030
+ [x: string]: unknown;
12031
+ }, 404, "application/json"> | import("@mittwald/api-client-commons").Response<{
12032
+ [x: string]: unknown;
12033
+ }, 412, "application/json"> | import("@mittwald/api-client-commons").Response<{
12034
+ [x: string]: unknown;
12035
+ }, 429, "application/json"> | import("@mittwald/api-client-commons").Response<{
12036
+ [x: string]: unknown;
12037
+ }, 500, "application/json">>>;
11967
12038
  };
11968
12039
  /** The customer API allows you to manage your own organizations and users. */
11969
12040
  readonly customer: {
@@ -867,3 +867,5 @@ export declare const verificationDetectPhishingEmail: OpenAPIOperation<RequestTy
867
867
  export declare const verificationVerifyAddress: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Responses.$500.Content.Empty>, 500, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
868
868
  /** Check if a company exists. */
869
869
  export declare const verificationVerifyCompany: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Responses.$412.Content.Empty>, 412, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Responses.$500.Content.Empty>, 500, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
870
+ /** Get a CronjobExecution analysis for failed executions. */
871
+ export declare const cronjobGetExecutionAnalysis: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2CronjobsCronjobIdExecutionsExecutionIdAnalysis.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2CronjobsCronjobIdExecutionsExecutionIdAnalysis.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2CronjobsCronjobIdExecutionsExecutionIdAnalysis.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2CronjobsCronjobIdExecutionsExecutionIdAnalysis.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CronjobsCronjobIdExecutionsExecutionIdAnalysis.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CronjobsCronjobIdExecutionsExecutionIdAnalysis.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CronjobsCronjobIdExecutionsExecutionIdAnalysis.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CronjobsCronjobIdExecutionsExecutionIdAnalysis.Get.Responses.$412.Content.ApplicationJson>, 412, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CronjobsCronjobIdExecutionsExecutionIdAnalysis.Get.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CronjobsCronjobIdExecutionsExecutionIdAnalysis.Get.Responses.$500.Content.ApplicationJson>, 500, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CronjobsCronjobIdExecutionsExecutionIdAnalysis.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
@@ -1730,6 +1730,10 @@ export declare namespace MittwaldAPIV2 {
1730
1730
  type RequestData = InferredRequestData<typeof descriptors.verificationVerifyCompany>;
1731
1731
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.verificationVerifyCompany, TStatus>;
1732
1732
  }
1733
+ namespace CronjobGetExecutionAnalysis {
1734
+ type RequestData = InferredRequestData<typeof descriptors.cronjobGetExecutionAnalysis>;
1735
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.cronjobGetExecutionAnalysis, TStatus>;
1736
+ }
1733
1737
  }
1734
1738
  namespace Components {
1735
1739
  namespace Schemas {
@@ -2245,6 +2249,9 @@ export declare namespace MittwaldAPIV2 {
2245
2249
  ports?: string[];
2246
2250
  volumes?: string[];
2247
2251
  }
2252
+ interface ContainerDeploy {
2253
+ resources?: MittwaldAPIV2.Components.Schemas.ContainerResources;
2254
+ }
2248
2255
  interface ContainerServiceRequest {
2249
2256
  /**
2250
2257
  * Defaults to image config on empty
@@ -2270,6 +2277,13 @@ export declare namespace MittwaldAPIV2 {
2270
2277
  ports?: string[];
2271
2278
  volumes?: string[];
2272
2279
  }
2280
+ interface ContainerResourceSpec {
2281
+ cpus?: string;
2282
+ memory?: string;
2283
+ }
2284
+ interface ContainerResources {
2285
+ limits?: MittwaldAPIV2.Components.Schemas.ContainerResourceSpec;
2286
+ }
2273
2287
  interface ContainerServiceResponse {
2274
2288
  deploy?: MittwaldAPIV2.Components.Schemas.ContainerDeploy;
2275
2289
  deployedState: MittwaldAPIV2.Components.Schemas.ContainerServiceState;
@@ -4235,6 +4249,9 @@ export declare namespace MittwaldAPIV2 {
4235
4249
  mailbox?: MittwaldAPIV2.Components.Schemas.MailmigrationMailbox;
4236
4250
  projectId: string;
4237
4251
  }
4252
+ interface MailmigrationCheckMigrationIsPossibleErrorActiveMailArchiveForAddress {
4253
+ address: string;
4254
+ }
4238
4255
  interface MailmigrationCheckMigrationIsPossibleErrorAlreadyExistingMailAddress {
4239
4256
  address: string;
4240
4257
  }
@@ -5418,18 +5435,10 @@ export declare namespace MittwaldAPIV2 {
5418
5435
  }
5419
5436
  type VerificationEmailOrigin = "IS_MITTWALD" | "IS_NOT_MITTWALD" | "COULD_BE_MITTWALD";
5420
5437
  type ContainerVolumeSortOrder = "nameAsc" | "nameDesc" | "storageAsc" | "storageDesc";
5421
- interface MailmigrationCheckMigrationIsPossibleErrorActiveMailArchiveForAddress {
5422
- address: string;
5423
- }
5424
- interface ContainerDeploy {
5425
- resources?: MittwaldAPIV2.Components.Schemas.ContainerResources;
5426
- }
5427
- interface ContainerResourceSpec {
5428
- cpus?: string;
5429
- memory?: string;
5430
- }
5431
- interface ContainerResources {
5432
- limits?: MittwaldAPIV2.Components.Schemas.ContainerResourceSpec;
5438
+ interface CronjobCronjobExecutionAnalysis {
5439
+ issues?: string[];
5440
+ message: string;
5441
+ recommendation?: string;
5433
5442
  }
5434
5443
  interface CommonsAddress {
5435
5444
  street: string;
@@ -27476,5 +27485,73 @@ export declare namespace MittwaldAPIV2 {
27476
27485
  }
27477
27486
  }
27478
27487
  }
27488
+ namespace V2CronjobsCronjobIdExecutionsExecutionIdAnalysis {
27489
+ namespace Get {
27490
+ namespace Parameters {
27491
+ type Path = {
27492
+ executionId: string;
27493
+ cronjobId: string;
27494
+ };
27495
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
27496
+ type Query = {};
27497
+ }
27498
+ namespace Responses {
27499
+ namespace $200 {
27500
+ namespace Content {
27501
+ type ApplicationJson = MittwaldAPIV2.Components.Schemas.CronjobCronjobExecutionAnalysis;
27502
+ }
27503
+ }
27504
+ namespace $400 {
27505
+ namespace Content {
27506
+ interface ApplicationJson {
27507
+ [k: string]: unknown;
27508
+ }
27509
+ }
27510
+ }
27511
+ namespace $403 {
27512
+ namespace Content {
27513
+ interface ApplicationJson {
27514
+ [k: string]: unknown;
27515
+ }
27516
+ }
27517
+ }
27518
+ namespace $404 {
27519
+ namespace Content {
27520
+ interface ApplicationJson {
27521
+ [k: string]: unknown;
27522
+ }
27523
+ }
27524
+ }
27525
+ namespace $412 {
27526
+ namespace Content {
27527
+ interface ApplicationJson {
27528
+ [k: string]: unknown;
27529
+ }
27530
+ }
27531
+ }
27532
+ namespace $429 {
27533
+ namespace Content {
27534
+ interface ApplicationJson {
27535
+ [k: string]: unknown;
27536
+ }
27537
+ }
27538
+ }
27539
+ namespace $500 {
27540
+ namespace Content {
27541
+ interface ApplicationJson {
27542
+ [k: string]: unknown;
27543
+ }
27544
+ }
27545
+ }
27546
+ namespace Default {
27547
+ namespace Content {
27548
+ interface ApplicationJson {
27549
+ [k: string]: unknown;
27550
+ }
27551
+ }
27552
+ }
27553
+ }
27554
+ }
27555
+ }
27479
27556
  }
27480
27557
  }
@@ -1 +1 @@
1
- export declare const MittwaldAPIClientVersion = '4.247.0';
1
+ export declare const MittwaldAPIClientVersion = '4.248.0';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mittwald/api-client",
3
- "version": "4.248.0",
3
+ "version": "4.249.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.248.0",
49
+ "@mittwald/api-client-commons": "^4.249.0",
50
50
  "browser-or-node": "^3.0.0"
51
51
  },
52
52
  "devDependencies": {
53
- "@mittwald/api-code-generator": "^4.248.0",
53
+ "@mittwald/api-code-generator": "^4.249.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": "7c40e960c450197eb655698a511a1e97e597c843"
83
+ "gitHead": "8140e9770eaca8b4bffd49020d8987388181b290"
84
84
  }