@mittwald/api-client 4.237.0 → 4.239.0

package/dist/esm/version.js

@@ -1 +1 @@
-export const MittwaldAPIClientVersion = '4.236.0';
+export const MittwaldAPIClientVersion = '4.238.0';

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

@@ -1111,6 +1111,9 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
         interactionRequired: boolean;
         status: "notStarted" | "pending" | "active" | "terminationPending";
         terminationTargetDate?: string | undefined;
+        variantDescription?: string | undefined;
+        variantKey?: string | undefined;
+        variantName?: string | undefined;
     }>;
     /** Get the ExtensionInstance of a specific customer and extension, if existing. */
     extensionGetExtensionInstanceForCustomer: (conf: {

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

@@ -4234,6 +4234,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
         }, import("@mittwald/api-client-commons").Response<{
             contractId?: string | undefined;
             contractItemId?: string | undefined;
+            explanation?: string | undefined;
             reason?: string | undefined;
             terminationTargetDate?: string | undefined;
         }, 201, "application/json"> | import("@mittwald/api-client-commons").Response<{
@@ -4265,6 +4266,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
         }, import("@mittwald/api-client-commons").Response<{
             contractId?: string | undefined;
             contractItemId?: string | undefined;
+            explanation?: string | undefined;
             reason?: string | undefined;
             terminationTargetDate?: string | undefined;
         }, 201, "application/json"> | import("@mittwald/api-client-commons").Response<{
@@ -4396,6 +4398,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
         terminateContract: (request: {
             contractId: string;
             data?: {
+                explanation?: string | undefined;
                 reason?: string | undefined;
                 terminationTargetDate?: string | undefined;
             } | undefined;
@@ -4405,6 +4408,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
             } | undefined;
         }, opts?: import("@mittwald/api-client-commons").RequestOptions<import("@mittwald/api-client-commons").OpenAPIOperation<{
             data: {
+                explanation?: string | undefined;
                 reason?: string | undefined;
                 terminationTargetDate?: string | undefined;
             };
@@ -4424,6 +4428,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
             }>;
         }, import("@mittwald/api-client-commons").Response<{
             contractId?: string | undefined;
+            explanation?: string | undefined;
             itemsScheduledForTermination?: string[] | undefined;
             reason?: string | undefined;
             terminationTargetDate?: string | undefined;
@@ -4435,6 +4440,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
             [x: string]: unknown;
         }, 429, "application/json">>> | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
             data: {
+                explanation?: string | undefined;
                 reason?: string | undefined;
                 terminationTargetDate?: string | undefined;
             };
@@ -4454,6 +4460,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
             }>;
         }, import("@mittwald/api-client-commons").Response<{
             contractId?: string | undefined;
+            explanation?: string | undefined;
             itemsScheduledForTermination?: string[] | undefined;
             reason?: string | undefined;
             terminationTargetDate?: string | undefined;
@@ -8919,6 +8926,9 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
             interactionRequired: boolean;
             status: "notStarted" | "pending" | "active" | "terminationPending";
             terminationTargetDate?: string | undefined;
+            variantDescription?: string | undefined;
+            variantKey?: string | undefined;
+            variantName?: string | undefined;
         }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
             [x: string]: unknown;
         }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
@@ -8945,6 +8955,9 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
             interactionRequired: boolean;
             status: "notStarted" | "pending" | "active" | "terminationPending";
             terminationTargetDate?: string | undefined;
+            variantDescription?: string | undefined;
+            variantKey?: string | undefined;
+            variantName?: string | undefined;
         }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
             [x: string]: unknown;
         }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
