@mittwald/api-client 4.386.0 → 4.388.0

package/dist/esm/version.js

@@ -1 +1 @@
-export const MittwaldAPIClientVersion = '4.385.0';
+export const MittwaldAPIClientVersion = '4.387.0';

package/dist/types/generated/v2/client-react.d.ts

@@ -1732,6 +1732,7 @@ declare const buildCronjobApi: (baseClient: MittwaldAPIV2Client) => {
         cronjobId: string;
         headers?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "Accept-Language"?: "de" | "en" | undefined;
             "x-access-token"?: string | undefined;
         } | undefined;
     }) => import("@mittwald/react-use-promise").AsyncResource<{

package/dist/types/generated/v2/client.d.ts

@@ -13808,6 +13808,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
             cronjobId: string;
             headers?: {
                 [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+                "Accept-Language"?: "de" | "en" | undefined;
                 "x-access-token"?: string | undefined;
             } | undefined;
         }, opts?: import("@mittwald/api-client-commons").RequestOptions<import("@mittwald/api-client-commons").OpenAPIOperation<{
@@ -13821,6 +13822,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
             };
         } & {
             headers: {
+                "Accept-Language"?: "de" | "en" | undefined;
                 "x-access-token"?: string | undefined;
             } & Partial<{
                 [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
@@ -13850,6 +13852,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
             };
         } & {
             headers: {
+                "Accept-Language"?: "de" | "en" | undefined;
                 "x-access-token"?: string | undefined;
             } & Partial<{
                 [TKey: string]: (string | number | boolean) | (string | number | boolean)[];

package/dist/types/generated/v2/types.d.ts

@@ -5582,19 +5582,49 @@ export declare namespace MittwaldAPIV2 {
                 machineType: string;
             }
             interface ArticleArticleAddons {
+                /**
+                 * Defines if the Addon should not be shown.
+                 */
                 hidden?: boolean;
+                /**
+                 * Unique key of the Addon.
+                 */
                 key: string;
+                /**
+                 * The type/category of the addon.
+                 */
                 type?: string;
+                /**
+                 * Value of the Addon, e.g. configuration details, status, or modifier properties.
+                 */
                 value: string;
+                /**
+                 * Used if Articles are ordered as a batch.
+                 */
                 valueMergeType?: "add" | "set";
             }
             interface ArticleArticleAttributes {
+                /**
+                 * Used if there are custom configurations needed for an Order like a Server name.
+                 */
                 customerEditable?: boolean;
                 key: string;
+                /**
+                 * Used if Articles are ordered as a batch.
+                 */
                 mergeType?: "add" | "set";
+                /**
+                 * Used if not need for an Order.
+                 */
                 readonly?: boolean;
                 required?: boolean;
+                /**
+                 * Used if Articles are ordered as a batch.
+                 */
                 unit?: string;
+                /**
+                 * Will be ignored if customerEditable is set.
+                 */
                 value?: string;
             }
             interface ArticleReadableBookableArticleOptions {
@@ -5645,14 +5675,32 @@ export declare namespace MittwaldAPIV2 {
                 addons?: MittwaldAPIV2.Components.Schemas.ArticleArticleAddons[];
                 articleId: string;
                 attributes?: MittwaldAPIV2.Components.Schemas.ArticleArticleAttributes[];
+                /**
+                 * @deprecated
+                 */
                 balanceAddonKey?: string;
                 contractDurationInMonth: number;
                 description?: string;
+                /**
+                 * If set, the Article will always be invoiced for the given months.
+                 */
                 forcedInvoicingPeriodInMonth?: number;
+                /**
+                 * Article has a contract period which is not dependent on the Contract Base Item.
+                 */
                 hasIndependentContractPeriod?: boolean;
+                /**
+                 * Free Article that is not showing on Invoices.
+                 */
                 hideOnInvoice?: boolean;
+                /**
+                 * Resources for hosting Articles.
+                 */
                 machineType?: {
                     cpu: string;
+                    /**
+                     * Memory in GiB
+                     */
                     memory: string;
                     name: string;
                 };
@@ -5663,6 +5711,9 @@ export declare namespace MittwaldAPIV2 {
                  */
                 orderable: "full" | "forbidden" | "internal" | "beta_testing" | "deprecated";
                 possibleArticleChanges?: MittwaldAPIV2.Components.Schemas.ArticleReadableChangeArticleOptions[];
+                /**
+                 * Monthly price in Eurocent
+                 */
                 price?: number;
                 tags?: MittwaldAPIV2.Components.Schemas.ArticleArticleTag[];
                 template: MittwaldAPIV2.Components.Schemas.ArticleArticleTemplate;
@@ -6286,19 +6337,9 @@ export declare namespace MittwaldAPIV2 {
             }
             type VerificationEmailOrigin = "IS_MITTWALD" | "IS_NOT_MITTWALD" | "COULD_BE_MITTWALD";
             type ContainerVolumeSortOrder = "nameAsc" | "nameDesc" | "storageAsc" | "storageDesc";
-            interface ActivitylogDatabaseMysqlNameSet {
-                changes: {
-                    after?: {
-                        name: string;
-                    };
-                    before?: {
-                        name: string | null;
-                    };
-                };
-                name: "database.mysql-name-set";
-                parameters: {
-                    name: MittwaldAPIV2.Components.Schemas.ActivitylogLinkedParameterProperty;
-                };
+            interface ActivitylogParameterProperty {
+                aggregate?: MittwaldAPIV2.Components.Schemas.ActivitylogAggregateReference;
+                name: string;
             }
             interface ActivitylogAppInstallationDesiredSystemSoftwareSet {
                 changes: {
@@ -6319,71 +6360,45 @@ export declare namespace MittwaldAPIV2 {
                     version: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
-            interface ActivitylogAppInstallationAppVersionSet {
+            interface ActivitylogAppInstallationCopyRequested {
                 changes: {
                     after?: {
                         appId: string;
-                        appVersionId: string;
+                        sourceAppInstallationId: string;
                     };
                     before?: {
                         appId?: string | null;
-                        appVersionId?: string | null;
+                        sourceAppInstallationId?: string | null;
                     };
                 };
-                name: "app.version-set";
+                name: "app.copy-requested";
             }
-            interface ActivitylogAppInstallationCopyRequested {
+            interface ActivitylogDnsCnameRecordSet {
                 changes: {
                     after?: {
-                        appId: string;
-                        sourceAppInstallationId: string;
+                        cname: string;
                     };
                     before?: {
-                        appId?: string | null;
-                        sourceAppInstallationId?: string | null;
+                        cname: string;
                     };
                 };
-                name: "app.copy-requested";
-            }
-            interface ActivitylogParameterProperty {
-                aggregate?: MittwaldAPIV2.Components.Schemas.ActivitylogAggregateReference;
-                name: string;
-            }
-            interface ActivitylogAggregateReference {
-                aggregate: string;
-                domain: string;
-                id: string;
-            }
-            interface ActivitylogLinkedParameterProperty {
-                aggregate: MittwaldAPIV2.Components.Schemas.ActivitylogAggregateReference;
-                name: string;
-            }
-            interface ActivitylogLogEntry {
-                action: MittwaldAPIV2.Components.Schemas.ActivitylogDnsZoneCreated | MittwaldAPIV2.Components.Schemas.ActivitylogDnsZoneDeleted | MittwaldAPIV2.Components.Schemas.ActivitylogDnsCnameRecordSet | MittwaldAPIV2.Components.Schemas.ActivitylogDnsSrvRecordSet | MittwaldAPIV2.Components.Schemas.ActivitylogDnsCaaRecordSet | MittwaldAPIV2.Components.Schemas.ActivitylogDnsTxtRecordSet | MittwaldAPIV2.Components.Schemas.ActivitylogDnsARecordSet | MittwaldAPIV2.Components.Schemas.ActivitylogDnsMxRecordSet | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseCreated | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseDeleted | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseDescriptionSet | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseVersionSet | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseMysqlNameSet | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseMysqlUserCreated | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseMysqlUserUpdated | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseMysqlUserDeleted | MittwaldAPIV2.Components.Schemas.ActivitylogAppInstallationCopyRequested | MittwaldAPIV2.Components.Schemas.ActivitylogAppInstallationAppVersionSet | MittwaldAPIV2.Components.Schemas.ActivitylogAppInstallationDesiredSystemSoftwareSet | MittwaldAPIV2.Components.Schemas.ActivitylogGenericAction;
-                aggregate: MittwaldAPIV2.Components.Schemas.ActivitylogAggregateReference;
-                dateTime: string;
-                /**
-                 * Null or empty object. If set, the action was executed by an mittwald employee.
-                 */
-                impersonator?: {};
-                user?: {
-                    id: string;
-                    type: "user" | "extension";
+                name: "dns.cname-record-set";
+                parameters: {
+                    domain: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
-            interface ActivitylogDnsMxRecordSet {
+            interface ActivitylogAppInstallationAppVersionSet {
                 changes: {
                     after?: {
-                        mx: {}[];
+                        appId: string;
+                        appVersionId: string;
                     };
                     before?: {
-                        mx: {}[];
+                        appId?: string | null;
+                        appVersionId?: string | null;
                     };
                 };
-                name: "dns.mx-record-set";
-                parameters: {
-                    domain: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
-                };
+                name: "app.version-set";
             }
             interface ActivitylogDnsZoneDeleted {
                 changes: {};
@@ -6392,54 +6407,38 @@ export declare namespace MittwaldAPIV2 {
                     domain: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
-            interface ActivitylogDnsTxtRecordSet {
+            interface ActivitylogDatabaseVersionSet {
                 changes: {
                     after?: {
-                        txt: string[];
+                        version: string;
                     };
                     before?: {
-                        txt: string[];
+                        version: string;
                     };
                 };
-                name: "dns.txt-record-set";
+                name: "database.mysql-version-set" | "database.redis-version-set";
                 parameters: {
-                    domain: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
+                    name: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
+                    version: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
-            interface ActivitylogDnsARecordSet {
+            interface ActivitylogDatabaseDescriptionSet {
                 changes: {
                     after?: {
-                        aRecords: string[];
-                        aaaaRecords: string[];
+                        description: string;
                     };
                     before?: {
-                        aRecords: string[];
-                        aaaaRecords: string[];
+                        description: string | null;
                     };
                 };
-                name: "dns.a-record-set";
+                name: "database.mysql-description-set" | "database.redis-description-set";
                 parameters: {
-                    domain: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
+                    name: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
-            /**
-             * Fallback when no matching action is found
-             */
-            interface ActivitylogGenericAction {
-                changes: {
-                    [k: string]: {
-                        after?: {
-                            [k: string]: unknown;
-                        };
-                        before?: {
-                            [k: string]: unknown;
-                        };
-                    };
-                };
+            interface ActivitylogLinkedParameterProperty {
+                aggregate: MittwaldAPIV2.Components.Schemas.ActivitylogAggregateReference;
                 name: string;
-                parameters: {
-                    [k: string]: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
-                };
             }
             interface ActivitylogDatabaseDeleted {
                 changes: {};
@@ -6448,101 +6447,150 @@ export declare namespace MittwaldAPIV2 {
                     name: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
-            interface ActivitylogDatabaseDescriptionSet {
+            interface ActivitylogDatabaseCreated {
                 changes: {
                     after?: {
                         description: string;
+                        name: string;
+                        version: string;
                     };
                     before?: {
-                        description: string | null;
+                        description?: string | null;
+                        name?: string | null;
+                        version?: string | null;
                     };
                 };
-                name: "database.mysql-description-set" | "database.redis-description-set";
+                name: "database.mysql-created" | "database.redis-created";
                 parameters: {
                     name: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
+                    version: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
-            interface ActivitylogDnsSrvRecordSet {
+            interface ActivitylogDatabaseMysqlUserCreated {
                 changes: {
                     after?: {
-                        srv: {}[];
+                        description: string;
+                        externalAccess: boolean;
+                        name: string;
+                        permissions: {};
                     };
                     before?: {
-                        srv: {}[];
+                        description?: string | null;
+                        externalAccess?: boolean | null;
+                        name?: string | null;
+                        permissions?: {} | null;
                     };
                 };
-                name: "dns.srv-record-set";
+                name: "database.mysql-user-created";
+                parameters: {
+                    databaseName: MittwaldAPIV2.Components.Schemas.ActivitylogLinkedParameterProperty;
+                    name: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
+                };
+            }
+            interface ActivitylogAggregateReference {
+                aggregate: string;
+                domain: string;
+                id: string;
+            }
+            interface ActivitylogDnsTxtRecordSet {
+                changes: {
+                    after?: {
+                        txt: string[];
+                    };
+                    before?: {
+                        txt: string[];
+                    };
+                };
+                name: "dns.txt-record-set";
                 parameters: {
                     domain: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
-            interface ActivitylogDatabaseMysqlUserUpdated {
+            interface ActivitylogDnsZoneCreated {
                 changes: {
                     after?: {
-                        description: string;
-                        externalAccess: boolean;
-                        permissions: {};
+                        domain: string;
                     };
                     before?: {
-                        description: string | null;
-                        externalAccess: boolean | null;
-                        permissions: {};
+                        domain: string | null;
                     };
                 };
-                name: "database.mysql-user-updated";
+                name: "dns.zone-created";
                 parameters: {
-                    databaseName: MittwaldAPIV2.Components.Schemas.ActivitylogLinkedParameterProperty;
-                    name: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
+                    domain: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
-            interface ActivitylogDatabaseVersionSet {
+            interface ActivitylogDnsMxRecordSet {
                 changes: {
                     after?: {
-                        version: string;
+                        mx: {}[];
                     };
                     before?: {
-                        version: string;
+                        mx: {}[];
                     };
                 };
-                name: "database.mysql-version-set" | "database.redis-version-set";
+                name: "dns.mx-record-set";
                 parameters: {
-                    name: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
-                    version: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
+                    domain: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
-            interface ActivitylogDatabaseCreated {
+            interface ActivitylogDnsARecordSet {
+                changes: {
+                    after?: {
+                        aRecords: string[];
+                        aaaaRecords: string[];
+                    };
+                    before?: {
+                        aRecords: string[];
+                        aaaaRecords: string[];
+                    };
+                };
+                name: "dns.a-record-set";
+                parameters: {
+                    domain: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
+                };
+            }
+            interface ActivitylogDatabaseMysqlNameSet {
                 changes: {
                     after?: {
-                        description: string;
                         name: string;
-                        version: string;
                     };
                     before?: {
-                        description?: string | null;
-                        name?: string | null;
-                        version?: string | null;
+                        name: string | null;
                     };
                 };
-                name: "database.mysql-created" | "database.redis-created";
+                name: "database.mysql-name-set";
                 parameters: {
-                    name: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
-                    version: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
+                    name: MittwaldAPIV2.Components.Schemas.ActivitylogLinkedParameterProperty;
                 };
             }
-            interface ActivitylogDnsCnameRecordSet {
+            interface ActivitylogDnsSrvRecordSet {
                 changes: {
                     after?: {
-                        cname: string;
+                        srv: {}[];
                     };
                     before?: {
-                        cname: string;
+                        srv: {}[];
                     };
                 };
-                name: "dns.cname-record-set";
+                name: "dns.srv-record-set";
                 parameters: {
                     domain: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
+            interface ActivitylogLogEntry {
+                action: MittwaldAPIV2.Components.Schemas.ActivitylogDnsZoneCreated | MittwaldAPIV2.Components.Schemas.ActivitylogDnsZoneDeleted | MittwaldAPIV2.Components.Schemas.ActivitylogDnsCnameRecordSet | MittwaldAPIV2.Components.Schemas.ActivitylogDnsSrvRecordSet | MittwaldAPIV2.Components.Schemas.ActivitylogDnsCaaRecordSet | MittwaldAPIV2.Components.Schemas.ActivitylogDnsTxtRecordSet | MittwaldAPIV2.Components.Schemas.ActivitylogDnsARecordSet | MittwaldAPIV2.Components.Schemas.ActivitylogDnsMxRecordSet | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseCreated | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseDeleted | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseDescriptionSet | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseVersionSet | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseMysqlNameSet | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseMysqlUserCreated | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseMysqlUserUpdated | MittwaldAPIV2.Components.Schemas.ActivitylogDatabaseMysqlUserDeleted | MittwaldAPIV2.Components.Schemas.ActivitylogAppInstallationCopyRequested | MittwaldAPIV2.Components.Schemas.ActivitylogAppInstallationAppVersionSet | MittwaldAPIV2.Components.Schemas.ActivitylogAppInstallationDesiredSystemSoftwareSet | MittwaldAPIV2.Components.Schemas.ActivitylogGenericAction;
+                aggregate: MittwaldAPIV2.Components.Schemas.ActivitylogAggregateReference;
+                dateTime: string;
+                /**
+                 * Null or empty object. If set, the action was executed by an mittwald employee.
+                 */
+                impersonator?: {};
+                user?: {
+                    id: string;
+                    type: "user" | "extension";
+                };
+            }
             interface ActivitylogDatabaseMysqlUserDeleted {
                 changes: {};
                 name: "database.mysql-user-deleted";
@@ -6551,53 +6599,56 @@ export declare namespace MittwaldAPIV2 {
                     name: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
-            interface ActivitylogDnsZoneCreated {
+            interface ActivitylogDnsCaaRecordSet {
                 changes: {
                     after?: {
-                        domain: string;
+                        caa: {}[];
                     };
                     before?: {
-                        domain: string | null;
+                        caa: {}[];
                     };
                 };
-                name: "dns.zone-created";
+                name: "dns.caa-record-set";
                 parameters: {
                     domain: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
-            interface ActivitylogDatabaseMysqlUserCreated {
+            /**
+             * Fallback when no matching action is found
+             */
+            interface ActivitylogGenericAction {
                 changes: {
-                    after?: {
-                        description: string;
-                        externalAccess: boolean;
-                        name: string;
-                        permissions: {};
-                    };
-                    before?: {
-                        description?: string | null;
-                        externalAccess?: boolean | null;
-                        name?: string | null;
-                        permissions?: {} | null;
+                    [k: string]: {
+                        after?: {
+                            [k: string]: unknown;
+                        };
+                        before?: {
+                            [k: string]: unknown;
+                        };
                     };
                 };
-                name: "database.mysql-user-created";
+                name: string;
                 parameters: {
-                    databaseName: MittwaldAPIV2.Components.Schemas.ActivitylogLinkedParameterProperty;
-                    name: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
+                    [k: string]: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
-            interface ActivitylogDnsCaaRecordSet {
+            interface ActivitylogDatabaseMysqlUserUpdated {
                 changes: {
                     after?: {
-                        caa: {}[];
+                        description: string;
+                        externalAccess: boolean;
+                        permissions: {};
                     };
                     before?: {
-                        caa: {}[];
+                        description: string | null;
+                        externalAccess: boolean | null;
+                        permissions: {};
                     };
                 };
-                name: "dns.caa-record-set";
+                name: "database.mysql-user-updated";
                 parameters: {
-                    domain: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
+                    databaseName: MittwaldAPIV2.Components.Schemas.ActivitylogLinkedParameterProperty;
+                    name: MittwaldAPIV2.Components.Schemas.ActivitylogParameterProperty;
                 };
             }
             interface CommonsAddress {
@@ -14111,7 +14162,9 @@ export declare namespace MittwaldAPIV2 {
                         executionId: string;
                         cronjobId: string;
                     };
-                    type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
+                    type Header = {
+                        "Accept-Language"?: "de" | "en";
+                    } & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
                     type Query = {};
                 }
                 namespace Responses {

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const MittwaldAPIClientVersion = '4.385.0';
+export declare const MittwaldAPIClientVersion = '4.387.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-client",
-  "version": "4.386.0",
+  "version": "4.388.0",
   "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
   "type": "module",
   "description": "Auto-generated client for the mittwald API",
@@ -46,11 +46,11 @@
     "test:compile": "run tsc --noEmit"
   },
   "dependencies": {
-    "@mittwald/api-client-commons": "^4.386.0",
+    "@mittwald/api-client-commons": "^4.388.0",
     "browser-or-node": "^3.0.0"
   },
   "devDependencies": {
-    "@mittwald/api-code-generator": "^4.386.0",
+    "@mittwald/api-code-generator": "^4.388.0",
     "@mittwald/react-use-promise": "^2.6.2",
     "@types/node": "^22.18.11",
     "@types/react": "^18.3.26",
@@ -80,5 +80,5 @@
       "optional": true
     }
   },
-  "gitHead": "6b8cfefd8f401066c050ad601aca8fd6f99514ca"
+  "gitHead": "9f64296c495062fd1440d499b7cbde2e7972d721"
 }