@mittwald/api-client 0.0.0-development-b04ddc9-20251030 → 0.0.0-development-3a5c2fb-20251119
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.
- package/dist/esm/generated/v2/client-react.js +1 -3
- package/dist/esm/generated/v2/client.js +7 -7
- package/dist/esm/generated/v2/descriptors.js +43 -19
- package/dist/esm/version.js +1 -1
- package/dist/types/generated/v2/client-react.d.ts +10 -19
- package/dist/types/generated/v2/client.d.ts +256 -249
- package/dist/types/generated/v2/descriptors.d.ts +18 -10
- package/dist/types/generated/v2/types.d.ts +557 -244
- package/dist/types/version.d.ts +1 -1
- package/package.json +4 -4
|
@@ -48,9 +48,7 @@ const buildBackupApi = (baseClient) => ({
|
|
|
48
48
|
getProjectBackupSchedule: new ApiCallAsyncResourceFactory(descriptors.backupGetProjectBackupSchedule, baseClient.backup.getProjectBackupSchedule).getApiResource,
|
|
49
49
|
/** Get a ProjectBackup. */
|
|
50
50
|
getProjectBackup: new ApiCallAsyncResourceFactory(descriptors.backupGetProjectBackup, baseClient.backup.getProjectBackup).getApiResource,
|
|
51
|
-
/**
|
|
52
|
-
getProjectBackupDatabases: new ApiCallAsyncResourceFactory(descriptors.backupGetProjectBackupDatabases, baseClient.backup.getProjectBackupDatabases).getApiResource,
|
|
53
|
-
/** Get paths for a ProjectBackup. */
|
|
51
|
+
/** Get table of contents for a ProjectBackup. */
|
|
54
52
|
getProjectBackupDirectories: new ApiCallAsyncResourceFactory(descriptors.backupGetProjectBackupDirectories, baseClient.backup.getProjectBackupDirectories).getApiResource,
|
|
55
53
|
});
|
|
56
54
|
const buildContainerApi = (baseClient) => ({
|
|
@@ -86,12 +86,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
86
86
|
getProjectBackup: this.requestFunctionFactory(descriptors.backupGetProjectBackup),
|
|
87
87
|
/** Delete a ProjectBackup. */
|
|
88
88
|
deleteProjectBackup: this.requestFunctionFactory(descriptors.backupDeleteProjectBackup),
|
|
89
|
-
/**
|
|
90
|
-
getProjectBackupDatabases: this.requestFunctionFactory(descriptors.backupGetProjectBackupDatabases),
|
|
91
|
-
/** Get paths for a ProjectBackup. */
|
|
89
|
+
/** Get table of contents for a ProjectBackup. */
|
|
92
90
|
getProjectBackupDirectories: this.requestFunctionFactory(descriptors.backupGetProjectBackupDirectories),
|
|
93
|
-
/** Restore a ProjectBackup's database. */
|
|
94
|
-
requestProjectBackupRestoreDatabase: this.requestFunctionFactory(descriptors.backupRequestProjectBackupRestoreDatabase),
|
|
95
91
|
/** Restore a ProjectBackup's path. */
|
|
96
92
|
requestProjectBackupRestorePath: this.requestFunctionFactory(descriptors.backupRequestProjectBackupRestorePath),
|
|
97
93
|
/** Change the description of a ProjectBackup. */
|
|
@@ -251,6 +247,10 @@ export class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
251
247
|
extensionScheduleExtensionTermination: this.requestFunctionFactory(descriptors.extensionScheduleExtensionTermination),
|
|
252
248
|
/** Cancel an Extension Instance Termination. */
|
|
253
249
|
extensionCancelExtensionTermination: this.requestFunctionFactory(descriptors.extensionCancelExtensionTermination),
|
|
250
|
+
/** Schedule an Extension Instance Variant change for the next possible date. */
|
|
251
|
+
extensionScheduleExtensionVariantChange: this.requestFunctionFactory(descriptors.extensionScheduleExtensionVariantChange),
|
|
252
|
+
/** Cancel an Extension Instance Variant Change. */
|
|
253
|
+
extensionCancelExtensionVariantChange: this.requestFunctionFactory(descriptors.extensionCancelExtensionVariantChange),
|
|
254
254
|
/** Change the context of an Extension. */
|
|
255
255
|
extensionChangeContext: this.requestFunctionFactory(descriptors.extensionChangeContext),
|
|
256
256
|
/** Consent to extension scopes. */
|
|
@@ -597,6 +597,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
597
597
|
updateMailAddressQuota: this.requestFunctionFactory(descriptors.mailUpdateMailAddressQuota),
|
|
598
598
|
/** Update the spam protection of a MailAddress. */
|
|
599
599
|
updateMailAddressSpamProtection: this.requestFunctionFactory(descriptors.mailUpdateMailAddressSpamProtection),
|
|
600
|
+
/** Update a mail setting of a Project. */
|
|
601
|
+
updateProjectMailSetting: this.requestFunctionFactory(descriptors.mailUpdateProjectMailSetting),
|
|
600
602
|
/** List DeliveryBoxes belonging to a Project. */
|
|
601
603
|
listDeliveryBoxes: this.requestFunctionFactory(descriptors.mailListDeliveryBoxes),
|
|
602
604
|
/** Create a DeliveryBox. */
|
|
@@ -637,8 +639,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
637
639
|
updateMailAddressAddress: this.requestFunctionFactory(descriptors.mailUpdateMailAddressAddress),
|
|
638
640
|
/** Update the catch-all of a MailAddress. */
|
|
639
641
|
updateMailAddressCatchAll: this.requestFunctionFactory(descriptors.mailUpdateMailAddressCatchAll),
|
|
640
|
-
/** Update a mail setting of a Project. */
|
|
641
|
-
updateProjectMailSetting: this.requestFunctionFactory(descriptors.mailUpdateProjectMailSetting),
|
|
642
642
|
};
|
|
643
643
|
/** The notification API allows you to manage your notifications. */
|
|
644
644
|
notification = {
|
|
@@ -220,24 +220,12 @@ export const backupDeleteProjectBackup = {
|
|
|
220
220
|
method: "DELETE",
|
|
221
221
|
operationId: "backup-delete-project-backup",
|
|
222
222
|
};
|
|
223
|
-
/**
|
|
224
|
-
export const backupGetProjectBackupDatabases = {
|
|
225
|
-
path: "/v2/project-backups/{projectBackupId}/database",
|
|
226
|
-
method: "GET",
|
|
227
|
-
operationId: "backup-get-project-backup-databases",
|
|
228
|
-
};
|
|
229
|
-
/** Get paths for a ProjectBackup. */
|
|
223
|
+
/** Get table of contents for a ProjectBackup. */
|
|
230
224
|
export const backupGetProjectBackupDirectories = {
|
|
231
225
|
path: "/v2/project-backups/{projectBackupId}/path",
|
|
232
226
|
method: "GET",
|
|
233
227
|
operationId: "backup-get-project-backup-directories",
|
|
234
228
|
};
|
|
235
|
-
/** Restore a ProjectBackup's database. */
|
|
236
|
-
export const backupRequestProjectBackupRestoreDatabase = {
|
|
237
|
-
path: "/v2/project-backups/{projectBackupId}/restore-database",
|
|
238
|
-
method: "POST",
|
|
239
|
-
operationId: "backup-request-project-backup-restore-database",
|
|
240
|
-
};
|
|
241
229
|
/** Restore a ProjectBackup's path. */
|
|
242
230
|
export const backupRequestProjectBackupRestorePath = {
|
|
243
231
|
path: "/v2/project-backups/{projectBackupId}/restore-path",
|
|
@@ -1090,6 +1078,12 @@ export const mailUpdateMailAddressSpamProtection = {
|
|
|
1090
1078
|
method: "PATCH",
|
|
1091
1079
|
operationId: "mail-update-mail-address-spam-protection",
|
|
1092
1080
|
};
|
|
1081
|
+
/** Update a mail setting of a Project. */
|
|
1082
|
+
export const mailUpdateProjectMailSetting = {
|
|
1083
|
+
path: "/v2/projects/{projectId}/mail-settings/{mailSetting}",
|
|
1084
|
+
method: "PATCH",
|
|
1085
|
+
operationId: "mail-update-project-mail-setting",
|
|
1086
|
+
};
|
|
1093
1087
|
/** Subscribe a user to the mStudio newsletter. */
|
|
1094
1088
|
export const newsletterSubscribeUser = {
|
|
1095
1089
|
path: "/v2/newsletter-subscriptions",
|
|
@@ -1264,6 +1258,18 @@ export const extensionCancelExtensionTermination = {
|
|
|
1264
1258
|
method: "DELETE",
|
|
1265
1259
|
operationId: "extension-cancel-extension-termination",
|
|
1266
1260
|
};
|
|
1261
|
+
/** Schedule an Extension Instance Variant change for the next possible date. */
|
|
1262
|
+
export const extensionScheduleExtensionVariantChange = {
|
|
1263
|
+
path: "/v2/extension-instances/{extensionInstanceId}/contract/variant-change",
|
|
1264
|
+
method: "POST",
|
|
1265
|
+
operationId: "extension-schedule-extension-variant-change",
|
|
1266
|
+
};
|
|
1267
|
+
/** Cancel an Extension Instance Variant Change. */
|
|
1268
|
+
export const extensionCancelExtensionVariantChange = {
|
|
1269
|
+
path: "/v2/extension-instances/{extensionInstanceId}/contract/variant-change",
|
|
1270
|
+
method: "DELETE",
|
|
1271
|
+
operationId: "extension-cancel-extension-variant-change",
|
|
1272
|
+
};
|
|
1267
1273
|
/** Change the context of an Extension. */
|
|
1268
1274
|
export const extensionChangeContext = {
|
|
1269
1275
|
path: "/v2/contributors/{contributorId}/extensions/{extensionId}/context",
|
|
@@ -1684,6 +1690,30 @@ export const leadfyndrRemoveUnlockedLeadReservation = {
|
|
|
1684
1690
|
method: "DELETE",
|
|
1685
1691
|
operationId: "leadfyndr-remove-unlocked-lead-reservation",
|
|
1686
1692
|
};
|
|
1693
|
+
/** Get a Licence. */
|
|
1694
|
+
export const licenceGetLicence = {
|
|
1695
|
+
path: "/v2/licences/{licenceId}",
|
|
1696
|
+
method: "GET",
|
|
1697
|
+
operationId: "licence-get-licence",
|
|
1698
|
+
};
|
|
1699
|
+
/** List Licences belonging to a Project. */
|
|
1700
|
+
export const licenceListLicencesForProject = {
|
|
1701
|
+
path: "/v2/projects/{projectId}/licences",
|
|
1702
|
+
method: "GET",
|
|
1703
|
+
operationId: "licence-list-licences-for-project",
|
|
1704
|
+
};
|
|
1705
|
+
/** rotate a Licence's key, i.e. revoke the old and generate a new one. */
|
|
1706
|
+
export const licenceRotateLicenceKey = {
|
|
1707
|
+
path: "/v2/licences/{licenceId}/actions/rotate-licence-key",
|
|
1708
|
+
method: "POST",
|
|
1709
|
+
operationId: "licence-rotate-licence-key",
|
|
1710
|
+
};
|
|
1711
|
+
/** Validate a Licence's key for a project. */
|
|
1712
|
+
export const licenceValidateLicenceKeyForProject = {
|
|
1713
|
+
path: "/v2/projects/{projectId}/actions/validate-licence-key",
|
|
1714
|
+
method: "POST",
|
|
1715
|
+
operationId: "licence-validate-licence-key-for-project",
|
|
1716
|
+
};
|
|
1687
1717
|
/** List DeliveryBoxes belonging to a Project. */
|
|
1688
1718
|
export const mailListDeliveryBoxes = {
|
|
1689
1719
|
path: "/v2/projects/{projectId}/delivery-boxes",
|
|
@@ -1804,12 +1834,6 @@ export const mailUpdateMailAddressCatchAll = {
|
|
|
1804
1834
|
method: "PATCH",
|
|
1805
1835
|
operationId: "mail-update-mail-address-catch-all",
|
|
1806
1836
|
};
|
|
1807
|
-
/** Update a mail setting of a Project. */
|
|
1808
|
-
export const mailUpdateProjectMailSetting = {
|
|
1809
|
-
path: "/v2/projects/{projectId}/mail-settings/{mailSetting}",
|
|
1810
|
-
method: "PATCH",
|
|
1811
|
-
operationId: "mail-update-project-mail-setting",
|
|
1812
|
-
};
|
|
1813
1837
|
/** Get payment method details */
|
|
1814
1838
|
export const marketplaceCustomerGetPaymentMethod = {
|
|
1815
1839
|
path: "/v2/customers/{customerId}/payment-method",
|
package/dist/esm/version.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const MittwaldAPIClientVersion = '4.
|
|
1
|
+
export const MittwaldAPIClientVersion = '4.261.0';
|
|
@@ -344,25 +344,10 @@ declare const buildBackupApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
344
344
|
parentId?: string | undefined;
|
|
345
345
|
projectId: string;
|
|
346
346
|
requestedAt: string;
|
|
347
|
-
restoreDatabase?: import("./types.js").MittwaldAPIV2.Components.Schemas.BackupProjectBackupRestoreDatabase | undefined;
|
|
348
347
|
restorePath?: import("./types.js").MittwaldAPIV2.Components.Schemas.BackupProjectBackupRestorePath | undefined;
|
|
349
348
|
status: string;
|
|
350
349
|
}>;
|
|
351
|
-
/**
|
|
352
|
-
getProjectBackupDatabases: (conf: {
|
|
353
|
-
projectBackupId: string;
|
|
354
|
-
headers?: {
|
|
355
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
356
|
-
"x-access-token"?: string | undefined;
|
|
357
|
-
} | undefined;
|
|
358
|
-
queryParameters?: {
|
|
359
|
-
[x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
|
|
360
|
-
databaseName?: string | undefined;
|
|
361
|
-
} | undefined;
|
|
362
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
363
|
-
databases: string[];
|
|
364
|
-
}>;
|
|
365
|
-
/** Get paths for a ProjectBackup. */
|
|
350
|
+
/** Get table of contents for a ProjectBackup. */
|
|
366
351
|
getProjectBackupDirectories: (conf: {
|
|
367
352
|
projectBackupId: string;
|
|
368
353
|
headers?: {
|
|
@@ -1011,10 +996,11 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1011
996
|
invoiceDate: string;
|
|
1012
997
|
invoiceId: string;
|
|
1013
998
|
invoiceNumber: string;
|
|
999
|
+
invoiceType: "INVOICE" | "CREDIT_NOTE";
|
|
1014
1000
|
pdfLink: string;
|
|
1015
1001
|
totalGross: number;
|
|
1016
1002
|
totalNet: number;
|
|
1017
|
-
webLink
|
|
1003
|
+
webLink?: string;
|
|
1018
1004
|
}[]>;
|
|
1019
1005
|
/** Request an Access Token for the Incoming Invoice file. */
|
|
1020
1006
|
contributorReceiptGetFileAccessToken: (conf: {
|
|
@@ -1106,6 +1092,7 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1106
1092
|
logoRefId?: string | undefined;
|
|
1107
1093
|
name: string;
|
|
1108
1094
|
pricing?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceMonthlyPricePlanStrategy | undefined;
|
|
1095
|
+
pricingDetails?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplacePricePlanDetails | undefined;
|
|
1109
1096
|
published: boolean;
|
|
1110
1097
|
requestedChanges?: {
|
|
1111
1098
|
context?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext;
|
|
@@ -1145,9 +1132,14 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1145
1132
|
"x-access-token"?: string | undefined;
|
|
1146
1133
|
} | undefined;
|
|
1147
1134
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1135
|
+
contractPeriodEndDate?: string | undefined;
|
|
1148
1136
|
currentPrice?: number | undefined;
|
|
1149
1137
|
interactionDeadline?: string | undefined;
|
|
1150
1138
|
interactionRequired: boolean;
|
|
1139
|
+
pendingVariantChange?: {
|
|
1140
|
+
effectiveDate?: string;
|
|
1141
|
+
targetVariantKey?: string;
|
|
1142
|
+
} | undefined;
|
|
1151
1143
|
status: "notStarted" | "pending" | "active" | "terminationPending";
|
|
1152
1144
|
terminationTargetDate?: string | undefined;
|
|
1153
1145
|
variantDescription?: string | undefined;
|
|
@@ -1484,9 +1476,7 @@ declare const buildCronjobApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1484
1476
|
"x-access-token"?: string | undefined;
|
|
1485
1477
|
} | undefined;
|
|
1486
1478
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
1487
|
-
issues?: string[] | undefined;
|
|
1488
1479
|
message: string;
|
|
1489
|
-
recommendation?: string | undefined;
|
|
1490
1480
|
}>;
|
|
1491
1481
|
/** Get a CronjobExecution. */
|
|
1492
1482
|
getExecution: (conf: {
|
|
@@ -1612,6 +1602,7 @@ declare const buildCustomerApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
1612
1602
|
creationDate: string;
|
|
1613
1603
|
customerId: string;
|
|
1614
1604
|
customerNumber: string;
|
|
1605
|
+
deletionProhibitedBy?: ("hasOpenInvoices" | "hasActiveContracts" | "hasActiveExtensionSubscriptions" | "isActiveContributor")[] | undefined;
|
|
1615
1606
|
executingUserRoles?: import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerRole[] | undefined;
|
|
1616
1607
|
flags?: import("./types.js").MittwaldAPIV2.Components.Schemas.CustomerCustomerFlag[] | undefined;
|
|
1617
1608
|
isAllowedToPlaceOrders?: boolean | undefined;
|