@@ -8955,18 +8968,25 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
         /** Update or Create Contract for existing Extension Instances. */
         extensionUpdateExtensionInstanceContract: (request: {
             extensionInstanceId: string;
+            data?: {
+                variantKey?: string | undefined;
+            } | undefined;
             headers?: {
                 [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
                 "x-access-token"?: string | undefined;
             } | undefined;
         }, opts?: import("@mittwald/api-client-commons").RequestOptions<import("@mittwald/api-client-commons").OpenAPIOperation<{
-            headers?: Partial<{
-                [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
-            }>;
+            data: {
+                variantKey?: string | undefined;
+            };
         } & {
             pathParameters: {
                 extensionInstanceId: string;
             };
+        } & {
+            headers?: Partial<{
+                [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
+            }>;
         } & {
             headers: {
                 "x-access-token"?: string | undefined;
@@ -8980,13 +9000,17 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
         }, 404, "application/json"> | import("@mittwald/api-client-commons").Response<{
             [x: string]: unknown;
         }, 429, "application/json">>> | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
-            headers?: Partial<{
-                [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
-            }>;
+            data: {
+                variantKey?: string | undefined;
+            };
         } & {
             pathParameters: {
                 extensionInstanceId: string;
             };
+        } & {
+            headers?: Partial<{
+                [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
+            }>;
         } & {
             headers: {
                 "x-access-token"?: string | undefined;
@@ -10227,27 +10251,45 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
         }, 429, "application/json">>>;
         /** Creates or Updates Pricing for an Extension. */
         extensionUpdateExtensionPricing: (request: {
+            data: {
+                priceInCents: number;
+                dryRun?: boolean | undefined;
+            };
             extensionId: string;
             contributorId: string;
-            data?: {
-                dryRun?: boolean | undefined;
-                priceInCents?: number | undefined;
+            headers?: {
+                [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+                "x-access-token"?: string | undefined;
             } | undefined;
+        } | {
+            data: {
+                pricePlan: {
+                    variants: import("./types.js").MittwaldAPIV2.Components.Schemas.ExtensionVariant[];
+                };
+                dryRun?: boolean | undefined;
+            };
+            extensionId: string;
+            contributorId: string;
             headers?: {
                 [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
                 "x-access-token"?: string | undefined;
             } | undefined;
-        }, opts?: import("@mittwald/api-client-commons").RequestOptions<import("@mittwald/api-client-commons").OpenAPIOperation<{
+        }, opts?: import("@mittwald/api-client-commons").RequestOptions<import("@mittwald/api-client-commons").OpenAPIOperation<(({
             data: {
                 dryRun?: boolean | undefined;
-                priceInCents?: number | undefined;
+                priceInCents: number;
             };
-        } & {
+        } | {
+            data: {
+                dryRun?: boolean | undefined;
+                pricePlan: import("./types.js").MittwaldAPIV2.Components.Schemas.ExtensionPricePlan;
+            };
+        }) & {
             pathParameters: {
                 extensionId: string;
                 contributorId: string;
             };
-        } & {
+        }) & {
             headers?: Partial<{
                 [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
             }>;
@@ -10258,15 +10300,16 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
                 [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
             }>;
         }, import("@mittwald/api-client-commons").Response<{
-            extensionId?: string | undefined;
-            priceChangeConsequence?: {
+            extensionId: string;
+            nextPossiblePriceChange?: string | undefined;
+            priceChangeConsequence: {
                 contributorConsequence: "NONE" | "EDIT_BLOCK";
                 globalCustomerConsequence: "NONE" | "INFO" | "CONFIRM_REQUIRED";
                 variantConsequences: {
                     consequence?: "NONE" | "INFO" | "CONFIRM_REQUIRED";
                     variantKey?: string;
                 }[];
-            } | undefined;
+            };
         }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
             [x: string]: unknown;
         }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
@@ -10275,17 +10318,22 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
             [x: string]: unknown;
         }, 412, "application/json"> | import("@mittwald/api-client-commons").Response<{
             [x: string]: unknown;
-        }, 429, "application/json">>> | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
+        }, 429, "application/json">>> | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<(({
             data: {
                 dryRun?: boolean | undefined;
-                priceInCents?: number | undefined;
+                priceInCents: number;
             };
-        } & {
+        } | {
+            data: {
+                dryRun?: boolean | undefined;
+                pricePlan: import("./types.js").MittwaldAPIV2.Components.Schemas.ExtensionPricePlan;
+            };
+        }) & {
             pathParameters: {
                 extensionId: string;
                 contributorId: string;
             };
-        } & {
+        }) & {
             headers?: Partial<{
                 [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
             }>;
@@ -10296,15 +10344,16 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
                 [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
             }>;
         }, import("@mittwald/api-client-commons").Response<{
-            extensionId?: string | undefined;
-            priceChangeConsequence?: {
+            extensionId: string;
+            nextPossiblePriceChange?: string | undefined;
+            priceChangeConsequence: {
                 contributorConsequence: "NONE" | "EDIT_BLOCK";
                 globalCustomerConsequence: "NONE" | "INFO" | "CONFIRM_REQUIRED";
                 variantConsequences: {
                     consequence?: "NONE" | "INFO" | "CONFIRM_REQUIRED";
                     variantKey?: string;
                 }[];
-            } | undefined;
+            };
         }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
             [x: string]: unknown;
         }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{

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

@@ -2050,6 +2050,9 @@ export declare namespace MittwaldAPIV2 {
                 interactionRequired: boolean;
                 status: "notStarted" | "pending" | "active" | "terminationPending";
                 terminationTargetDate?: string;
+                variantDescription?: string;
+                variantKey?: string;
+                variantName?: string;
             }
             interface ContainerCreateRegistry {
                 credentials?: MittwaldAPIV2.Components.Schemas.ContainerSetRegistryCredentials;
@@ -2385,6 +2388,7 @@ export declare namespace MittwaldAPIV2 {
                  * Indicates whether the User is allowed to cancel the Termination.
                  */
                 cancellationForbidden?: boolean;
+                explanation?: string;
                 reason?: string;
                 scheduledAtDate: string;
                 scheduledByUserId?: string;
@@ -5364,6 +5368,37 @@ export declare namespace MittwaldAPIV2 {
                 };
                 userId: string;
             }
+            /**
+             * PricePlan with Variants.
+             */
+            interface ExtensionPricePlan {
+                variants: MittwaldAPIV2.Components.Schemas.ExtensionVariant[];
+            }
+            interface ExtensionVariant {
+                /**
+                 * Description of Variant.
+                 */
+                description?: string;
+                /**
+                 * DescriptionChangeType defines how the description change should be handled. Values:
+                 *   - FEATURE_SET_MODIFIED: The users have to confirm to the new contract details equal as price changes.
+                 *   - FEATURE_SET_UNCHANGED: The changes are only wording updates and do not impact the contract details, so no confirm is required.
+                 *
+                 */
+                descriptionChangeType?: "FEATURE_SET_MODIFIED" | "FEATURE_SET_UNCHANGED";
+                /**
+                 * Key that needs to be unique in Variant.
+                 */
+                key: string;
+                /**
+                 * Name of Variant.
+                 */
+                name?: string;
+                /**
+                 * Price in cents.
+                 */
+                priceInCents: number;
+            }
             interface CommonsAddress {
                 street: string;
                 houseNumber: string;
@@ -8766,6 +8801,7 @@ export declare namespace MittwaldAPIV2 {
                             interface ApplicationJson {
                                 contractId?: string;
                                 contractItemId?: string;
+                                explanation?: string;
                                 reason?: string;
                                 terminationTargetDate?: string;
                             }
@@ -8909,6 +8945,7 @@ export declare namespace MittwaldAPIV2 {
                         contractId: string;
                     };
                     interface RequestBody {
+                        explanation?: string;
                         /**
                          * A reason for the termination can be given as plain text.
                          */
@@ -8926,6 +8963,7 @@ export declare namespace MittwaldAPIV2 {
                         namespace Content {
                             interface ApplicationJson {
                                 contractId?: string;
+                                explanation?: string;
                                 itemsScheduledForTermination?: string[];
                                 reason?: string;
                                 terminationTargetDate?: string;
@@ -16568,6 +16606,10 @@ export declare namespace MittwaldAPIV2 {
                         extensionInstanceId: string;
                     };
                     interface RequestBody {
+                        /**
+                         * The Variant Key of the selected Variant of the Extension. This is only required if the Extension has multiple Variants.
+                         */
+                        variantKey?: string;
                     }
                     type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
                     type Query = {};
@@ -17489,7 +17531,7 @@ export declare namespace MittwaldAPIV2 {
                         extensionId: string;
                         contributorId: string;
                     };
-                    interface RequestBody {
+                    type RequestBody = {
                         /**
                          * If set to true, the request will be validated but not executed.
                          */
@@ -17497,8 +17539,14 @@ export declare namespace MittwaldAPIV2 {
                         /**
                          * Price in cents.
                          */
-                        priceInCents?: number;
-                    }
+                        priceInCents: number;
+                    } | {
+                        /**
+                         * If set to true, the request will be validated but not executed.
+                         */
+                        dryRun?: boolean;
+                        pricePlan: MittwaldAPIV2.Components.Schemas.ExtensionPricePlan;
+                    };
                     type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
                     type Query = {};
                 }
@@ -17506,8 +17554,15 @@ export declare namespace MittwaldAPIV2 {
                     namespace $200 {
                         namespace Content {
                             interface ApplicationJson {
-                                extensionId?: string;
-                                priceChangeConsequence?: {
+                                /**
+                                 * The ID of the Extension.
+                                 */
+                                extensionId: string;
+                                /**
+                                 * The time until which the contributor is blocked from changing the price again.
+                                 */
+                                nextPossiblePriceChange?: string;
+                                priceChangeConsequence: {
                                     /**
                                      * Description of the consequence for the Extension from the perspective of the contributor. Values: * "NONE": No consequence. * "EDIT_BLOCK": The Extension will be blocked for editing by the contributor for 30 days.
                                      *

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const MittwaldAPIClientVersion = '4.236.0';
+export declare const MittwaldAPIClientVersion = '4.238.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-client",
-  "version": "4.237.0",
+  "version": "4.239.0",
   "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
   "type": "module",
   "description": "Auto-generated client for the mittwald API",
@@ -80,5 +80,5 @@
       "optional": true
     }
   },
-  "gitHead": "9584ac15ebf21dcf30c0c648c707c10a827dc623"
+  "gitHead": "7367fb79dbf9d6816140fe24c54dc2f6f7d075c3"
 }