@mittwald/api-client 4.206.0 → 4.208.0

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

@@ -593,6 +593,21 @@ declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
         customerId: string;
         termination?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
     }>;
+    /** Return the Contract for the given Mail Address. */
+    getDetailOfContractByMailAddress: (conf: {
+        mailAddressId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        additionalItems?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContractItem[] | undefined;
+        baseItem: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContractItem;
+        contractId: string;
+        contractNumber: string;
+        customerId: string;
+        termination?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
+    }>;
     /** Return the Contract for the given Project. */
     getDetailOfContractByProject: (conf: {
         projectId: string;
@@ -836,21 +851,6 @@ declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
             "x-access-token"?: string | undefined;
         } | undefined;
     }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.OrderCustomerOrder[]>;
-    /** Return the Contract for the given Mail Address. */
-    getDetailOfContractByMailAddress: (conf: {
-        mailAddressId: string;
-        headers?: {
-            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
-            "x-access-token"?: string | undefined;
-        } | undefined;
-    }) => import("@mittwald/react-use-promise").AsyncResource<{
-        additionalItems?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContractItem[] | undefined;
-        baseItem: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractContractItem;
-        contractId: string;
-        contractNumber: string;
-        customerId: string;
-        termination?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContractTermination | undefined;
-    }>;
 };
 declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
     /** Get Contributor Billing Information. */
@@ -886,22 +886,17 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
     }) => import("@mittwald/react-use-promise").AsyncResource<{
         url?: string | undefined;
     }>;
