@mittwald/api-client 4.453.0 → 4.455.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.
@@ -1898,6 +1898,18 @@ export declare namespace MittwaldAPIV2 {
1898
1898
  type RequestData = InferredRequestData<typeof descriptors.aiHostingProjectGetPlans>;
1899
1899
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.aiHostingProjectGetPlans, TStatus>;
1900
1900
  }
1901
+ namespace ContainerGetServiceLogsAnalysis {
1902
+ type RequestData = InferredRequestData<typeof descriptors.containerGetServiceLogsAnalysis>;
1903
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.containerGetServiceLogsAnalysis, TStatus>;
1904
+ }
1905
+ namespace AppGetAppinstallationErrorAnalysis {
1906
+ type RequestData = InferredRequestData<typeof descriptors.appGetAppinstallationErrorAnalysis>;
1907
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.appGetAppinstallationErrorAnalysis, TStatus>;
1908
+ }
1909
+ namespace CustomerSetCustomerReferralSource {
1910
+ type RequestData = InferredRequestData<typeof descriptors.customerSetCustomerReferralSource>;
1911
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.customerSetCustomerReferralSource, TStatus>;
1912
+ }
1901
1913
  }
1902
1914
  namespace Components {
1903
1915
  namespace Schemas {
@@ -2404,7 +2416,10 @@ export declare namespace MittwaldAPIV2 {
2404
2416
  * Whether to clear the target path before restoring. If true, existing files in the target path will be deleted before the restore. If false, existing files will be kept and may be overwritten if they exist in the backup.
2405
2417
  */
2406
2418
  clearTargetPath?: boolean;
2407
- sourcePaths: string[];
2419
+ /**
2420
+ * @minItems 1
2421
+ */
2422
+ sourcePaths: [string, ...string[]];
2408
2423
  /**
2409
2424
  * Target path where the source paths should be restored to. If not set, the target path will be determined to equal the origin source. The target path should always be a folder, no files allowed here.
2410
2425
  */
@@ -2418,7 +2433,13 @@ export declare namespace MittwaldAPIV2 {
2418
2433
  }
2419
2434
  type BackupProjectBackupRestorePhase = "running" | "completed";
2420
2435
  interface BackupProjectBackupRestoreRequest {
2421
- databaseRestores?: MittwaldAPIV2.Components.Schemas.BackupProjectBackupRestoreDatabaseRequest[];
2436
+ /**
2437
+ * @minItems 1
2438
+ */
2439
+ databaseRestores?: [
2440
+ MittwaldAPIV2.Components.Schemas.BackupProjectBackupRestoreDatabaseRequest,
2441
+ ...MittwaldAPIV2.Components.Schemas.BackupProjectBackupRestoreDatabaseRequest[]
2442
+ ];
2422
2443
  pathRestore?: MittwaldAPIV2.Components.Schemas.BackupProjectBackupRestorePathRequest;
2423
2444
  }
2424
2445
  interface BackupProjectBackupRestore {
@@ -3486,8 +3507,13 @@ export declare namespace MittwaldAPIV2 {
3486
3507
  };
3487
3508
  }
3488
3509
  interface CronjobCronjobExecutionAnalysis {
3510
+ /**
3511
+ * @deprecated
3512
+ * Deprecated: contains summary and recommendation combined. Use the separate fields instead.
3513
+ */
3489
3514
  message: string;
3490
3515
  recommendation?: string;
3516
+ summary: string;
3491
3517
  }
3492
3518
  type CronjobCronjobExecutionSortOrder = "oldestFirst" | "newestFirst" | "slowestFirst" | "fastestFirst";
3493
3519
  interface CronjobAppInstallationPatchTarget {
@@ -7166,6 +7192,7 @@ export declare namespace MittwaldAPIV2 {
7166
7192
  }
7167
7193
  type VerificationEmailOrigin = "IS_MITTWALD" | "IS_NOT_MITTWALD" | "COULD_BE_MITTWALD";
7168
7194
  type ContainerVolumeSortOrder = "nameAsc" | "nameDesc" | "storageAsc" | "storageDesc";
7195
+ type AihostingCustomerPlanOptions = MittwaldAPIV2.Components.Schemas.AihostingCustomerPlan;
7169
7196
  interface AihostingCustomerPlan {
7170
7197
  customerId: string;
7171
7198
  deletedAt?: string;
@@ -7183,14 +7210,18 @@ export declare namespace MittwaldAPIV2 {
7183
7210
  tokenUsed: number;
7184
7211
  }[];
7185
7212
  }
7186
- type AihostingCustomerPlanOptions = MittwaldAPIV2.Components.Schemas.AihostingCustomerPlan;
7187
7213
  interface AihostingCustomerPlans {
7188
7214
  modelTermsApprovalRequired: boolean;
7189
7215
  plans: MittwaldAPIV2.Components.Schemas.AihostingCustomerPlan[];
7190
7216
  }
7217
+ interface AihostingProjectPlans {
7218
+ modelTermsApprovalRequired: boolean;
7219
+ plans: MittwaldAPIV2.Components.Schemas.AihostingProjectPlan[];
7220
+ }
7191
7221
  interface AihostingProfile {
7192
7222
  planIds: string[];
7193
7223
  }
7224
+ type AihostingProjectPlanOptions = MittwaldAPIV2.Components.Schemas.AihostingProjectPlans;
7194
7225
  interface AihostingProjectPlan {
7195
7226
  description?: string;
7196
7227
  keys: MittwaldAPIV2.Components.Schemas.AihostingPlanUsage;
@@ -7199,10 +7230,13 @@ export declare namespace MittwaldAPIV2 {
7199
7230
  planId: string;
7200
7231
  projectId: string;
7201
7232
  }
7202
- type AihostingProjectPlanOptions = MittwaldAPIV2.Components.Schemas.AihostingProjectPlans;
7203
- interface AihostingProjectPlans {
7204
- modelTermsApprovalRequired: boolean;
7205
- plans: MittwaldAPIV2.Components.Schemas.AihostingProjectPlan[];
7233
+ interface ContainerServiceLogsAnalysis {
7234
+ recommendation?: string;
7235
+ summary: string;
7236
+ }
7237
+ interface AppAppInstallationErrorAnalysis {
7238
+ recommendation?: string;
7239
+ summary: string;
7206
7240
  }
7207
7241
  interface CommonsAddress {
7208
7242
  street: string;
@@ -7444,6 +7478,9 @@ export declare namespace MittwaldAPIV2 {
7444
7478
  type Header = {};
7445
7479
  type Query = {
7446
7480
  planId?: string;
7481
+ limit?: number;
7482
+ skip?: number;
7483
+ page?: number;
7447
7484
  };
7448
7485
  }
7449
7486
  namespace Responses {
@@ -7866,6 +7903,9 @@ export declare namespace MittwaldAPIV2 {
7866
7903
  type Header = {};
7867
7904
  type Query = {
7868
7905
  planId?: string;
7906
+ limit?: number;
7907
+ skip?: number;
7908
+ page?: number;
7869
7909
  };
7870
7910
  }
7871
7911
  namespace Responses {
@@ -31692,6 +31732,9 @@ export declare namespace MittwaldAPIV2 {
31692
31732
  type Header = {};
31693
31733
  type Query = {
31694
31734
  topUsageCount?: number;
31735
+ limit?: number;
31736
+ skip?: number;
31737
+ page?: number;
31695
31738
  };
31696
31739
  }
31697
31740
  namespace Responses {
@@ -31850,7 +31893,11 @@ export declare namespace MittwaldAPIV2 {
31850
31893
  projectId: string;
31851
31894
  };
31852
31895
  type Header = {};
31853
- type Query = {};
31896
+ type Query = {
31897
+ limit?: number;
31898
+ skip?: number;
31899
+ page?: number;
31900
+ };
31854
31901
  }
31855
31902
  namespace Responses {
31856
31903
  namespace $200 {
@@ -31896,5 +31943,173 @@ export declare namespace MittwaldAPIV2 {
31896
31943
  }
31897
31944
  }
31898
31945
  }
31946
+ namespace V2StacksStackIdServicesServiceIdLogAnalysis {
31947
+ namespace Get {
31948
+ namespace Parameters {
31949
+ type Path = {
31950
+ stackId: string;
31951
+ serviceId: string;
31952
+ };
31953
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
31954
+ type Query = {};
31955
+ }
31956
+ namespace Responses {
31957
+ namespace $200 {
31958
+ namespace Content {
31959
+ type ApplicationJson = MittwaldAPIV2.Components.Schemas.ContainerServiceLogsAnalysis;
31960
+ }
31961
+ }
31962
+ namespace $400 {
31963
+ namespace Content {
31964
+ interface ApplicationJson {
31965
+ [k: string]: unknown;
31966
+ }
31967
+ }
31968
+ }
31969
+ namespace $403 {
31970
+ namespace Content {
31971
+ interface ApplicationJson {
31972
+ [k: string]: unknown;
31973
+ }
31974
+ }
31975
+ }
31976
+ namespace $404 {
31977
+ namespace Content {
31978
+ interface ApplicationJson {
31979
+ [k: string]: unknown;
31980
+ }
31981
+ }
31982
+ }
31983
+ namespace $429 {
31984
+ namespace Content {
31985
+ interface ApplicationJson {
31986
+ [k: string]: unknown;
31987
+ }
31988
+ }
31989
+ }
31990
+ namespace $500 {
31991
+ namespace Content {
31992
+ interface ApplicationJson {
31993
+ [k: string]: unknown;
31994
+ }
31995
+ }
31996
+ }
31997
+ namespace Default {
31998
+ namespace Content {
31999
+ interface ApplicationJson {
32000
+ [k: string]: unknown;
32001
+ }
32002
+ }
32003
+ }
32004
+ }
32005
+ }
32006
+ }
32007
+ namespace V2AppInstallationsAppInstallationIdErrorAnalysis {
32008
+ namespace Get {
32009
+ namespace Parameters {
32010
+ type Path = {
32011
+ appInstallationId: string;
32012
+ };
32013
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
32014
+ type Query = {};
32015
+ }
32016
+ namespace Responses {
32017
+ namespace $200 {
32018
+ namespace Content {
32019
+ type ApplicationJson = MittwaldAPIV2.Components.Schemas.AppAppInstallationErrorAnalysis;
32020
+ }
32021
+ }
32022
+ namespace $400 {
32023
+ namespace Content {
32024
+ interface ApplicationJson {
32025
+ [k: string]: unknown;
32026
+ }
32027
+ }
32028
+ }
32029
+ namespace $404 {
32030
+ namespace Content {
32031
+ interface ApplicationJson {
32032
+ [k: string]: unknown;
32033
+ }
32034
+ }
32035
+ }
32036
+ namespace $429 {
32037
+ namespace Content {
32038
+ interface ApplicationJson {
32039
+ [k: string]: unknown;
32040
+ }
32041
+ }
32042
+ }
32043
+ namespace Default {
32044
+ namespace Content {
32045
+ interface ApplicationJson {
32046
+ [k: string]: unknown;
32047
+ }
32048
+ }
32049
+ }
32050
+ }
32051
+ }
32052
+ }
32053
+ namespace V2CustomersCustomerIdReferralSource {
32054
+ namespace Put {
32055
+ namespace Parameters {
32056
+ type Path = {
32057
+ customerId: string;
32058
+ };
32059
+ interface RequestBody {
32060
+ /**
32061
+ * free answer on how the customer became aware of mittwald.
32062
+ */
32063
+ referralSource: string;
32064
+ }
32065
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
32066
+ type Query = {};
32067
+ }
32068
+ namespace Responses {
32069
+ namespace $200 {
32070
+ namespace Content {
32071
+ interface ApplicationJson {
32072
+ [k: string]: unknown;
32073
+ }
32074
+ }
32075
+ }
32076
+ namespace $400 {
32077
+ namespace Content {
32078
+ interface ApplicationJson {
32079
+ [k: string]: unknown;
32080
+ }
32081
+ }
32082
+ }
32083
+ namespace $403 {
32084
+ namespace Content {
32085
+ interface ApplicationJson {
32086
+ [k: string]: unknown;
32087
+ }
32088
+ }
32089
+ }
32090
+ namespace $404 {
32091
+ namespace Content {
32092
+ interface ApplicationJson {
32093
+ [k: string]: unknown;
32094
+ }
32095
+ }
32096
+ }
32097
+ namespace $429 {
32098
+ namespace Content {
32099
+ interface ApplicationJson {
32100
+ [k: string]: unknown;
32101
+ }
32102
+ }
32103
+ }
32104
+ namespace Default {
32105
+ namespace Content {
32106
+ interface ApplicationJson {
32107
+ [k: string]: unknown;
32108
+ }
32109
+ }
32110
+ }
32111
+ }
32112
+ }
32113
+ }
31899
32114
  }
31900
32115
  }
@@ -10,6 +10,9 @@ declare const buildAiHostingApi: (baseClient: MittwaldAPIV3NextClient) => {
10
10
  queryParameters?: {
11
11
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
12
12
  planId?: string | undefined;
13
+ limit?: number | undefined;
14
+ skip?: number | undefined;
15
+ page?: number | undefined;
13
16
  } | undefined;
14
17
  }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldAihostingKey[]>;
15
18
  /** Get a key of a customer. */
@@ -55,6 +58,9 @@ declare const buildAiHostingApi: (baseClient: MittwaldAPIV3NextClient) => {
55
58
  queryParameters?: {
56
59
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
57
60
  planId?: string | undefined;
61
+ limit?: number | undefined;
62
+ skip?: number | undefined;
63
+ page?: number | undefined;
58
64
  } | undefined;
59
65
  }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldAihostingKey[]>;
60
66
  /** Get a key of a project. */
@@ -122,6 +128,9 @@ declare const buildAiHostingApi: (baseClient: MittwaldAPIV3NextClient) => {
122
128
  queryParameters?: {
123
129
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
124
130
  topUsageCount?: number | undefined;
131
+ limit?: number | undefined;
132
+ skip?: number | undefined;
133
+ page?: number | undefined;
125
134
  } | undefined;
126
135
  }) => import("@mittwald/react-use-promise").AsyncResource<{
127
136
  modelTermsApprovalRequired: boolean;
@@ -148,6 +157,12 @@ declare const buildAiHostingApi: (baseClient: MittwaldAPIV3NextClient) => {
148
157
  headers?: {
149
158
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
150
159
  } | undefined;
160
+ queryParameters?: {
161
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
162
+ limit?: number | undefined;
163
+ skip?: number | undefined;
164
+ page?: number | undefined;
165
+ } | undefined;
151
166
  }) => import("@mittwald/react-use-promise").AsyncResource<{
152
167
  modelTermsApprovalRequired: boolean;
153
168
  plans: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldAihostingProjectPlan[];
@@ -403,6 +418,17 @@ declare const buildAppApi: (baseClient: MittwaldAPIV3NextClient) => {
403
418
  state: "running" | "stopped" | "exited";
404
419
  uptimeSeconds?: number | undefined;
405
420
  }>;
421
+ /** Get an analysis of the error of an AppInstallation. */
422
+ getAppinstallationErrorAnalysis: (conf: {
423
+ appInstallationId: string;
424
+ headers?: {
425
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
426
+ "x-access-token"?: string | undefined;
427
+ } | undefined;
428
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
429
+ recommendation?: string | undefined;
430
+ summary: string;
431
+ }>;
406
432
  };
407
433
  declare const buildArticleApi: (baseClient: MittwaldAPIV3NextClient) => {
408
434
  /** Get an Article. */
@@ -884,6 +910,18 @@ declare const buildContainerApi: (baseClient: MittwaldAPIV3NextClient) => {
884
910
  page?: number | undefined;
885
911
  } | undefined;
886
912
  }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldContainerVolumeResponse[]>;
913
+ /** Get an analysis of the logs belonging to a Service. */
914
+ getServiceLogsAnalysis: (conf: {
915
+ stackId: string;
916
+ serviceId: string;
917
+ headers?: {
918
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
919
+ "x-access-token"?: string | undefined;
920
+ } | undefined;
921
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
922
+ recommendation?: string | undefined;
923
+ summary: string;
924
+ }>;
887
925
  };
888
926
  declare const buildContractApi: (baseClient: MittwaldAPIV3NextClient) => {
889
927
  /** Return the BaseItem of the Contract with the given ID. */
@@ -1911,6 +1949,7 @@ declare const buildCronjobApi: (baseClient: MittwaldAPIV3NextClient) => {
1911
1949
  }) => import("@mittwald/react-use-promise").AsyncResource<{
1912
1950
  message: string;
1913
1951
  recommendation?: string | undefined;
1952
+ summary: string;
1914
1953
  }>;
1915
1954
  /** Get a CronjobExecution. */
1916
1955
  getExecution: (conf: {