@mittwald/api-client 4.459.0 → 4.461.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.
@@ -50,6 +50,14 @@ export declare namespace MittwaldAPIV2 {
50
50
  type RequestData = InferredRequestData<typeof descriptors.aiHostingGetModels>;
51
51
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.aiHostingGetModels, TStatus>;
52
52
  }
53
+ namespace AiHostingPlanGetBillingPeriods {
54
+ type RequestData = InferredRequestData<typeof descriptors.aiHostingPlanGetBillingPeriods>;
55
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.aiHostingPlanGetBillingPeriods, TStatus>;
56
+ }
57
+ namespace AiHostingPlanGetUsageStats {
58
+ type RequestData = InferredRequestData<typeof descriptors.aiHostingPlanGetUsageStats>;
59
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.aiHostingPlanGetUsageStats, TStatus>;
60
+ }
53
61
  namespace AiHostingProjectGetKeys {
54
62
  type RequestData = InferredRequestData<typeof descriptors.aiHostingProjectGetKeys>;
55
63
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.aiHostingProjectGetKeys, TStatus>;
@@ -1910,14 +1918,6 @@ export declare namespace MittwaldAPIV2 {
1910
1918
  type RequestData = InferredRequestData<typeof descriptors.verificationVerifyCompany>;
1911
1919
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.verificationVerifyCompany, TStatus>;
1912
1920
  }
1913
- namespace AiHostingPlanGetBillingPeriods {
1914
- type RequestData = InferredRequestData<typeof descriptors.aiHostingPlanGetBillingPeriods>;
1915
- type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.aiHostingPlanGetBillingPeriods, TStatus>;
1916
- }
1917
- namespace AiHostingPlanGetUsageStats {
1918
- type RequestData = InferredRequestData<typeof descriptors.aiHostingPlanGetUsageStats>;
1919
- type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.aiHostingPlanGetUsageStats, TStatus>;
1920
- }
1921
1921
  }