-    /** List ContractPartners of the contributor. */
-    contributorListContractPartnersOfContributor: (conf: {
+    /** List incoming Invoices of a Contributor. */
+    contributorListIncomingInvoices: (conf: {
         contributorId: string;
         queryParameters?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
-            extensionId?: string | undefined;
-            extensionInstanceId?: string | undefined;
-        } | undefined;
-        headers?: {
-            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
-            "x-access-token"?: string | undefined;
+            limit?: number | undefined;
+            skip?: number | undefined;
+            page?: number | undefined;
+            sort?: "invoiceNumber"[] | undefined;
+            order?: ("asc" | "desc")[] | undefined;
         } | undefined;
-    }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContractPartner[]>;
-    /** List incoming Invoices of a Contributor. */
-    contributorListIncomingInvoices: (conf: {
-        contributorId: string;
         headers?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
             "x-access-token"?: string | undefined;
@@ -947,28 +942,86 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
         accessToken: string;
         expiresAt: string;
     }>;
-    /** List ExtensionInstances. */
-    extensionListExtensionInstances: (conf?: {
+    /** Get all open extension orders for given customer */
+    extensionGetCustomerExtensionInstanceOrders: (conf: {
+        customerId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        extensionId?: string;
+    }[]>;
+    /** Get the Contract Strategy of an Extension Instance */
+    extensionGetExtensionInstanceContract: (conf: {
+        extensionInstanceId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        currentPrice?: number | undefined;
+        interactionDeadline?: string | undefined;
+        interactionRequired: boolean;
+        status: "notStarted" | "pending" | "active" | "terminationPending";
+        terminationTargetDate?: string | undefined;
+    }>;
+    /** Get all open extension orders for given project */
+    extensionGetProjectExtensionInstanceOrders: (conf: {
+        projectId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        extensionId?: string;
+    }[]>;
+    /** Get payment method details */
+    customerGetPaymentMethod: (conf: {
+        customerId: string;
         headers?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
             "x-access-token"?: string | undefined;
         } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        cardDetails?: {
+            brand: string;
+            last4: string;
+        } | undefined;
+    }>;
+    /** List ContractPartners of the contributor. */
+    contributorListContractPartnersOfContributor: (conf: {
+        contributorId: string;
         queryParameters?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
-            context?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext | undefined;
-            contextId?: string | undefined;
             extensionId?: string | undefined;
-            searchTerm?: string | undefined;
-            limit?: number | undefined;
-            skip?: number | undefined;
-            page?: number | undefined;
-            sort?: ("createdAt" | "extensionId" | "extensionName")[] | undefined;
-            order?: ("asc" | "desc")[] | undefined;
+            extensionInstanceId?: string | undefined;
         } | undefined;
-    } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionInstance[]>;
-    /** Get an ExtensionInstance. */
-    extensionGetExtensionInstance: (conf: {
-        extensionInstanceId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContractPartner[]>;
+    /** Get the public key to verify the webhook signature. */
+    extensionGetPublicKey: (conf: {
+        serial: string;
+        queryParameters?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            purpose?: "webhook" | "session_token" | undefined;
+            format?: "raw" | "spki" | undefined;
+        } | undefined;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        algorithm: string;
+        key: string;
+        serial: string;
+    }>;
+    /** Get the ExtensionInstance of a specific customer and extension, if existing. */
+    extensionGetExtensionInstanceForCustomer: (conf: {
+        customerId: string;
+        extensionId: string;
         headers?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
             "x-access-token"?: string | undefined;
@@ -992,53 +1045,18 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
         pendingInstallation: boolean;
         pendingRemoval: boolean;
     }>;
-    /** Get Extension of own contributor. */
-    extensionGetOwnExtension: (conf: {
-        contributorId: string;
-        extensionId: string;
+    /** List Contributors. */
+    extensionListContributors: (conf?: {
         headers?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
-            "x-access-token"?: string | undefined;
         } | undefined;
-    }) => import("@mittwald/react-use-promise").AsyncResource<{
-        assets: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionAsset[];
-        backendComponents?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceBackendComponents | undefined;
-        blocked?: boolean | undefined;
-        context?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext | undefined;
-        contributorId: string;
-        deprecation?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionDeprecation | undefined;
-        description?: string | undefined;
-        detailedDescriptions?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceDetailedDescriptions | undefined;
-        disabled?: boolean | undefined;
-        externalFrontends?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExternalComponent[] | undefined;
-        frontendComponents?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExternalComponent[] | undefined;
-        frontendFragments?: {
-            [k: string]: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceFrontendFragment;
-        } | undefined;
-        functional: boolean;
-        id: string;
-        logoRefId?: string | undefined;
-        name: string;
-        pricing?: (import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceMonthlyPricingStrategy | import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceMonthlyPricePlanStrategy) | undefined;
-        published: boolean;
-        requestedChanges?: {
-            context?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext;
-            scopes?: string[];
-            webhookUrls?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceWebhookUrls | {};
+        queryParameters?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            limit?: number | undefined;
+            skip?: number | undefined;
+            page?: number | undefined;
         } | undefined;
-        scopes?: string[] | undefined;
-        secrets: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionSecret[];
-        state?: "enabled" | "blocked" | "disabled" | undefined;
-        statistics: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionStatistics;
-        subTitle?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceSubTitle | undefined;
-        support?: (import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceSupportMeta & {
-            inherited: boolean;
-        }) | undefined;
-        tags?: string[] | undefined;
-        verificationRequested: boolean;
-        verified: boolean;
-        webhookUrls?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceWebhookUrls | undefined;
-    }>;
+    } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContributor[]>;
     /** Get a Contributor. */
     extensionGetContributor: (conf: {
         contributorId: string;
@@ -1046,33 +1064,24 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
         } | undefined;
     }) => import("@mittwald/react-use-promise").AsyncResource<import("@mittwald/api-client-commons").Simplify<import("./types.js").MittwaldAPIV2.Paths.V2ContributorsContributorId.Get.Responses.$200.Content.ApplicationJson>>;
-    /** Get all open extension orders for given customer */
-    extensionGetCustomerExtensionInstanceOrders: (conf: {
-        customerId: string;
+    /** List Scopes. */
+    extensionListScopes: (conf?: {
         headers?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
-            "x-access-token"?: string | undefined;
         } | undefined;
-    }) => import("@mittwald/react-use-promise").AsyncResource<{
-        extensionId?: string;
+    } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
+        name: string;
     }[]>;
-    /** Get the Contract Strategy of an Extension Instance */
-    extensionGetExtensionInstanceContract: (conf: {
-        extensionInstanceId: string;
+    /** Get an Extension. */
+    extensionGetExtension: (conf: {
+        extensionId: string;
         headers?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
-            "x-access-token"?: string | undefined;
         } | undefined;
-    }) => import("@mittwald/react-use-promise").AsyncResource<{
-        currentPrice?: number | undefined;
-        interactionDeadline?: string | undefined;
-        interactionRequired: boolean;
-        status: "notStarted" | "pending" | "active" | "terminationPending";
-        terminationTargetDate?: string | undefined;
-    }>;
-    /** Get the ExtensionInstance of a specific customer and extension, if existing. */
-    extensionGetExtensionInstanceForCustomer: (conf: {
-        customerId: string;
+    }) => import("@mittwald/react-use-promise").AsyncResource<import("@mittwald/api-client-commons").Simplify<import("./types.js").MittwaldAPIV2.Paths.V2ExtensionsExtensionId.Get.Responses.$200.Content.ApplicationJson>>;
+    /** Get the ExtensionInstance of a specific project and extension, if existing. */
+    extensionGetExtensionInstanceForProject: (conf: {
+        projectId: string;
         extensionId: string;
         headers?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
@@ -1097,10 +1106,9 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
         pendingInstallation: boolean;
         pendingRemoval: boolean;
     }>;
-    /** Get the ExtensionInstance of a specific project and extension, if existing. */
-    extensionGetExtensionInstanceForProject: (conf: {
-        projectId: string;
-        extensionId: string;
+    /** Get an ExtensionInstance. */
+    extensionGetExtensionInstance: (conf: {
+        extensionInstanceId: string;
         headers?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
             "x-access-token"?: string | undefined;
@@ -1124,51 +1132,86 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
         pendingInstallation: boolean;
         pendingRemoval: boolean;
     }>;
-    /** Get an Extension. */
-    extensionGetExtension: (conf: {
-        extensionId: string;
-        headers?: {
-            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
-        } | undefined;
-    }) => import("@mittwald/react-use-promise").AsyncResource<import("@mittwald/api-client-commons").Simplify<import("./types.js").MittwaldAPIV2.Paths.V2ExtensionsExtensionId.Get.Responses.$200.Content.ApplicationJson>>;
-    /** Get all open extension orders for given project */
-    extensionGetProjectExtensionInstanceOrders: (conf: {
-        projectId: string;
+    /** List ExtensionInstances. */
+    extensionListExtensionInstances: (conf?: {
         headers?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
             "x-access-token"?: string | undefined;
         } | undefined;
-    }) => import("@mittwald/react-use-promise").AsyncResource<{
-        extensionId?: string;
-    }[]>;
-    /** Get the public key to verify the webhook signature. */
-    extensionGetPublicKey: (conf: {
-        serial: string;
         queryParameters?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
-            purpose?: "webhook" | "session_token" | undefined;
-            format?: "raw" | "spki" | undefined;
+            context?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext | undefined;
+            contextId?: string | undefined;
+            extensionId?: string | undefined;
+            searchTerm?: string | undefined;
+            limit?: number | undefined;
+            skip?: number | undefined;
+            page?: number | undefined;
+            sort?: ("createdAt" | "extensionId" | "extensionName")[] | undefined;
+            order?: ("asc" | "desc")[] | undefined;
         } | undefined;
+    } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionInstance[]>;
+    /** Get Extension of own contributor. */
+    extensionGetOwnExtension: (conf: {
+        contributorId: string;
+        extensionId: string;
         headers?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
         } | undefined;
     }) => import("@mittwald/react-use-promise").AsyncResource<{
-        algorithm: string;
-        key: string;
-        serial: string;
-    }>;
-    /** List Contributors. */
-    extensionListContributors: (conf?: {
-        headers?: {
-            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+        assets: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionAsset[];
+        backendComponents?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceBackendComponents | undefined;
+        blocked?: boolean | undefined;
+        context?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext | undefined;
+        contributorId: string;
+        deprecation?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionDeprecation | undefined;
+        description?: string | undefined;
+        detailedDescriptions?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceDetailedDescriptions | undefined;
+        disabled?: boolean | undefined;
+        externalFrontends?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExternalComponent[] | undefined;
+        frontendComponents?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExternalComponent[] | undefined;
+        frontendFragments?: {
+            [k: string]: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceFrontendFragment;
+        } | undefined;
+        functional: boolean;
+        id: string;
+        logoRefId?: string | undefined;
+        name: string;
+        pricing?: (import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceMonthlyPricingStrategy | import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceMonthlyPricePlanStrategy) | undefined;
+        published: boolean;
+        requestedChanges?: {
+            context?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext;
+            scopes?: string[];
+            webhookUrls?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceWebhookUrls | {};
         } | undefined;
+        scopes?: string[] | undefined;
+        secrets: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionSecret[];
+        state?: "enabled" | "blocked" | "disabled" | undefined;
+        statistics: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionStatistics;
+        subTitle?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceSubTitle | undefined;
+        support?: (import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceSupportMeta & {
+            inherited: boolean;
+        }) | undefined;
+        tags?: string[] | undefined;
+        verificationRequested: boolean;
+        verified: boolean;
+        webhookUrls?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceWebhookUrls | undefined;
+    }>;
+    /** List Extensions of own contributor. */
+    extensionListOwnExtensions: (conf: {
+        contributorId: string;
         queryParameters?: {
             [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
             limit?: number | undefined;
             skip?: number | undefined;
             page?: number | undefined;
         } | undefined;
-    } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContributor[]>;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceOwnExtension[]>;
     /** List Extensions. */
     extensionListExtensions: (conf?: {
         headers?: {
@@ -1186,41 +1229,6 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
             order?: "asc" | "desc" | undefined;
         } | undefined;
     } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtension[]>;
-    /** List Extensions of own contributor. */
-    extensionListOwnExtensions: (conf: {
-        contributorId: string;
-        queryParameters?: {
-            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
-            limit?: number | undefined;
-            skip?: number | undefined;
-            page?: number | undefined;
-        } | undefined;
-        headers?: {
-            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
-            "x-access-token"?: string | undefined;
-        } | undefined;
-    }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceOwnExtension[]>;
-    /** List Scopes. */
-    extensionListScopes: (conf?: {
-        headers?: {
-            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
-        } | undefined;
-    } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
-        name: string;
-    }[]>;
-    /** Get payment method details */
-    customerGetPaymentMethod: (conf: {
-        customerId: string;
-        headers?: {
-            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
-            "x-access-token"?: string | undefined;
-        } | undefined;
-    }) => import("@mittwald/react-use-promise").AsyncResource<{
-        cardDetails?: {
-            brand: string;
-            last4: string;
-        } | undefined;
-    }>;
 };
 declare const buildConversationApi: (baseClient: MittwaldAPIV2Client) => {
     /** Get all conversation the authenticated user has created or has access to. */