@mittwald/api-client 3.1.22 → 3.1.23

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.
Files changed (46) hide show
  1. package/dist/index.d.mts +16 -0
  2. package/dist/index.d.ts +16 -0
  3. package/dist/index.mjs +1164 -0
  4. package/dist/{cjs/generated/v2/client-react.d.ts → react.d.mts} +270 -265
  5. package/dist/{esm/generated/v2/client-react.d.ts → react.d.ts} +270 -265
  6. package/dist/react.mjs +744 -0
  7. package/dist/shared/api-client.f3482d23.d.mts +25479 -0
  8. package/dist/shared/api-client.f3482d23.d.ts +25479 -0
  9. package/dist/shared/api-client.f512b243.mjs +1467 -0
  10. package/dist/version.d.ts +1 -1
  11. package/dist/version.js +1 -1
  12. package/package.json +93 -54
  13. package/dist/cjs/generated/v2/client-react.js +0 -347
  14. package/dist/cjs/generated/v2/client.d.ts +0 -9982
  15. package/dist/cjs/generated/v2/client.js +0 -678
  16. package/dist/cjs/generated/v2/descriptors.d.ts +0 -593
  17. package/dist/cjs/generated/v2/descriptors.js +0 -1772
  18. package/dist/cjs/generated/v2/types.d.ts +0 -14896
  19. package/dist/cjs/generated/v2/types.js +0 -2
  20. package/dist/cjs/index.d.ts +0 -3
  21. package/dist/cjs/index.js +0 -7
  22. package/dist/cjs/react.d.ts +0 -1
  23. package/dist/cjs/react.js +0 -5
  24. package/dist/cjs/v2/default.d.ts +0 -12
  25. package/dist/cjs/v2/default.js +0 -70
  26. package/dist/cjs/v2/react.d.ts +0 -3
  27. package/dist/cjs/v2/react.js +0 -7
  28. package/dist/cjs/version.d.ts +0 -1
  29. package/dist/cjs/version.js +0 -4
  30. package/dist/esm/generated/v2/client-react.js +0 -351
  31. package/dist/esm/generated/v2/client.d.ts +0 -9982
  32. package/dist/esm/generated/v2/client.js +0 -648
  33. package/dist/esm/generated/v2/descriptors.d.ts +0 -593
  34. package/dist/esm/generated/v2/descriptors.js +0 -1764
  35. package/dist/esm/generated/v2/types.d.ts +0 -14896
  36. package/dist/esm/generated/v2/types.js +0 -1
  37. package/dist/esm/index.d.ts +0 -3
  38. package/dist/esm/index.js +0 -2
  39. package/dist/esm/react.d.ts +0 -1
  40. package/dist/esm/react.js +0 -1
  41. package/dist/esm/v2/default.d.ts +0 -12
  42. package/dist/esm/v2/default.js +0 -53
  43. package/dist/esm/v2/react.d.ts +0 -3
  44. package/dist/esm/v2/react.js +0 -3
  45. package/dist/esm/version.d.ts +0 -1
  46. package/dist/esm/version.js +0 -1
