@mittwald/api-client 0.0.0-development-11873f7-20260707 → 0.0.0-development-38105fd-20260708

package/README.md

@@ -14,6 +14,7 @@ see the [LICENSE](../../LICENSE) file for details.
 
 - [Installing](#installing)
 - [Usage](#usage)
+  - [Using the v3-next client](#using-the-v3-next-client)
   - [Setting request parameters](#setting-request-parameters)
     - [Path parameters](#path-parameters)
     - [Headers, query parameters and request body](#headers-query-parameters-and-request-body)
@@ -58,6 +59,34 @@ different types of authentication:
 Have a look at our [API introduction][api-getting-started] for more information
 on how to obtain an API token and how to get started with the API.
 
+### Using the v3-next client
+
+The default import path exposes the v2 client. To use the production
+`v3-next` client, import it from the `@mittwald/api-client/v3-next` subpath:
+
+```typescript
+import { MittwaldAPIClient } from "@mittwald/api-client/v3-next";
+
+const mittwaldApi = MittwaldAPIClient.newWithToken("your-access-token");
+```
+
+The React client is available from the matching React subpath:
+
+```typescript
+import { MittwaldAPIClientReact } from "@mittwald/api-client/v3-next/react";
+```
+
+TypeScript request and response types are exported through the
+`MittwaldAPIV3Next` namespace:
+
+```typescript
+import { MittwaldAPIV3Next } from "@mittwald/api-client/v3-next";
+```
+
+This uses the published, non-development `v3-next` client. The package does not
+expose a `@mittwald/api-client/v3-next-dev` import path; the `v3-next-dev`
+OpenAPI spec is only used for generating development builds.
+
 ### Setting request parameters
 
 API requests may require these type of parameters:

package/dist/esm/generated/v2/client-react.js

@@ -8,7 +8,7 @@ const buildAiHostingApi = (baseClient) => ({
     customerGetKey: new ApiCallAsyncResourceFactory(descriptors.aiHostingCustomerGetKey, baseClient.aiHosting.customerGetKey).getApiResource,
     /** Get a list of currently active models. */
     customerGetDetailedModels: new ApiCallAsyncResourceFactory(descriptors.aiHostingCustomerGetDetailedModels, baseClient.aiHosting.customerGetDetailedModels).getApiResource,
-    /** Get ai hosting plan and usages of a customer. */
+    /** Get ai hosting plan and usages of a customer. Deprecated: use /ai-hostings/{planId} instead. */
     customerGetUsage: new ApiCallAsyncResourceFactory(descriptors.aiHostingCustomerGetUsage, baseClient.aiHosting.customerGetUsage).getApiResource,
     /** Get a list of currently active models. */
     getModels: new ApiCallAsyncResourceFactory(descriptors.aiHostingGetModels, baseClient.aiHosting.getModels).getApiResource,
@@ -20,8 +20,10 @@ const buildAiHostingApi = (baseClient) => ({
     projectGetDetailedModels: new ApiCallAsyncResourceFactory(descriptors.aiHostingProjectGetDetailedModels, baseClient.aiHosting.projectGetDetailedModels).getApiResource,
     /** Get ai hosting plan and usages of a project. Same as the customer route, but less details. */
     projectGetUsage: new ApiCallAsyncResourceFactory(descriptors.aiHostingProjectGetUsage, baseClient.aiHosting.projectGetUsage).getApiResource,
-    /** Get ai hosting subscriptions of a customer. */
-    customerGetSubscriptions: new ApiCallAsyncResourceFactory(descriptors.aiHostingCustomerGetSubscriptions, baseClient.aiHosting.customerGetSubscriptions).getApiResource,
+    /** Get ai hosting plan and usages of a customer by planId. */
+    customerGetPlan: new ApiCallAsyncResourceFactory(descriptors.aiHostingCustomerGetPlan, baseClient.aiHosting.customerGetPlan).getApiResource,
+    /** Get all ai hosting plans of a customer. */
+    customerGetPlans: new ApiCallAsyncResourceFactory(descriptors.aiHostingCustomerGetPlans, baseClient.aiHosting.customerGetPlans).getApiResource,
 });
 const buildAppApi = (baseClient) => ({
     /** Get an App. */

package/dist/esm/generated/v2/client.js

@@ -20,7 +20,7 @@ export class MittwaldAPIV2Client extends ApiClientBase {
         customerDeleteKey: this.requestFunctionFactory(descriptors.aiHostingCustomerDeleteKey),
         /** Get a list of currently active models. */
         customerGetDetailedModels: this.requestFunctionFactory(descriptors.aiHostingCustomerGetDetailedModels),
-        /** Get ai hosting plan and usages of a customer. */
+        /** Get ai hosting plan and usages of a customer. Deprecated: use /ai-hostings/{planId} instead. */
         customerGetUsage: this.requestFunctionFactory(descriptors.aiHostingCustomerGetUsage),
         /** Get a list of currently active models. */
         getModels: this.requestFunctionFactory(descriptors.aiHostingGetModels),
@@ -40,8 +40,10 @@ export class MittwaldAPIV2Client extends ApiClientBase {
         projectGetUsage: this.requestFunctionFactory(descriptors.aiHostingProjectGetUsage),
         /** Links a container with a project licence. */
         projectLinkContainer: this.requestFunctionFactory(descriptors.aiHostingProjectLinkContainer),
-        /** Get ai hosting subscriptions of a customer. */
-        customerGetSubscriptions: this.requestFunctionFactory(descriptors.aiHostingCustomerGetSubscriptions),
+        /** Get ai hosting plan and usages of a customer by planId. */
+        customerGetPlan: this.requestFunctionFactory(descriptors.aiHostingCustomerGetPlan),
+        /** Get all ai hosting plans of a customer. */
+        customerGetPlans: this.requestFunctionFactory(descriptors.aiHostingCustomerGetPlans),
     };
     /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
     app = {
@@ -720,8 +722,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
         migrationRequestMailMigration: this.requestFunctionFactory(descriptors.mailMigrationRequestMailMigration),
         /** Recover emails for a MailAddress from a backup. */
         recoverMailAddressEmails: this.requestFunctionFactory(descriptors.mailRecoverMailAddressEmails),
-        /** Request a rate limit change for a MailAddress. */
-        requestMailAddressRateLimitChange: this.requestFunctionFactory(descriptors.mailRequestMailAddressRateLimitChange),
         /** Update the description of a DeliveryBox. */
         updateDeliveryBoxDescription: this.requestFunctionFactory(descriptors.mailUpdateDeliveryBoxDescription),
         /** Update the password of a DeliveryBox. */
@@ -730,6 +730,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
         updateMailAddressAddress: this.requestFunctionFactory(descriptors.mailUpdateMailAddressAddress),
         /** Update the catch-all of a MailAddress. */
         updateMailAddressCatchAll: this.requestFunctionFactory(descriptors.mailUpdateMailAddressCatchAll),
+        /** Request a rate limit change for a MailAddress. */
+        requestMailAddressRateLimitChange: this.requestFunctionFactory(descriptors.mailRequestMailAddressRateLimitChange),
     };
     /** The notification API allows you to manage your notifications. */
     notification = {

package/dist/esm/generated/v2/descriptors.js

@@ -40,7 +40,7 @@ export const aiHostingCustomerGetDetailedModels = {
     method: "GET",
     operationId: "ai-hosting-customer-get-detailed-models",
 };
-/** Get ai hosting plan and usages of a customer. */
+/** Get ai hosting plan and usages of a customer. Deprecated: use /ai-hostings/{planId} instead. */
 export const aiHostingCustomerGetUsage = {
     path: "/v2/customers/{customerId}/ai-hosting",
     method: "GET",
@@ -2050,12 +2050,6 @@ export const mailRecoverMailAddressEmails = {
     method: "POST",
     operationId: "mail-recover-mail-address-emails",
 };
-/** Request a rate limit change for a MailAddress. */
-export const mailRequestMailAddressRateLimitChange = {
-    path: "/v2/mail-addresses/{mailAddressId}/request-rate-limit-change",
-    method: "POST",
-    operationId: "mail-request-mail-address-rate-limit-change",
-};
 /** Update the description of a DeliveryBox. */
 export const mailUpdateDeliveryBoxDescription = {
     path: "/v2/delivery-boxes/{deliveryBoxId}/description",
@@ -2902,12 +2896,6 @@ export const verificationVerifyCompany = {
     method: "POST",
     operationId: "verification-verify-company",
 };
-/** Get ai hosting subscriptions of a customer. */
-export const aiHostingCustomerGetSubscriptions = {
-    path: "/v2/customers/{customerId}/ai-subscriptions",
-    method: "GET",
-    operationId: "ai-hosting-customer-get-subscriptions",
-};
 /** Get Container Template statistics. */
 export const containerGetTemplateStatistics = {
     path: "/v2/container-templates/{templateId}/statistics",
@@ -2920,3 +2908,21 @@ export const containerGetTemplateStatisticsByCategory = {
     method: "GET",
     operationId: "container-get-template-statistics-by-category",
 };
+/** Get ai hosting plan and usages of a customer by planId. */
+export const aiHostingCustomerGetPlan = {
+    path: "/v2/customers/{customerId}/ai-hostings/{planId}",
+    method: "GET",
+    operationId: "ai-hosting-customer-get-plan",
+};
+/** Get all ai hosting plans of a customer. */
+export const aiHostingCustomerGetPlans = {
+    path: "/v2/customers/{customerId}/ai-hostings",
+    method: "GET",
+    operationId: "ai-hosting-customer-get-plans",
+};
+/** Request a rate limit change for a MailAddress. */
+export const mailRequestMailAddressRateLimitChange = {
+    path: "/v2/mail-addresses/{mailAddressId}/request-rate-limit-change",
+    method: "POST",
+    operationId: "mail-request-mail-address-rate-limit-change",
+};