@mittwald/api-client 4.404.0 → 4.405.1
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 +29 -0
- package/dist/esm/generated/v3-next/client-react.js +559 -0
- package/dist/esm/generated/v3-next/client.js +1026 -0
- package/dist/esm/generated/v3-next/descriptors.js +2838 -0
- package/dist/esm/generated/v3-next/types.js +1 -0
- package/dist/esm/v2/index.js +2 -0
- package/dist/esm/v3-next/default.js +38 -0
- package/dist/esm/v3-next/index.js +2 -0
- package/dist/esm/v3-next/react.js +3 -0
- package/dist/esm/version.js +1 -1
- package/dist/types/generated/v2/client-react.d.ts +1 -0
- package/dist/types/generated/v2/client.d.ts +2 -0
- package/dist/types/generated/v2/types.d.ts +1 -0
- package/dist/types/generated/v3-next/client-react.d.ts +3789 -0
- package/dist/types/generated/v3-next/client.d.ts +31303 -0
- package/dist/types/generated/v3-next/descriptors.d.ts +951 -0
- package/dist/types/generated/v3-next/types.d.ts +31466 -0
- package/dist/types/v2/index.d.ts +3 -0
- package/dist/types/v3-next/default.d.ts +12 -0
- package/dist/types/v3-next/index.d.ts +3 -0
- package/dist/types/v3-next/react.d.ts +3 -0
- package/dist/types/version.d.ts +1 -1
- package/package.json +35 -9
|
@@ -0,0 +1,1026 @@
|
|
|
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 MittwaldAPIV3NextClient extends ApiClientBase {
|
|
7
|
+
/** The AI hosting provides access to multiple large language and embedding models – GDPR compliant and hosted in Germany. */
|
|
8
|
+
aiHosting = {
|
|
9
|
+
/** Accepts the model terms for a customer. */
|
|
10
|
+
customerAcceptModelTerms: this.requestFunctionFactory(descriptors.aiHostingCustomerAcceptModelTerms),
|
|
11
|
+
/** Get a list of already created keys. */
|
|
12
|
+
customerGetKeys: this.requestFunctionFactory(descriptors.aiHostingCustomerGetKeys),
|
|
13
|
+
/** Creates a new key. */
|
|
14
|
+
customerCreateKey: this.requestFunctionFactory(descriptors.aiHostingCustomerCreateKey),
|
|
15
|
+
/** Get a key of a customer. */
|
|
16
|
+
customerGetKey: this.requestFunctionFactory(descriptors.aiHostingCustomerGetKey),
|
|
17
|
+
/** Update a key for a customer. */
|
|
18
|
+
customerUpdateKey: this.requestFunctionFactory(descriptors.aiHostingCustomerUpdateKey),
|
|
19
|
+
/** Delete a key for a customer. */
|
|
20
|
+
customerDeleteKey: this.requestFunctionFactory(descriptors.aiHostingCustomerDeleteKey),
|
|
21
|
+
/** Get a list of currently active models. */
|
|
22
|
+
customerGetDetailedModels: this.requestFunctionFactory(descriptors.aiHostingCustomerGetDetailedModels),
|
|
23
|
+
/** Get ai hosting plan and usages of a customer. */
|
|
24
|
+
customerGetUsage: this.requestFunctionFactory(descriptors.aiHostingCustomerGetUsage),
|
|
25
|
+
/** Get a list of currently active models. */
|
|
26
|
+
getModels: this.requestFunctionFactory(descriptors.aiHostingGetModels),
|
|
27
|
+
/** Get a list of keys of a project. */
|
|
28
|
+
projectGetKeys: this.requestFunctionFactory(descriptors.aiHostingProjectGetKeys),
|
|
29
|
+
/** Creates a new key for a project. */
|
|
30
|
+
projectCreateKey: this.requestFunctionFactory(descriptors.aiHostingProjectCreateKey),
|
|
31
|
+
/** Get a key of a project. */
|
|
32
|
+
projectGetKey: this.requestFunctionFactory(descriptors.aiHostingProjectGetKey),
|
|
33
|
+
/** Update a key for a project. */
|
|
34
|
+
projectUpdateKey: this.requestFunctionFactory(descriptors.aiHostingProjectUpdateKey),
|
|
35
|
+
/** Delete a key for a project. */
|
|
36
|
+
projectDeleteKey: this.requestFunctionFactory(descriptors.aiHostingProjectDeleteKey),
|
|
37
|
+
/** Get a list of currently active models. */
|
|
38
|
+
projectGetDetailedModels: this.requestFunctionFactory(descriptors.aiHostingProjectGetDetailedModels),
|
|
39
|
+
/** Get ai hosting plan and usages of a project. Same as the customer route, but less details. */
|
|
40
|
+
projectGetUsage: this.requestFunctionFactory(descriptors.aiHostingProjectGetUsage),
|
|
41
|
+
/** Links a container with a project licence. */
|
|
42
|
+
projectLinkContainer: this.requestFunctionFactory(descriptors.aiHostingProjectLinkContainer),
|
|
43
|
+
};
|
|
44
|
+
/** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
|
|
45
|
+
app = {
|
|
46
|
+
/** Get an App. */
|
|
47
|
+
getApp: this.requestFunctionFactory(descriptors.appGetApp),
|
|
48
|
+
/** Get an AppInstallation. */
|
|
49
|
+
getAppinstallation: this.requestFunctionFactory(descriptors.appGetAppinstallation),
|
|
50
|
+
/** Trigger an uninstallation process for an AppInstallation. */
|
|
51
|
+
uninstallAppinstallation: this.requestFunctionFactory(descriptors.appUninstallAppinstallation),
|
|
52
|
+
/** Update properties belonging to an AppInstallation. */
|
|
53
|
+
patchAppinstallation: this.requestFunctionFactory(descriptors.appPatchAppinstallation),
|
|
54
|
+
/** Get an AppVersion. */
|
|
55
|
+
getAppversion: this.requestFunctionFactory(descriptors.appGetAppversion),
|
|
56
|
+
/** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
|
|
57
|
+
getInstalledSystemsoftwareForAppinstallation: this.requestFunctionFactory(descriptors.appGetInstalledSystemsoftwareForAppinstallation),
|
|
58
|
+
/** Get the missing requirements of an appInstallation for a specific target AppVersion. */
|
|
59
|
+
getMissingDependenciesForAppinstallation: this.requestFunctionFactory(descriptors.appGetMissingDependenciesForAppinstallation),
|
|
60
|
+
/** Get a SystemSoftware. */
|
|
61
|
+
getSystemsoftware: this.requestFunctionFactory(descriptors.appGetSystemsoftware),
|
|
62
|
+
/** Get a SystemSoftwareVersion. */
|
|
63
|
+
getSystemsoftwareversion: this.requestFunctionFactory(descriptors.appGetSystemsoftwareversion),
|
|
64
|
+
/** Create linkage between an AppInstallation and a MySQLDatabase. */
|
|
65
|
+
linkDatabase: this.requestFunctionFactory(descriptors.appLinkDatabase),
|
|
66
|
+
/** List AppInstallations that a user has access to. */
|
|
67
|
+
listAppinstallationsForUser: this.requestFunctionFactory(descriptors.appListAppinstallationsForUser),
|
|
68
|
+
/** List AppInstallations belonging to a Project. */
|
|
69
|
+
listAppinstallations: this.requestFunctionFactory(descriptors.appListAppinstallations),
|
|
70
|
+
/** Request an AppInstallation. */
|
|
71
|
+
requestAppinstallation: this.requestFunctionFactory(descriptors.appRequestAppinstallation),
|
|
72
|
+
/** List Apps. */
|
|
73
|
+
listApps: this.requestFunctionFactory(descriptors.appListApps),
|
|
74
|
+
/** List AppVersions belonging to an App. */
|
|
75
|
+
listAppversions: this.requestFunctionFactory(descriptors.appListAppversions),
|
|
76
|
+
/** List SystemSoftwares. */
|
|
77
|
+
listSystemsoftwares: this.requestFunctionFactory(descriptors.appListSystemsoftwares),
|
|
78
|
+
/** List SystemSoftwareVersions belonging to a SystemSoftware. */
|
|
79
|
+
listSystemsoftwareversions: this.requestFunctionFactory(descriptors.appListSystemsoftwareversions),
|
|
80
|
+
/** List update candidates belonging to an AppVersion. */
|
|
81
|
+
listUpdateCandidatesForAppversion: this.requestFunctionFactory(descriptors.appListUpdateCandidatesForAppversion),
|
|
82
|
+
/** Replace a MySQL Database with another MySQL Database. */
|
|
83
|
+
replaceDatabase: this.requestFunctionFactory(descriptors.appReplaceDatabase),
|
|
84
|
+
/** Request a copy of an AppInstallation. */
|
|
85
|
+
requestAppinstallationCopy: this.requestFunctionFactory(descriptors.appRequestAppinstallationCopy),
|
|
86
|
+
/** Get runtime status belonging to an AppInstallation. */
|
|
87
|
+
retrieveStatus: this.requestFunctionFactory(descriptors.appRetrieveStatus),
|
|
88
|
+
/** Remove linkage between an AppInstallation and a Database. */
|
|
89
|
+
unlinkDatabase: this.requestFunctionFactory(descriptors.appUnlinkDatabase),
|
|
90
|
+
/** Create linkage between an AppInstallation and DatabaseUsers. */
|
|
91
|
+
setDatabaseUsers: this.requestFunctionFactory(descriptors.appSetDatabaseUsers),
|
|
92
|
+
};
|
|
93
|
+
/** The article API allows you to read article information. */
|
|
94
|
+
article = {
|
|
95
|
+
/** Get an Article. */
|
|
96
|
+
getArticle: this.requestFunctionFactory(descriptors.articleGetArticle),
|
|
97
|
+
/** List Articles. */
|
|
98
|
+
listArticles: this.requestFunctionFactory(descriptors.articleListArticles),
|
|
99
|
+
};
|
|
100
|
+
/** The backup API allows you to manage your project backups. */
|
|
101
|
+
backup = {
|
|
102
|
+
/** Export a ProjectBackup for download. */
|
|
103
|
+
createProjectBackupExport: this.requestFunctionFactory(descriptors.backupCreateProjectBackupExport),
|
|
104
|
+
/** Delete a ProjectBackupExport. */
|
|
105
|
+
deleteProjectBackupExport: this.requestFunctionFactory(descriptors.backupDeleteProjectBackupExport),
|
|
106
|
+
/** List BackupSchedules belonging to a Project. */
|
|
107
|
+
listProjectBackupSchedules: this.requestFunctionFactory(descriptors.backupListProjectBackupSchedules),
|
|
108
|
+
/** Create a BackupSchedule for a Project. */
|
|
109
|
+
createProjectBackupSchedule: this.requestFunctionFactory(descriptors.backupCreateProjectBackupSchedule),
|
|
110
|
+
/** List Backups belonging to a Project. */
|
|
111
|
+
listProjectBackups: this.requestFunctionFactory(descriptors.backupListProjectBackups),
|
|
112
|
+
/** Create a Backup of a Project. */
|
|
113
|
+
createProjectBackup: this.requestFunctionFactory(descriptors.backupCreateProjectBackup),
|
|
114
|
+
/** Get a ProjectBackupSchedule. */
|
|
115
|
+
getProjectBackupSchedule: this.requestFunctionFactory(descriptors.backupGetProjectBackupSchedule),
|
|
116
|
+
/** Delete a ProjectBackupSchedule. */
|
|
117
|
+
deleteProjectBackupSchedule: this.requestFunctionFactory(descriptors.backupDeleteProjectBackupSchedule),
|
|
118
|
+
/** Update a ProjectBackupSchedule. */
|
|
119
|
+
updateProjectBackupSchedule: this.requestFunctionFactory(descriptors.backupUpdateProjectBackupSchedule),
|
|
120
|
+
/** Get a ProjectBackup. */
|
|
121
|
+
getProjectBackup: this.requestFunctionFactory(descriptors.backupGetProjectBackup),
|
|
122
|
+
/** Delete a ProjectBackup. */
|
|
123
|
+
deleteProjectBackup: this.requestFunctionFactory(descriptors.backupDeleteProjectBackup),
|
|
124
|
+
/** List database dump's for a ProjectBackup. */
|
|
125
|
+
getProjectBackupDatabaseDumps: this.requestFunctionFactory(descriptors.backupGetProjectBackupDatabaseDumps),
|
|
126
|
+
/** List paths for a ProjectBackup. */
|
|
127
|
+
getProjectBackupDirectories: this.requestFunctionFactory(descriptors.backupGetProjectBackupDirectories),
|
|
128
|
+
/** Update a Backup's expiration time. */
|
|
129
|
+
replaceProjectBackupExpirationTime: this.requestFunctionFactory(descriptors.backupReplaceProjectBackupExpirationTime),
|
|
130
|
+
/** Restore a ProjectBackup. */
|
|
131
|
+
requestProjectBackupRestore: this.requestFunctionFactory(descriptors.backupRequestProjectBackupRestore),
|
|
132
|
+
/** Change the description of a ProjectBackup. */
|
|
133
|
+
updateProjectBackupDescription: this.requestFunctionFactory(descriptors.backupUpdateProjectBackupDescription),
|
|
134
|
+
};
|
|
135
|
+
/** The container API allows you to manage your stacks, containers, volumes and registries. */
|
|
136
|
+
container = {
|
|
137
|
+
/** Call pull-image webhook */
|
|
138
|
+
callPullImageWebhookForService: this.requestFunctionFactory(descriptors.containerCallPullImageWebhookForService),
|
|
139
|
+
/** List Registries belonging to a Project. */
|
|
140
|
+
listRegistries: this.requestFunctionFactory(descriptors.containerListRegistries),
|
|
141
|
+
/** Create a Registry. */
|
|
142
|
+
createRegistry: this.requestFunctionFactory(descriptors.containerCreateRegistry),
|
|
143
|
+
/** List Stacks belonging to a Project. */
|
|
144
|
+
listStacks: this.requestFunctionFactory(descriptors.containerListStacks),
|
|
145
|
+
/** Create a Stack. */
|
|
146
|
+
createStack: this.requestFunctionFactory(descriptors.containerCreateStack),
|
|
147
|
+
/** Get a Stack. */
|
|
148
|
+
getStack: this.requestFunctionFactory(descriptors.containerGetStack),
|
|
149
|
+
/** Declaratively create, update or delete Services or Volumes belonging to a Stack. */
|
|
150
|
+
declareStack: this.requestFunctionFactory(descriptors.containerDeclareStack),
|
|
151
|
+
/** Delete a Stack. */
|
|
152
|
+
deleteStack: this.requestFunctionFactory(descriptors.containerDeleteStack),
|
|
153
|
+
/** Create, update or delete Services or Volumes belonging to a Stack. */
|
|
154
|
+
updateStack: this.requestFunctionFactory(descriptors.containerUpdateStack),
|
|
155
|
+
/** Get a Registry. */
|
|
156
|
+
getRegistry: this.requestFunctionFactory(descriptors.containerGetRegistry),
|
|
157
|
+
/** Delete a Registry. */
|
|
158
|
+
deleteRegistry: this.requestFunctionFactory(descriptors.containerDeleteRegistry),
|
|
159
|
+
/** Update a Registry. */
|
|
160
|
+
updateRegistry: this.requestFunctionFactory(descriptors.containerUpdateRegistry),
|
|
161
|
+
/** Get a Volume belonging to a Stack. */
|
|
162
|
+
getVolume: this.requestFunctionFactory(descriptors.containerGetVolume),
|
|
163
|
+
/** Delete a Volume belonging to a Stack. */
|
|
164
|
+
deleteVolume: this.requestFunctionFactory(descriptors.containerDeleteVolume),
|
|
165
|
+
/** Get a ContainerImageConfig. */
|
|
166
|
+
getContainerImageConfig: this.requestFunctionFactory(descriptors.containerGetContainerImageConfig),
|
|
167
|
+
/** Get logs belonging to a Service. */
|
|
168
|
+
getServiceLogs: this.requestFunctionFactory(descriptors.containerGetServiceLogs),
|
|
169
|
+
/** Get a Service belonging to a Stack. */
|
|
170
|
+
getService: this.requestFunctionFactory(descriptors.containerGetService),
|
|
171
|
+
/** Get a Container Template icon. */
|
|
172
|
+
getTemplateIcon: this.requestFunctionFactory(descriptors.containerGetTemplateIcon),
|
|
173
|
+
/** Get a Container Template by ID. */
|
|
174
|
+
getTemplate: this.requestFunctionFactory(descriptors.containerGetTemplate),
|
|
175
|
+
/** List Stacks belonging to the executing user. */
|
|
176
|
+
listSelfStacks: this.requestFunctionFactory(descriptors.containerListSelfStacks),
|
|
177
|
+
/** List Services belonging to a Project. */
|
|
178
|
+
listServices: this.requestFunctionFactory(descriptors.containerListServices),
|
|
179
|
+
/** List Volumes belonging to a Stack. */
|
|
180
|
+
listStackVolumes: this.requestFunctionFactory(descriptors.containerListStackVolumes),
|
|
181
|
+
/** List Container Templates. */
|
|
182
|
+
listTemplates: this.requestFunctionFactory(descriptors.containerListTemplates),
|
|
183
|
+
/** List Volumes belonging to a Project. */
|
|
184
|
+
listVolumes: this.requestFunctionFactory(descriptors.containerListVolumes),
|
|
185
|
+
/** Pull image and recreate */
|
|
186
|
+
pullImageForService: this.requestFunctionFactory(descriptors.containerPullImageForService),
|
|
187
|
+
/** Recreate a Service. */
|
|
188
|
+
recreateService: this.requestFunctionFactory(descriptors.containerRecreateService),
|
|
189
|
+
/** Restart a started Service. */
|
|
190
|
+
restartService: this.requestFunctionFactory(descriptors.containerRestartService),
|
|
191
|
+
/** Create or rotate pull-image webhook token */
|
|
192
|
+
rotatePullImageWebhookForService: this.requestFunctionFactory(descriptors.containerRotatePullImageWebhookForService),
|
|
193
|
+
/** Set an update schedule for a Stack. */
|
|
194
|
+
setStackUpdateSchedule: this.requestFunctionFactory(descriptors.containerSetStackUpdateSchedule),
|
|
195
|
+
/** Start a stopped Service. */
|
|
196
|
+
startService: this.requestFunctionFactory(descriptors.containerStartService),
|
|
197
|
+
/** Stop a started Service. */
|
|
198
|
+
stopService: this.requestFunctionFactory(descriptors.containerStopService),
|
|
199
|
+
};
|
|
200
|
+
/** The contract API allows you to manage your contracts and orders */
|
|
201
|
+
contract = {
|
|
202
|
+
/** Schedule the Termination of a ContractItem. */
|
|
203
|
+
terminateContractItem: this.requestFunctionFactory(descriptors.contractTerminateContractItem),
|
|
204
|
+
/** Cancel the Termination for the referred ContractItem. */
|
|
205
|
+
cancelContractItemTermination: this.requestFunctionFactory(descriptors.contractCancelContractItemTermination),
|
|
206
|
+
/** Cancel the TariffChange for the referred ContractItem. */
|
|
207
|
+
cancelContractTariffChange: this.requestFunctionFactory(descriptors.contractCancelContractTariffChange),
|
|
208
|
+
/** Schedule the Termination of a Contract. */
|
|
209
|
+
terminateContract: this.requestFunctionFactory(descriptors.contractTerminateContract),
|
|
210
|
+
/** Cancel the Termination for the referred Contract. */
|
|
211
|
+
cancelContractTermination: this.requestFunctionFactory(descriptors.contractCancelContractTermination),
|
|
212
|
+
/** Return the BaseItem of the Contract with the given ID. */
|
|
213
|
+
getBaseItemOfContract: this.requestFunctionFactory(descriptors.contractGetBaseItemOfContract),
|
|
214
|
+
/** Return the AI Hosting Contract for the given Customer. */
|
|
215
|
+
getDetailOfContractByAiHosting: this.requestFunctionFactory(descriptors.contractGetDetailOfContractByAiHosting),
|
|
216
|
+
/** Return the Contract for the given Certificate. */
|
|
217
|
+
getDetailOfContractByCertificate: this.requestFunctionFactory(descriptors.contractGetDetailOfContractByCertificate),
|
|
218
|
+
/** Return the Contract for the given Domain. */
|
|
219
|
+
getDetailOfContractByDomain: this.requestFunctionFactory(descriptors.contractGetDetailOfContractByDomain),
|
|
220
|
+
/** Return the Contract for the given LeadFyndrProfile. */
|
|
221
|
+
getDetailOfContractByLeadFyndr: this.requestFunctionFactory(descriptors.contractGetDetailOfContractByLeadFyndr),
|
|
222
|
+
/** Return the Contract for the given License. */
|
|
223
|
+
getDetailOfContractByLicense: this.requestFunctionFactory(descriptors.contractGetDetailOfContractByLicense),
|
|
224
|
+
/** Return the Contract for the given Mail Address. */
|
|
225
|
+
getDetailOfContractByMailAddress: this.requestFunctionFactory(descriptors.contractGetDetailOfContractByMailAddress),
|
|
226
|
+
/** Return the Contract for the given Project. */
|
|
227
|
+
getDetailOfContractByProject: this.requestFunctionFactory(descriptors.contractGetDetailOfContractByProject),
|
|
228
|
+
/** Return the Contract for the given Server. */
|
|
229
|
+
getDetailOfContractByServer: this.requestFunctionFactory(descriptors.contractGetDetailOfContractByServer),
|
|
230
|
+
/** Get the ContractItem with the given ID. */
|
|
231
|
+
getDetailOfContractItem: this.requestFunctionFactory(descriptors.contractGetDetailOfContractItem),
|
|
232
|
+
/** Returns the Contract with the given ID. */
|
|
233
|
+
getDetailOfContract: this.requestFunctionFactory(descriptors.contractGetDetailOfContract),
|
|
234
|
+
/** Return a list of Contracts for the given Customer. */
|
|
235
|
+
listContracts: this.requestFunctionFactory(descriptors.contractListContracts),
|
|
236
|
+
/** Get details of an Invoice. */
|
|
237
|
+
invoiceDetail: this.requestFunctionFactory(descriptors.invoiceDetail),
|
|
238
|
+
/** Get InvoiceSettings of a Customer. */
|
|
239
|
+
invoiceGetDetailOfInvoiceSettings: this.requestFunctionFactory(descriptors.invoiceGetDetailOfInvoiceSettings),
|
|
240
|
+
/** Update InvoiceSettings of a Customer. */
|
|
241
|
+
invoiceUpdateInvoiceSettings: this.requestFunctionFactory(descriptors.invoiceUpdateInvoiceSettings),
|
|
242
|
+
/** Request an Access Token for the Invoice file. */
|
|
243
|
+
invoiceGetFileAccessToken: this.requestFunctionFactory(descriptors.invoiceGetFileAccessToken),
|
|
244
|
+
/** List Invoices of a Customer. */
|
|
245
|
+
invoiceListCustomerInvoices: this.requestFunctionFactory(descriptors.invoiceListCustomerInvoices),
|
|
246
|
+
/** Get list of Orders. */
|
|
247
|
+
orderListOrders: this.requestFunctionFactory(descriptors.orderListOrders),
|
|
248
|
+
/** Create an Order. */
|
|
249
|
+
orderCreateOrder: this.requestFunctionFactory(descriptors.orderCreateOrder),
|
|
250
|
+
/** Create TariffChange Order. */
|
|
251
|
+
orderCreateTariffChange: this.requestFunctionFactory(descriptors.orderCreateTariffChange),
|
|
252
|
+
/** Get Order for Customer. */
|
|
253
|
+
orderGetOrder: this.requestFunctionFactory(descriptors.orderGetOrder),
|
|
254
|
+
/** Get list of Orders of a Customer. */
|
|
255
|
+
orderListCustomerOrders: this.requestFunctionFactory(descriptors.orderListCustomerOrders),
|
|
256
|
+
/** Get list of Orders of a Project. */
|
|
257
|
+
orderListProjectOrders: this.requestFunctionFactory(descriptors.orderListProjectOrders),
|
|
258
|
+
/** Preview Order. */
|
|
259
|
+
orderPreviewOrder: this.requestFunctionFactory(descriptors.orderPreviewOrder),
|
|
260
|
+
/** Preview TariffChange. */
|
|
261
|
+
orderPreviewTariffChange: this.requestFunctionFactory(descriptors.orderPreviewTariffChange),
|
|
262
|
+
};
|
|
263
|
+
/** The marketplace API allows you to manage extensions and more information regaring the marketplace. */
|
|
264
|
+
marketplace = {
|
|
265
|
+
/** Start the verification process of a contributor. */
|
|
266
|
+
contributorRequestVerification: this.requestFunctionFactory(descriptors.contributorRequestVerification),
|
|
267
|
+
/** Cancel the verification-process of a contributor. */
|
|
268
|
+
contributorCancelVerification: this.requestFunctionFactory(descriptors.contributorCancelVerification),
|
|
269
|
+
/** Get a Contributor. */
|
|
270
|
+
extensionGetContributor: this.requestFunctionFactory(descriptors.extensionGetContributor),
|
|
271
|
+
/** Delete a Contributor. */
|
|
272
|
+
contributorDeleteContributor: this.requestFunctionFactory(descriptors.contributorDeleteContributor),
|
|
273
|
+
/** Patch Contributor. */
|
|
274
|
+
contributorPatchContributor: this.requestFunctionFactory(descriptors.contributorPatchContributor),
|
|
275
|
+
/** Express interest to be a contributor. */
|
|
276
|
+
contributorExpressInterestToContribute: this.requestFunctionFactory(descriptors.contributorExpressInterestToContribute),
|
|
277
|
+
/** Get Contributor Billing Information. */
|
|
278
|
+
contributorGetBillingInformation: this.requestFunctionFactory(descriptors.contributorGetBillingInformation),
|
|
279
|
+
/** Update Contributor Billing Information. */
|
|
280
|
+
contributorUpdateBillingInformation: this.requestFunctionFactory(descriptors.contributorUpdateBillingInformation),
|
|
281
|
+
/** Get the Stripe Billing Portal Link for a Customer */
|
|
282
|
+
contributorGetCustomerBillingPortalLink: this.requestFunctionFactory(descriptors.contributorGetCustomerBillingPortalLink),
|
|
283
|
+
/** Get the Stripe Dashboard Link for a Contributor. */
|
|
284
|
+
contributorGetLoginLink: this.requestFunctionFactory(descriptors.contributorGetLoginLink),
|
|
285
|
+
/** List ContractPartners of the contributor. */
|
|
286
|
+
contributorListContractPartnersOfContributor: this.requestFunctionFactory(descriptors.contributorListContractPartnersOfContributor),
|
|
287
|
+
/** List incoming Invoices of a Contributor. */
|
|
288
|
+
contributorListIncomingInvoices: this.requestFunctionFactory(descriptors.contributorListIncomingInvoices),
|
|
289
|
+
/** List all invoices on behalf of a contributor. */
|
|
290
|
+
contributorListOnbehalfInvoices: this.requestFunctionFactory(descriptors.contributorListOnbehalfInvoices),
|
|
291
|
+
/** Request an Access Token for the Incoming Invoice file. */
|
|
292
|
+
contributorReceiptGetFileAccessToken: this.requestFunctionFactory(descriptors.contributorReceiptGetFileAccessToken),
|
|
293
|
+
/** Add a deviating avatar to a Contributor. */
|
|
294
|
+
contributorRequestDeviatingContributorAvatarUpload: this.requestFunctionFactory(descriptors.contributorRequestDeviatingContributorAvatarUpload),
|
|
295
|
+
/** Delete deviating contributor avatar und return to the inherited customer avatar. */
|
|
296
|
+
contributorResetContributorAvatar: this.requestFunctionFactory(descriptors.contributorResetContributorAvatar),
|
|
297
|
+
/** Rotate the secret for an extension instance. */
|
|
298
|
+
contributorRotateSecretForExtensionInstance: this.requestFunctionFactory(descriptors.contributorRotateSecretForExtensionInstance),
|
|
299
|
+
/** Authenticate your external application using the extensionInstanceSecret. */
|
|
300
|
+
extensionAuthenticateInstance: this.requestFunctionFactory(descriptors.extensionAuthenticateInstance),
|
|
301
|
+
/** Authenticate your external application using a session token and an extension secret */
|
|
302
|
+
extensionAuthenticateWithSessionToken: this.requestFunctionFactory(descriptors.extensionAuthenticateWithSessionToken),
|
|
303
|
+
/** Schedule an Extension Instance Termination for the next possible date. */
|
|
304
|
+
extensionScheduleExtensionTermination: this.requestFunctionFactory(descriptors.extensionScheduleExtensionTermination),
|
|
305
|
+
/** Cancel an Extension Instance Termination. */
|
|
306
|
+
extensionCancelExtensionTermination: this.requestFunctionFactory(descriptors.extensionCancelExtensionTermination),
|
|
307
|
+
/** Schedule an Extension Instance Variant change for the next possible date. */
|
|
308
|
+
extensionScheduleExtensionVariantChange: this.requestFunctionFactory(descriptors.extensionScheduleExtensionVariantChange),
|
|
309
|
+
/** Cancel an Extension Instance Variant Change. */
|
|
310
|
+
extensionCancelExtensionVariantChange: this.requestFunctionFactory(descriptors.extensionCancelExtensionVariantChange),
|
|
311
|
+
/** Change the context of an Extension. */
|
|
312
|
+
extensionChangeContext: this.requestFunctionFactory(descriptors.extensionChangeContext),
|
|
313
|
+
/** Check if an Extension is unchargable for this specific context or if it must be charged. */
|
|
314
|
+
extensionCheckExtensionIsChargable: this.requestFunctionFactory(descriptors.extensionCheckExtensionIsChargable),
|
|
315
|
+
/** Consent to extension scopes. */
|
|
316
|
+
extensionConsentToExtensionScopes: this.requestFunctionFactory(descriptors.extensionConsentToExtensionScopes),
|
|
317
|
+
/** Create the OnboardingProcess of a Contributor. */
|
|
318
|
+
extensionCreateContributorOnboardingProcess: this.requestFunctionFactory(descriptors.extensionCreateContributorOnboardingProcess),
|
|
319
|
+
/** List ExtensionInstances. */
|
|
320
|
+
extensionListExtensionInstances: this.requestFunctionFactory(descriptors.extensionListExtensionInstances),
|
|
321
|
+
/** Create an ExtensionInstance. */
|
|
322
|
+
extensionCreateExtensionInstance: this.requestFunctionFactory(descriptors.extensionCreateExtensionInstance),
|
|
323
|
+
/** Create an access token retrieval key for an extension instance. */
|
|
324
|
+
extensionCreateRetrievalKey: this.requestFunctionFactory(descriptors.extensionCreateRetrievalKey),
|
|
325
|
+
/** Get an ExtensionInstance. */
|
|
326
|
+
extensionGetExtensionInstance: this.requestFunctionFactory(descriptors.extensionGetExtensionInstance),
|
|
327
|
+
/** Delete a free ExtensionInstance. If the Extension is chargable the contract must be terminated instead. */
|
|
328
|
+
extensionDeleteExtensionInstance: this.requestFunctionFactory(descriptors.extensionDeleteExtensionInstance),
|
|
329
|
+
/** Get Extension of own contributor. */
|
|
330
|
+
extensionGetOwnExtension: this.requestFunctionFactory(descriptors.extensionGetOwnExtension),
|
|
331
|
+
/** Delete an Extension. */
|
|
332
|
+
extensionDeleteExtension: this.requestFunctionFactory(descriptors.extensionDeleteExtension),
|
|
333
|
+
/** Patch Extension. */
|
|
334
|
+
extensionPatchExtension: this.requestFunctionFactory(descriptors.extensionPatchExtension),
|
|
335
|
+
/** Disable an ExtensionInstance. */
|
|
336
|
+
extensionDisableExtensionInstance: this.requestFunctionFactory(descriptors.extensionDisableExtensionInstance),
|
|
337
|
+
/** Dry run a webhook with random or given values. */
|
|
338
|
+
extensionDryRunWebhook: this.requestFunctionFactory(descriptors.extensionDryRunWebhook),
|
|
339
|
+
/** Enable an ExtensionInstance. */
|
|
340
|
+
extensionEnableExtensionInstance: this.requestFunctionFactory(descriptors.extensionEnableExtensionInstance),
|
|
341
|
+
/** Generate an Extension secret for the given Extension. */
|
|
342
|
+
extensionGenerateExtensionSecret: this.requestFunctionFactory(descriptors.extensionGenerateExtensionSecret),
|
|
343
|
+
/** Generate a session token to transmit it to the extensions frontend fragment. */
|
|
344
|
+
extensionGenerateSessionToken: this.requestFunctionFactory(descriptors.extensionGenerateSessionToken),
|
|
345
|
+
/** Get all open extension orders for given customer */
|
|
346
|
+
extensionGetCustomerExtensionInstanceOrders: this.requestFunctionFactory(descriptors.extensionGetCustomerExtensionInstanceOrders),
|
|
347
|
+
/** Get the Contract Strategy of an Extension Instance */
|
|
348
|
+
extensionGetExtensionInstanceContract: this.requestFunctionFactory(descriptors.extensionGetExtensionInstanceContract),
|
|
349
|
+
/** Update or Create Contract for existing Extension Instances. */
|
|
350
|
+
extensionUpdateExtensionInstanceContract: this.requestFunctionFactory(descriptors.extensionUpdateExtensionInstanceContract),
|
|
351
|
+
/** Get the ExtensionInstance of a specific customer and extension, if existing. */
|
|
352
|
+
extensionGetExtensionInstanceForCustomer: this.requestFunctionFactory(descriptors.extensionGetExtensionInstanceForCustomer),
|
|
353
|
+
/** Get the ExtensionInstance of a specific project and extension, if existing. */
|
|
354
|
+
extensionGetExtensionInstanceForProject: this.requestFunctionFactory(descriptors.extensionGetExtensionInstanceForProject),
|
|
355
|
+
/** Get an Extension. */
|
|
356
|
+
extensionGetExtension: this.requestFunctionFactory(descriptors.extensionGetExtension),
|
|
357
|
+
/** Get all open extension orders for given project */
|
|
358
|
+
extensionGetProjectExtensionInstanceOrders: this.requestFunctionFactory(descriptors.extensionGetProjectExtensionInstanceOrders),
|
|
359
|
+
/** Get the public key to verify the webhook signature. */
|
|
360
|
+
extensionGetPublicKey: this.requestFunctionFactory(descriptors.extensionGetPublicKey),
|
|
361
|
+
/** Invalidate the given Extension secret immediately. */
|
|
362
|
+
extensionInvalidateExtensionSecret: this.requestFunctionFactory(descriptors.extensionInvalidateExtensionSecret),
|
|
363
|
+
/** List all Webhook Executions. */
|
|
364
|
+
extensionListAllExtensionInstanceWebhookExecutions: this.requestFunctionFactory(descriptors.extensionListAllExtensionInstanceWebhookExecutions),
|
|
365
|
+
/** List Contributors. */
|
|
366
|
+
extensionListContributors: this.requestFunctionFactory(descriptors.extensionListContributors),
|
|
367
|
+
/** List Extensions. */
|
|
368
|
+
extensionListExtensions: this.requestFunctionFactory(descriptors.extensionListExtensions),
|
|
369
|
+
/** List Extensions of own contributor. */
|
|
370
|
+
extensionListOwnExtensions: this.requestFunctionFactory(descriptors.extensionListOwnExtensions),
|
|
371
|
+
/** Register an Extension. */
|
|
372
|
+
extensionRegisterExtension: this.requestFunctionFactory(descriptors.extensionRegisterExtension),
|
|
373
|
+
/** List Scopes. */
|
|
374
|
+
extensionListScopes: this.requestFunctionFactory(descriptors.extensionListScopes),
|
|
375
|
+
/** Order Extension with saved payment method */
|
|
376
|
+
extensionOrderExtension: this.requestFunctionFactory(descriptors.extensionOrderExtension),
|
|
377
|
+
/** Remove an asset of an extension. */
|
|
378
|
+
extensionRemoveAsset: this.requestFunctionFactory(descriptors.extensionRemoveAsset),
|
|
379
|
+
/** Add a logo to an extension. */
|
|
380
|
+
extensionRequestLogoUpload: this.requestFunctionFactory(descriptors.extensionRequestLogoUpload),
|
|
381
|
+
/** Remove the logo of an extension. */
|
|
382
|
+
extensionRemoveLogo: this.requestFunctionFactory(descriptors.extensionRemoveLogo),
|
|
383
|
+
/** Add an asset to an extension. */
|
|
384
|
+
extensionRequestAssetUpload: this.requestFunctionFactory(descriptors.extensionRequestAssetUpload),
|
|
385
|
+
/** Start the verification process of an Extension. */
|
|
386
|
+
extensionRequestExtensionVerification: this.requestFunctionFactory(descriptors.extensionRequestExtensionVerification),
|
|
387
|
+
/** Publish or withdraw an Extension. */
|
|
388
|
+
extensionSetExtensionPublishedState: this.requestFunctionFactory(descriptors.extensionSetExtensionPublishedState),
|
|
389
|
+
/** Creates or Updates Pricing for an Extension. */
|
|
390
|
+
extensionUpdateExtensionPricing: this.requestFunctionFactory(descriptors.extensionUpdateExtensionPricing),
|
|
391
|
+
/** Get payment method details */
|
|
392
|
+
customerGetPaymentMethod: this.requestFunctionFactory(descriptors.marketplaceCustomerGetPaymentMethod),
|
|
393
|
+
/** Get the link to update the marketplace payment method */
|
|
394
|
+
customerUpdatePaymentMethod: this.requestFunctionFactory(descriptors.marketplaceCustomerUpdatePaymentMethod),
|
|
395
|
+
};
|
|
396
|
+
/** The conversation API allows you to manage your support conversations. */
|
|
397
|
+
conversation = {
|
|
398
|
+
/** Get all conversation the authenticated user has created or has access to. */
|
|
399
|
+
listConversations: this.requestFunctionFactory(descriptors.conversationListConversations),
|
|
400
|
+
/** Create a conversation. */
|
|
401
|
+
createConversation: this.requestFunctionFactory(descriptors.conversationCreateConversation),
|
|
402
|
+
/** Get all message of the conversation. */
|
|
403
|
+
listMessagesByConversation: this.requestFunctionFactory(descriptors.conversationListMessagesByConversation),
|
|
404
|
+
/** Send a new message in the conversation. */
|
|
405
|
+
createMessage: this.requestFunctionFactory(descriptors.conversationCreateMessage),
|
|
406
|
+
/** Get a specific conversation category. */
|
|
407
|
+
getCategory: this.requestFunctionFactory(descriptors.conversationGetCategory),
|
|
408
|
+
/** Get members of a support conversation. */
|
|
409
|
+
getConversationMembers: this.requestFunctionFactory(descriptors.conversationGetConversationMembers),
|
|
410
|
+
/** Get preferences for customer conversations. */
|
|
411
|
+
getConversationPreferencesOfCustomer: this.requestFunctionFactory(descriptors.conversationGetConversationPreferencesOfCustomer),
|
|
412
|
+
/** Get a support conversation. */
|
|
413
|
+
getConversation: this.requestFunctionFactory(descriptors.conversationGetConversation),
|
|
414
|
+
/** Update the basic properties of the conversation. */
|
|
415
|
+
updateConversation: this.requestFunctionFactory(descriptors.conversationUpdateConversation),
|
|
416
|
+
/** Request an access token for the File belonging to the Conversation. */
|
|
417
|
+
getFileAccessToken: this.requestFunctionFactory(descriptors.conversationGetFileAccessToken),
|
|
418
|
+
/** Get all conversation categories. */
|
|
419
|
+
listCategories: this.requestFunctionFactory(descriptors.conversationListCategories),
|
|
420
|
+
/** Request a file upload token for the conversation. */
|
|
421
|
+
requestFileUpload: this.requestFunctionFactory(descriptors.conversationRequestFileUpload),
|
|
422
|
+
/** Update the status of a conversation. */
|
|
423
|
+
setConversationStatus: this.requestFunctionFactory(descriptors.conversationSetConversationStatus),
|
|
424
|
+
/** Update the content of the message */
|
|
425
|
+
updateMessage: this.requestFunctionFactory(descriptors.conversationUpdateMessage),
|
|
426
|
+
};
|
|
427
|
+
/** The cronjob API allows you to manage cronjobs within a project. */
|
|
428
|
+
cronjob = {
|
|
429
|
+
/** List Cronjobs belonging to a Project. */
|
|
430
|
+
listCronjobs: this.requestFunctionFactory(descriptors.cronjobListCronjobs),
|
|
431
|
+
/** Create a Cronjob. */
|
|
432
|
+
createCronjob: this.requestFunctionFactory(descriptors.cronjobCreateCronjob),
|
|
433
|
+
/** List CronjobExecutions belonging to a Cronjob. */
|
|
434
|
+
listExecutions: this.requestFunctionFactory(descriptors.cronjobListExecutions),
|
|
435
|
+
/** Trigger a Cronjob. */
|
|
436
|
+
createExecution: this.requestFunctionFactory(descriptors.cronjobCreateExecution),
|
|
437
|
+
/** Get a Cronjob. */
|
|
438
|
+
getCronjob: this.requestFunctionFactory(descriptors.cronjobGetCronjob),
|
|
439
|
+
/** Delete a Cronjob. */
|
|
440
|
+
deleteCronjob: this.requestFunctionFactory(descriptors.cronjobDeleteCronjob),
|
|
441
|
+
/** Update a Cronjob. */
|
|
442
|
+
updateCronjob: this.requestFunctionFactory(descriptors.cronjobUpdateCronjob),
|
|
443
|
+
/** Get a CronjobExecution analysis for failed executions. */
|
|
444
|
+
getExecutionAnalysis: this.requestFunctionFactory(descriptors.cronjobGetExecutionAnalysis),
|
|
445
|
+
/** Get a CronjobExecution. */
|
|
446
|
+
getExecution: this.requestFunctionFactory(descriptors.cronjobGetExecution),
|
|
447
|
+
/** Update a Cronjob's app installation id. */
|
|
448
|
+
replaceCronjobAppInstallationId: this.requestFunctionFactory(descriptors.cronjobReplaceCronjobAppInstallationId),
|
|
449
|
+
};
|
|
450
|
+
/** The customer API allows you to manage your own organizations and users. */
|
|
451
|
+
customer = {
|
|
452
|
+
/** Accept a CustomerInvite. */
|
|
453
|
+
acceptCustomerInvite: this.requestFunctionFactory(descriptors.customerAcceptCustomerInvite),
|
|
454
|
+
/** List Invites belonging to a Customer. */
|
|
455
|
+
listInvitesForCustomer: this.requestFunctionFactory(descriptors.customerListInvitesForCustomer),
|
|
456
|
+
/** Create a CustomerInvite. */
|
|
457
|
+
createCustomerInvite: this.requestFunctionFactory(descriptors.customerCreateCustomerInvite),
|
|
458
|
+
/** Get all customer profiles the authenticated user has access to. */
|
|
459
|
+
listCustomers: this.requestFunctionFactory(descriptors.customerListCustomers),
|
|
460
|
+
/** Create a new customer profile. */
|
|
461
|
+
createCustomer: this.requestFunctionFactory(descriptors.customerCreateCustomer),
|
|
462
|
+
/** Lets us know your idea for our recommendation programm. */
|
|
463
|
+
createRecommendationSuggestion: this.requestFunctionFactory(descriptors.customerCreateRecommendationSuggestion),
|
|
464
|
+
/** Gets the Wallet of the Customer. */
|
|
465
|
+
getWallet: this.requestFunctionFactory(descriptors.customerGetWallet),
|
|
466
|
+
/** Create the Wallet for the Customer. */
|
|
467
|
+
createWallet: this.requestFunctionFactory(descriptors.customerCreateWallet),
|
|
468
|
+
/** Decline a CustomerInvite. */
|
|
469
|
+
declineCustomerInvite: this.requestFunctionFactory(descriptors.customerDeclineCustomerInvite),
|
|
470
|
+
/** Get a CustomerInvite. */
|
|
471
|
+
getCustomerInvite: this.requestFunctionFactory(descriptors.customerGetCustomerInvite),
|
|
472
|
+
/** Delete a CustomerInvite. */
|
|
473
|
+
deleteCustomerInvite: this.requestFunctionFactory(descriptors.customerDeleteCustomerInvite),
|
|
474
|
+
/** Get a CustomerMembership. */
|
|
475
|
+
getCustomerMembership: this.requestFunctionFactory(descriptors.customerGetCustomerMembership),
|
|
476
|
+
/** Delete a CustomerMembership. */
|
|
477
|
+
deleteCustomerMembership: this.requestFunctionFactory(descriptors.customerDeleteCustomerMembership),
|
|
478
|
+
/** Update a CustomerMembership. */
|
|
479
|
+
updateCustomerMembership: this.requestFunctionFactory(descriptors.customerUpdateCustomerMembership),
|
|
480
|
+
/** Get a customer profile. */
|
|
481
|
+
getCustomer: this.requestFunctionFactory(descriptors.customerGetCustomer),
|
|
482
|
+
/** Update a customer profile. */
|
|
483
|
+
updateCustomer: this.requestFunctionFactory(descriptors.customerUpdateCustomer),
|
|
484
|
+
/** Delete a customer profile. */
|
|
485
|
+
deleteCustomer: this.requestFunctionFactory(descriptors.customerDeleteCustomer),
|
|
486
|
+
/** Get a CustomerInvite by token. */
|
|
487
|
+
getCustomerTokenInvite: this.requestFunctionFactory(descriptors.customerGetCustomerTokenInvite),
|
|
488
|
+
/** Check if the customer profile has a valid contract partner configured. */
|
|
489
|
+
isCustomerLegallyCompetent: this.requestFunctionFactory(descriptors.customerIsCustomerLegallyCompetent),
|
|
490
|
+
/** List CustomerInvites belonging to the executing user. */
|
|
491
|
+
listCustomerInvites: this.requestFunctionFactory(descriptors.customerListCustomerInvites),
|
|
492
|
+
/** List CustomerMemberships belonging to the executing user. */
|
|
493
|
+
listCustomerMemberships: this.requestFunctionFactory(descriptors.customerListCustomerMemberships),
|
|
494
|
+
/** List Memberships belonging to a Customer. */
|
|
495
|
+
listMembershipsForCustomer: this.requestFunctionFactory(descriptors.customerListMembershipsForCustomer),
|
|
496
|
+
/** Request a new avatar upload for the customer profile. */
|
|
497
|
+
requestAvatarUpload: this.requestFunctionFactory(descriptors.customerRequestAvatarUpload),
|
|
498
|
+
/** Remove the avatar picture of the customer profile. */
|
|
499
|
+
removeAvatar: this.requestFunctionFactory(descriptors.customerRemoveAvatar),
|
|
500
|
+
/** Resend the mail for a CustomerInvite. */
|
|
501
|
+
resendCustomerInviteMail: this.requestFunctionFactory(descriptors.customerResendCustomerInviteMail),
|
|
502
|
+
};
|
|
503
|
+
/** The database API allows you to manage your databases, like MySQL and Redis databases. */
|
|
504
|
+
database = {
|
|
505
|
+
/** Copy a MySQLDatabase with a MySQLUser. */
|
|
506
|
+
copyMysqlDatabase: this.requestFunctionFactory(descriptors.databaseCopyMysqlDatabase),
|
|
507
|
+
/** List MySQLDatabases belonging to a Project. */
|
|
508
|
+
listMysqlDatabases: this.requestFunctionFactory(descriptors.databaseListMysqlDatabases),
|
|
509
|
+
/** Create a MySQLDatabase with a MySQLUser. */
|
|
510
|
+
createMysqlDatabase: this.requestFunctionFactory(descriptors.databaseCreateMysqlDatabase),
|
|
511
|
+
/** List MySQLUsers belonging to a Database. */
|
|
512
|
+
listMysqlUsers: this.requestFunctionFactory(descriptors.databaseListMysqlUsers),
|
|
513
|
+
/** Create a MySQLUser. */
|
|
514
|
+
createMysqlUser: this.requestFunctionFactory(descriptors.databaseCreateMysqlUser),
|
|
515
|
+
/** List RedisDatabases belonging to a Project. */
|
|
516
|
+
listRedisDatabases: this.requestFunctionFactory(descriptors.databaseListRedisDatabases),
|
|
517
|
+
/** Create a RedisDatabase. */
|
|
518
|
+
createRedisDatabase: this.requestFunctionFactory(descriptors.databaseCreateRedisDatabase),
|
|
519
|
+
/** Get a MySQLDatabase. */
|
|
520
|
+
getMysqlDatabase: this.requestFunctionFactory(descriptors.databaseGetMysqlDatabase),
|
|
521
|
+
/** Delete a MySQLDatabase. */
|
|
522
|
+
deleteMysqlDatabase: this.requestFunctionFactory(descriptors.databaseDeleteMysqlDatabase),
|
|
523
|
+
/** Update a MySqlDatabase. */
|
|
524
|
+
patchMysqlDatabase: this.requestFunctionFactory(descriptors.databasePatchMysqlDatabase),
|
|
525
|
+
/** Get a MySQLUser. */
|
|
526
|
+
getMysqlUser: this.requestFunctionFactory(descriptors.databaseGetMysqlUser),
|
|
527
|
+
/** Update a MySQLUser. */
|
|
528
|
+
updateMysqlUser: this.requestFunctionFactory(descriptors.databaseUpdateMysqlUser),
|
|
529
|
+
/** Delete a MySQLUser. */
|
|
530
|
+
deleteMysqlUser: this.requestFunctionFactory(descriptors.databaseDeleteMysqlUser),
|
|
531
|
+
/** Get a RedisDatabase. */
|
|
532
|
+
getRedisDatabase: this.requestFunctionFactory(descriptors.databaseGetRedisDatabase),
|
|
533
|
+
/** Delete a RedisDatabase. */
|
|
534
|
+
deleteRedisDatabase: this.requestFunctionFactory(descriptors.databaseDeleteRedisDatabase),
|
|
535
|
+
/** Update a RedisDatabase. */
|
|
536
|
+
patchRedisDatabase: this.requestFunctionFactory(descriptors.databasePatchRedisDatabase),
|
|
537
|
+
/** Disable a MySQLUser. */
|
|
538
|
+
disableMysqlUser: this.requestFunctionFactory(descriptors.databaseDisableMysqlUser),
|
|
539
|
+
/** Enable a MySQLUser. */
|
|
540
|
+
enableMysqlUser: this.requestFunctionFactory(descriptors.databaseEnableMysqlUser),
|
|
541
|
+
/** Get a MySQLUser's PhpMyAdmin-URL. */
|
|
542
|
+
getMysqlUserPhpMyAdminUrl: this.requestFunctionFactory(descriptors.databaseGetMysqlUserPhpMyAdminUrl),
|
|
543
|
+
/** List available MySQL character sets and collations, optionally filtered by a MySQLVersion. */
|
|
544
|
+
listMysqlCharsets: this.requestFunctionFactory(descriptors.databaseListMysqlCharsets),
|
|
545
|
+
/** List MySQLVersions. */
|
|
546
|
+
listMysqlVersions: this.requestFunctionFactory(descriptors.databaseListMysqlVersions),
|
|
547
|
+
/** List RedisVersions. */
|
|
548
|
+
listRedisVersions: this.requestFunctionFactory(descriptors.databaseListRedisVersions),
|
|
549
|
+
/** Update a MySQLDatabase's default character settings. */
|
|
550
|
+
updateMysqlDatabaseDefaultCharset: this.requestFunctionFactory(descriptors.databaseUpdateMysqlDatabaseDefaultCharset),
|
|
551
|
+
/** Update a MySQLDatabase's description. */
|
|
552
|
+
updateMysqlDatabaseDescription: this.requestFunctionFactory(descriptors.databaseUpdateMysqlDatabaseDescription),
|
|
553
|
+
/** Update a MySQLUser's password. */
|
|
554
|
+
updateMysqlUserPassword: this.requestFunctionFactory(descriptors.databaseUpdateMysqlUserPassword),
|
|
555
|
+
/** Update a RedisDatabase's configuration. */
|
|
556
|
+
updateRedisDatabaseConfiguration: this.requestFunctionFactory(descriptors.databaseUpdateRedisDatabaseConfiguration),
|
|
557
|
+
/** Update a RedisDatabase's description. */
|
|
558
|
+
updateRedisDatabaseDescription: this.requestFunctionFactory(descriptors.databaseUpdateRedisDatabaseDescription),
|
|
559
|
+
};
|
|
560
|
+
/** The domain API allows you to manage your domains, DNS records, SSL certificates and ingress resources. */
|
|
561
|
+
domain = {
|
|
562
|
+
/** List Domains */
|
|
563
|
+
listDomains: this.requestFunctionFactory(descriptors.domainListDomains),
|
|
564
|
+
/** Update the nameservers of a Domain. */
|
|
565
|
+
updateDomainNameservers: this.requestFunctionFactory(descriptors.domainUpdateDomainNameservers),
|
|
566
|
+
/** Update the paths of an Ingress. */
|
|
567
|
+
ingressUpdateIngressPaths: this.requestFunctionFactory(descriptors.ingressUpdateIngressPaths),
|
|
568
|
+
/** Update the tls settings of an Ingress. */
|
|
569
|
+
ingressUpdateIngressTls: this.requestFunctionFactory(descriptors.ingressUpdateIngressTls),
|
|
570
|
+
/** Create a DNSZone. */
|
|
571
|
+
dnsCreateDnsZone: this.requestFunctionFactory(descriptors.dnsCreateDnsZone),
|
|
572
|
+
/** Get a DNSZone. */
|
|
573
|
+
dnsGetDnsZone: this.requestFunctionFactory(descriptors.dnsGetDnsZone),
|
|
574
|
+
/** Delete a DNSZone. */
|
|
575
|
+
dnsDeleteDnsZone: this.requestFunctionFactory(descriptors.dnsDeleteDnsZone),
|
|
576
|
+
/** Get a zone file for a DNSZone. */
|
|
577
|
+
dnsGetZoneFile: this.requestFunctionFactory(descriptors.dnsGetZoneFile),
|
|
578
|
+
/** List DNSZones belonging to a Project. */
|
|
579
|
+
dnsListDnsZones: this.requestFunctionFactory(descriptors.dnsListDnsZones),
|
|
580
|
+
/** Set a record set on a DNSZone to managed. */
|
|
581
|
+
dnsSetRecordSetManaged: this.requestFunctionFactory(descriptors.dnsSetRecordSetManaged),
|
|
582
|
+
/** Update a record set on a DNSZone. */
|
|
583
|
+
dnsUpdateRecordSet: this.requestFunctionFactory(descriptors.dnsUpdateRecordSet),
|
|
584
|
+
/** Abort a Domain declaration. */
|
|
585
|
+
abortDomainDeclaration: this.requestFunctionFactory(descriptors.domainAbortDomainDeclaration),
|
|
586
|
+
/** Create a scheduled deletion of a Domain. */
|
|
587
|
+
createScheduledDeletion: this.requestFunctionFactory(descriptors.domainCreateScheduledDeletion),
|
|
588
|
+
/** Cancel a scheduled deletion of a Domain. */
|
|
589
|
+
cancelScheduledDeletion: this.requestFunctionFactory(descriptors.domainCancelScheduledDeletion),
|
|
590
|
+
/** Check if a Domain is available to register. */
|
|
591
|
+
checkDomainRegistrability: this.requestFunctionFactory(descriptors.domainCheckDomainRegistrability),
|
|
592
|
+
/** Check if a Domain is available to transfer. */
|
|
593
|
+
checkDomainTransferability: this.requestFunctionFactory(descriptors.domainCheckDomainTransferability),
|
|
594
|
+
/** Create an auth code for a Domains transfer-out process. */
|
|
595
|
+
createDomainAuthCode: this.requestFunctionFactory(descriptors.domainCreateDomainAuthCode),
|
|
596
|
+
/** Get a Domain. */
|
|
597
|
+
getDomain: this.requestFunctionFactory(descriptors.domainGetDomain),
|
|
598
|
+
/** Delete a Domain. */
|
|
599
|
+
deleteDomain: this.requestFunctionFactory(descriptors.domainDeleteDomain),
|
|
600
|
+
/** Get a Contact-Verification. */
|
|
601
|
+
getContactVerification: this.requestFunctionFactory(descriptors.domainGetContactVerification),
|
|
602
|
+
/** Get the latest screenshot's FileReference belonging to a Domain. */
|
|
603
|
+
getLatestScreenshot: this.requestFunctionFactory(descriptors.domainGetLatestScreenshot),
|
|
604
|
+
/** List Contact-Verifications belonging to the executing user. */
|
|
605
|
+
listContactVerifications: this.requestFunctionFactory(descriptors.domainListContactVerifications),
|
|
606
|
+
/** List the contact schemas for a TLD. */
|
|
607
|
+
listTldContactSchemas: this.requestFunctionFactory(descriptors.domainListTldContactSchemas),
|
|
608
|
+
/** List TLDs. */
|
|
609
|
+
listTlds: this.requestFunctionFactory(descriptors.domainListTlds),
|
|
610
|
+
/** List Domain-Migrations belonging to a Project. */
|
|
611
|
+
migrationListMigrationsByProjectId: this.requestFunctionFactory(descriptors.domainMigrationListMigrationsByProjectId),
|
|
612
|
+
/** Resends a Contact-Verification email. */
|
|
613
|
+
resendContactVerificationEmail: this.requestFunctionFactory(descriptors.domainResendContactVerificationEmail),
|
|
614
|
+
/** Resend a Domain email. */
|
|
615
|
+
resendDomainEmail: this.requestFunctionFactory(descriptors.domainResendDomainEmail),
|
|
616
|
+
/** Suggest a list of domains based on a prompt using AI. */
|
|
617
|
+
suggest: this.requestFunctionFactory(descriptors.domainSuggest),
|
|
618
|
+
/** Update the auth code of a Domain. */
|
|
619
|
+
updateDomainAuthCode: this.requestFunctionFactory(descriptors.domainUpdateDomainAuthCode),
|
|
620
|
+
/** Update a contact of a Domain. */
|
|
621
|
+
updateDomainContact: this.requestFunctionFactory(descriptors.domainUpdateDomainContact),
|
|
622
|
+
/** Update a Domain's project id. */
|
|
623
|
+
updateDomainProjectId: this.requestFunctionFactory(descriptors.domainUpdateDomainProjectId),
|
|
624
|
+
/** List Ingresses. */
|
|
625
|
+
ingressListIngresses: this.requestFunctionFactory(descriptors.ingressListIngresses),
|
|
626
|
+
/** Create an Ingress. */
|
|
627
|
+
ingressCreateIngress: this.requestFunctionFactory(descriptors.ingressCreateIngress),
|
|
628
|
+
/** Get an Ingress. */
|
|
629
|
+
ingressGetIngress: this.requestFunctionFactory(descriptors.ingressGetIngress),
|
|
630
|
+
/** Delete an Ingress. */
|
|
631
|
+
ingressDeleteIngress: this.requestFunctionFactory(descriptors.ingressDeleteIngress),
|
|
632
|
+
/** Verifiy the ownership of an Ingress. */
|
|
633
|
+
ingressIngressVerifyOwnership: this.requestFunctionFactory(descriptors.ingressIngressVerifyOwnership),
|
|
634
|
+
/** List Ingresses compatible with a certificate. */
|
|
635
|
+
ingressListIngressesCompatibleWithCertificate: this.requestFunctionFactory(descriptors.ingressListIngressesCompatibleWithCertificate),
|
|
636
|
+
/** Request the ACME certificate issuance of an Ingress. */
|
|
637
|
+
ingressRequestIngressAcmeCertificateIssuance: this.requestFunctionFactory(descriptors.ingressRequestIngressAcmeCertificateIssuance),
|
|
638
|
+
/** Check the replacement of a Certificate. */
|
|
639
|
+
sslCheckReplaceCertificate: this.requestFunctionFactory(descriptors.sslCheckReplaceCertificate),
|
|
640
|
+
/** List CertificateRequests belonging to a Project or an Ingress. */
|
|
641
|
+
sslListCertificateRequests: this.requestFunctionFactory(descriptors.sslListCertificateRequests),
|
|
642
|
+
/** Create a CertificateRequest. */
|
|
643
|
+
sslCreateCertificateRequest: this.requestFunctionFactory(descriptors.sslCreateCertificateRequest),
|
|
644
|
+
/** Delete a CertificateRequest. */
|
|
645
|
+
sslDeleteCertificateRequest: this.requestFunctionFactory(descriptors.sslDeleteCertificateRequest),
|
|
646
|
+
/** Delete a Certificate. */
|
|
647
|
+
sslDeleteCertificate: this.requestFunctionFactory(descriptors.sslDeleteCertificate),
|
|
648
|
+
/** Get a CertificateRequest. */
|
|
649
|
+
sslGetCertificateRequest: this.requestFunctionFactory(descriptors.sslGetCertificateRequest),
|
|
650
|
+
/** Get a Certificate. */
|
|
651
|
+
sslGetCertificate: this.requestFunctionFactory(descriptors.sslGetCertificate),
|
|
652
|
+
/** Update a Certificate. */
|
|
653
|
+
sslReplaceCertificate: this.requestFunctionFactory(descriptors.sslReplaceCertificate),
|
|
654
|
+
/** List Certificates belonging to a Project or an Ingress. */
|
|
655
|
+
sslListCertificates: this.requestFunctionFactory(descriptors.sslListCertificates),
|
|
656
|
+
};
|
|
657
|
+
/** The mail API allows you to manage your mail accounts. */
|
|
658
|
+
mail = {
|
|
659
|
+
/** Update the autoresponder of a MailAddress. */
|
|
660
|
+
updateMailAddressAutoresponder: this.requestFunctionFactory(descriptors.mailUpdateMailAddressAutoresponder),
|
|
661
|
+
/** Update the forward addresses of a MailAddresses. */
|
|
662
|
+
updateMailAddressForwardAddresses: this.requestFunctionFactory(descriptors.mailUpdateMailAddressForwardAddresses),
|
|
663
|
+
/** Update the password for a MailAddress. */
|
|
664
|
+
updateMailAddressPassword: this.requestFunctionFactory(descriptors.mailUpdateMailAddressPassword),
|
|
665
|
+
/** Update the quota of a MailAddress. */
|
|
666
|
+
updateMailAddressQuota: this.requestFunctionFactory(descriptors.mailUpdateMailAddressQuota),
|
|
667
|
+
/** Update the spam protection of a MailAddress. */
|
|
668
|
+
updateMailAddressSpamProtection: this.requestFunctionFactory(descriptors.mailUpdateMailAddressSpamProtection),
|
|
669
|
+
/** Update a mail setting of a Project. */
|
|
670
|
+
updateProjectMailSetting: this.requestFunctionFactory(descriptors.mailUpdateProjectMailSetting),
|
|
671
|
+
/** List DeliveryBoxes belonging to a Project. */
|
|
672
|
+
listDeliveryBoxes: this.requestFunctionFactory(descriptors.mailListDeliveryBoxes),
|
|
673
|
+
/** Create a DeliveryBox. */
|
|
674
|
+
createDeliverybox: this.requestFunctionFactory(descriptors.mailCreateDeliverybox),
|
|
675
|
+
/** List MailAddresses belonging to a Project. */
|
|
676
|
+
listMailAddresses: this.requestFunctionFactory(descriptors.mailListMailAddresses),
|
|
677
|
+
/** Create a MailAddress. */
|
|
678
|
+
createMailAddress: this.requestFunctionFactory(descriptors.mailCreateMailAddress),
|
|
679
|
+
/** Get a DeliveryBox. */
|
|
680
|
+
getDeliveryBox: this.requestFunctionFactory(descriptors.mailGetDeliveryBox),
|
|
681
|
+
/** Delete a DeliveryBox. */
|
|
682
|
+
deleteDeliveryBox: this.requestFunctionFactory(descriptors.mailDeleteDeliveryBox),
|
|
683
|
+
/** Get a MailAddress. */
|
|
684
|
+
getMailAddress: this.requestFunctionFactory(descriptors.mailGetMailAddress),
|
|
685
|
+
/** Delete a MailAddress. */
|
|
686
|
+
deleteMailAddress: this.requestFunctionFactory(descriptors.mailDeleteMailAddress),
|
|
687
|
+
/** Disable the mail-archive of a MailAddress. */
|
|
688
|
+
disableMailArchive: this.requestFunctionFactory(descriptors.mailDisableMailArchive),
|
|
689
|
+
/** List backups belonging to a MailAddress. */
|
|
690
|
+
listBackupsForMailAddress: this.requestFunctionFactory(descriptors.mailListBackupsForMailAddress),
|
|
691
|
+
/** List MailAddresses. */
|
|
692
|
+
listMailAddressesForUser: this.requestFunctionFactory(descriptors.mailListMailAddressesForUser),
|
|
693
|
+
/** List mail settings of a Project. */
|
|
694
|
+
listProjectMailSettings: this.requestFunctionFactory(descriptors.mailListProjectMailSettings),
|
|
695
|
+
/** Recover emails for a MailAddress from a backup. */
|
|
696
|
+
recoverMailAddressEmails: this.requestFunctionFactory(descriptors.mailRecoverMailAddressEmails),
|
|
697
|
+
/** Update the description of a DeliveryBox. */
|
|
698
|
+
updateDeliveryBoxDescription: this.requestFunctionFactory(descriptors.mailUpdateDeliveryBoxDescription),
|
|
699
|
+
/** Update the password of a DeliveryBox. */
|
|
700
|
+
updateDeliveryBoxPassword: this.requestFunctionFactory(descriptors.mailUpdateDeliveryBoxPassword),
|
|
701
|
+
/** Update a MailAddress. */
|
|
702
|
+
updateMailAddressAddress: this.requestFunctionFactory(descriptors.mailUpdateMailAddressAddress),
|
|
703
|
+
/** Update the catch-all of a MailAddress. */
|
|
704
|
+
updateMailAddressCatchAll: this.requestFunctionFactory(descriptors.mailUpdateMailAddressCatchAll),
|
|
705
|
+
};
|
|
706
|
+
/** The notification API allows you to manage your notifications. */
|
|
707
|
+
notification = {
|
|
708
|
+
/** Subscribe a user to the mStudio newsletter. */
|
|
709
|
+
newsletterSubscribeUser: this.requestFunctionFactory(descriptors.newsletterSubscribeUser),
|
|
710
|
+
/** Getting the subscription status of the subscription. */
|
|
711
|
+
newsletterGetInfo: this.requestFunctionFactory(descriptors.newsletterGetInfo),
|
|
712
|
+
/** Unsubscribe a user from the mStudio newsletter. */
|
|
713
|
+
newsletterUnsubscribeUser: this.requestFunctionFactory(descriptors.newsletterUnsubscribeUser),
|
|
714
|
+
/** Get the counts for unread notifications of the user. */
|
|
715
|
+
scountUnreadNotifications: this.requestFunctionFactory(descriptors.notificationsCountUnreadNotifications),
|
|
716
|
+
/** List all unread notifications. */
|
|
717
|
+
slistNotifications: this.requestFunctionFactory(descriptors.notificationsListNotifications),
|
|
718
|
+
/** Mark all notifications as read. */
|
|
719
|
+
sreadAllNotifications: this.requestFunctionFactory(descriptors.notificationsReadAllNotifications),
|
|
720
|
+
/** Mark notification as read. */
|
|
721
|
+
sreadNotification: this.requestFunctionFactory(descriptors.notificationsReadNotification),
|
|
722
|
+
};
|
|
723
|
+
/** The user API allows you to manage your own user and access information of other users that might be visible to you. */
|
|
724
|
+
user = {
|
|
725
|
+
/** Update your account information. */
|
|
726
|
+
updateAccount: this.requestFunctionFactory(descriptors.userUpdateAccount),
|
|
727
|
+
/** Get a PasswordPolicy. */
|
|
728
|
+
passwordValidationGetPasswordPolicy: this.requestFunctionFactory(descriptors.passwordValidationGetPasswordPolicy),
|
|
729
|
+
/** Add phone number and start verification process. */
|
|
730
|
+
addPhoneNumber: this.requestFunctionFactory(descriptors.userAddPhoneNumber),
|
|
731
|
+
/** Remove phone number. */
|
|
732
|
+
removePhoneNumber: this.requestFunctionFactory(descriptors.userRemovePhoneNumber),
|
|
733
|
+
/** Validate your second factor. */
|
|
734
|
+
authenticateMfa: this.requestFunctionFactory(descriptors.userAuthenticateMfa),
|
|
735
|
+
/** Authenticate yourself to get an access token. */
|
|
736
|
+
authenticate: this.requestFunctionFactory(descriptors.userAuthenticate),
|
|
737
|
+
/** Authenticate an user with an access token retrieval key. */
|
|
738
|
+
authenticateWithAccessTokenRetrievalKey: this.requestFunctionFactory(descriptors.userAuthenticateWithAccessTokenRetrievalKey),
|
|
739
|
+
/** Get your verified Email-Address. */
|
|
740
|
+
getOwnEmail: this.requestFunctionFactory(descriptors.userGetOwnEmail),
|
|
741
|
+
/** Change your Email-Address. */
|
|
742
|
+
changeEmail: this.requestFunctionFactory(descriptors.userChangeEmail),
|
|
743
|
+
/** Change your password. */
|
|
744
|
+
changePassword: this.requestFunctionFactory(descriptors.userChangePassword),
|
|
745
|
+
/** Get your current multi factor auth status. */
|
|
746
|
+
getMfaStatus: this.requestFunctionFactory(descriptors.userGetMfaStatus),
|
|
747
|
+
/** Reset RecoveryCodes for MFA. */
|
|
748
|
+
resetRecoverycodes: this.requestFunctionFactory(descriptors.userResetRecoverycodes),
|
|
749
|
+
/** Confirm Multi Factor Authentication. */
|
|
750
|
+
confirmMfa: this.requestFunctionFactory(descriptors.userConfirmMfa),
|
|
751
|
+
/** Disable Multi Factor Authentication. */
|
|
752
|
+
disableMfa: this.requestFunctionFactory(descriptors.userDisableMfa),
|
|
753
|
+
/** Confirm password reset. */
|
|
754
|
+
confirmPasswordReset: this.requestFunctionFactory(descriptors.userConfirmPasswordReset),
|
|
755
|
+
/** List all of your ApiTokens. */
|
|
756
|
+
listApiTokens: this.requestFunctionFactory(descriptors.userListApiTokens),
|
|
757
|
+
/** Create a new ApiToken. */
|
|
758
|
+
createApiToken: this.requestFunctionFactory(descriptors.userCreateApiToken),
|
|
759
|
+
/** Submit your user feedback. */
|
|
760
|
+
createFeedback: this.requestFunctionFactory(descriptors.userCreateFeedback),
|
|
761
|
+
/** Get your stored ssh-keys. */
|
|
762
|
+
listSshKeys: this.requestFunctionFactory(descriptors.userListSshKeys),
|
|
763
|
+
/** Store a new ssh-key. */
|
|
764
|
+
createSshKey: this.requestFunctionFactory(descriptors.userCreateSshKey),
|
|
765
|
+
/** Get a specific ApiToken. */
|
|
766
|
+
getApiToken: this.requestFunctionFactory(descriptors.userGetApiToken),
|
|
767
|
+
/** Update an existing `ApiToken`. */
|
|
768
|
+
editApiToken: this.requestFunctionFactory(descriptors.userEditApiToken),
|
|
769
|
+
/** Deletes an ApiToken. */
|
|
770
|
+
deleteApiToken: this.requestFunctionFactory(descriptors.userDeleteApiToken),
|
|
771
|
+
/** Get a specific stored ssh-key. */
|
|
772
|
+
getSshKey: this.requestFunctionFactory(descriptors.userGetSshKey),
|
|
773
|
+
/** Edit a stored ssh-key. */
|
|
774
|
+
editSshKey: this.requestFunctionFactory(descriptors.userEditSshKey),
|
|
775
|
+
/** Remove a ssh-key. */
|
|
776
|
+
deleteSshKey: this.requestFunctionFactory(descriptors.userDeleteSshKey),
|
|
777
|
+
/** Delete your account and all your personal data. */
|
|
778
|
+
deleteUser: this.requestFunctionFactory(descriptors.userDeleteUser),
|
|
779
|
+
/** Check status of the current session. */
|
|
780
|
+
getCurrentSessionStatus: this.requestFunctionFactory(descriptors.userGetCurrentSessionStatus),
|
|
781
|
+
/** The timestamp of your latest password change. */
|
|
782
|
+
getPasswordUpdatedAt: this.requestFunctionFactory(descriptors.userGetPasswordUpdatedAt),
|
|
783
|
+
/** Get personalized settings. */
|
|
784
|
+
getPersonalizedSettings: this.requestFunctionFactory(descriptors.userGetPersonalizedSettings),
|
|
785
|
+
/** Update personalized GUI settings. */
|
|
786
|
+
updatePersonalizedSettings: this.requestFunctionFactory(descriptors.userUpdatePersonalizedSettings),
|
|
787
|
+
/** Get poll settings for the specified user. */
|
|
788
|
+
getPollStatus: this.requestFunctionFactory(descriptors.userGetPollStatus),
|
|
789
|
+
/** Store new or update poll settings. */
|
|
790
|
+
postPollStatus: this.requestFunctionFactory(descriptors.userPostPollStatus),
|
|
791
|
+
/** Get a specific session. */
|
|
792
|
+
getSession: this.requestFunctionFactory(descriptors.userGetSession),
|
|
793
|
+
/** Terminate a specific Session. */
|
|
794
|
+
terminateSession: this.requestFunctionFactory(descriptors.userTerminateSession),
|
|
795
|
+
/** Get profile information for a user. */
|
|
796
|
+
getUser: this.requestFunctionFactory(descriptors.userGetUser),
|
|
797
|
+
/** Change personal information. */
|
|
798
|
+
updatePersonalInformation: this.requestFunctionFactory(descriptors.userUpdatePersonalInformation),
|
|
799
|
+
/** Initialize Multi Factor Authentication. If successful, it needs to be confirmed, before usage of mfa. */
|
|
800
|
+
initMfa: this.requestFunctionFactory(descriptors.userInitMfa),
|
|
801
|
+
/** Initialize password reset process. */
|
|
802
|
+
initPasswordReset: this.requestFunctionFactory(descriptors.userInitPasswordReset),
|
|
803
|
+
/** Submitted feedback of the given user. */
|
|
804
|
+
listFeedback: this.requestFunctionFactory(descriptors.userListFeedback),
|
|
805
|
+
/** List all sessions. */
|
|
806
|
+
listSessions: this.requestFunctionFactory(descriptors.userListSessions),
|
|
807
|
+
/** Refresh a session. */
|
|
808
|
+
refreshSession: this.requestFunctionFactory(descriptors.userRefreshSession),
|
|
809
|
+
/** Terminate all sessions, except the current session. */
|
|
810
|
+
terminateAllSessions: this.requestFunctionFactory(descriptors.userTerminateAllSessions),
|
|
811
|
+
/** Terminate session and invalidate access token. */
|
|
812
|
+
logout: this.requestFunctionFactory(descriptors.userLogout),
|
|
813
|
+
/** Obtain authorization from the resource owner. */
|
|
814
|
+
oauthGetAuthorization: this.requestFunctionFactory(descriptors.userOauthGetAuthorization),
|
|
815
|
+
/** Retrieve Access Token from Authorization Code. */
|
|
816
|
+
oauthRetrieveAccessToken: this.requestFunctionFactory(descriptors.userOauthRetrieveAccessToken),
|
|
817
|
+
/** Register with email and password. */
|
|
818
|
+
register: this.requestFunctionFactory(descriptors.userRegister),
|
|
819
|
+
/** Request a new avatar image upload. */
|
|
820
|
+
requestAvatarUpload: this.requestFunctionFactory(descriptors.userRequestAvatarUpload),
|
|
821
|
+
/** Remove Avatar. */
|
|
822
|
+
removeAvatar: this.requestFunctionFactory(descriptors.userRemoveAvatar),
|
|
823
|
+
/** Resend the Email-Address verification email. */
|
|
824
|
+
resendVerificationEmail: this.requestFunctionFactory(descriptors.userResendVerificationEmail),
|
|
825
|
+
/** Request a support code. */
|
|
826
|
+
supportCodeRequest: this.requestFunctionFactory(descriptors.userSupportCodeRequest),
|
|
827
|
+
/** Verify an added Email-Address. */
|
|
828
|
+
verifyEmail: this.requestFunctionFactory(descriptors.userVerifyEmail),
|
|
829
|
+
/** Verify phone number. */
|
|
830
|
+
verifyPhoneNumber: this.requestFunctionFactory(descriptors.userVerifyPhoneNumber),
|
|
831
|
+
/** Verify your registration. */
|
|
832
|
+
verifyRegistration: this.requestFunctionFactory(descriptors.userVerifyRegistration),
|
|
833
|
+
};
|
|
834
|
+
/** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
|
|
835
|
+
file = {
|
|
836
|
+
/** Create a File. */
|
|
837
|
+
createFile: this.requestFunctionFactory(descriptors.fileCreateFile),
|
|
838
|
+
/** Get a File's meta. */
|
|
839
|
+
getFileMeta: this.requestFunctionFactory(descriptors.fileGetFileMeta),
|
|
840
|
+
/** Get a FileUploadToken's rules. */
|
|
841
|
+
getFileUploadTokenRules: this.requestFunctionFactory(descriptors.fileGetFileUploadTokenRules),
|
|
842
|
+
/** Get a FileUploadType's rules. */
|
|
843
|
+
getFileUploadTypeRules: this.requestFunctionFactory(descriptors.fileGetFileUploadTypeRules),
|
|
844
|
+
/** Get a File. */
|
|
845
|
+
getFile: this.requestFunctionFactory(descriptors.fileGetFile),
|
|
846
|
+
/** Get a File with user-friendly url. */
|
|
847
|
+
getFileWithName: this.requestFunctionFactory(descriptors.fileGetFileWithName),
|
|
848
|
+
};
|
|
849
|
+
/** The lead fyndr api allow you to manage you leads and your fyndr profile. */
|
|
850
|
+
leadFyndr = {
|
|
851
|
+
/** Get your LeadFyndr request. */
|
|
852
|
+
leadfyndrGetLeadFyndrProfileRequest: this.requestFunctionFactory(descriptors.leadfyndrGetLeadFyndrProfileRequest),
|
|
853
|
+
/** Create a new access request for LeadFyndr. */
|
|
854
|
+
leadfyndrCreateLeadFyndrAccessRequest: this.requestFunctionFactory(descriptors.leadfyndrCreateLeadFyndrAccessRequest),
|
|
855
|
+
/** Create an export of unlocked leads for the given customerId. */
|
|
856
|
+
leadfyndrCreateLeadsExport: this.requestFunctionFactory(descriptors.leadfyndrCreateLeadsExport),
|
|
857
|
+
/** Get cities in DACH. */
|
|
858
|
+
leadfyndrGetCities: this.requestFunctionFactory(descriptors.leadfyndrGetCities),
|
|
859
|
+
/** Get lead tariff options. How many leads did you unlock this month? */
|
|
860
|
+
leadfyndrGetLeadFyndrProfileTariffOptions: this.requestFunctionFactory(descriptors.leadfyndrGetLeadFyndrProfileTariffOptions),
|
|
861
|
+
/** Get your LeadFyndr profile. */
|
|
862
|
+
leadfyndrGetLeadFyndrProfile: this.requestFunctionFactory(descriptors.leadfyndrGetLeadFyndrProfile),
|
|
863
|
+
/** Get a simple lead. Use the unlocked route for more detail leads. */
|
|
864
|
+
leadfyndrGetLead: this.requestFunctionFactory(descriptors.leadfyndrGetLead),
|
|
865
|
+
/** Get unlocked leads export history for the given customerId. */
|
|
866
|
+
leadfyndrGetLeadsExportHistory: this.requestFunctionFactory(descriptors.leadfyndrGetLeadsExportHistory),
|
|
867
|
+
/** Get a detail of a unlocked lead. Organisation can unlock leads. */
|
|
868
|
+
leadfyndrGetUnlockedLead: this.requestFunctionFactory(descriptors.leadfyndrGetUnlockedLead),
|
|
869
|
+
/** Unlock a lead for the given customerId. */
|
|
870
|
+
leadfyndrUnlockLead: this.requestFunctionFactory(descriptors.leadfyndrUnlockLead),
|
|
871
|
+
/** Get all leads. Use the unlocked routes for more lead details. */
|
|
872
|
+
leadfyndrListLeads: this.requestFunctionFactory(descriptors.leadfyndrListLeads),
|
|
873
|
+
/** Get all unlocked leads. Organisation can unlock leads. */
|
|
874
|
+
leadfyndrListUnlockedLeads: this.requestFunctionFactory(descriptors.leadfyndrListUnlockedLeads),
|
|
875
|
+
/** Reserve a unlocked lead for the given customerId. */
|
|
876
|
+
leadfyndrReserveUnlockedLead: this.requestFunctionFactory(descriptors.leadfyndrReserveUnlockedLead),
|
|
877
|
+
/** Removes a reservation on a unlocked lead for the given customerId. */
|
|
878
|
+
leadfyndrRemoveUnlockedLeadReservation: this.requestFunctionFactory(descriptors.leadfyndrRemoveUnlockedLeadReservation),
|
|
879
|
+
};
|
|
880
|
+
/** The license API allows you to manage your paid licenses. */
|
|
881
|
+
license = {
|
|
882
|
+
/** Get a license. */
|
|
883
|
+
getLicense: this.requestFunctionFactory(descriptors.licenseGetLicense),
|
|
884
|
+
/** List Licenses belonging to a Project. */
|
|
885
|
+
listLicensesForProject: this.requestFunctionFactory(descriptors.licenseListLicensesForProject),
|
|
886
|
+
/** rotate a License's key, i.e. revoke the old and generate a new one. */
|
|
887
|
+
rotateLicenseKey: this.requestFunctionFactory(descriptors.licenseRotateLicenseKey),
|
|
888
|
+
/** Validate a License's key for a project. */
|
|
889
|
+
validateLicenseKeyForProject: this.requestFunctionFactory(descriptors.licenseValidateLicenseKeyForProject),
|
|
890
|
+
};
|
|
891
|
+
/** API endpoints that are not related to any specific API domain */
|
|
892
|
+
misc = {
|
|
893
|
+
/** List valid time zones. */
|
|
894
|
+
ellaneousListTimeZones: this.requestFunctionFactory(descriptors.miscellaneousListTimeZones),
|
|
895
|
+
/** Check if an email is from mittwald. */
|
|
896
|
+
verificationDetectPhishingEmail: this.requestFunctionFactory(descriptors.verificationDetectPhishingEmail),
|
|
897
|
+
/** Check if an address exists. */
|
|
898
|
+
verificationVerifyAddress: this.requestFunctionFactory(descriptors.verificationVerifyAddress),
|
|
899
|
+
/** Check if a company exists. */
|
|
900
|
+
verificationVerifyCompany: this.requestFunctionFactory(descriptors.verificationVerifyCompany),
|
|
901
|
+
};
|
|
902
|
+
/** The page insights API allows you to get page insights information. */
|
|
903
|
+
pageInsights = {
|
|
904
|
+
/** Get detailed performance data for a given domain and path. */
|
|
905
|
+
pageinsightsGetPerformanceData: this.requestFunctionFactory(descriptors.pageinsightsGetPerformanceData),
|
|
906
|
+
/** Get all data for a given strace. */
|
|
907
|
+
pageinsightsGetStraceData: this.requestFunctionFactory(descriptors.pageinsightsGetStraceData),
|
|
908
|
+
/** List websites (specified as domain and path) from a project where performance data is available. */
|
|
909
|
+
pageinsightsListPerformanceDataForProject: this.requestFunctionFactory(descriptors.pageinsightsListPerformanceDataForProject),
|
|
910
|
+
/** Schedule a strace measurement for a single http request. */
|
|
911
|
+
pageinsightsScheduleStrace: this.requestFunctionFactory(descriptors.pageinsightsScheduleStrace),
|
|
912
|
+
};
|
|
913
|
+
/** The project API allows you to manage your projects, and also any kinds of user memberships concerning these projects. */
|
|
914
|
+
project = {
|
|
915
|
+
/** Accept a ProjectInvite. */
|
|
916
|
+
acceptProjectInvite: this.requestFunctionFactory(descriptors.projectAcceptProjectInvite),
|
|
917
|
+
/** List Invites belonging to a Project. */
|
|
918
|
+
listInvitesForProject: this.requestFunctionFactory(descriptors.projectListInvitesForProject),
|
|
919
|
+
/** Create a ProjectInvite. */
|
|
920
|
+
createProjectInvite: this.requestFunctionFactory(descriptors.projectCreateProjectInvite),
|
|
921
|
+
/** Create a Project belonging to a Server. */
|
|
922
|
+
createProject: this.requestFunctionFactory(descriptors.projectCreateProject),
|
|
923
|
+
/** Decline a ProjectInvite. */
|
|
924
|
+
declineProjectInvite: this.requestFunctionFactory(descriptors.projectDeclineProjectInvite),
|
|
925
|
+
/** Request a Project avatar upload. */
|
|
926
|
+
requestProjectAvatarUpload: this.requestFunctionFactory(descriptors.projectRequestProjectAvatarUpload),
|
|
927
|
+
/** Delete a Project's avatar. */
|
|
928
|
+
deleteProjectAvatar: this.requestFunctionFactory(descriptors.projectDeleteProjectAvatar),
|
|
929
|
+
/** Get a ProjectInvite. */
|
|
930
|
+
getProjectInvite: this.requestFunctionFactory(descriptors.projectGetProjectInvite),
|
|
931
|
+
/** Delete a ProjectInvite. */
|
|
932
|
+
deleteProjectInvite: this.requestFunctionFactory(descriptors.projectDeleteProjectInvite),
|
|
933
|
+
/** Get a ProjectMembership */
|
|
934
|
+
getProjectMembership: this.requestFunctionFactory(descriptors.projectGetProjectMembership),
|
|
935
|
+
/** Delete a ProjectMembership. */
|
|
936
|
+
deleteProjectMembership: this.requestFunctionFactory(descriptors.projectDeleteProjectMembership),
|
|
937
|
+
/** Update a ProjectMembership. */
|
|
938
|
+
updateProjectMembership: this.requestFunctionFactory(descriptors.projectUpdateProjectMembership),
|
|
939
|
+
/** Get a Project. */
|
|
940
|
+
getProject: this.requestFunctionFactory(descriptors.projectGetProject),
|
|
941
|
+
/** Delete a Project. */
|
|
942
|
+
deleteProject: this.requestFunctionFactory(descriptors.projectDeleteProject),
|
|
943
|
+
/** Request a Server avatar upload. */
|
|
944
|
+
requestServerAvatarUpload: this.requestFunctionFactory(descriptors.projectRequestServerAvatarUpload),
|
|
945
|
+
/** Delete a Server's avatar. */
|
|
946
|
+
deleteServerAvatar: this.requestFunctionFactory(descriptors.projectDeleteServerAvatar),
|
|
947
|
+
/** Get a ProjectInvite by token. */
|
|
948
|
+
getProjectTokenInvite: this.requestFunctionFactory(descriptors.projectGetProjectTokenInvite),
|
|
949
|
+
/** Get the executing user's membership in a Project. */
|
|
950
|
+
getSelfMembershipForProject: this.requestFunctionFactory(descriptors.projectGetSelfMembershipForProject),
|
|
951
|
+
/** Get a Server. */
|
|
952
|
+
getServer: this.requestFunctionFactory(descriptors.projectGetServer),
|
|
953
|
+
/** List Projects belonging to a Customer. */
|
|
954
|
+
listCustomerProjects: this.requestFunctionFactory(descriptors.projectListCustomerProjects),
|
|
955
|
+
/** List Memberships belonging to a Project. */
|
|
956
|
+
listMembershipsForProject: this.requestFunctionFactory(descriptors.projectListMembershipsForProject),
|
|
957
|
+
/** Get the activities of a project. */
|
|
958
|
+
listProjectActivities: this.requestFunctionFactory(descriptors.projectListProjectActivities),
|
|
959
|
+
/** List ProjectInvites belonging to the executing user. */
|
|
960
|
+
listProjectInvites: this.requestFunctionFactory(descriptors.projectListProjectInvites),
|
|
961
|
+
/** List ProjectMemberships belonging to the executing user. */
|
|
962
|
+
listProjectMemberships: this.requestFunctionFactory(descriptors.projectListProjectMemberships),
|
|
963
|
+
/** List Projects belonging to the executing user. */
|
|
964
|
+
listProjects: this.requestFunctionFactory(descriptors.projectListProjects),
|
|
965
|
+
/** List Servers belonging to the executing user. */
|
|
966
|
+
listServers: this.requestFunctionFactory(descriptors.projectListServers),
|
|
967
|
+
/** Resend the mail for a ProjectInvite. */
|
|
968
|
+
resendProjectInviteMail: this.requestFunctionFactory(descriptors.projectResendProjectInviteMail),
|
|
969
|
+
/** Update a Project's description. */
|
|
970
|
+
updateProjectDescription: this.requestFunctionFactory(descriptors.projectUpdateProjectDescription),
|
|
971
|
+
/** Update a Servers's description. */
|
|
972
|
+
updateServerDescription: this.requestFunctionFactory(descriptors.projectUpdateServerDescription),
|
|
973
|
+
/** Get storage space Statistics belonging to a Project. */
|
|
974
|
+
storagespaceGetProjectStatistics: this.requestFunctionFactory(descriptors.storagespaceGetProjectStatistics),
|
|
975
|
+
/** Get storage space Statistics belonging to a Server. */
|
|
976
|
+
storagespaceGetServerStatistics: this.requestFunctionFactory(descriptors.storagespaceGetServerStatistics),
|
|
977
|
+
/** Update a Project's storage space notification threshold. */
|
|
978
|
+
storagespaceReplaceProjectNotificationThreshold: this.requestFunctionFactory(descriptors.storagespaceReplaceProjectNotificationThreshold),
|
|
979
|
+
/** Update a Server's storage space notification threshold. */
|
|
980
|
+
storagespaceReplaceServerNotificationThreshold: this.requestFunctionFactory(descriptors.storagespaceReplaceServerNotificationThreshold),
|
|
981
|
+
};
|
|
982
|
+
/** The filesystem API allows you to directly access the filesystem of your project. */
|
|
983
|
+
projectFileSystem = {
|
|
984
|
+
/** List directories belonging to a Project. */
|
|
985
|
+
getDirectories: this.requestFunctionFactory(descriptors.projectFileSystemGetDirectories),
|
|
986
|
+
/** Get a Project directory filesystem usage. */
|
|
987
|
+
getDiskUsage: this.requestFunctionFactory(descriptors.projectFileSystemGetDiskUsage),
|
|
988
|
+
/** Get a Project file's content. */
|
|
989
|
+
getFileContent: this.requestFunctionFactory(descriptors.projectFileSystemGetFileContent),
|
|
990
|
+
/** Get a Project's file/filesystem authorization token. */
|
|
991
|
+
getJwt: this.requestFunctionFactory(descriptors.projectFileSystemGetJwt),
|
|
992
|
+
/** Get a Project file's information. */
|
|
993
|
+
listFiles: this.requestFunctionFactory(descriptors.projectFileSystemListFiles),
|
|
994
|
+
};
|
|
995
|
+
/** The relocation API allows you to manage your relocations. */
|
|
996
|
+
relocation = {
|
|
997
|
+
/** Register a tariff change for a legacy tariff. */
|
|
998
|
+
createLegacyTariffChange: this.requestFunctionFactory(descriptors.relocationCreateLegacyTariffChange),
|
|
999
|
+
/** Relocate an external Project to mittwald. */
|
|
1000
|
+
createRelocation: this.requestFunctionFactory(descriptors.relocationCreateRelocation),
|
|
1001
|
+
};
|
|
1002
|
+
/** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
|
|
1003
|
+
sshsftpUser = {
|
|
1004
|
+
/** Get all SFTPUsers for a Project. */
|
|
1005
|
+
sftpUserListSftpUsers: this.requestFunctionFactory(descriptors.sftpUserListSftpUsers),
|
|
1006
|
+
/** Create an SFTPUser for a Project. */
|
|
1007
|
+
sftpUserCreateSftpUser: this.requestFunctionFactory(descriptors.sftpUserCreateSftpUser),
|
|
1008
|
+
/** Get an SFTPUser. */
|
|
1009
|
+
sftpUserGetSftpUser: this.requestFunctionFactory(descriptors.sftpUserGetSftpUser),
|
|
1010
|
+
/** Delete an SFTPUser. */
|
|
1011
|
+
sftpUserDeleteSftpUser: this.requestFunctionFactory(descriptors.sftpUserDeleteSftpUser),
|
|
1012
|
+
/** Update an SFTPUser. */
|
|
1013
|
+
sftpUserUpdateSftpUser: this.requestFunctionFactory(descriptors.sftpUserUpdateSftpUser),
|
|
1014
|
+
/** Get all SSHUsers for a Project. */
|
|
1015
|
+
sshUserListSshUsers: this.requestFunctionFactory(descriptors.sshUserListSshUsers),
|
|
1016
|
+
/** Create an SSHUser for a Project. */
|
|
1017
|
+
sshUserCreateSshUser: this.requestFunctionFactory(descriptors.sshUserCreateSshUser),
|
|
1018
|
+
/** Get an SSHUser. */
|
|
1019
|
+
sshUserGetSshUser: this.requestFunctionFactory(descriptors.sshUserGetSshUser),
|
|
1020
|
+
/** Delete an SSHUser. */
|
|
1021
|
+
sshUserDeleteSshUser: this.requestFunctionFactory(descriptors.sshUserDeleteSshUser),
|
|
1022
|
+
/** Update an SSHUser. */
|
|
1023
|
+
sshUserUpdateSshUser: this.requestFunctionFactory(descriptors.sshUserUpdateSshUser),
|
|
1024
|
+
};
|
|
1025
|
+
}
|
|
1026
|
+
export default MittwaldAPIV3NextClient;
|