1922
1922
  namespace Components {
1923
1923
  namespace Schemas {
@@ -2014,6 +2014,30 @@ export declare namespace MittwaldAPIV2 {
2014
2014
  termsOfServiceLink: string;
2015
2015
  tokenFactor: number;
2016
2016
  }
2017
+ interface AihostingPlanBillingPeriods {
2018
+ customerId: string;
2019
+ /**
2020
+ * End of the current period, i.e. when the token counter next resets.
2021
+ */
2022
+ nextTokenReset?: string;
2023
+ /**
2024
+ * Every contract month of the plan from its start up to the current one, anchored on the plan start date rather than the calendar.
2025
+ */
2026
+ periods: {
2027
+ end: string;
2028
+ isCurrent: boolean;
2029
+ /**
2030
+ * True when an upgrade cut this period short: the token counter is reset immediately on an upgrade, so the period ends there instead of on the regular grid. A downgrade does not do this - it takes effect at the next regular boundary.
2031
+ */
2032
+ shortenedByUpgrade: boolean;
2033
+ start: string;
2034
+ /**
2035
+ * The limit that applied during this period, which after a tariff change differs from the plan's current limit.
2036
+ */
2037
+ tokenLimit: number;
2038
+ }[];
2039
+ planId: string;
2040
+ }
2017
2041
  type AihostingPlanOptions = MittwaldAPIV2.Components.Schemas.AihostingCustomerPlan;
2018
2042
  interface AihostingPlanUsageBig {
2019
2043
  available: number;
@@ -2025,6 +2049,33 @@ export declare namespace MittwaldAPIV2 {
2025
2049
  planLimit: number;
2026
2050
  used: number;
2027
2051
  }
2052
+ interface AihostingPlanUsageStats {
2053
+ customerId: string;
2054
+ daily: {
2055
+ byKey: {
2056
+ [k: string]: number;
2057
+ };
2058
+ date: string;
2059
+ totalTokens: number;
2060
+ }[];
2061
+ /**
2062
+ * Every licence of the plan, most used in the timeframe first. Includes licences deleted inside the timeframe, which still carry usage but are no longer returned by the keys endpoint. Ordered, so callers can key chart colours off the position.
2063
+ */
2064
+ keys: {
2065
+ id: string;
2066
+ name: string;
2067
+ }[];
2068
+ modelShare: {
2069
+ model: string;
2070
+ tokens: number;
2071
+ }[];
2072
+ planId: string;
2073
+ timeframe: {
2074
+ end: string;
2075
+ start: string;
2076
+ };
2077
+ totalTokens: number;
2078
+ }
2028
2079
  interface AihostingProfile {
2029
2080
  planIds: string[];
2030
2081
  }
@@ -3695,7 +3746,7 @@ export declare namespace MittwaldAPIV2 {
3695
3746
  }
3696
3747
  interface DatabaseCreateMySqlUser {
3697
3748
  /**
3698
- * An IP range (in CIDR notation) for which access should be allowed.
3749
+ * An IP range (in CIDR notation) for which access should be allowed. This field currently has no effect.
3699
3750
  */
3700
3751
  accessIpMask?: string;
3701
3752
  /**
@@ -3716,6 +3767,9 @@ export declare namespace MittwaldAPIV2 {
3716
3767
  password: string;
3717
3768
  }
3718
3769
  interface DatabaseCreateMySqlUserWithDatabase {
3770
+ /**
3771
+ * This field currently has no effect.
3772
+ */
3719
3773
  accessIpMask?: string;
3720
3774
  /**
3721
3775
  * The access level that this MySQLUser should have for the database. The `full` access level grants the user read/write privileges on the database.
@@ -3800,7 +3854,7 @@ export declare namespace MittwaldAPIV2 {
3800
3854
  }
3801
3855
  interface DatabaseMySqlUser {
3802
3856
  /**
3803
- * An IP range (in CIDR notation) for which access should be allowed.
3857
+ * An IP range (in CIDR notation) for which access should be allowed. This field currently has no effect.
3804
3858
  */
3805
3859
  accessIpMask?: string;
3806
3860
  /**
@@ -7246,57 +7300,6 @@ export declare namespace MittwaldAPIV2 {
7246
7300
  }
7247
7301
  type VerificationEmailOrigin = "IS_MITTWALD" | "IS_NOT_MITTWALD" | "COULD_BE_MITTWALD";
7248
7302
  type ContainerVolumeSortOrder = "nameAsc" | "nameDesc" | "storageAsc" | "storageDesc";
7249
- interface AihostingPlanBillingPeriods {
7250
- customerId: string;
7251
- /**
7252
- * End of the current period, i.e. when the token counter next resets.
7253
- */
7254
- nextTokenReset?: string;
7255
- /**
7256
- * Every contract month of the plan from its start up to the current one, anchored on the plan start date rather than the calendar.
7257
- */
7258
- periods: {
7259
- end: string;
7260
- isCurrent: boolean;
7261
- /**
7262
- * True when an upgrade cut this period short: the token counter is reset immediately on an upgrade, so the period ends there instead of on the regular grid. A downgrade does not do this - it takes effect at the next regular boundary.
7263
- */
7264
- shortenedByUpgrade: boolean;
7265
- start: string;
7266
- /**
7267
- * The limit that applied during this period, which after a tariff change differs from the plan's current limit.
7268
- */
7269
- tokenLimit: number;
7270
- }[];
7271
- planId: string;
7272
- }
7273
- interface AihostingPlanUsageStats {
7274
- customerId: string;
7275
- daily: {
7276
- byKey: {
7277
- [k: string]: number;
7278
- };
7279
- date: string;
7280
- totalTokens: number;
7281
- }[];
7282
- /**
7283
- * Every licence of the plan, most used in the timeframe first. Includes licences deleted inside the timeframe, which still carry usage but are no longer returned by the keys endpoint. Ordered, so callers can key chart colours off the position.
7284
- */
7285
- keys: {
7286
- id: string;
7287
- name: string;
7288
- }[];
7289
- modelShare: {
7290
- model: string;
7291
- tokens: number;
7292
- }[];
7293
- planId: string;
7294
- timeframe: {
7295
- end: string;
7296
- start: string;
7297
- };
7298
- totalTokens: number;
7299
- }
7300
7303
  interface CommonsAddress {
7301
7304
  street: string;
7302
7305
  houseNumber: string;
@@ -8173,6 +8176,118 @@ export declare namespace MittwaldAPIV2 {
8173
8176
  }
8174
8177
  }
8175
8178
  }
8179
+ namespace V2CustomersCustomerIdAiHostingsPlanIdBillingPeriods {
8180
+ namespace Get {
8181
+ namespace Parameters {
8182
+ type Path = {
8183
+ customerId: string;
8184
+ planId: string;
8185
+ };
8186
+ type Header = {};
8187
+ type Query = {};
8188
+ }
8189
+ namespace Responses {
8190
+ namespace $200 {
8191
+ namespace Content {
8192
+ type ApplicationJson = MittwaldAPIV2.Components.Schemas.AihostingPlanBillingPeriods;
8193
+ }
8194
+ }
8195
+ namespace $400 {
8196
+ namespace Content {
8197
+ interface ApplicationJson {
8198
+ [k: string]: unknown;
8199
+ }
8200
+ }
8201
+ }
8202
+ namespace $403 {
8203
+ namespace Content {
8204
+ interface ApplicationJson {
8205
+ [k: string]: unknown;
8206
+ }
8207
+ }
8208
+ }
8209
+ namespace $404 {
8210
+ namespace Content {
8211
+ interface ApplicationJson {
8212
+ [k: string]: unknown;
8213
+ }
8214
+ }
8215
+ }
8216
+ namespace $429 {
8217
+ namespace Content {
8218
+ interface ApplicationJson {
8219
+ [k: string]: unknown;
8220
+ }
8221
+ }
8222
+ }
8223
+ namespace Default {
8224
+ namespace Content {
8225
+ interface ApplicationJson {
8226
+ [k: string]: unknown;
8227
+ }
8228
+ }
8229
+ }
8230
+ }
8231
+ }
8232
+ }
8233
+ namespace V2CustomersCustomerIdAiHostingsPlanIdUsage {
8234
+ namespace Get {
8235
+ namespace Parameters {
8236
+ type Path = {
8237
+ customerId: string;
8238
+ planId: string;
8239
+ };
8240
+ type Header = {};
8241
+ type Query = {
8242
+ startDate: string;
8243
+ endDate: string;
8244
+ keyId?: string;
8245
+ };
8246
+ }
8247
+ namespace Responses {
8248
+ namespace $200 {
8249
+ namespace Content {
8250
+ type ApplicationJson = MittwaldAPIV2.Components.Schemas.AihostingPlanUsageStats;
8251
+ }
8252
+ }
8253
+ namespace $400 {
8254
+ namespace Content {
8255
+ interface ApplicationJson {
8256
+ [k: string]: unknown;
8257
+ }
8258
+ }
8259
+ }
8260
+ namespace $403 {
8261
+ namespace Content {
8262
+ interface ApplicationJson {
8263
+ [k: string]: unknown;
8264
+ }
8265
+ }
8266
+ }
8267
+ namespace $404 {
8268
+ namespace Content {
8269
+ interface ApplicationJson {
8270
+ [k: string]: unknown;
8271
+ }
8272
+ }
8273
+ }
8274
+ namespace $429 {
8275
+ namespace Content {
8276
+ interface ApplicationJson {
8277
+ [k: string]: unknown;
8278
+ }
8279
+ }
8280
+ }
8281
+ namespace Default {
8282
+ namespace Content {
8283
+ interface ApplicationJson {
8284
+ [k: string]: unknown;
8285
+ }
8286
+ }
8287
+ }
8288
+ }
8289
+ }
8290
+ }
8176
8291
  namespace V2ProjectsProjectIdAiHostingKeys {
8177
8292
  namespace Get {
8178
8293
  namespace Parameters {
@@ -17449,6 +17564,9 @@ export declare namespace MittwaldAPIV2 {
17449
17564
  mysqlUserId: string;
17450
17565
  };
17451
17566
  interface RequestBody {
17567
+ /**
17568
+ * This field currently has no effect.
17569
+ */
17452
17570
  accessIpMask?: string;
17453
17571
  accessLevel?: "full" | "readonly";
17454
17572
  description?: string;
@@ -29740,7 +29858,7 @@ export declare namespace MittwaldAPIV2 {
29740
29858
  }
29741
29859
  namespace $400 {
29742
29860
  namespace Content {
29743
- type ApplicationJson = MittwaldAPIV2.Components.Schemas.CommonsValidationErrors;
29861
+ type ApplicationJson = MittwaldAPIV2.Components.Schemas.CommonsValidationErrors | MittwaldAPIV2.Components.Schemas.CommonsError;
29744
29862
  }
29745
29863
  }
29746
29864
  namespace $408 {
@@ -32170,117 +32288,5 @@ export declare namespace MittwaldAPIV2 {
32170
32288
  }
32171
32289
  }
32172
32290
  }
32173
- namespace V2CustomersCustomerIdAiHostingsPlanIdBillingPeriods {
32174
- namespace Get {
32175
- namespace Parameters {
32176
- type Path = {
32177
- customerId: string;
32178
- planId: string;
32179
- };
32180
- type Header = {};
32181
- type Query = {};
32182
- }
32183
- namespace Responses {
32184
- namespace $200 {
32185
- namespace Content {
32186
- type ApplicationJson = MittwaldAPIV2.Components.Schemas.AihostingPlanBillingPeriods;
32187
- }
32188
- }
32189
- namespace $400 {
32190
- namespace Content {
32191
- interface ApplicationJson {
32192
- [k: string]: unknown;
32193
- }
32194
- }
32195
- }
32196
- namespace $403 {
32197
- namespace Content {
32198
- interface ApplicationJson {
32199
- [k: string]: unknown;
32200
- }
32201
- }
32202
- }
32203
- namespace $404 {
32204
- namespace Content {
32205
- interface ApplicationJson {
32206
- [k: string]: unknown;
32207
- }
32208
- }
32209
- }
32210
- namespace $429 {
32211
- namespace Content {
32212
- interface ApplicationJson {
32213
- [k: string]: unknown;
32214
- }
32215
- }
32216
- }
32217
- namespace Default {
32218
- namespace Content {
32219
- interface ApplicationJson {
32220
- [k: string]: unknown;
32221
- }
32222
- }
32223
- }
32224
- }
32225
- }
32226
- }
32227
- namespace V2CustomersCustomerIdAiHostingsPlanIdUsage {
32228
- namespace Get {
32229
- namespace Parameters {
32230
- type Path = {
32231
- customerId: string;
32232
- planId: string;
32233
- };
32234
- type Header = {};
32235
- type Query = {
32236
- startDate: string;
32237
- endDate: string;
32238
- keyId?: string;
32239
- };
32240
- }
32241
- namespace Responses {
32242
- namespace $200 {
32243
- namespace Content {
32244
- type ApplicationJson = MittwaldAPIV2.Components.Schemas.AihostingPlanUsageStats;
32245
- }
32246
- }
32247
- namespace $400 {
32248
- namespace Content {
32249
- interface ApplicationJson {
32250
- [k: string]: unknown;
32251
- }
32252
- }
32253
- }
32254
- namespace $403 {
32255
- namespace Content {
32256
- interface ApplicationJson {
32257
- [k: string]: unknown;
32258
- }
32259
- }
32260
- }
32261
- namespace $404 {
32262
- namespace Content {
32263
- interface ApplicationJson {
32264
- [k: string]: unknown;
32265
- }
32266
- }
32267
- }
32268
- namespace $429 {
32269
- namespace Content {
32270
- interface ApplicationJson {
32271
- [k: string]: unknown;
32272
- }
32273
- }
32274
- }
32275
- namespace Default {
32276
- namespace Content {
32277
- interface ApplicationJson {
32278
- [k: string]: unknown;
32279
- }
32280
- }
32281
- }
32282
- }
32283
- }
32284
- }
32285
32291
  }
32286
32292
  }
@@ -94,6 +94,62 @@ declare const buildAiHostingApi: (baseClient: MittwaldAPIV3NextClient) => {
94
94
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
95
95
  } | undefined;
96
96
  } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldAihostingModel[]>;
97
+ /** List the contract months of an ai hosting plan. */
98
+ planGetBillingPeriods: (conf: {
99
+ customerId: string;
100
+ planId: string;
101
+ headers?: {
102
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
103
+ } | undefined;
104
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
105
+ customerId: string;
106
+ nextTokenReset?: string | undefined;
107
+ periods: {
108
+ end: string;
109
+ isCurrent: boolean;
110
+ shortenedByUpgrade: boolean;
111
+ start: string;
112
+ tokenLimit: number;
113
+ }[];
114
+ planId: string;
115
+ }>;
116
+ /** Get aggregated token usage statistics for an ai hosting plan of a customer. */
117
+ planGetUsageStats: (conf: {
118
+ queryParameters: {
119
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
120
+ startDate: string;
121
+ endDate: string;
122
+ keyId?: string | undefined;
123
+ };
124
+ customerId: string;
125
+ planId: string;
126
+ headers?: {
127
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
128
+ } | undefined;
129
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
130
+ customerId: string;
131
+ daily: {
132
+ byKey: {
133
+ [k: string]: number;
134
+ };
135
+ date: string;
136
+ totalTokens: number;
137
+ }[];
138
+ keys: {
139
+ id: string;
140
+ name: string;
141
+ }[];
142
+ modelShare: {
143
+ model: string;
144
+ tokens: number;
145
+ }[];
146
+ planId: string;
147
+ timeframe: {
148
+ end: string;
149
+ start: string;
150
+ };
151
+ totalTokens: number;
152
+ }>;
97
153
  /** Get a list of keys of a project. */
98
154
  projectGetKeys: (conf: {
99
155
  projectId: string;
@@ -167,62 +223,6 @@ declare const buildAiHostingApi: (baseClient: MittwaldAPIV3NextClient) => {
167
223
  modelTermsApprovalRequired: boolean;
168
224
  plans: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldAihostingProjectPlan[];
169
225
  }>;
170
- /** List the contract months of an ai hosting plan. */
171
- planGetBillingPeriods: (conf: {
172
- customerId: string;
173
- planId: string;
174
- headers?: {
175
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
176
- } | undefined;
177
- }) => import("@mittwald/react-use-promise").AsyncResource<{
178
- customerId: string;
179
- nextTokenReset?: string | undefined;
180
- periods: {
181
- end: string;
182
- isCurrent: boolean;
183
- shortenedByUpgrade: boolean;
184
- start: string;
185
- tokenLimit: number;
186
- }[];
187
- planId: string;
188
- }>;
189
- /** Get aggregated token usage statistics for an ai hosting plan of a customer. */
190
- planGetUsageStats: (conf: {
191
- queryParameters: {
192
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
193
- startDate: string;
194
- endDate: string;
195
- keyId?: string | undefined;
196
- };
197
- customerId: string;
198
- planId: string;
199
- headers?: {
200
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
201
- } | undefined;
202
- }) => import("@mittwald/react-use-promise").AsyncResource<{
203
- customerId: string;
204
- daily: {
205
- byKey: {
206
- [k: string]: number;
207
- };
208
- date: string;
209
- totalTokens: number;
210
- }[];
211
- keys: {
212
- id: string;
213
- name: string;
214
- }[];
215
- modelShare: {
216
- model: string;
217
- tokens: number;
218
- }[];
219
- planId: string;
220
- timeframe: {
221
- end: string;
222
- start: string;
223
- };
224
- totalTokens: number;
225
- }>;
226
226
  };
227
227
  declare const buildAppApi: (baseClient: MittwaldAPIV3NextClient) => {
228
228
  /** Get the installed `SystemSoftware' for a specific `AppInstallation`. */