@@ -1,648 +0,0 @@
1
- /* eslint-disable */
2
- /* prettier-ignore */
3
- /* This file is auto-generated with acg (@mittwald/api-code-generator) */
4
- import * as descriptors from "./descriptors.js";
5
- import { ApiClientBase } from "@mittwald/api-client-commons";
6
- export class MittwaldAPIV2Client extends ApiClientBase {
7
- /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
8
- app = {
9
- /** Execute a runtime concerning action on a specific `AppInstallation`. */
10
- executeAction: this.requestFunctionFactory(descriptors.appExecuteAction),
11
- /** Get a specific `App`. */
12
- getApp: this.requestFunctionFactory(descriptors.appGetApp),
13
- /** Get a specific `AppInstallation`. */
14
- getAppinstallation: this.requestFunctionFactory(descriptors.appGetAppinstallation),
15
- /** Start uninstallation process for a specific `AppInstallation`. */
16
- uninstallAppinstallation: this.requestFunctionFactory(descriptors.appUninstallAppinstallation),
17
- /** Patch desired properties of a specific `AppInstallation`. */
18
- patchAppinstallation: this.requestFunctionFactory(descriptors.appPatchAppinstallation),
19
- /** Get a specific `AppVersion`. */
20
- getAppversion: this.requestFunctionFactory(descriptors.appGetAppversion),
21
- /** Get the missing requirements of an appInstallation for a specific target AppVersion. */
22
- getMissingDependenciesForAppinstallation: this.requestFunctionFactory(descriptors.appGetMissingDependenciesForAppinstallation),
23
- /** Get a specific `SystemSoftware`. */
24
- getSystemsoftware: this.requestFunctionFactory(descriptors.appGetSystemsoftware),
25
- /** Get a specific `SystemSoftwareVersion`. */
26
- getSystemsoftwareversion: this.requestFunctionFactory(descriptors.appGetSystemsoftwareversion),
27
- /** Create linkage between an `AppInstallation` and a MySql-`Database`. */
28
- linkDatabase: this.requestFunctionFactory(descriptors.appLinkDatabase),
29
- /** Get all `AppInstallations` inside a specific `Project`. */
30
- listAppinstallations: this.requestFunctionFactory(descriptors.appListAppinstallations),
31
- /** Request a new `AppInstallation`. */
32
- requestAppinstallation: this.requestFunctionFactory(descriptors.appRequestAppinstallation),
33
- /** Get all available `Apps`. */
34
- listApps: this.requestFunctionFactory(descriptors.appListApps),
35
- /** Get all `AppVersions` of a specific `App`. */
36
- listAppversions: this.requestFunctionFactory(descriptors.appListAppversions),
37
- /** Get all available `SystemSoftware`. */
38
- listSystemsoftwares: this.requestFunctionFactory(descriptors.appListSystemsoftwares),
39
- /** Get all available `SystemSoftwareVersions` of a specific `SystemSoftware`. */
40
- listSystemsoftwareversions: this.requestFunctionFactory(descriptors.appListSystemsoftwareversions),
41
- /** Get all update candidates for a specific `AppVersion`. */
42
- listUpdateCandidatesForAppversion: this.requestFunctionFactory(descriptors.appListUpdateCandidatesForAppversion),
43
- /** Request a copy of an `AppInstallation`. */
44
- requestAppinstallationCopy: this.requestFunctionFactory(descriptors.appRequestAppinstallationCopy),
45
- /** Get runtime status of a specific `AppInstallation`. */
46
- retrieveStatus: this.requestFunctionFactory(descriptors.appRetrieveStatus),
47
- /** Create linkage between an `AppInstallation` and `DatabaseUsers`. */
48
- setDatabaseUsers: this.requestFunctionFactory(descriptors.appSetDatabaseUsers),
49
- /** Remove linkage between an `AppInstallation` and a `Database`. */
50
- unlinkDatabase: this.requestFunctionFactory(descriptors.appUnlinkDatabase),
51
- };
52
- /** The article API allows you to read article information. */
53
- article = {
54
- /** Get an Article. */
55
- getArticle: this.requestFunctionFactory(descriptors.articleGetArticle),
56
- /** List Articles. */
57
- listArticles: this.requestFunctionFactory(descriptors.articleListArticles),
58
- };
59
- /** The backup API allows you to manage your project backups. */
60
- backup = {
61
- /** Export a ProjectBackup for download. */
62
- createProjectBackupExport: this.requestFunctionFactory(descriptors.backupCreateProjectBackupExport),
63
- /** Delete a ProjectBackupExport. */
64
- deleteProjectBackupExport: this.requestFunctionFactory(descriptors.backupDeleteProjectBackupExport),
65
- /** List BackupSchedules belonging to a Project. */
66
- listProjectBackupSchedules: this.requestFunctionFactory(descriptors.backupListProjectBackupSchedules),
67
- /** Create a BackupSchedule for a Project. */
68
- createProjectBackupSchedule: this.requestFunctionFactory(descriptors.backupCreateProjectBackupSchedule),
69
- /** List Backups belonging to a Project. */
70
- listProjectBackups: this.requestFunctionFactory(descriptors.backupListProjectBackups),
71
- /** Create a Backup of a Project. */
72
- createProjectBackup: this.requestFunctionFactory(descriptors.backupCreateProjectBackup),
73
- /** Get a ProjectBackupSchedule. */
74
- getProjectBackupSchedule: this.requestFunctionFactory(descriptors.backupGetProjectBackupSchedule),
75
- /** Delete a ProjectBackupSchedule. */
76
- deleteProjectBackupSchedule: this.requestFunctionFactory(descriptors.backupDeleteProjectBackupSchedule),
77
- /** Update a ProjectBackupSchedule. */
78
- updateProjectBackupSchedule: this.requestFunctionFactory(descriptors.backupUpdateProjectBackupSchedule),
79
- /** Get a ProjectBackup. */
80
- getProjectBackup: this.requestFunctionFactory(descriptors.backupGetProjectBackup),
81
- /** Delete a ProjectBackup. */
82
- deleteProjectBackup: this.requestFunctionFactory(descriptors.backupDeleteProjectBackup),
83
- /** Change the description of a ProjectBackup. */
84
- updateProjectBackupDescription: this.requestFunctionFactory(descriptors.backupUpdateProjectBackupDescription),
85
- };
86
- /** The contract API allows you to manage your contracts and orders */
87
- contract = {
88
- /** Schedule the Termination of a ContractItem. */
89
- terminateContractItem: this.requestFunctionFactory(descriptors.contractTerminateContractItem),
90
- /** Cancel the Termination for the referred ContractItem. */
91
- cancelContractItemTermination: this.requestFunctionFactory(descriptors.contractCancelContractItemTermination),
92
- /** Cancel the TariffChange for the referred ContractItem. */
93
- cancelContractTariffChange: this.requestFunctionFactory(descriptors.contractCancelContractTariffChange),
94
- /** Schedule the Termination of a Contract. */
95
- terminateContract: this.requestFunctionFactory(descriptors.contractTerminateContract),
96
- /** Cancel the Termination for the referred Contract. */
97
- cancelContractTermination: this.requestFunctionFactory(descriptors.contractCancelContractTermination),
98
- /** Return the BaseItem of the Contract with the given ID. */
99
- getBaseItemOfContract: this.requestFunctionFactory(descriptors.contractGetBaseItemOfContract),
100
- /** Return the Contract for the given Domain. */
101
- getDetailOfContractByDomain: this.requestFunctionFactory(descriptors.contractGetDetailOfContractByDomain),
102
- /** Return the Contract for the given Project. */
103
- getDetailOfContractByProject: this.requestFunctionFactory(descriptors.contractGetDetailOfContractByProject),
104
- /** Return the Contract for the given Server. */
105
- getDetailOfContractByServer: this.requestFunctionFactory(descriptors.contractGetDetailOfContractByServer),
106
- /** Get the ContractItem with the given ID. */
107
- getDetailOfContractItem: this.requestFunctionFactory(descriptors.contractGetDetailOfContractItem),
108
- /** Returns the Contract with the given ID. */
109
- getDetailOfContract: this.requestFunctionFactory(descriptors.contractGetDetailOfContract),
110
- /** Return the next TerminationDate for the ContractItem with the given ID. */
111
- getNextTerminationDateForItem: this.requestFunctionFactory(descriptors.contractGetNextTerminationDateForItem),
112
- /** Return a list of Contracts for the given Customer. */
113
- listContracts: this.requestFunctionFactory(descriptors.contractListContracts),
114
- /** Get details of an Invoice. */
115
- invoiceDetailOfInvoice: this.requestFunctionFactory(descriptors.invoiceDetailOfInvoice),
116
- /** Get InvoiceSettings of a Customer. */
117
- invoiceGetDetailOfInvoiceSettings: this.requestFunctionFactory(descriptors.invoiceGetDetailOfInvoiceSettings),
118
- /** Update InvoiceSettings of a Customer. */
119
- invoiceUpdateInvoiceSettings: this.requestFunctionFactory(descriptors.invoiceUpdateInvoiceSettings),
120
- /** Request an Access Token for the Invoice file. */
121
- invoiceGetFileAccessToken: this.requestFunctionFactory(descriptors.invoiceGetFileAccessToken),
122
- /** List Invoices of a Customer. */
123
- invoiceListCustomerInvoices: this.requestFunctionFactory(descriptors.invoiceListCustomerInvoices),
124
- /** Create an Order. */
125
- orderCreateOrder: this.requestFunctionFactory(descriptors.orderCreateOrder),
126
- /** Create TariffChange Order. */
127
- orderCreateTariffChange: this.requestFunctionFactory(descriptors.orderCreateTariffChange),
128
- /** Get Order for Customer. */
129
- orderGetOrder: this.requestFunctionFactory(descriptors.orderGetOrder),
130
- /** Get list of Orders of a Customer. */
131
- orderListCustomerOrders: this.requestFunctionFactory(descriptors.orderListCustomerOrders),
132
- /** Get list of Orders of a Project. */
133
- orderListProjectOrders: this.requestFunctionFactory(descriptors.orderListProjectOrders),
134
- /** Preview Order. */
135
- orderPreviewOrder: this.requestFunctionFactory(descriptors.orderPreviewOrder),
136
- /** Preview TariffChange. */
137
- orderPreviewTariffChange: this.requestFunctionFactory(descriptors.orderPreviewTariffChange),
138
- };
139
- /** The conversation API allows you to manage your support conversations. */
140
- conversation = {
141
- /** Get all conversation the authenticated user has created or has access to. */
142
- listConversations: this.requestFunctionFactory(descriptors.conversationListConversations),
143
- /** Create a conversation. */
144
- createConversation: this.requestFunctionFactory(descriptors.conversationCreateConversation),
145
- /** Get all message of the conversation. */
146
- listMessagesByConversation: this.requestFunctionFactory(descriptors.conversationListMessagesByConversation),
147
- /** Send a new message in the conversation. */
148
- createMessage: this.requestFunctionFactory(descriptors.conversationCreateMessage),
149
- /** Get a specific conversation category. */
150
- getCategory: this.requestFunctionFactory(descriptors.conversationGetCategory),
151
- /** Get members of a support conversation. */
152
- getConversationMembers: this.requestFunctionFactory(descriptors.conversationGetConversationMembers),
153
- /** Get a support conversation. */
154
- getConversation: this.requestFunctionFactory(descriptors.conversationGetConversation),
155
- /** Update the basic properties of the conversation. */
156
- updateConversation: this.requestFunctionFactory(descriptors.conversationUpdateConversation),
157
- /** Request an access token for the File belonging to the Conversation. */
158
- getFileAccessToken: this.requestFunctionFactory(descriptors.conversationGetFileAccessToken),
159
- /** Get all conversation categories. */
160
- listCategories: this.requestFunctionFactory(descriptors.conversationListCategories),
161
- /** Request a file upload token for the conversation. */
162
- requestFileUpload: this.requestFunctionFactory(descriptors.conversationRequestFileUpload),
163
- /** Update the status of a conversation. */
164
- setConversationStatus: this.requestFunctionFactory(descriptors.conversationSetConversationStatus),
165
- /** Update the content of the message */
166
- updateMessage: this.requestFunctionFactory(descriptors.conversationUpdateMessage),
167
- };
168
- /** The cronjob API allows you to manage cronjobs within a project. */
169
- cronjob = {
170
- /** Abort a CronjobExecution. */
171
- abortExecution: this.requestFunctionFactory(descriptors.cronjobAbortExecution),
172
- /** List Cronjobs belonging to a Project. */
173
- listCronjobs: this.requestFunctionFactory(descriptors.cronjobListCronjobs),
174
- /** Create a Cronjob. */
175
- createCronjob: this.requestFunctionFactory(descriptors.cronjobCreateCronjob),
176
- /** List CronjobExecutions belonging to a Cronjob. */
177
- listExecutions: this.requestFunctionFactory(descriptors.cronjobListExecutions),
178
- /** Trigger a Cronjob. */
179
- createExecution: this.requestFunctionFactory(descriptors.cronjobCreateExecution),
180
- /** Get a Cronjob. */
181
- getCronjob: this.requestFunctionFactory(descriptors.cronjobGetCronjob),
182
- /** Delete a Cronjob. */
183
- deleteCronjob: this.requestFunctionFactory(descriptors.cronjobDeleteCronjob),
184
- /** Update a Cronjob. */
185
- updateCronjob: this.requestFunctionFactory(descriptors.cronjobUpdateCronjob),
186
- /** Get a CronjobExecution. */
187
- getExecution: this.requestFunctionFactory(descriptors.cronjobGetExecution),
188
- /** Update a Cronjob's app id. */
189
- updateCronjobAppId: this.requestFunctionFactory(descriptors.cronjobUpdateCronjobAppId),
190
- };
191
- /** The customer API allows you to manage your own organizations and users. */
192
- customer = {
193
- /** Accept a CustomerInvite. */
194
- acceptCustomerInvite: this.requestFunctionFactory(descriptors.customerAcceptCustomerInvite),
195
- /** Get all customer categories. */
196
- listOfCustomerCategories: this.requestFunctionFactory(descriptors.customerListOfCustomerCategories),
197
- /** Create a new customer category. */
198
- createCategory: this.requestFunctionFactory(descriptors.customerCreateCategory),
199
- /** Create a CustomerInvite. */
200
- createCustomerInvite: this.requestFunctionFactory(descriptors.customerCreateCustomerInvite),
201
- /** Get all customer profiles the authenticated user has access to. */
202
- listCustomers: this.requestFunctionFactory(descriptors.customerListCustomers),
203
- /** Create a new customer profile. */
204
- createCustomer: this.requestFunctionFactory(descriptors.customerCreateCustomer),
205
- /** Decline a CustomerInvite. */
206
- declineCustomerInvite: this.requestFunctionFactory(descriptors.customerDeclineCustomerInvite),
207
- /** Get a customer category. */
208
- getCustomerCategory: this.requestFunctionFactory(descriptors.customerGetCustomerCategory),
209
- /** Update a customer category. */
210
- updateCategory: this.requestFunctionFactory(descriptors.customerUpdateCategory),
211
- /** Delete a customer category. */
212
- deleteCategory: this.requestFunctionFactory(descriptors.customerDeleteCategory),
213
- /** Get a CustomerInvite. */
214
- getCustomerInvite: this.requestFunctionFactory(descriptors.customerGetCustomerInvite),
215
- /** Delete a CustomerInvite. */
216
- deleteCustomerInvite: this.requestFunctionFactory(descriptors.customerDeleteCustomerInvite),
217
- /** Get a CustomerMembership. */
218
- getCustomerMembership: this.requestFunctionFactory(descriptors.customerGetCustomerMembership),
219
- /** Delete a CustomerMembership. */
220
- deleteCustomerMembership: this.requestFunctionFactory(descriptors.customerDeleteCustomerMembership),
221
- /** Update a CustomerMembership. */
222
- updateCustomerMembership: this.requestFunctionFactory(descriptors.customerUpdateCustomerMembership),
223
- /** Get a customer profile. */
224
- getCustomer: this.requestFunctionFactory(descriptors.customerGetCustomer),
225
- /** Update a customer profile. */
226
- updateCustomer: this.requestFunctionFactory(descriptors.customerUpdateCustomer),
227
- /** Delete a customer profile. */
228
- deleteCustomer: this.requestFunctionFactory(descriptors.customerDeleteCustomer),
229
- /** Get a CustomerInvite by token. */
230
- getCustomerTokenInvite: this.requestFunctionFactory(descriptors.customerGetCustomerTokenInvite),
231
- /** Check if the customer profile has a valid contract partner configured. */
232
- isCustomerLegallyCompetent: this.requestFunctionFactory(descriptors.customerIsCustomerLegallyCompetent),
233
- /** Leave a Customer. */
234
- leaveCustomer: this.requestFunctionFactory(descriptors.customerLeaveCustomer),
235
- /** List CustomerInvites belonging to the executing user. */
236
- listCustomerInvites: this.requestFunctionFactory(descriptors.customerListCustomerInvites),
237
- /** List CustomerMemberships belonging to the executing user. */
238
- listCustomerMemberships: this.requestFunctionFactory(descriptors.customerListCustomerMemberships),
239
- /** List Invites belonging to a Customer. */
240
- listInvitesForCustomer: this.requestFunctionFactory(descriptors.customerListInvitesForCustomer),
241
- /** List Memberships belonging to a Customer. */
242
- listMembershipsForCustomer: this.requestFunctionFactory(descriptors.customerListMembershipsForCustomer),
243
- /** Request a new avatar upload for the customer profile. */
244
- requestAvatarUpload: this.requestFunctionFactory(descriptors.customerRequestAvatarUpload),
245
- /** Remove the avatar picture of the customer profile. */
246
- removeAvatar: this.requestFunctionFactory(descriptors.customerRemoveAvatar),
247
- /** Resend the mail for a CustomerInvite. */
248
- resendCustomerInviteMail: this.requestFunctionFactory(descriptors.customerResendCustomerInviteMail),
249
- };
250
- /** The database API allows you to manage your databases, like MySQL and Redis databases. */
251
- database = {
252
- /** List MySQLDatabases belonging to a Project. */
253
- listMysqlDatabases: this.requestFunctionFactory(descriptors.databaseListMysqlDatabases),
254
- /** Create a MySQLDatabase with a MySQLUser. */
255
- createMysqlDatabase: this.requestFunctionFactory(descriptors.databaseCreateMysqlDatabase),
256
- /** List MySQLUsers belonging to a Database. */
257
- listMysqlUsers: this.requestFunctionFactory(descriptors.databaseListMysqlUsers),
258
- /** Create a MySQLUser. */
259
- createMysqlUser: this.requestFunctionFactory(descriptors.databaseCreateMysqlUser),
260
- /** List RedisDatabases belonging to a Project. */
261
- listRedisDatabases: this.requestFunctionFactory(descriptors.databaseListRedisDatabases),
262
- /** Create a RedisDatabase. */
263
- createRedisDatabase: this.requestFunctionFactory(descriptors.databaseCreateRedisDatabase),
264
- /** Get a MySQLDatabase. */
265
- getMysqlDatabase: this.requestFunctionFactory(descriptors.databaseGetMysqlDatabase),
266
- /** Delete a MySQLDatabase. */
267
- deleteMysqlDatabase: this.requestFunctionFactory(descriptors.databaseDeleteMysqlDatabase),
268
- /** Get a MySQLUser. */
269
- getMysqlUser: this.requestFunctionFactory(descriptors.databaseGetMysqlUser),
270
- /** Update a MySQLUser. */
271
- updateMysqlUser: this.requestFunctionFactory(descriptors.databaseUpdateMysqlUser),
272
- /** Delete a MySQLUser. */
273
- deleteMysqlUser: this.requestFunctionFactory(descriptors.databaseDeleteMysqlUser),
274
- /** Get a RedisDatabase. */
275
- getRedisDatabase: this.requestFunctionFactory(descriptors.databaseGetRedisDatabase),
276
- /** Delete a RedisDatabase. */
277
- deleteRedisDatabase: this.requestFunctionFactory(descriptors.databaseDeleteRedisDatabase),
278
- /** Disable a MySQLUser. */
279
- disableMysqlUser: this.requestFunctionFactory(descriptors.databaseDisableMysqlUser),
280
- /** Enable a MySQLUser. */
281
- enableMysqlUser: this.requestFunctionFactory(descriptors.databaseEnableMysqlUser),
282
- /** Get a MySQLUser's PhpMyAdmin-URL. */
283
- getMysqlUserPhpMyAdminUrl: this.requestFunctionFactory(descriptors.databaseGetMysqlUserPhpMyAdminUrl),
284
- /** List available MySQL character sets and collations, optionally filtered by a MySQLVersion. */
285
- listMysqlCharsets: this.requestFunctionFactory(descriptors.databaseListMysqlCharsets),
286
- /** List MySQLVersions. */
287
- listMysqlVersions: this.requestFunctionFactory(descriptors.databaseListMysqlVersions),
288
- /** List RedisVersions. */
289
- listRedisVersions: this.requestFunctionFactory(descriptors.databaseListRedisVersions),
290
- /** Update a MySQLDatabase's default character settings. */
291
- updateMysqlDatabaseDefaultCharset: this.requestFunctionFactory(descriptors.databaseUpdateMysqlDatabaseDefaultCharset),
292
- /** Update a MySQLDatabase's description. */
293
- updateMysqlDatabaseDescription: this.requestFunctionFactory(descriptors.databaseUpdateMysqlDatabaseDescription),
294
- /** Update a MySQLUser's password. */
295
- updateMysqlUserPassword: this.requestFunctionFactory(descriptors.databaseUpdateMysqlUserPassword),
296
- /** Update a RedisDatabase's configuration. */
297
- updateRedisDatabaseConfiguration: this.requestFunctionFactory(descriptors.databaseUpdateRedisDatabaseConfiguration),
298
- /** Update a RedisDatabase's description. */
299
- updateRedisDatabaseDescription: this.requestFunctionFactory(descriptors.databaseUpdateRedisDatabaseDescription),
300
- };
301
- /** The notification API allows you to manage your notifications. */
302
- notification = {
303
- /** Subscribe a user to the mStudio newsletter. */
304
- newsletterSubscribeUser: this.requestFunctionFactory(descriptors.newsletterSubscribeUser),
305
- /** Getting the subscription status of the subscription. */
306
- newsletterGetInfo: this.requestFunctionFactory(descriptors.newsletterGetInfo),
307
- /** Unsubscribe a user from the mStudio newsletter. */
308
- newsletterUnsubscribeUser: this.requestFunctionFactory(descriptors.newsletterUnsubscribeUser),
309
- /** Get the counts for unread notifications of the user. */
310
- scountUnreadNotifications: this.requestFunctionFactory(descriptors.notificationsCountUnreadNotifications),
311
- /** List all unread notifications. */
312
- slistNotifications: this.requestFunctionFactory(descriptors.notificationsListNotifications),
313
- /** Mark all notifications as read. */
314
- sreadAllNotifications: this.requestFunctionFactory(descriptors.notificationsReadAllNotifications),
315
- /** Mark notification as read. */
316
- sreadNotification: this.requestFunctionFactory(descriptors.notificationsReadNotification),
317
- };
318
- /** The domain API allows you to manage your domains, DNS records and ingress resources. */
319
- domain = {
320
- /** Create a DNSZone. */
321
- dnsCreateDnsZone: this.requestFunctionFactory(descriptors.dnsCreateDnsZone),
322
- /** Get a DNSZone. */
323
- dnsGetDnsZone: this.requestFunctionFactory(descriptors.dnsGetDnsZone),
324
- /** Delete a DNSZone. */
325
- dnsDeleteDnsZone: this.requestFunctionFactory(descriptors.dnsDeleteDnsZone),
326
- /** List DNSZones belonging to a Project. */
327
- dnsListDnsZones: this.requestFunctionFactory(descriptors.dnsListDnsZones),
328
- /** Set a record set on a DNSZone to managed. */
329
- dnsSetRecordSetManaged: this.requestFunctionFactory(descriptors.dnsSetRecordSetManaged),
330
- /** Update a record set on a DNSZone. */
331
- dnsUpdateRecordSet: this.requestFunctionFactory(descriptors.dnsUpdateRecordSet),
332
- /** Abort a Domain declaration. */
333
- abortDomainDeclaration: this.requestFunctionFactory(descriptors.domainAbortDomainDeclaration),
334
- /** Check if a Domain is available to register. */
335
- checkDomainRegistrability: this.requestFunctionFactory(descriptors.domainCheckDomainRegistrability),
336
- /** Create an auth code 2. */
337
- createDomainAuthCode2: this.requestFunctionFactory(descriptors.domainCreateDomainAuthCode2),
338
- /** Create an auth code for a Domains transfer-out process. */
339
- createDomainAuthCode: this.requestFunctionFactory(descriptors.domainCreateDomainAuthCode),
340
- /** Update the nameservers of a Domain. */
341
- updateDomainNameservers: this.requestFunctionFactory(descriptors.domainUpdateDomainNameservers),
342
- /** Get a Domain. */
343
- getDomain: this.requestFunctionFactory(descriptors.domainGetDomain),
344
- /** Delete a Domain. */
345
- deleteDomain: this.requestFunctionFactory(descriptors.domainDeleteDomain),
346
- /** Get a DomainOwnership. */
347
- getDomainOwnership: this.requestFunctionFactory(descriptors.domainGetDomainOwnership),
348
- /** Get the latest screenshot's FileReference belonging to a Domain. */
349
- getLatestScreenshot: this.requestFunctionFactory(descriptors.domainGetLatestScreenshot),
350
- /** List the DomainOwnerships of a project. */
351
- listDomainOwnerships: this.requestFunctionFactory(descriptors.domainListDomainOwnerships),
352
- /** List Domains belonging to a Project. */
353
- listDomains: this.requestFunctionFactory(descriptors.domainListDomains),
354
- /** List the contact schemas for a TLD. */
355
- listTldContactSchemas: this.requestFunctionFactory(descriptors.domainListTldContactSchemas),
356
- /** List TLDs. */
357
- listTlds: this.requestFunctionFactory(descriptors.domainListTlds),
358
- /** Resend a Domain email. */
359
- resendDomainEmail: this.requestFunctionFactory(descriptors.domainResendDomainEmail),
360
- /** Update the auth code of a Domain. */
361
- updateDomainAuthCode: this.requestFunctionFactory(descriptors.domainUpdateDomainAuthCode),
362
- /** Update a contact of a Domain. */
363
- updateDomainContact: this.requestFunctionFactory(descriptors.domainUpdateDomainContact),
364
- /** Update a Domain's project id. */
365
- updateDomainProjectId: this.requestFunctionFactory(descriptors.domainUpdateDomainProjectId),
366
- /** Verify a DomainOwnership. */
367
- verifyDomainOwnership: this.requestFunctionFactory(descriptors.domainVerifyDomainOwnership),
368
- /** List Ingresses. */
369
- ingressListIngresses: this.requestFunctionFactory(descriptors.ingressListIngresses),
370
- /** Create an Ingress. */
371
- ingressCreateIngress: this.requestFunctionFactory(descriptors.ingressCreateIngress),
372
- /** Get an Ingress. */
373
- ingressGetIngress: this.requestFunctionFactory(descriptors.ingressGetIngress),
374
- /** Delete an Ingress. */
375
- ingressDeleteIngress: this.requestFunctionFactory(descriptors.ingressDeleteIngress),
376
- /** Update the paths of an Ingress. */
377
- ingressUpdateIngressPaths: this.requestFunctionFactory(descriptors.ingressUpdateIngressPaths),
378
- /** Request the ACME certificate issuance of an Ingress. */
379
- ingressRequestIngressAcmeCertificateIssuance: this.requestFunctionFactory(descriptors.ingressRequestIngressAcmeCertificateIssuance),
380
- /** Update the tls settings of an Ingress. */
381
- ingressUpdateIngressTls: this.requestFunctionFactory(descriptors.ingressUpdateIngressTls),
382
- };
383
- /** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
384
- file = {
385
- /** Create a File. */
386
- createFile: this.requestFunctionFactory(descriptors.fileCreateFile),
387
- /** Get a File's meta. */
388
- getFileMeta: this.requestFunctionFactory(descriptors.fileGetFileMeta),
389
- /** Get a FileUploadToken's rules. */
390
- getFileUploadTokenRules: this.requestFunctionFactory(descriptors.fileGetFileUploadTokenRules),
391
- /** Get a FileUploadType's rules. */
392
- getFileUploadTypeRules: this.requestFunctionFactory(descriptors.fileGetFileUploadTypeRules),
393
- /** Get a File. */
394
- getFile: this.requestFunctionFactory(descriptors.fileGetFile),
395
- };
396
- /** The mail API allows you to manage your mail accounts. */
397
- mail = {
398
- /** List DeliveryBoxes belonging to a Project. */
399
- listDeliveryBoxes: this.requestFunctionFactory(descriptors.mailListDeliveryBoxes),
400
- /** Create a DeliveryBox. */
401
- createDeliverybox: this.requestFunctionFactory(descriptors.mailCreateDeliverybox),
402
- /** List MailAddresses belonging to a Project. */
403
- listMailAddresses: this.requestFunctionFactory(descriptors.mailListMailAddresses),
404
- /** Create a MailAddress. */
405
- createMailAddress: this.requestFunctionFactory(descriptors.mailCreateMailAddress),
406
- /** Get a DeliveryBox. */
407
- getDeliveryBox: this.requestFunctionFactory(descriptors.mailGetDeliveryBox),
408
- /** Delete a DeliveryBox. */
409
- deleteDeliveryBox: this.requestFunctionFactory(descriptors.mailDeleteDeliveryBox),
410
- /** Get a MailAddress. */
411
- getMailAddress: this.requestFunctionFactory(descriptors.mailGetMailAddress),
412
- /** Delete a MailAddress. */
413
- deleteMailAddress: this.requestFunctionFactory(descriptors.mailDeleteMailAddress),
414
- /** List mail settings of a Project. */
415
- listProjectMailSettings: this.requestFunctionFactory(descriptors.mailListProjectMailSettings),
416
- /** Update the description of a DeliveryBox. */
417
- updateDeliveryBoxDescription: this.requestFunctionFactory(descriptors.mailUpdateDeliveryBoxDescription),
418
- /** Update the password of a DeliveryBox. */
419
- updateDeliveryBoxPassword: this.requestFunctionFactory(descriptors.mailUpdateDeliveryBoxPassword),
420
- /** Update a MailAddress. */
421
- updateMailAddressAddress: this.requestFunctionFactory(descriptors.mailUpdateMailAddressAddress),
422
- /** Update the autoresponder of a MailAddress. */
423
- updateMailAddressAutoresponder: this.requestFunctionFactory(descriptors.mailUpdateMailAddressAutoresponder),
424
- /** Update the catchall of a MailAddress. */
425
- updateMailAddressCatchAll: this.requestFunctionFactory(descriptors.mailUpdateMailAddressCatchAll),
426
- /** Update the forward addresses of a MailAddresses. */
427
- updateMailAddressForwardAddresses: this.requestFunctionFactory(descriptors.mailUpdateMailAddressForwardAddresses),
428
- /** Update the password for a MailAddress. */
429
- updateMailAddressPassword: this.requestFunctionFactory(descriptors.mailUpdateMailAddressPassword),
430
- /** Update the quota of a MailAddress. */
431
- updateMailAddressQuota: this.requestFunctionFactory(descriptors.mailUpdateMailAddressQuota),
432
- /** Update the spam protection of a MailAddress. */
433
- updateMailAddressSpamProtection: this.requestFunctionFactory(descriptors.mailUpdateMailAddressSpamProtection),
434
- /** Update a mail setting of a Project. */
435
- updateProjectMailSetting: this.requestFunctionFactory(descriptors.mailUpdateProjectMailSetting),
436
- };
437
- /** The page insights API allows you to get page insights information. */
438
- pageInsights = {
439
- /** Get detailed performance data for a given domain and path. */
440
- pageinsightsGetPerformanceData: this.requestFunctionFactory(descriptors.pageinsightsGetPerformanceData),
441
- /** List websites (specified as domain and path) from a project where performance data is available. */
442
- pageinsightsListPerformanceDataForProject: this.requestFunctionFactory(descriptors.pageinsightsListPerformanceDataForProject),
443
- };
444
- /** The user API allows you to manage your own user and access information of other users that might be visible to you. */
445
- user = {
446
- /** Get a PasswordPolicy. */
447
- passwordValidationGetPasswordPolicy: this.requestFunctionFactory(descriptors.passwordValidationGetPasswordPolicy),
448
- /** Add phone number and start verification process. */
449
- addPhoneNumber: this.requestFunctionFactory(descriptors.userAddPhoneNumber),
450
- /** Remove phone number. */
451
- removePhoneNumber: this.requestFunctionFactory(descriptors.userRemovePhoneNumber),
452
- /** Validate your second factor. */
453
- authenticateMfa: this.requestFunctionFactory(descriptors.userAuthenticateMfa),
454
- /** Authenticate yourself to get an access token. */
455
- authenticate: this.requestFunctionFactory(descriptors.userAuthenticate),
456
- /** Get your verified Email-Address. */
457
- getOwnEmail: this.requestFunctionFactory(descriptors.userGetOwnEmail),
458
- /** Change your Email-Address. */
459
- changeEmail: this.requestFunctionFactory(descriptors.userChangeEmail),
460
- /** Change your password. */
461
- changePassword: this.requestFunctionFactory(descriptors.userChangePassword),
462
- /** Check token for validity. */
463
- checkToken: this.requestFunctionFactory(descriptors.userCheckToken),
464
- /** Get your current multi factor auth status. */
465
- getMfaStatus: this.requestFunctionFactory(descriptors.userGetMfaStatus),
466
- /** Reset RecoveryCodes for MFA. */
467
- resetRecoverycodes: this.requestFunctionFactory(descriptors.userResetRecoverycodes),
468
- /** Confirm Multi Factor Authentication. */
469
- confirmMfa: this.requestFunctionFactory(descriptors.userConfirmMfa),
470
- /** Disable Multi Factor Authentication. */
471
- disableMfa: this.requestFunctionFactory(descriptors.userDisableMfa),
472
- /** Confirm password reset. */
473
- confirmPasswordReset: this.requestFunctionFactory(descriptors.userConfirmPasswordReset),
474
- /** List all of your ApiTokens. */
475
- listApiTokens: this.requestFunctionFactory(descriptors.userListApiTokens),
476
- /** Store a new ApiToken. */
477
- createApiToken: this.requestFunctionFactory(descriptors.userCreateApiToken),
478
- /** Submit your user feedback. */
479
- createFeedback: this.requestFunctionFactory(descriptors.userCreateFeedback),
480
- /** Get your stored ssh-keys. */
481
- listSshKeys: this.requestFunctionFactory(descriptors.userListSshKeys),
482
- /** Store a new ssh-key. */
483
- createSshKey: this.requestFunctionFactory(descriptors.userCreateSshKey),
484
- /** Get a specific ApiToken. */
485
- getApiToken: this.requestFunctionFactory(descriptors.userGetApiToken),
486
- /** Update an existing `ApiToken`. */
487
- editApiToken: this.requestFunctionFactory(descriptors.userEditApiToken),
488
- /** Deletes an ApiToken. */
489
- deleteApiToken: this.requestFunctionFactory(descriptors.userDeleteApiToken),
490
- /** Get a specific stored ssh-key. */
491
- getSshKey: this.requestFunctionFactory(descriptors.userGetSshKey),
492
- /** Edit a stored ssh-key. */
493
- editSshKey: this.requestFunctionFactory(descriptors.userEditSshKey),
494
- /** Remove a ssh-key. */
495
- deleteSshKey: this.requestFunctionFactory(descriptors.userDeleteSshKey),
496
- /** Delete your account and all your personal data. */
497
- deleteUser: this.requestFunctionFactory(descriptors.userDeleteUser),
498
- /** Get your account information. */
499
- getOwnAccount: this.requestFunctionFactory(descriptors.userGetOwnAccount),
500
- /** Update your account information. */
501
- updateAccount: this.requestFunctionFactory(descriptors.userUpdateAccount),
502
- /** The timestamp of your latest password change. */
503
- getPasswordUpdatedAt: this.requestFunctionFactory(descriptors.userGetPasswordUpdatedAt),
504
- /** Get personalized settings. */
505
- getPersonalizedSettings: this.requestFunctionFactory(descriptors.userGetPersonalizedSettings),
506
- /** Update personalized GUI settings. */
507
- updatePersonalizedSettings: this.requestFunctionFactory(descriptors.userUpdatePersonalizedSettings),
508
- /** Get a specific session. */
509
- getSession: this.requestFunctionFactory(descriptors.userGetSession),
510
- /** Terminate a specific Session. */
511
- terminateSession: this.requestFunctionFactory(descriptors.userTerminateSession),
512
- /** Get profile information for a user. */
513
- getUser: this.requestFunctionFactory(descriptors.userGetUser),
514
- /** Change personal information. */
515
- updatePersonalInformation: this.requestFunctionFactory(descriptors.userUpdatePersonalInformation),
516
- /** Initialize Multi Factor Authentication. If successful, it needs to be confirmed, before usage of mfa. */
517
- initMfa: this.requestFunctionFactory(descriptors.userInitMfa),
518
- /** Initialize password reset process. */
519
- initPasswordReset: this.requestFunctionFactory(descriptors.userInitPasswordReset),
520
- /** Submitted feedback of the given user. */
521
- listFeedback: this.requestFunctionFactory(descriptors.userListFeedback),
522
- /** List all sessions. */
523
- listSessions: this.requestFunctionFactory(descriptors.userListSessions),
524
- /** Terminate all sessions, except the current session. */
525
- terminateAllSessions: this.requestFunctionFactory(descriptors.userTerminateAllSessions),
526
- /** Terminate session and invalidate access token. */
527
- logout: this.requestFunctionFactory(descriptors.userLogout),
528
- /** Register with email and password. */
529
- register: this.requestFunctionFactory(descriptors.userRegister),
530
- /** Request a new avatar image upload. */
531
- requestAvatarUpload: this.requestFunctionFactory(descriptors.userRequestAvatarUpload),
532
- /** Remove Avatar. */
533
- removeAvatar: this.requestFunctionFactory(descriptors.userRemoveAvatar),
534
- /** Resend the Email-Address verification email. */
535
- resendVerificationEmail: this.requestFunctionFactory(descriptors.userResendVerificationEmail),
536
- /** Request a support code. */
537
- supportCodeRequest: this.requestFunctionFactory(descriptors.userSupportCodeRequest),
538
- /** Verify an added Email-Address. */
539
- verifyEmail: this.requestFunctionFactory(descriptors.userVerifyEmail),
540
- /** Verify phone number. */
541
- verifyPhoneNumber: this.requestFunctionFactory(descriptors.userVerifyPhoneNumber),
542
- /** Verify your registration. */
543
- verifyRegistration: this.requestFunctionFactory(descriptors.userVerifyRegistration),
544
- };
545
- /** The project API allows you to manage your projects, and also any kinds of user memberships concerning these projects. */
546
- project = {
547
- /** Accept a ProjectInvite. */
548
- acceptProjectInvite: this.requestFunctionFactory(descriptors.projectAcceptProjectInvite),
549
- /** Create a ProjectInvite. */
550
- createProjectInvite: this.requestFunctionFactory(descriptors.projectCreateProjectInvite),
551
- /** Create a Project belonging to a Server. */
552
- createProject: this.requestFunctionFactory(descriptors.projectCreateProject),
553
- /** Decline a ProjectInvite. */
554
- declineProjectInvite: this.requestFunctionFactory(descriptors.projectDeclineProjectInvite),
555
- /** Request a Project avatar upload. */
556
- requestProjectAvatarUpload: this.requestFunctionFactory(descriptors.projectRequestProjectAvatarUpload),
557
- /** Delete a Project's avatar. */
558
- deleteProjectAvatar: this.requestFunctionFactory(descriptors.projectDeleteProjectAvatar),
559
- /** Get a ProjectInvite. */
560
- getProjectInvite: this.requestFunctionFactory(descriptors.projectGetProjectInvite),
561
- /** Delete a ProjectInvite. */
562
- deleteProjectInvite: this.requestFunctionFactory(descriptors.projectDeleteProjectInvite),
563
- /** Get a ProjectMembership */
564
- getProjectMembership: this.requestFunctionFactory(descriptors.projectGetProjectMembership),
565
- /** Delete a ProjectMembership. */
566
- deleteProjectMembership: this.requestFunctionFactory(descriptors.projectDeleteProjectMembership),
567
- /** Update a ProjectMembership. */
568
- updateProjectMembership: this.requestFunctionFactory(descriptors.projectUpdateProjectMembership),
569
- /** Get a Project. */
570
- getProject: this.requestFunctionFactory(descriptors.projectGetProject),
571
- /** Delete a Project. */
572
- deleteProject: this.requestFunctionFactory(descriptors.projectDeleteProject),
573
- /** Request a Server avatar upload. */
574
- requestServerAvatarUpload: this.requestFunctionFactory(descriptors.projectRequestServerAvatarUpload),
575
- /** Delete a Server's avatar. */
576
- deleteServerAvatar: this.requestFunctionFactory(descriptors.projectDeleteServerAvatar),
577
- /** Get a ProjectInvite by token. */
578
- getProjectTokenInvite: this.requestFunctionFactory(descriptors.projectGetProjectTokenInvite),
579
- /** Get the executing user's membership in a Project. */
580
- getSelfMembershipForProject: this.requestFunctionFactory(descriptors.projectGetSelfMembershipForProject),
581
- /** Get a Server. */
582
- getServer: this.requestFunctionFactory(descriptors.projectGetServer),
583
- /** Leave a Project. */
584
- leaveProject: this.requestFunctionFactory(descriptors.projectLeaveProject),
585
- /** List Invites belonging to a Project. */
586
- listInvitesForProject: this.requestFunctionFactory(descriptors.projectListInvitesForProject),
587
- /** List Memberships belonging to a Project. */
588
- listMembershipsForProject: this.requestFunctionFactory(descriptors.projectListMembershipsForProject),
589
- /** List ProjectInvites belonging to the executing user. */
590
- listProjectInvites: this.requestFunctionFactory(descriptors.projectListProjectInvites),
591
- /** List ProjectMemberships belonging to the executing user. */
592
- listProjectMemberships: this.requestFunctionFactory(descriptors.projectListProjectMemberships),
593
- /** List Projects belonging to the executing user. */
594
- listProjects: this.requestFunctionFactory(descriptors.projectListProjects),
595
- /** List Servers belonging to the executing user. */
596
- listServers: this.requestFunctionFactory(descriptors.projectListServers),
597
- /** Resend the mail for a ProjectInvite. */
598
- resendProjectInviteMail: this.requestFunctionFactory(descriptors.projectResendProjectInviteMail),
599
- /** Update a Project's description. */
600
- updateProjectDescription: this.requestFunctionFactory(descriptors.projectUpdateProjectDescription),
601
- /** Update a Servers's description. */
602
- updateServerDescription: this.requestFunctionFactory(descriptors.projectUpdateServerDescription),
603
- };
604
- /** The filesystem API allows you to directly access the filesystem of your project. */
605
- projectFileSystem = {
606
- /** List directories belonging to a Project. */
607
- getDirectories: this.requestFunctionFactory(descriptors.projectFileSystemGetDirectories),
608
- /** Get a Project directory filesystem usage. */
609
- getDiskUsage: this.requestFunctionFactory(descriptors.projectFileSystemGetDiskUsage),
610
- /** Get a Project file's content. */
611
- getFileContent: this.requestFunctionFactory(descriptors.projectFileSystemGetFileContent),
612
- /** Get a Project's file/filesystem authorization token. */
613
- getJwt: this.requestFunctionFactory(descriptors.projectFileSystemGetJwt),
614
- /** Get a Project file's information. */
615
- listFiles: this.requestFunctionFactory(descriptors.projectFileSystemListFiles),
616
- };
617
- /** The relocation API allows you to manage your relocations. */
618
- relocation = {
619
- /** Register a tariff change for a legacy tariff. */
620
- createLegacyTariffChange: this.requestFunctionFactory(descriptors.relocationCreateLegacyTariffChange),
621
- /** Relocate an external Project to mittwald. */
622
- createRelocation: this.requestFunctionFactory(descriptors.relocationCreateRelocation),
623
- };
624
- /** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
625
- sshsftpUser = {
626
- /** Get all SFTPUsers for a Project. */
627
- sftpUserListSftpUsers: this.requestFunctionFactory(descriptors.sftpUserListSftpUsers),
628
- /** Create an SFTPUser for a Project. */
629
- sftpUserCreateSftpUser: this.requestFunctionFactory(descriptors.sftpUserCreateSftpUser),
630
- /** Get an SFTPUser. */
631
- sftpUserGetSftpUser: this.requestFunctionFactory(descriptors.sftpUserGetSftpUser),
632
- /** Delete an SFTPUser. */
633
- sftpUserDeleteSftpUser: this.requestFunctionFactory(descriptors.sftpUserDeleteSftpUser),
634
- /** Update an SFTPUser. */
635
- sftpUserUpdateSftpUser: this.requestFunctionFactory(descriptors.sftpUserUpdateSftpUser),
636
- /** Get all SSHUsers for a Project. */
637
- sshUserListSshUsers: this.requestFunctionFactory(descriptors.sshUserListSshUsers),
638
- /** Create an SSHUser for a Project. */
639
- sshUserCreateSshUser: this.requestFunctionFactory(descriptors.sshUserCreateSshUser),
640
- /** Get an SSHUser. */
641
- sshUserGetSshUser: this.requestFunctionFactory(descriptors.sshUserGetSshUser),
642
- /** Delete an SSHUser. */
643
- sshUserDeleteSshUser: this.requestFunctionFactory(descriptors.sshUserDeleteSshUser),
644
- /** Update an SSHUser. */
645
- sshUserUpdateSshUser: this.requestFunctionFactory(descriptors.sshUserUpdateSshUser),
646
- };
647
- }
648
- export default MittwaldAPIV2Client;