@mittwald/api-client 1.0.0-alpha.12
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/README.md +114 -0
- package/dist/generated/v2/client.d.ts +6026 -0
- package/dist/generated/v2/client.js +696 -0
- package/dist/generated/v2/descriptors.d.ts +646 -0
- package/dist/generated/v2/descriptors.js +1921 -0
- package/dist/generated/v2/types.d.ts +16161 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/v2.d.ts +10 -0
- package/dist/v2.js +41 -0
- package/package.json +39 -0
|
@@ -0,0 +1,696 @@
|
|
|
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/dist/core/ApiClientBase.js";
|
|
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 a specific `SystemSoftware` */
|
|
22
|
+
getSystemsoftware: this.requestFunctionFactory(descriptors.appGetSystemsoftware),
|
|
23
|
+
/** get a specific `SystemSoftwareVersion` */
|
|
24
|
+
getSystemsoftwareversion: this.requestFunctionFactory(descriptors.appGetSystemsoftwareversion),
|
|
25
|
+
/** create linkage between an `AppInstallation` and a `Database` */
|
|
26
|
+
linkDatabase: this.requestFunctionFactory(descriptors.appLinkDatabase),
|
|
27
|
+
/** get all `AppInstallations` inside a specific `Project` */
|
|
28
|
+
listAppinstallations: this.requestFunctionFactory(descriptors.appListAppinstallations),
|
|
29
|
+
/** request a new `AppInstallation` */
|
|
30
|
+
requestAppinstallation: this.requestFunctionFactory(descriptors.appRequestAppinstallation),
|
|
31
|
+
/** get all available `Apps` */
|
|
32
|
+
listApps: this.requestFunctionFactory(descriptors.appListApps),
|
|
33
|
+
/** get all `AppVersions` of a specific `App` */
|
|
34
|
+
listAppversions: this.requestFunctionFactory(descriptors.appListAppversions),
|
|
35
|
+
/** get all available `SystemSoftware` */
|
|
36
|
+
listSystemsoftwares: this.requestFunctionFactory(descriptors.appListSystemsoftwares),
|
|
37
|
+
/** get all available `SystemSoftwareVersions` of a specific `SystemSoftware` */
|
|
38
|
+
listSystemsoftwareversions: this.requestFunctionFactory(descriptors.appListSystemsoftwareversions),
|
|
39
|
+
/** get runtime status of a specific `AppInstallation` */
|
|
40
|
+
retrieveStatus: this.requestFunctionFactory(descriptors.appRetrieveStatus),
|
|
41
|
+
/** create linkage between an `AppInstallation` and `DatabaseUsers` */
|
|
42
|
+
setDatabaseUsers: this.requestFunctionFactory(descriptors.appSetDatabaseUsers),
|
|
43
|
+
/** remove linkage between an `AppInstallation` and a `Database` */
|
|
44
|
+
unlinkDatabase: this.requestFunctionFactory(descriptors.appUnlinkDatabase),
|
|
45
|
+
/** trigger `AppInstallation` to retrieve current installation status based on an appJob */
|
|
46
|
+
updateStatus: this.requestFunctionFactory(descriptors.appUpdateStatus),
|
|
47
|
+
};
|
|
48
|
+
/** The article API allows you to read article information. */
|
|
49
|
+
article = {
|
|
50
|
+
/** Get an Article. */
|
|
51
|
+
serviceGetArticle: this.requestFunctionFactory(descriptors.articleServiceGetArticle),
|
|
52
|
+
/** List Articles. */
|
|
53
|
+
serviceListArticles: this.requestFunctionFactory(descriptors.articleServiceListArticles),
|
|
54
|
+
};
|
|
55
|
+
/** The backup API allows you to manage your project backups. */
|
|
56
|
+
backup = {
|
|
57
|
+
/** Export a ProjectBackup for download. */
|
|
58
|
+
createProjectBackupExport: this.requestFunctionFactory(descriptors.backupCreateProjectBackupExport),
|
|
59
|
+
/** Delete a ProjectBackupExport. */
|
|
60
|
+
deleteProjectBackupExport: this.requestFunctionFactory(descriptors.backupDeleteProjectBackupExport),
|
|
61
|
+
/** List BackupSchedules belonging to a given Project. */
|
|
62
|
+
listProjectBackupSchedules: this.requestFunctionFactory(descriptors.backupListProjectBackupSchedules),
|
|
63
|
+
/** Create a BackupSchedule for a Project. */
|
|
64
|
+
createProjectBackupSchedule: this.requestFunctionFactory(descriptors.backupCreateProjectBackupSchedule),
|
|
65
|
+
/** List Backups for a given Project. */
|
|
66
|
+
listProjectBackups: this.requestFunctionFactory(descriptors.backupListProjectBackups),
|
|
67
|
+
/** Create a Backup of a Project. */
|
|
68
|
+
createProjectBackup: this.requestFunctionFactory(descriptors.backupCreateProjectBackup),
|
|
69
|
+
/** Get a ProjectBackupSchedule. */
|
|
70
|
+
getProjectBackupSchedule: this.requestFunctionFactory(descriptors.backupGetProjectBackupSchedule),
|
|
71
|
+
/** Delete a ProjectBackupSchedule. */
|
|
72
|
+
deleteProjectBackupSchedule: this.requestFunctionFactory(descriptors.backupDeleteProjectBackupSchedule),
|
|
73
|
+
/** Update a ProjectBackupSchedule. */
|
|
74
|
+
updateProjectBackupSchedule: this.requestFunctionFactory(descriptors.backupUpdateProjectBackupSchedule),
|
|
75
|
+
/** Get a ProjectBackup. */
|
|
76
|
+
getProjectBackup: this.requestFunctionFactory(descriptors.backupGetProjectBackup),
|
|
77
|
+
/** Delete a ProjectBackup. */
|
|
78
|
+
deleteProjectBackup: this.requestFunctionFactory(descriptors.backupDeleteProjectBackup),
|
|
79
|
+
/** Change the description of a ProjectBackup. */
|
|
80
|
+
updateProjectBackupDescription: this.requestFunctionFactory(descriptors.backupUpdateProjectBackupDescription),
|
|
81
|
+
};
|
|
82
|
+
/** The contract API allows you to manage your contracts and orders */
|
|
83
|
+
contract = {
|
|
84
|
+
/** Schedule the Termination of a ContractItem. */
|
|
85
|
+
terminateContractItem: this.requestFunctionFactory(descriptors.contractTerminateContractItem),
|
|
86
|
+
/** Cancel the Termination for the referred ContractItem. */
|
|
87
|
+
cancelContractItemTermination: this.requestFunctionFactory(descriptors.contractCancelContractItemTermination),
|
|
88
|
+
/** Cancel the TariffChange for the referred ContractItem. */
|
|
89
|
+
cancelContractTariffChange: this.requestFunctionFactory(descriptors.contractCancelContractTariffChange),
|
|
90
|
+
/** Schedule the Termination of a Contract. */
|
|
91
|
+
terminateContract: this.requestFunctionFactory(descriptors.contractTerminateContract),
|
|
92
|
+
/** Cancel the Termination for the referred Contract. */
|
|
93
|
+
cancelContractTermination: this.requestFunctionFactory(descriptors.contractCancelContractTermination),
|
|
94
|
+
/** Return the BaseItem of the Contract with the given ID. */
|
|
95
|
+
getBaseItemOfContract: this.requestFunctionFactory(descriptors.contractGetBaseItemOfContract),
|
|
96
|
+
/** Return the Contract for the given Domain. */
|
|
97
|
+
getDetailOfContractByDomain: this.requestFunctionFactory(descriptors.contractGetDetailOfContractByDomain),
|
|
98
|
+
/** Return the Contract for the given Project. */
|
|
99
|
+
getDetailOfContractByProject: this.requestFunctionFactory(descriptors.contractGetDetailOfContractByProject),
|
|
100
|
+
/** Return the Contract for the given Server. */
|
|
101
|
+
getDetailOfContractByServer: this.requestFunctionFactory(descriptors.contractGetDetailOfContractByServer),
|
|
102
|
+
/** Get the ContractItem with the given ID. */
|
|
103
|
+
getDetailOfContractItem: this.requestFunctionFactory(descriptors.contractGetDetailOfContractItem),
|
|
104
|
+
/** Returns the Contract with the given ID. */
|
|
105
|
+
getDetailOfContract: this.requestFunctionFactory(descriptors.contractGetDetailOfContract),
|
|
106
|
+
/** Return the next TerminationDate for the ContractItem with the given ID. */
|
|
107
|
+
getNextTerminationDateForItem: this.requestFunctionFactory(descriptors.contractGetNextTerminationDateForItem),
|
|
108
|
+
/** Return a list of Contracts for the given Customer. */
|
|
109
|
+
listContracts: this.requestFunctionFactory(descriptors.contractListContracts),
|
|
110
|
+
/** Get InvoiceSettings of a Customer. */
|
|
111
|
+
deprecatedInvoiceInvoiceSettings: this.requestFunctionFactory(descriptors.deprecatedInvoiceInvoiceSettings),
|
|
112
|
+
/** Update InvoiceSettings of a Customer. */
|
|
113
|
+
deprecatedInvoiceUpdateInvoiceSettings: this.requestFunctionFactory(descriptors.deprecatedInvoiceUpdateInvoiceSettings),
|
|
114
|
+
/** Prospace tariff change order */
|
|
115
|
+
deprecatedOrderChangeProjecthosting: this.requestFunctionFactory(descriptors.deprecatedOrderChangeProjecthosting),
|
|
116
|
+
/** SpaceServer order */
|
|
117
|
+
deprecatedOrderChangeServer: this.requestFunctionFactory(descriptors.deprecatedOrderChangeServer),
|
|
118
|
+
/** Order a domain. */
|
|
119
|
+
deprecatedOrderOrderDomain: this.requestFunctionFactory(descriptors.deprecatedOrderOrderDomain),
|
|
120
|
+
/** Prospace order */
|
|
121
|
+
deprecatedOrderOrderProjecthosting: this.requestFunctionFactory(descriptors.deprecatedOrderOrderProjecthosting),
|
|
122
|
+
/** SpaceServer order */
|
|
123
|
+
deprecatedOrderOrderServer: this.requestFunctionFactory(descriptors.deprecatedOrderOrderServer),
|
|
124
|
+
/** Preview Prospace tariff change */
|
|
125
|
+
deprecatedOrderPreviewChangeProjecthosting: this.requestFunctionFactory(descriptors.deprecatedOrderPreviewChangeProjecthosting),
|
|
126
|
+
/** Preview SpaceServer tariff change */
|
|
127
|
+
deprecatedOrderPreviewChangeServer: this.requestFunctionFactory(descriptors.deprecatedOrderPreviewChangeServer),
|
|
128
|
+
/** Preview domain order. */
|
|
129
|
+
deprecatedOrderPreviewOrderDomain: this.requestFunctionFactory(descriptors.deprecatedOrderPreviewOrderDomain),
|
|
130
|
+
/** Preview Prospace order */
|
|
131
|
+
deprecatedOrderPreviewOrderProjecthosting: this.requestFunctionFactory(descriptors.deprecatedOrderPreviewOrderProjecthosting),
|
|
132
|
+
/** Preview SpaceServer order */
|
|
133
|
+
deprecatedOrderPreviewOrderServer: this.requestFunctionFactory(descriptors.deprecatedOrderPreviewOrderServer),
|
|
134
|
+
/** Get details of an Invoice. */
|
|
135
|
+
invoiceDetailOfInvoice: this.requestFunctionFactory(descriptors.invoiceDetailOfInvoice),
|
|
136
|
+
/** Get InvoiceSettings of a Customer. */
|
|
137
|
+
invoiceGetDetailOfInvoiceSettings: this.requestFunctionFactory(descriptors.invoiceGetDetailOfInvoiceSettings),
|
|
138
|
+
/** Update InvoiceSettings of a Customer. */
|
|
139
|
+
invoiceUpdateInvoiceSettings: this.requestFunctionFactory(descriptors.invoiceUpdateInvoiceSettings),
|
|
140
|
+
/** List Invoices of a Customer. */
|
|
141
|
+
invoiceListCustomerInvoices: this.requestFunctionFactory(descriptors.invoiceListCustomerInvoices),
|
|
142
|
+
/** Create an Order. */
|
|
143
|
+
orderCreateOrder: this.requestFunctionFactory(descriptors.orderCreateOrder),
|
|
144
|
+
/** Create TariffChange Order. */
|
|
145
|
+
orderCreateTariffChange: this.requestFunctionFactory(descriptors.orderCreateTariffChange),
|
|
146
|
+
/** Get Order for Customer. */
|
|
147
|
+
orderGetOrder: this.requestFunctionFactory(descriptors.orderGetOrder),
|
|
148
|
+
/** Get list of Orders of a Customer. */
|
|
149
|
+
orderListCustomerOrders: this.requestFunctionFactory(descriptors.orderListCustomerOrders),
|
|
150
|
+
/** Get list of Orders of a Project. */
|
|
151
|
+
orderListProjectOrders: this.requestFunctionFactory(descriptors.orderListProjectOrders),
|
|
152
|
+
/** Preview Order. */
|
|
153
|
+
orderPreviewOrder: this.requestFunctionFactory(descriptors.orderPreviewOrder),
|
|
154
|
+
/** Preview TariffChange. */
|
|
155
|
+
orderPreviewTariffChange: this.requestFunctionFactory(descriptors.orderPreviewTariffChange),
|
|
156
|
+
};
|
|
157
|
+
/** The conversation API allows you to manage your support conversations. */
|
|
158
|
+
conversation = {
|
|
159
|
+
/** Get all conversation the authenticated user has created or has access to. */
|
|
160
|
+
listConversations: this.requestFunctionFactory(descriptors.conversationListConversations),
|
|
161
|
+
/** Create a conversation. */
|
|
162
|
+
createConversation: this.requestFunctionFactory(descriptors.conversationCreateConversation),
|
|
163
|
+
/** Get all message of the conversation. */
|
|
164
|
+
listMessagesByConversation: this.requestFunctionFactory(descriptors.conversationListMessagesByConversation),
|
|
165
|
+
/** Send a new message in the conversation. */
|
|
166
|
+
createMessage: this.requestFunctionFactory(descriptors.conversationCreateMessage),
|
|
167
|
+
/** Get a specific conversation category. */
|
|
168
|
+
getCategory: this.requestFunctionFactory(descriptors.conversationGetCategory),
|
|
169
|
+
/** Get a support conversation. */
|
|
170
|
+
getConversation: this.requestFunctionFactory(descriptors.conversationGetConversation),
|
|
171
|
+
/** Update the basic properties of the conversation. */
|
|
172
|
+
updateConversation: this.requestFunctionFactory(descriptors.conversationUpdateConversation),
|
|
173
|
+
/** Get all conversation categories. */
|
|
174
|
+
listCategories: this.requestFunctionFactory(descriptors.conversationListCategories),
|
|
175
|
+
/** Request a file upload token for the conversation. */
|
|
176
|
+
requestFileUpload: this.requestFunctionFactory(descriptors.conversationRequestFileUpload),
|
|
177
|
+
/** Update the status of a conversation. */
|
|
178
|
+
setConversationStatus: this.requestFunctionFactory(descriptors.conversationSetConversationStatus),
|
|
179
|
+
/** Update the content of the message */
|
|
180
|
+
updateMessage: this.requestFunctionFactory(descriptors.conversationUpdateMessage),
|
|
181
|
+
};
|
|
182
|
+
/** The cronjob API allows you to manage cronjobs within a project. */
|
|
183
|
+
cronjob = {
|
|
184
|
+
/** Abort a CronjobExecution. */
|
|
185
|
+
abortExecution: this.requestFunctionFactory(descriptors.cronjobAbortExecution),
|
|
186
|
+
/** List Cronjobs belonging to a Project. */
|
|
187
|
+
listCronjobs: this.requestFunctionFactory(descriptors.cronjobListCronjobs),
|
|
188
|
+
/** Create a Cronjob. */
|
|
189
|
+
createCronjob: this.requestFunctionFactory(descriptors.cronjobCreateCronjob),
|
|
190
|
+
/** List CronjobExecutions belonging to a Cronjob. */
|
|
191
|
+
listExecutions: this.requestFunctionFactory(descriptors.cronjobListExecutions),
|
|
192
|
+
/** Trigger a Cronjob. */
|
|
193
|
+
createExecution: this.requestFunctionFactory(descriptors.cronjobCreateExecution),
|
|
194
|
+
/** Get a Cronjob. */
|
|
195
|
+
getCronjob: this.requestFunctionFactory(descriptors.cronjobGetCronjob),
|
|
196
|
+
/** Delete a Cronjob. */
|
|
197
|
+
deleteCronjob: this.requestFunctionFactory(descriptors.cronjobDeleteCronjob),
|
|
198
|
+
/** Update a Cronjob. */
|
|
199
|
+
updateCronjob: this.requestFunctionFactory(descriptors.cronjobUpdateCronjob),
|
|
200
|
+
/** Get a CronjobExecution. */
|
|
201
|
+
getExecution: this.requestFunctionFactory(descriptors.cronjobGetExecution),
|
|
202
|
+
/** Update a Cronjob's app id. */
|
|
203
|
+
updateCronjobAppId: this.requestFunctionFactory(descriptors.cronjobUpdateCronjobAppId),
|
|
204
|
+
};
|
|
205
|
+
/** The customer API allows you to manage your own organizations and users. */
|
|
206
|
+
customer = {
|
|
207
|
+
/** Accept a CustomerInvite. */
|
|
208
|
+
acceptCustomerInvite: this.requestFunctionFactory(descriptors.customerAcceptCustomerInvite),
|
|
209
|
+
/** Get all customer categories. */
|
|
210
|
+
listOfCustomerCategoriesDeprecated: this.requestFunctionFactory(descriptors.customerListOfCustomerCategoriesDeprecated),
|
|
211
|
+
/** Create a new customer category. */
|
|
212
|
+
createCategoryDeprecated: this.requestFunctionFactory(descriptors.customerCreateCategoryDeprecated),
|
|
213
|
+
/** Get all customer categories. */
|
|
214
|
+
listOfCustomerCategories: this.requestFunctionFactory(descriptors.customerListOfCustomerCategories),
|
|
215
|
+
/** Create a new customer category. */
|
|
216
|
+
createCategory: this.requestFunctionFactory(descriptors.customerCreateCategory),
|
|
217
|
+
/** Create a CustomerInvite. */
|
|
218
|
+
createCustomerInvite: this.requestFunctionFactory(descriptors.customerCreateCustomerInvite),
|
|
219
|
+
/** Get all customer profiles the authenticated user has access to. */
|
|
220
|
+
listCustomers: this.requestFunctionFactory(descriptors.customerListCustomers),
|
|
221
|
+
/** Create a new customer profile. */
|
|
222
|
+
createCustomer: this.requestFunctionFactory(descriptors.customerCreateCustomer),
|
|
223
|
+
/** Get all notes for the customer profile. */
|
|
224
|
+
listOfNotes: this.requestFunctionFactory(descriptors.customerListOfNotes),
|
|
225
|
+
/** Add a note to the customer profile. */
|
|
226
|
+
createNote: this.requestFunctionFactory(descriptors.customerCreateNote),
|
|
227
|
+
/** Decline a CustomerInvite. */
|
|
228
|
+
declineCustomerInvite: this.requestFunctionFactory(descriptors.customerDeclineCustomerInvite),
|
|
229
|
+
/** Get a customer category. */
|
|
230
|
+
detailOfCustomerCategoryDeprecated: this.requestFunctionFactory(descriptors.customerDetailOfCustomerCategoryDeprecated),
|
|
231
|
+
/** Update a customer category. */
|
|
232
|
+
updateCategoryDeprecated: this.requestFunctionFactory(descriptors.customerUpdateCategoryDeprecated),
|
|
233
|
+
/** Delete a customer category. */
|
|
234
|
+
deleteCategoryDeprecated: this.requestFunctionFactory(descriptors.customerDeleteCategoryDeprecated),
|
|
235
|
+
/** Get a customer category. */
|
|
236
|
+
getCustomerCategory: this.requestFunctionFactory(descriptors.customerGetCustomerCategory),
|
|
237
|
+
/** Update a customer category. */
|
|
238
|
+
updateCategory: this.requestFunctionFactory(descriptors.customerUpdateCategory),
|
|
239
|
+
/** Delete a customer category. */
|
|
240
|
+
deleteCategory: this.requestFunctionFactory(descriptors.customerDeleteCategory),
|
|
241
|
+
/** Get a CustomerInvite. */
|
|
242
|
+
getCustomerInvite: this.requestFunctionFactory(descriptors.customerGetCustomerInvite),
|
|
243
|
+
/** Delete a CustomerInvite. */
|
|
244
|
+
deleteCustomerInvite: this.requestFunctionFactory(descriptors.customerDeleteCustomerInvite),
|
|
245
|
+
/** Get a CustomerMembership. */
|
|
246
|
+
getCustomerMembership: this.requestFunctionFactory(descriptors.customerGetCustomerMembership),
|
|
247
|
+
/** Delete a CustomerMembership. */
|
|
248
|
+
deleteCustomerMembership: this.requestFunctionFactory(descriptors.customerDeleteCustomerMembership),
|
|
249
|
+
/** Update a CustomerMembership. */
|
|
250
|
+
updateCustomerMembership: this.requestFunctionFactory(descriptors.customerUpdateCustomerMembership),
|
|
251
|
+
/** Get a customer profile. */
|
|
252
|
+
getCustomer: this.requestFunctionFactory(descriptors.customerGetCustomer),
|
|
253
|
+
/** Update a customer profile. */
|
|
254
|
+
updateCustomer: this.requestFunctionFactory(descriptors.customerUpdateCustomer),
|
|
255
|
+
/** Delete a customer profile. */
|
|
256
|
+
deleteCustomer: this.requestFunctionFactory(descriptors.customerDeleteCustomer),
|
|
257
|
+
/** Update a note of the customer profile. */
|
|
258
|
+
updateNote: this.requestFunctionFactory(descriptors.customerUpdateNote),
|
|
259
|
+
/** Delete a note from customer profile. */
|
|
260
|
+
deleteNote: this.requestFunctionFactory(descriptors.customerDeleteNote),
|
|
261
|
+
/** Get a CustomerInvite by token. */
|
|
262
|
+
getCustomerTokenInvite: this.requestFunctionFactory(descriptors.customerGetCustomerTokenInvite),
|
|
263
|
+
/** Check if the customer profile has a valid contract partner configured. */
|
|
264
|
+
isCustomerLegallyCompetent: this.requestFunctionFactory(descriptors.customerIsCustomerLegallyCompetent),
|
|
265
|
+
/** Leave a Customer. */
|
|
266
|
+
leaveCustomer: this.requestFunctionFactory(descriptors.customerLeaveCustomer),
|
|
267
|
+
/** List all CustomerInvites for the executing user. */
|
|
268
|
+
listCustomerInvites: this.requestFunctionFactory(descriptors.customerListCustomerInvites),
|
|
269
|
+
/** List all CustomerMemberships for the executing user. */
|
|
270
|
+
listCustomerMemberships: this.requestFunctionFactory(descriptors.customerListCustomerMemberships),
|
|
271
|
+
/** List all invites for a Customer. */
|
|
272
|
+
listInvitesForCustomer: this.requestFunctionFactory(descriptors.customerListInvitesForCustomer),
|
|
273
|
+
/** List all memberships belonging to a Customer. */
|
|
274
|
+
listMembershipsForCustomer: this.requestFunctionFactory(descriptors.customerListMembershipsForCustomer),
|
|
275
|
+
/** Request a new avatar upload for the customer profile. */
|
|
276
|
+
requestAvatarUpload: this.requestFunctionFactory(descriptors.customerRequestAvatarUpload),
|
|
277
|
+
/** Remove the avatar picture of the customer profile. */
|
|
278
|
+
removeAvatar: this.requestFunctionFactory(descriptors.customerRemoveAvatar),
|
|
279
|
+
/** Resend the mail for a CustomerInvite. */
|
|
280
|
+
resendCustomerInviteMail: this.requestFunctionFactory(descriptors.customerResendCustomerInviteMail),
|
|
281
|
+
};
|
|
282
|
+
/** The database API allows you to manage your databases, like MySQL and Redis databases. */
|
|
283
|
+
database = {
|
|
284
|
+
/** List MySQLDatabases belonging to a Project. */
|
|
285
|
+
listMysqlDatabases: this.requestFunctionFactory(descriptors.databaseListMysqlDatabases),
|
|
286
|
+
/** Create a MySQLDatabase with an optional MySQLUser */
|
|
287
|
+
createMysqlDatabase: this.requestFunctionFactory(descriptors.databaseCreateMysqlDatabase),
|
|
288
|
+
/** List MySQLUsers belonging to a database. */
|
|
289
|
+
listMysqlUsers: this.requestFunctionFactory(descriptors.databaseListMysqlUsers),
|
|
290
|
+
/** Create a MySQLUser. */
|
|
291
|
+
createMysqlUser: this.requestFunctionFactory(descriptors.databaseCreateMysqlUser),
|
|
292
|
+
/** List RedisDatabases belonging to a project. */
|
|
293
|
+
listRedisDatabases: this.requestFunctionFactory(descriptors.databaseListRedisDatabases),
|
|
294
|
+
/** Create a RedisDatabase. */
|
|
295
|
+
createRedisDatabase: this.requestFunctionFactory(descriptors.databaseCreateRedisDatabase),
|
|
296
|
+
/** Get a MySQLDatabase. */
|
|
297
|
+
getMysqlDatabase: this.requestFunctionFactory(descriptors.databaseGetMysqlDatabase),
|
|
298
|
+
/** Delete a MySQLDatabase. */
|
|
299
|
+
deleteMysqlDatabase: this.requestFunctionFactory(descriptors.databaseDeleteMysqlDatabase),
|
|
300
|
+
/** Get a MySQLUser. */
|
|
301
|
+
getMysqlUser: this.requestFunctionFactory(descriptors.databaseGetMysqlUser),
|
|
302
|
+
/** Update a MySQLUser. */
|
|
303
|
+
updateMysqlUser: this.requestFunctionFactory(descriptors.databaseUpdateMysqlUser),
|
|
304
|
+
/** Delete a MySQLUser. */
|
|
305
|
+
deleteMysqlUser: this.requestFunctionFactory(descriptors.databaseDeleteMysqlUser),
|
|
306
|
+
/** Get a RedisDatabase. */
|
|
307
|
+
getRedisDatabase: this.requestFunctionFactory(descriptors.databaseGetRedisDatabase),
|
|
308
|
+
/** Delete a RedisDatabase. */
|
|
309
|
+
deleteRedisDatabase: this.requestFunctionFactory(descriptors.databaseDeleteRedisDatabase),
|
|
310
|
+
/** Disable a MySQLUser. */
|
|
311
|
+
disableMysqlUser: this.requestFunctionFactory(descriptors.databaseDisableMysqlUser),
|
|
312
|
+
/** Enable a MySQLUser. */
|
|
313
|
+
enableMysqlUser: this.requestFunctionFactory(descriptors.databaseEnableMysqlUser),
|
|
314
|
+
/** Get a MySQLUser's PhpMyAdmin-URL. */
|
|
315
|
+
getMysqlUserPhpMyAdminUrl: this.requestFunctionFactory(descriptors.databaseGetMysqlUserPhpMyAdminUrl),
|
|
316
|
+
/** List available MySQL character sets and collations, optionally filtered by a MySQLVersion. */
|
|
317
|
+
listMysqlCharsets: this.requestFunctionFactory(descriptors.databaseListMysqlCharsets),
|
|
318
|
+
/** List available MySQLVersions. */
|
|
319
|
+
listMysqlVersions: this.requestFunctionFactory(descriptors.databaseListMysqlVersions),
|
|
320
|
+
/** List available Redis versions. */
|
|
321
|
+
listRedisVersions: this.requestFunctionFactory(descriptors.databaseListRedisVersions),
|
|
322
|
+
/** Update a MySQLDatabase's default character settings. */
|
|
323
|
+
updateMysqlDatabaseDefaultCharset: this.requestFunctionFactory(descriptors.databaseUpdateMysqlDatabaseDefaultCharset),
|
|
324
|
+
/** Update a MySQLDatabase's description. */
|
|
325
|
+
updateMysqlDatabaseDescription: this.requestFunctionFactory(descriptors.databaseUpdateMysqlDatabaseDescription),
|
|
326
|
+
/** Update a MySQLUser's password. */
|
|
327
|
+
updateMysqlUserPassword: this.requestFunctionFactory(descriptors.databaseUpdateMysqlUserPassword),
|
|
328
|
+
/** Update a RedisDatabase's description. */
|
|
329
|
+
updateRedisDatabaseDescription: this.requestFunctionFactory(descriptors.databaseUpdateRedisDatabaseDescription),
|
|
330
|
+
};
|
|
331
|
+
/** The domain API allows you to manage your domains, DNS records and ingress resources. */
|
|
332
|
+
domain = {
|
|
333
|
+
/** updates a-records for a specific zone */
|
|
334
|
+
dnsRecordAsetCustom: this.requestFunctionFactory(descriptors.dnsRecordAsetCustom),
|
|
335
|
+
/** set a-records managed by ingress for a specific zone */
|
|
336
|
+
dnsRecordAsetManagedByIngress: this.requestFunctionFactory(descriptors.dnsRecordAsetManagedByIngress),
|
|
337
|
+
/** updates cname-record for a specific zone */
|
|
338
|
+
dnsRecordCnameSet: this.requestFunctionFactory(descriptors.dnsRecordCnameSet),
|
|
339
|
+
/** updates mx-records for a specific zone */
|
|
340
|
+
dnsRecordMxSetCustom: this.requestFunctionFactory(descriptors.dnsRecordMxSetCustom),
|
|
341
|
+
/** sets mx-records to managed for a specific zone */
|
|
342
|
+
dnsRecordMxSetManaged: this.requestFunctionFactory(descriptors.dnsRecordMxSetManaged),
|
|
343
|
+
/** updates txt-records for a specific zone */
|
|
344
|
+
dnsRecordTxtSet: this.requestFunctionFactory(descriptors.dnsRecordTxtSet),
|
|
345
|
+
/** gets a specific zone */
|
|
346
|
+
dnsZoneGetSpecific: this.requestFunctionFactory(descriptors.dnsZoneGetSpecific),
|
|
347
|
+
/** gets all dns zones by project id */
|
|
348
|
+
dnsZonesForProject: this.requestFunctionFactory(descriptors.dnsZonesForProject),
|
|
349
|
+
/** Abort a declare process. */
|
|
350
|
+
serviceAbortDeclareProcess: this.requestFunctionFactory(descriptors.domainServiceAbortDeclareProcess),
|
|
351
|
+
/** Change the ownerC of a domain. */
|
|
352
|
+
serviceChangeOwnercOfDomain: this.requestFunctionFactory(descriptors.domainServiceChangeOwnercOfDomain),
|
|
353
|
+
/** Change the Project relation of a Domain. */
|
|
354
|
+
serviceChangeProjectOfDomain: this.requestFunctionFactory(descriptors.domainServiceChangeProjectOfDomain),
|
|
355
|
+
/** Check if a Domain is available to register. */
|
|
356
|
+
serviceCheckDomainAvailability: this.requestFunctionFactory(descriptors.domainServiceCheckDomainAvailability),
|
|
357
|
+
/** Create an AuthCode for a Domains transfer out process. */
|
|
358
|
+
serviceCreateAuthcodeForDomain: this.requestFunctionFactory(descriptors.domainServiceCreateAuthcodeForDomain),
|
|
359
|
+
/** Create an AuthCode2. */
|
|
360
|
+
serviceCreateAuthcode2ForDomain: this.requestFunctionFactory(descriptors.domainServiceCreateAuthcode2ForDomain),
|
|
361
|
+
/** Change all nameservers of a Domain. */
|
|
362
|
+
serviceDeclareNameservers: this.requestFunctionFactory(descriptors.domainServiceDeclareNameservers),
|
|
363
|
+
/** Update an AuthCode. */
|
|
364
|
+
serviceDeclareProcessChangeAuthcode: this.requestFunctionFactory(descriptors.domainServiceDeclareProcessChangeAuthcode),
|
|
365
|
+
/** Update a Domain's OwnerC handle. */
|
|
366
|
+
serviceDeclareProcessChangeHandles: this.requestFunctionFactory(descriptors.domainServiceDeclareProcessChangeHandles),
|
|
367
|
+
/** Get a Domain. */
|
|
368
|
+
serviceGetDomain: this.requestFunctionFactory(descriptors.domainServiceGetDomain),
|
|
369
|
+
/** Delete a Domain. */
|
|
370
|
+
serviceDeleteDomain: this.requestFunctionFactory(descriptors.domainServiceDeleteDomain),
|
|
371
|
+
/** Get a HandleSchema. */
|
|
372
|
+
serviceGetHandleFields: this.requestFunctionFactory(descriptors.domainServiceGetHandleFields),
|
|
373
|
+
/** Get a domain ownership. */
|
|
374
|
+
serviceGetSpecificDomainOwnership: this.requestFunctionFactory(descriptors.domainServiceGetSpecificDomainOwnership),
|
|
375
|
+
/** Verify a domain ownership. */
|
|
376
|
+
serviceVerifyDomainOwnership: this.requestFunctionFactory(descriptors.domainServiceVerifyDomainOwnership),
|
|
377
|
+
/** Get a toplevel domain. */
|
|
378
|
+
serviceGetToplevelDomain: this.requestFunctionFactory(descriptors.domainServiceGetToplevelDomain),
|
|
379
|
+
/** List all domain ownerships of a project. */
|
|
380
|
+
serviceListDomainOwnerships: this.requestFunctionFactory(descriptors.domainServiceListDomainOwnerships),
|
|
381
|
+
/** List Domains belonging to a Project. */
|
|
382
|
+
serviceListDomains: this.requestFunctionFactory(descriptors.domainServiceListDomains),
|
|
383
|
+
/** List all supported toplevel domains. */
|
|
384
|
+
serviceListToplevelDomains: this.requestFunctionFactory(descriptors.domainServiceListToplevelDomains),
|
|
385
|
+
/** Resend a domain email. */
|
|
386
|
+
serviceResendDomainEmail: this.requestFunctionFactory(descriptors.domainServiceResendDomainEmail),
|
|
387
|
+
/** Create an Ingress. */
|
|
388
|
+
ingressServiceCreate: this.requestFunctionFactory(descriptors.ingressServiceCreate),
|
|
389
|
+
/** Get an Ingress. */
|
|
390
|
+
ingressServiceGetSpecific: this.requestFunctionFactory(descriptors.ingressServiceGetSpecific),
|
|
391
|
+
/** Delete an Ingress. */
|
|
392
|
+
ingressServiceDelete: this.requestFunctionFactory(descriptors.ingressServiceDelete),
|
|
393
|
+
/** List Ingresses the user has access to. */
|
|
394
|
+
ingressServiceListAccessible: this.requestFunctionFactory(descriptors.ingressServiceListAccessible),
|
|
395
|
+
/** List Ingresses belonging to a project. */
|
|
396
|
+
ingressServiceListForProject: this.requestFunctionFactory(descriptors.ingressServiceListForProject),
|
|
397
|
+
/** Update an Ingresses paths. */
|
|
398
|
+
ingressServicePaths: this.requestFunctionFactory(descriptors.ingressServicePaths),
|
|
399
|
+
/** Update an Ingresses tls settings. */
|
|
400
|
+
ingressServiceTls: this.requestFunctionFactory(descriptors.ingressServiceTls),
|
|
401
|
+
};
|
|
402
|
+
/** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
|
|
403
|
+
file = {
|
|
404
|
+
/** Create a File. */
|
|
405
|
+
createFile: this.requestFunctionFactory(descriptors.fileCreateFile),
|
|
406
|
+
/** Get a File's meta. */
|
|
407
|
+
getFileMeta: this.requestFunctionFactory(descriptors.fileGetFileMeta),
|
|
408
|
+
/** Get a Token's upload rules. */
|
|
409
|
+
getFileTokenRules: this.requestFunctionFactory(descriptors.fileGetFileTokenRules),
|
|
410
|
+
/** Get a Type's upload rules. */
|
|
411
|
+
getFileTypeRules: this.requestFunctionFactory(descriptors.fileGetFileTypeRules),
|
|
412
|
+
/** Get a File. */
|
|
413
|
+
getFile: this.requestFunctionFactory(descriptors.fileGetFile),
|
|
414
|
+
};
|
|
415
|
+
/** The mail API allows you to manage your mail accounts. */
|
|
416
|
+
mail = {
|
|
417
|
+
/** Get all deliveryboxes by project ID */
|
|
418
|
+
serviceDeliveryboxList: this.requestFunctionFactory(descriptors.mailServiceDeliveryboxList),
|
|
419
|
+
/** Create a new deliverybox */
|
|
420
|
+
serviceDeliveryboxCreate: this.requestFunctionFactory(descriptors.mailServiceDeliveryboxCreate),
|
|
421
|
+
/** Get a specific deliverybox */
|
|
422
|
+
serviceDeliveryboxGetSpecific: this.requestFunctionFactory(descriptors.mailServiceDeliveryboxGetSpecific),
|
|
423
|
+
/** Delete a specific deliverybox */
|
|
424
|
+
serviceDeliveryboxDelete: this.requestFunctionFactory(descriptors.mailServiceDeliveryboxDelete),
|
|
425
|
+
/** Update the description of an deliverybox */
|
|
426
|
+
serviceDeliveryboxUpdateDescription: this.requestFunctionFactory(descriptors.mailServiceDeliveryboxUpdateDescription),
|
|
427
|
+
/** Update the password for a specific deliverybox */
|
|
428
|
+
serviceDeliveryboxUpdatePassword: this.requestFunctionFactory(descriptors.mailServiceDeliveryboxUpdatePassword),
|
|
429
|
+
/** Get all mail addresses for a project ID */
|
|
430
|
+
serviceMailaddressList: this.requestFunctionFactory(descriptors.mailServiceMailaddressList),
|
|
431
|
+
/** Create a new mail address */
|
|
432
|
+
serviceMailaddressCreate: this.requestFunctionFactory(descriptors.mailServiceMailaddressCreate),
|
|
433
|
+
/** Get a specific mail address */
|
|
434
|
+
serviceMailaddressGetSpecific: this.requestFunctionFactory(descriptors.mailServiceMailaddressGetSpecific),
|
|
435
|
+
/** Delete a specific mail address */
|
|
436
|
+
serviceMailaddressDelete: this.requestFunctionFactory(descriptors.mailServiceMailaddressDelete),
|
|
437
|
+
/** Update mail-address */
|
|
438
|
+
serviceMailaddressUpdateAddress: this.requestFunctionFactory(descriptors.mailServiceMailaddressUpdateAddress),
|
|
439
|
+
/** Update the auto responder of a mail address */
|
|
440
|
+
serviceMailaddressUpdateAutoresponder: this.requestFunctionFactory(descriptors.mailServiceMailaddressUpdateAutoresponder),
|
|
441
|
+
/** Enable or disable the catchAll flag for a specific mail address */
|
|
442
|
+
serviceMailaddressUpdateCatchall: this.requestFunctionFactory(descriptors.mailServiceMailaddressUpdateCatchall),
|
|
443
|
+
/** Update the addresses an email is forwarded to */
|
|
444
|
+
serviceMailaddressUpdateForwardaddresses: this.requestFunctionFactory(descriptors.mailServiceMailaddressUpdateForwardaddresses),
|
|
445
|
+
/** Update the password for a specific mail address */
|
|
446
|
+
serviceMailaddressUpdatePassword: this.requestFunctionFactory(descriptors.mailServiceMailaddressUpdatePassword),
|
|
447
|
+
/** Update the quota of a mailbox */
|
|
448
|
+
serviceMailaddressUpdateQuota: this.requestFunctionFactory(descriptors.mailServiceMailaddressUpdateQuota),
|
|
449
|
+
/** Update the spamprotection of a mailbox */
|
|
450
|
+
serviceMailaddressUpdateSpamprotection: this.requestFunctionFactory(descriptors.mailServiceMailaddressUpdateSpamprotection),
|
|
451
|
+
/** Get settings for a given project ID */
|
|
452
|
+
serviceProjectsettingGetSpecific: this.requestFunctionFactory(descriptors.mailServiceProjectsettingGetSpecific),
|
|
453
|
+
/** Update blacklist for a given project ID */
|
|
454
|
+
serviceProjectsettingUpdateBlacklist: this.requestFunctionFactory(descriptors.mailServiceProjectsettingUpdateBlacklist),
|
|
455
|
+
/** Update whitelist for a given project ID */
|
|
456
|
+
serviceProjectsettingUpdateWhitelist: this.requestFunctionFactory(descriptors.mailServiceProjectsettingUpdateWhitelist),
|
|
457
|
+
};
|
|
458
|
+
/** The notification API allows you to manage your notifications. */
|
|
459
|
+
notification = {
|
|
460
|
+
/** getting the subscription status of the subscription */
|
|
461
|
+
newsletterGetInfo: this.requestFunctionFactory(descriptors.newsletterGetInfo),
|
|
462
|
+
/** unsubscribe a user from the mStudio newsletter */
|
|
463
|
+
newsletterUnsubscribeUser: this.requestFunctionFactory(descriptors.newsletterUnsubscribeUser),
|
|
464
|
+
/** subscribe a user to the mStudio newsletter */
|
|
465
|
+
newsletterSubscribeUser: this.requestFunctionFactory(descriptors.newsletterSubscribeUser),
|
|
466
|
+
/** Get the counts for unread notifications of the user. */
|
|
467
|
+
scountUnreadNotifications: this.requestFunctionFactory(descriptors.notificationsCountUnreadNotifications),
|
|
468
|
+
/** List all unread notifications */
|
|
469
|
+
slistNotifications: this.requestFunctionFactory(descriptors.notificationsListNotifications),
|
|
470
|
+
/** Mark all notifications as read. */
|
|
471
|
+
sreadAllNotifications: this.requestFunctionFactory(descriptors.notificationsReadAllNotifications),
|
|
472
|
+
/** Mark notification as read. */
|
|
473
|
+
sreadNotification: this.requestFunctionFactory(descriptors.notificationsReadNotification),
|
|
474
|
+
};
|
|
475
|
+
/** The project API allows you to manage your projects, and also any kinds of user memberships concerning these projects. */
|
|
476
|
+
project = {
|
|
477
|
+
/** Accept a ProjectInvite. */
|
|
478
|
+
acceptProjectInvite: this.requestFunctionFactory(descriptors.projectAcceptProjectInvite),
|
|
479
|
+
/** Create a ProjectInvite. */
|
|
480
|
+
createProjectInvite: this.requestFunctionFactory(descriptors.projectCreateProjectInvite),
|
|
481
|
+
/** Create a Project belonging to a Server. */
|
|
482
|
+
createProject: this.requestFunctionFactory(descriptors.projectCreateProject),
|
|
483
|
+
/** Decline a ProjectInvite. */
|
|
484
|
+
declineProjectInvite: this.requestFunctionFactory(descriptors.projectDeclineProjectInvite),
|
|
485
|
+
/** Request a Project avatar upload. */
|
|
486
|
+
requestProjectAvatarUpload: this.requestFunctionFactory(descriptors.projectRequestProjectAvatarUpload),
|
|
487
|
+
/** Delete a Project's avatar. */
|
|
488
|
+
deleteProjectAvatar: this.requestFunctionFactory(descriptors.projectDeleteProjectAvatar),
|
|
489
|
+
/** Get a ProjectInvite. */
|
|
490
|
+
getProjectInvite: this.requestFunctionFactory(descriptors.projectGetProjectInvite),
|
|
491
|
+
/** Delete a ProjectInvite. */
|
|
492
|
+
deleteProjectInvite: this.requestFunctionFactory(descriptors.projectDeleteProjectInvite),
|
|
493
|
+
/** Get a ProjectMembership */
|
|
494
|
+
getProjectMembership: this.requestFunctionFactory(descriptors.projectGetProjectMembership),
|
|
495
|
+
/** Delete a ProjectMembership. */
|
|
496
|
+
deleteProjectMembership: this.requestFunctionFactory(descriptors.projectDeleteProjectMembership),
|
|
497
|
+
/** Update a ProjectMembership. */
|
|
498
|
+
updateProjectMembership: this.requestFunctionFactory(descriptors.projectUpdateProjectMembership),
|
|
499
|
+
/** Delete a Project. */
|
|
500
|
+
deleteProject: this.requestFunctionFactory(descriptors.projectDeleteProject),
|
|
501
|
+
/** Request a Server avatar upload. */
|
|
502
|
+
requestServerAvatarUpload: this.requestFunctionFactory(descriptors.projectRequestServerAvatarUpload),
|
|
503
|
+
/** Delete a Server's avatar. */
|
|
504
|
+
deleteServerAvatar: this.requestFunctionFactory(descriptors.projectDeleteServerAvatar),
|
|
505
|
+
/** Get a ProjectInvite by token. */
|
|
506
|
+
getProjectTokenInvite: this.requestFunctionFactory(descriptors.projectGetProjectTokenInvite),
|
|
507
|
+
/** Get a Project. */
|
|
508
|
+
getProject: this.requestFunctionFactory(descriptors.projectGetProject),
|
|
509
|
+
/** Get the executing user's membership in a Project. */
|
|
510
|
+
getSelfMembershipForProject: this.requestFunctionFactory(descriptors.projectGetSelfMembershipForProject),
|
|
511
|
+
/** Get a Server. */
|
|
512
|
+
getServer: this.requestFunctionFactory(descriptors.projectGetServer),
|
|
513
|
+
/** Leave a Project. */
|
|
514
|
+
leaveProject: this.requestFunctionFactory(descriptors.projectLeaveProject),
|
|
515
|
+
/** List all invites belonging to a Project. */
|
|
516
|
+
listInvitesForProject: this.requestFunctionFactory(descriptors.projectListInvitesForProject),
|
|
517
|
+
/** List all memberships for a Project. */
|
|
518
|
+
listMembershipsForProject: this.requestFunctionFactory(descriptors.projectListMembershipsForProject),
|
|
519
|
+
/** List all ProjectInvites for the executing user. */
|
|
520
|
+
listProjectInvites: this.requestFunctionFactory(descriptors.projectListProjectInvites),
|
|
521
|
+
/** List ProjectMemberships belonging to the executing user. */
|
|
522
|
+
listProjectMemberships: this.requestFunctionFactory(descriptors.projectListProjectMemberships),
|
|
523
|
+
/** List Project's for an Organization or Server. */
|
|
524
|
+
listProjects: this.requestFunctionFactory(descriptors.projectListProjects),
|
|
525
|
+
/** List Servers for an Organization or User. */
|
|
526
|
+
listServers: this.requestFunctionFactory(descriptors.projectListServers),
|
|
527
|
+
/** Resend the mail for a ProjectInvite. */
|
|
528
|
+
resendProjectInviteMail: this.requestFunctionFactory(descriptors.projectResendProjectInviteMail),
|
|
529
|
+
/** Update a Project's description. */
|
|
530
|
+
updateProjectDescription: this.requestFunctionFactory(descriptors.projectUpdateProjectDescription),
|
|
531
|
+
/** Update a Servers's description. */
|
|
532
|
+
updateServerDescription: this.requestFunctionFactory(descriptors.projectUpdateServerDescription),
|
|
533
|
+
};
|
|
534
|
+
/** The filesystem API allows you to directly access the filesystem of your project. */
|
|
535
|
+
projectFileSystem = {
|
|
536
|
+
/** List the directories of a Project. */
|
|
537
|
+
getDirectories: this.requestFunctionFactory(descriptors.projectFileSystemGetDirectories),
|
|
538
|
+
/** Get a Project directory filesystem usage. */
|
|
539
|
+
getDiskUsage: this.requestFunctionFactory(descriptors.projectFileSystemGetDiskUsage),
|
|
540
|
+
/** Get a Project file's content. */
|
|
541
|
+
getFileContent: this.requestFunctionFactory(descriptors.projectFileSystemGetFileContent),
|
|
542
|
+
/** Get a Project's file/filesystem authorization token. */
|
|
543
|
+
getJwt: this.requestFunctionFactory(descriptors.projectFileSystemGetJwt),
|
|
544
|
+
/** Get a Project file's information. */
|
|
545
|
+
listFiles: this.requestFunctionFactory(descriptors.projectFileSystemListFiles),
|
|
546
|
+
};
|
|
547
|
+
/** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
|
|
548
|
+
sshsftpUser = {
|
|
549
|
+
/** Create an SFTPUser for a Project. */
|
|
550
|
+
sftpUserCreateSftpUser: this.requestFunctionFactory(descriptors.sftpUserCreateSftpUser),
|
|
551
|
+
/** Get an SFTPUser. */
|
|
552
|
+
sftpUserGetSftpUser: this.requestFunctionFactory(descriptors.sftpUserGetSftpUser),
|
|
553
|
+
/** Delete an SFTPUser. */
|
|
554
|
+
sftpUserDeleteSftpUser: this.requestFunctionFactory(descriptors.sftpUserDeleteSftpUser),
|
|
555
|
+
/** Update an SFTPUser. */
|
|
556
|
+
sftpUserUpdateSftpUser: this.requestFunctionFactory(descriptors.sftpUserUpdateSftpUser),
|
|
557
|
+
/** Get all SFTPUsers for a Project. */
|
|
558
|
+
sftpUserListSftpUsers: this.requestFunctionFactory(descriptors.sftpUserListSftpUsers),
|
|
559
|
+
/** Get all SSHUsers for a Project. */
|
|
560
|
+
sshUserListSshUsers: this.requestFunctionFactory(descriptors.sshUserListSshUsers),
|
|
561
|
+
/** Create an SSHUser for a Project. */
|
|
562
|
+
sshUserCreateSshUser: this.requestFunctionFactory(descriptors.sshUserCreateSshUser),
|
|
563
|
+
/** Get an SSHUser. */
|
|
564
|
+
sshUserGetSshUser: this.requestFunctionFactory(descriptors.sshUserGetSshUser),
|
|
565
|
+
/** Delete an SSHUser. */
|
|
566
|
+
sshUserDeleteSshUser: this.requestFunctionFactory(descriptors.sshUserDeleteSshUser),
|
|
567
|
+
/** Update an SSHUser. */
|
|
568
|
+
sshUserUpdateSshUser: this.requestFunctionFactory(descriptors.sshUserUpdateSshUser),
|
|
569
|
+
};
|
|
570
|
+
/** The user API allows you to manage your own user and access information of other users that might be visible to you. */
|
|
571
|
+
user = {
|
|
572
|
+
/** List all ApiTokens of the user */
|
|
573
|
+
signupApiApiTokenList: this.requestFunctionFactory(descriptors.signupApiApiTokenList),
|
|
574
|
+
/** Store a new ApiToken */
|
|
575
|
+
signupApiApiTokenCreate: this.requestFunctionFactory(descriptors.signupApiApiTokenCreate),
|
|
576
|
+
/** Get a specific ApiToken */
|
|
577
|
+
signupApiApiTokenGet: this.requestFunctionFactory(descriptors.signupApiApiTokenGet),
|
|
578
|
+
/** Update an existing `ApiToken` */
|
|
579
|
+
signupApiApiTokenEdit: this.requestFunctionFactory(descriptors.signupApiApiTokenEdit),
|
|
580
|
+
/** Deletes an ApiToken */
|
|
581
|
+
signupApiApiTokenDelete: this.requestFunctionFactory(descriptors.signupApiApiTokenDelete),
|
|
582
|
+
/** Authenticate yourself to get an access token. */
|
|
583
|
+
signupApiAuthenticate: this.requestFunctionFactory(descriptors.signupApiAuthenticate),
|
|
584
|
+
/** Authenticate yourself against your legacy account to migrate it with the '/registration'-Route */
|
|
585
|
+
signupApiAuthenticateLegacy: this.requestFunctionFactory(descriptors.signupApiAuthenticateLegacy),
|
|
586
|
+
/** Validate your second factor. */
|
|
587
|
+
signupApiAuthenticateMfa: this.requestFunctionFactory(descriptors.signupApiAuthenticateMfa),
|
|
588
|
+
/** Request a new avatar upload */
|
|
589
|
+
signupApiAvatarRequestUpload: this.requestFunctionFactory(descriptors.signupApiAvatarRequestUpload),
|
|
590
|
+
/** Remove avatar */
|
|
591
|
+
signupApiAvatarRemove: this.requestFunctionFactory(descriptors.signupApiAvatarRemove),
|
|
592
|
+
/** Get your primary verified email address */
|
|
593
|
+
signupApiEmailGet: this.requestFunctionFactory(descriptors.signupApiEmailGet),
|
|
594
|
+
/** Change your email */
|
|
595
|
+
signupApiEmailChange: this.requestFunctionFactory(descriptors.signupApiEmailChange),
|
|
596
|
+
/** Resend the email address verification email */
|
|
597
|
+
signupApiEmailResend: this.requestFunctionFactory(descriptors.signupApiEmailResend),
|
|
598
|
+
/** Verify an added email address */
|
|
599
|
+
signupApiEmailVerify: this.requestFunctionFactory(descriptors.signupApiEmailVerify),
|
|
600
|
+
/** Terminate session and invalidate access token */
|
|
601
|
+
signupApiLogout: this.requestFunctionFactory(descriptors.signupApiLogout),
|
|
602
|
+
/** Confirm Multi Factor Authentication */
|
|
603
|
+
signupApiMfaConfirm: this.requestFunctionFactory(descriptors.signupApiMfaConfirm),
|
|
604
|
+
/** Get your current multi factor auth status */
|
|
605
|
+
signupApiMfaGetStatus: this.requestFunctionFactory(descriptors.signupApiMfaGetStatus),
|
|
606
|
+
/** Initialize Multi Factor Authentication. If successfull, it needs to be confirmed, before usage of mfa. */
|
|
607
|
+
signupApiMfaInit: this.requestFunctionFactory(descriptors.signupApiMfaInit),
|
|
608
|
+
/** Disable Multi Factor Authentication. */
|
|
609
|
+
signupApiMfaDisable: this.requestFunctionFactory(descriptors.signupApiMfaDisable),
|
|
610
|
+
/** Get timestamp of your latest password change */
|
|
611
|
+
signupApiPasswordGetUpdatedAt: this.requestFunctionFactory(descriptors.signupApiPasswordGetUpdatedAt),
|
|
612
|
+
/** Change your password */
|
|
613
|
+
signupApiPasswordChange: this.requestFunctionFactory(descriptors.signupApiPasswordChange),
|
|
614
|
+
/** Confirm password reset */
|
|
615
|
+
signupApiPasswordResetConfirm: this.requestFunctionFactory(descriptors.signupApiPasswordResetConfirm),
|
|
616
|
+
/** Initialize password reset process */
|
|
617
|
+
signupApiPasswordResetInit: this.requestFunctionFactory(descriptors.signupApiPasswordResetInit),
|
|
618
|
+
/** Get current phone number */
|
|
619
|
+
signupApiPhoneNumberGet: this.requestFunctionFactory(descriptors.signupApiPhoneNumberGet),
|
|
620
|
+
/** Initialize phone number process */
|
|
621
|
+
signupApiPhoneNumberInitProcess: this.requestFunctionFactory(descriptors.signupApiPhoneNumberInitProcess),
|
|
622
|
+
/** Deletes phone number */
|
|
623
|
+
signupApiPhoneNumberDelete: this.requestFunctionFactory(descriptors.signupApiPhoneNumberDelete),
|
|
624
|
+
/** Initialize phone number process */
|
|
625
|
+
signupApiPhoneNumberVerify: this.requestFunctionFactory(descriptors.signupApiPhoneNumberVerify),
|
|
626
|
+
/** Get your profile information */
|
|
627
|
+
signupApiProfileGet: this.requestFunctionFactory(descriptors.signupApiProfileGet),
|
|
628
|
+
/** Change your profile information */
|
|
629
|
+
signupApiProfileChange: this.requestFunctionFactory(descriptors.signupApiProfileChange),
|
|
630
|
+
/** Delete your profile and all your personal data */
|
|
631
|
+
signupApiProfileDelete: this.requestFunctionFactory(descriptors.signupApiProfileDelete),
|
|
632
|
+
/** Reset Recovery-Codes for MFA */
|
|
633
|
+
signupApiRecoverycodesReset: this.requestFunctionFactory(descriptors.signupApiRecoverycodesReset),
|
|
634
|
+
/** Register with email and password.
|
|
635
|
+
*/
|
|
636
|
+
signupApiRegister: this.requestFunctionFactory(descriptors.signupApiRegister),
|
|
637
|
+
/** Verify your registration */
|
|
638
|
+
signupApiRegistrationVerify: this.requestFunctionFactory(descriptors.signupApiRegistrationVerify),
|
|
639
|
+
/** Get a specific session of an authorized user */
|
|
640
|
+
signupApiSessionGet: this.requestFunctionFactory(descriptors.signupApiSessionGet),
|
|
641
|
+
/** Terminate a specific session of an authorized user */
|
|
642
|
+
signupApiSessionTerminate: this.requestFunctionFactory(descriptors.signupApiSessionTerminate),
|
|
643
|
+
/** List all active sessions of authorized user */
|
|
644
|
+
signupApiSessionsList: this.requestFunctionFactory(descriptors.signupApiSessionsList),
|
|
645
|
+
/** Terminate all session of an authorized user, except his current session */
|
|
646
|
+
signupApiSessionsTerminateAll: this.requestFunctionFactory(descriptors.signupApiSessionsTerminateAll),
|
|
647
|
+
/** Get your stored ssh keys */
|
|
648
|
+
signupApiSshList: this.requestFunctionFactory(descriptors.signupApiSshList),
|
|
649
|
+
/** Store a new SSH key */
|
|
650
|
+
signupApiSshCreate: this.requestFunctionFactory(descriptors.signupApiSshCreate),
|
|
651
|
+
/** Get your stored ssh keys */
|
|
652
|
+
signupApiSshGet: this.requestFunctionFactory(descriptors.signupApiSshGet),
|
|
653
|
+
/** Edit an existing SSH key */
|
|
654
|
+
signupApiSshEdit: this.requestFunctionFactory(descriptors.signupApiSshEdit),
|
|
655
|
+
/** Remove an existing SSH Key */
|
|
656
|
+
signupApiSshDelete: this.requestFunctionFactory(descriptors.signupApiSshDelete),
|
|
657
|
+
/** request a support code */
|
|
658
|
+
signupApiSupportCodeRequest: this.requestFunctionFactory(descriptors.signupApiSupportCodeRequest),
|
|
659
|
+
/** Check, if the current access token is valid */
|
|
660
|
+
signupApiTokenCheck: this.requestFunctionFactory(descriptors.signupApiTokenCheck),
|
|
661
|
+
/** Request a new avatar upload */
|
|
662
|
+
serviceAvatarRequestUpload: this.requestFunctionFactory(descriptors.userServiceAvatarRequestUpload),
|
|
663
|
+
/** Remove avatar */
|
|
664
|
+
serviceAvatarRemove: this.requestFunctionFactory(descriptors.userServiceAvatarRemove),
|
|
665
|
+
/** Returns your given feedback. */
|
|
666
|
+
serviceFeedbackList: this.requestFunctionFactory(descriptors.userServiceFeedbackList),
|
|
667
|
+
/** */
|
|
668
|
+
serviceFeedbackCreate: this.requestFunctionFactory(descriptors.userServiceFeedbackCreate),
|
|
669
|
+
/** create a new issue */
|
|
670
|
+
serviceIssueNew: this.requestFunctionFactory(descriptors.userServiceIssueNew),
|
|
671
|
+
/** Get profile information for the specified user */
|
|
672
|
+
serviceUserGet: this.requestFunctionFactory(descriptors.userServiceUserGet),
|
|
673
|
+
/** Change your personal information */
|
|
674
|
+
servicePersonalInformationUpdate: this.requestFunctionFactory(descriptors.userServicePersonalInformationUpdate),
|
|
675
|
+
/** Get personalized settings for the specified user */
|
|
676
|
+
servicePersonalizedSettingsGet: this.requestFunctionFactory(descriptors.userServicePersonalizedSettingsGet),
|
|
677
|
+
/** update personalized settings */
|
|
678
|
+
servicePersonalizedSettingsUpdate: this.requestFunctionFactory(descriptors.userServicePersonalizedSettingsUpdate),
|
|
679
|
+
/** Add phone number and init verification process */
|
|
680
|
+
servicePhoneNumberAdd: this.requestFunctionFactory(descriptors.userServicePhoneNumberAdd),
|
|
681
|
+
/** Deletes phone number */
|
|
682
|
+
servicePhoneNumberRemove: this.requestFunctionFactory(descriptors.userServicePhoneNumberRemove),
|
|
683
|
+
/** Verify phone number */
|
|
684
|
+
servicePhoneNumberVerify: this.requestFunctionFactory(descriptors.userServicePhoneNumberVerify),
|
|
685
|
+
/** Get profile information for the specified user */
|
|
686
|
+
serviceUserGetOwn: this.requestFunctionFactory(descriptors.userServiceUserGetOwn),
|
|
687
|
+
};
|
|
688
|
+
/** The varnish API allows you to manage your varnish caches. */
|
|
689
|
+
varnish = {
|
|
690
|
+
/** List all available validators. */
|
|
691
|
+
serviceListValidators: this.requestFunctionFactory(descriptors.varnishServiceListValidators),
|
|
692
|
+
/** validate a set of config files with a named validator against a specific version */
|
|
693
|
+
serviceValidate: this.requestFunctionFactory(descriptors.varnishServiceValidate),
|
|
694
|
+
};
|
|
695
|
+
}
|
|
696
|
+
export default MittwaldAPIV2Client;
|