@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
package/README.md
CHANGED
|
@@ -14,6 +14,7 @@ see the [LICENSE](../../LICENSE) file for details.
|
|
|
14
14
|
|
|
15
15
|
- [Installing](#installing)
|
|
16
16
|
- [Usage](#usage)
|
|
17
|
+
- [Using the v3-next client](#using-the-v3-next-client)
|
|
17
18
|
- [Setting request parameters](#setting-request-parameters)
|
|
18
19
|
- [Path parameters](#path-parameters)
|
|
19
20
|
- [Headers, query parameters and request body](#headers-query-parameters-and-request-body)
|
|
@@ -58,6 +59,34 @@ different types of authentication:
|
|
|
58
59
|
Have a look at our [API introduction][api-getting-started] for more information
|
|
59
60
|
on how to obtain an API token and how to get started with the API.
|
|
60
61
|
|
|
62
|
+
### Using the v3-next client
|
|
63
|
+
|
|
64
|
+
The default import path exposes the v2 client. To use the production
|
|
65
|
+
`v3-next` client, import it from the `@mittwald/api-client/v3-next` subpath:
|
|
66
|
+
|
|
67
|
+
```typescript
|
|
68
|
+
import { MittwaldAPIClient } from "@mittwald/api-client/v3-next";
|
|
69
|
+
|
|
70
|
+
const mittwaldApi = MittwaldAPIClient.newWithToken("your-access-token");
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
The React client is available from the matching React subpath:
|
|
74
|
+
|
|
75
|
+
```typescript
|
|
76
|
+
import { MittwaldAPIClientReact } from "@mittwald/api-client/v3-next/react";
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
TypeScript request and response types are exported through the
|
|
80
|
+
`MittwaldAPIV3Next` namespace:
|
|
81
|
+
|
|
82
|
+
```typescript
|
|
83
|
+
import { MittwaldAPIV3Next } from "@mittwald/api-client/v3-next";
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
This uses the published, non-development `v3-next` client. The package does not
|
|
87
|
+
expose a `@mittwald/api-client/v3-next-dev` import path; the `v3-next-dev`
|
|
88
|
+
OpenAPI spec is only used for generating development builds.
|
|
89
|
+
|
|
61
90
|
### Setting request parameters
|
|
62
91
|
|
|
63
92
|
API requests may require these type of parameters:
|
|
@@ -0,0 +1,559 @@
|
|
|
1
|
+
import { ApiCallAsyncResourceFactory } from "@mittwald/api-client-commons/react";
|
|
2
|
+
import * as descriptors from "./descriptors.js";
|
|
3
|
+
export * from "@mittwald/react-use-promise";
|
|
4
|
+
const buildAiHostingApi = (baseClient) => ({
|
|
5
|
+
/** Get a list of already created keys. */
|
|
6
|
+
customerGetKeys: new ApiCallAsyncResourceFactory(descriptors.aiHostingCustomerGetKeys, baseClient.aiHosting.customerGetKeys).getApiResource,
|
|
7
|
+
/** Get a key of a customer. */
|
|
8
|
+
customerGetKey: new ApiCallAsyncResourceFactory(descriptors.aiHostingCustomerGetKey, baseClient.aiHosting.customerGetKey).getApiResource,
|
|
9
|
+
/** Get a list of currently active models. */
|
|
10
|
+
customerGetDetailedModels: new ApiCallAsyncResourceFactory(descriptors.aiHostingCustomerGetDetailedModels, baseClient.aiHosting.customerGetDetailedModels).getApiResource,
|
|
11
|
+
/** Get ai hosting plan and usages of a customer. */
|
|
12
|
+
customerGetUsage: new ApiCallAsyncResourceFactory(descriptors.aiHostingCustomerGetUsage, baseClient.aiHosting.customerGetUsage).getApiResource,
|
|
13
|
+
/** Get a list of currently active models. */
|
|
14
|
+
getModels: new ApiCallAsyncResourceFactory(descriptors.aiHostingGetModels, baseClient.aiHosting.getModels).getApiResource,
|
|
15
|
+
/** Get a list of keys of a project. */
|
|
16
|
+
projectGetKeys: new ApiCallAsyncResourceFactory(descriptors.aiHostingProjectGetKeys, baseClient.aiHosting.projectGetKeys).getApiResource,
|
|
17
|
+
/** Get a key of a project. */
|
|
18
|
+
projectGetKey: new ApiCallAsyncResourceFactory(descriptors.aiHostingProjectGetKey, baseClient.aiHosting.projectGetKey).getApiResource,
|
|
19
|
+
/** Get a list of currently active models. */
|
|
20
|
+
projectGetDetailedModels: new ApiCallAsyncResourceFactory(descriptors.aiHostingProjectGetDetailedModels, baseClient.aiHosting.projectGetDetailedModels).getApiResource,
|
|
21
|
+
/** Get ai hosting plan and usages of a project. Same as the customer route, but less details. */
|
|
22
|
+
projectGetUsage: new ApiCallAsyncResourceFactory(descriptors.aiHostingProjectGetUsage, baseClient.aiHosting.projectGetUsage).getApiResource,
|
|
23
|
+
});
|
|
24
|
+
const buildAppApi = (baseClient) => ({
|
|
25
|
+
/** Get an App. */
|
|
26
|
+
getApp: new ApiCallAsyncResourceFactory(descriptors.appGetApp, baseClient.app.getApp).getApiResource,
|
|
27
|
+
/** Get an AppInstallation. */
|
|
28
|
+
getAppinstallation: new ApiCallAsyncResourceFactory(descriptors.appGetAppinstallation, baseClient.app.getAppinstallation).getApiResource,
|
|
29
|
+
/** Get an AppVersion. */
|
|
30
|
+
getAppversion: new ApiCallAsyncResourceFactory(descriptors.appGetAppversion, baseClient.app.getAppversion).getApiResource,
|
|
31
|
+
/** Get the installed `SystemSoftware' for a specific `AppInstallation`. */
|
|
32
|
+
getInstalledSystemsoftwareForAppinstallation: new ApiCallAsyncResourceFactory(descriptors.appGetInstalledSystemsoftwareForAppinstallation, baseClient.app.getInstalledSystemsoftwareForAppinstallation).getApiResource,
|
|
33
|
+
/** Get the missing requirements of an appInstallation for a specific target AppVersion. */
|
|
34
|
+
getMissingDependenciesForAppinstallation: new ApiCallAsyncResourceFactory(descriptors.appGetMissingDependenciesForAppinstallation, baseClient.app.getMissingDependenciesForAppinstallation).getApiResource,
|
|
35
|
+
/** Get a SystemSoftware. */
|
|
36
|
+
getSystemsoftware: new ApiCallAsyncResourceFactory(descriptors.appGetSystemsoftware, baseClient.app.getSystemsoftware).getApiResource,
|
|
37
|
+
/** Get a SystemSoftwareVersion. */
|
|
38
|
+
getSystemsoftwareversion: new ApiCallAsyncResourceFactory(descriptors.appGetSystemsoftwareversion, baseClient.app.getSystemsoftwareversion).getApiResource,
|
|
39
|
+
/** List AppInstallations that a user has access to. */
|
|
40
|
+
listAppinstallationsForUser: new ApiCallAsyncResourceFactory(descriptors.appListAppinstallationsForUser, baseClient.app.listAppinstallationsForUser).getApiResource,
|
|
41
|
+
/** List AppInstallations belonging to a Project. */
|
|
42
|
+
listAppinstallations: new ApiCallAsyncResourceFactory(descriptors.appListAppinstallations, baseClient.app.listAppinstallations).getApiResource,
|
|
43
|
+
/** List Apps. */
|
|
44
|
+
listApps: new ApiCallAsyncResourceFactory(descriptors.appListApps, baseClient.app.listApps).getApiResource,
|
|
45
|
+
/** List AppVersions belonging to an App. */
|
|
46
|
+
listAppversions: new ApiCallAsyncResourceFactory(descriptors.appListAppversions, baseClient.app.listAppversions).getApiResource,
|
|
47
|
+
/** List SystemSoftwares. */
|
|
48
|
+
listSystemsoftwares: new ApiCallAsyncResourceFactory(descriptors.appListSystemsoftwares, baseClient.app.listSystemsoftwares).getApiResource,
|
|
49
|
+
/** List SystemSoftwareVersions belonging to a SystemSoftware. */
|
|
50
|
+
listSystemsoftwareversions: new ApiCallAsyncResourceFactory(descriptors.appListSystemsoftwareversions, baseClient.app.listSystemsoftwareversions).getApiResource,
|
|
51
|
+
/** List update candidates belonging to an AppVersion. */
|
|
52
|
+
listUpdateCandidatesForAppversion: new ApiCallAsyncResourceFactory(descriptors.appListUpdateCandidatesForAppversion, baseClient.app.listUpdateCandidatesForAppversion).getApiResource,
|
|
53
|
+
/** Get runtime status belonging to an AppInstallation. */
|
|
54
|
+
retrieveStatus: new ApiCallAsyncResourceFactory(descriptors.appRetrieveStatus, baseClient.app.retrieveStatus).getApiResource,
|
|
55
|
+
});
|
|
56
|
+
const buildArticleApi = (baseClient) => ({
|
|
57
|
+
/** Get an Article. */
|
|
58
|
+
getArticle: new ApiCallAsyncResourceFactory(descriptors.articleGetArticle, baseClient.article.getArticle).getApiResource,
|
|
59
|
+
/** List Articles. */
|
|
60
|
+
listArticles: new ApiCallAsyncResourceFactory(descriptors.articleListArticles, baseClient.article.listArticles).getApiResource,
|
|
61
|
+
});
|
|
62
|
+
const buildBackupApi = (baseClient) => ({
|
|
63
|
+
/** List BackupSchedules belonging to a Project. */
|
|
64
|
+
listProjectBackupSchedules: new ApiCallAsyncResourceFactory(descriptors.backupListProjectBackupSchedules, baseClient.backup.listProjectBackupSchedules).getApiResource,
|
|
65
|
+
/** List Backups belonging to a Project. */
|
|
66
|
+
listProjectBackups: new ApiCallAsyncResourceFactory(descriptors.backupListProjectBackups, baseClient.backup.listProjectBackups).getApiResource,
|
|
67
|
+
/** Get a ProjectBackupSchedule. */
|
|
68
|
+
getProjectBackupSchedule: new ApiCallAsyncResourceFactory(descriptors.backupGetProjectBackupSchedule, baseClient.backup.getProjectBackupSchedule).getApiResource,
|
|
69
|
+
/** Get a ProjectBackup. */
|
|
70
|
+
getProjectBackup: new ApiCallAsyncResourceFactory(descriptors.backupGetProjectBackup, baseClient.backup.getProjectBackup).getApiResource,
|
|
71
|
+
/** List database dump's for a ProjectBackup. */
|
|
72
|
+
getProjectBackupDatabaseDumps: new ApiCallAsyncResourceFactory(descriptors.backupGetProjectBackupDatabaseDumps, baseClient.backup.getProjectBackupDatabaseDumps).getApiResource,
|
|
73
|
+
/** List paths for a ProjectBackup. */
|
|
74
|
+
getProjectBackupDirectories: new ApiCallAsyncResourceFactory(descriptors.backupGetProjectBackupDirectories, baseClient.backup.getProjectBackupDirectories).getApiResource,
|
|
75
|
+
});
|
|
76
|
+
const buildContainerApi = (baseClient) => ({
|
|
77
|
+
/** Call pull-image webhook */
|
|
78
|
+
callPullImageWebhookForService: new ApiCallAsyncResourceFactory(descriptors.containerCallPullImageWebhookForService, baseClient.container.callPullImageWebhookForService).getApiResource,
|
|
79
|
+
/** List Registries belonging to a Project. */
|
|
80
|
+
listRegistries: new ApiCallAsyncResourceFactory(descriptors.containerListRegistries, baseClient.container.listRegistries).getApiResource,
|
|
81
|
+
/** List Stacks belonging to a Project. */
|
|
82
|
+
listStacks: new ApiCallAsyncResourceFactory(descriptors.containerListStacks, baseClient.container.listStacks).getApiResource,
|
|
83
|
+
/** Get a Stack. */
|
|
84
|
+
getStack: new ApiCallAsyncResourceFactory(descriptors.containerGetStack, baseClient.container.getStack).getApiResource,
|
|
85
|
+
/** Get a Registry. */
|
|
86
|
+
getRegistry: new ApiCallAsyncResourceFactory(descriptors.containerGetRegistry, baseClient.container.getRegistry).getApiResource,
|
|
87
|
+
/** Get a Volume belonging to a Stack. */
|
|
88
|
+
getVolume: new ApiCallAsyncResourceFactory(descriptors.containerGetVolume, baseClient.container.getVolume).getApiResource,
|
|
89
|
+
/** Get a ContainerImageConfig. */
|
|
90
|
+
getContainerImageConfig: new ApiCallAsyncResourceFactory(descriptors.containerGetContainerImageConfig, baseClient.container.getContainerImageConfig).getApiResource,
|
|
91
|
+
/** Get logs belonging to a Service. */
|
|
92
|
+
getServiceLogs: new ApiCallAsyncResourceFactory(descriptors.containerGetServiceLogs, baseClient.container.getServiceLogs).getApiResource,
|
|
93
|
+
/** Get a Service belonging to a Stack. */
|
|
94
|
+
getService: new ApiCallAsyncResourceFactory(descriptors.containerGetService, baseClient.container.getService).getApiResource,
|
|
95
|
+
/** Get a Container Template icon. */
|
|
96
|
+
getTemplateIcon: new ApiCallAsyncResourceFactory(descriptors.containerGetTemplateIcon, baseClient.container.getTemplateIcon).getApiResource,
|
|
97
|
+
/** Get a Container Template by ID. */
|
|
98
|
+
getTemplate: new ApiCallAsyncResourceFactory(descriptors.containerGetTemplate, baseClient.container.getTemplate).getApiResource,
|
|
99
|
+
/** List Stacks belonging to the executing user. */
|
|
100
|
+
listSelfStacks: new ApiCallAsyncResourceFactory(descriptors.containerListSelfStacks, baseClient.container.listSelfStacks).getApiResource,
|
|
101
|
+
/** List Services belonging to a Project. */
|
|
102
|
+
listServices: new ApiCallAsyncResourceFactory(descriptors.containerListServices, baseClient.container.listServices).getApiResource,
|
|
103
|
+
/** List Volumes belonging to a Stack. */
|
|
104
|
+
listStackVolumes: new ApiCallAsyncResourceFactory(descriptors.containerListStackVolumes, baseClient.container.listStackVolumes).getApiResource,
|
|
105
|
+
/** List Container Templates. */
|
|
106
|
+
listTemplates: new ApiCallAsyncResourceFactory(descriptors.containerListTemplates, baseClient.container.listTemplates).getApiResource,
|
|
107
|
+
/** List Volumes belonging to a Project. */
|
|
108
|
+
listVolumes: new ApiCallAsyncResourceFactory(descriptors.containerListVolumes, baseClient.container.listVolumes).getApiResource,
|
|
109
|
+
});
|
|
110
|
+
const buildContractApi = (baseClient) => ({
|
|
111
|
+
/** Return the BaseItem of the Contract with the given ID. */
|
|
112
|
+
getBaseItemOfContract: new ApiCallAsyncResourceFactory(descriptors.contractGetBaseItemOfContract, baseClient.contract.getBaseItemOfContract).getApiResource,
|
|
113
|
+
/** Return the AI Hosting Contract for the given Customer. */
|
|
114
|
+
getDetailOfContractByAiHosting: new ApiCallAsyncResourceFactory(descriptors.contractGetDetailOfContractByAiHosting, baseClient.contract.getDetailOfContractByAiHosting).getApiResource,
|
|
115
|
+
/** Return the Contract for the given Certificate. */
|
|
116
|
+
getDetailOfContractByCertificate: new ApiCallAsyncResourceFactory(descriptors.contractGetDetailOfContractByCertificate, baseClient.contract.getDetailOfContractByCertificate).getApiResource,
|
|
117
|
+
/** Return the Contract for the given Domain. */
|
|
118
|
+
getDetailOfContractByDomain: new ApiCallAsyncResourceFactory(descriptors.contractGetDetailOfContractByDomain, baseClient.contract.getDetailOfContractByDomain).getApiResource,
|
|
119
|
+
/** Return the Contract for the given LeadFyndrProfile. */
|
|
120
|
+
getDetailOfContractByLeadFyndr: new ApiCallAsyncResourceFactory(descriptors.contractGetDetailOfContractByLeadFyndr, baseClient.contract.getDetailOfContractByLeadFyndr).getApiResource,
|
|
121
|
+
/** Return the Contract for the given License. */
|
|
122
|
+
getDetailOfContractByLicense: new ApiCallAsyncResourceFactory(descriptors.contractGetDetailOfContractByLicense, baseClient.contract.getDetailOfContractByLicense).getApiResource,
|
|
123
|
+
/** Return the Contract for the given Mail Address. */
|
|
124
|
+
getDetailOfContractByMailAddress: new ApiCallAsyncResourceFactory(descriptors.contractGetDetailOfContractByMailAddress, baseClient.contract.getDetailOfContractByMailAddress).getApiResource,
|
|
125
|
+
/** Return the Contract for the given Project. */
|
|
126
|
+
getDetailOfContractByProject: new ApiCallAsyncResourceFactory(descriptors.contractGetDetailOfContractByProject, baseClient.contract.getDetailOfContractByProject).getApiResource,
|
|
127
|
+
/** Return the Contract for the given Server. */
|
|
128
|
+
getDetailOfContractByServer: new ApiCallAsyncResourceFactory(descriptors.contractGetDetailOfContractByServer, baseClient.contract.getDetailOfContractByServer).getApiResource,
|
|
129
|
+
/** Get the ContractItem with the given ID. */
|
|
130
|
+
getDetailOfContractItem: new ApiCallAsyncResourceFactory(descriptors.contractGetDetailOfContractItem, baseClient.contract.getDetailOfContractItem).getApiResource,
|
|
131
|
+
/** Returns the Contract with the given ID. */
|
|
132
|
+
getDetailOfContract: new ApiCallAsyncResourceFactory(descriptors.contractGetDetailOfContract, baseClient.contract.getDetailOfContract).getApiResource,
|
|
133
|
+
/** Return a list of Contracts for the given Customer. */
|
|
134
|
+
listContracts: new ApiCallAsyncResourceFactory(descriptors.contractListContracts, baseClient.contract.listContracts).getApiResource,
|
|
135
|
+
/** Get details of an Invoice. */
|
|
136
|
+
invoiceDetail: new ApiCallAsyncResourceFactory(descriptors.invoiceDetail, baseClient.contract.invoiceDetail).getApiResource,
|
|
137
|
+
/** Get InvoiceSettings of a Customer. */
|
|
138
|
+
invoiceGetDetailOfInvoiceSettings: new ApiCallAsyncResourceFactory(descriptors.invoiceGetDetailOfInvoiceSettings, baseClient.contract.invoiceGetDetailOfInvoiceSettings).getApiResource,
|
|
139
|
+
/** Request an Access Token for the Invoice file. */
|
|
140
|
+
invoiceGetFileAccessToken: new ApiCallAsyncResourceFactory(descriptors.invoiceGetFileAccessToken, baseClient.contract.invoiceGetFileAccessToken).getApiResource,
|
|
141
|
+
/** List Invoices of a Customer. */
|
|
142
|
+
invoiceListCustomerInvoices: new ApiCallAsyncResourceFactory(descriptors.invoiceListCustomerInvoices, baseClient.contract.invoiceListCustomerInvoices).getApiResource,
|
|
143
|
+
/** Get list of Orders. */
|
|
144
|
+
orderListOrders: new ApiCallAsyncResourceFactory(descriptors.orderListOrders, baseClient.contract.orderListOrders).getApiResource,
|
|
145
|
+
/** Get Order for Customer. */
|
|
146
|
+
orderGetOrder: new ApiCallAsyncResourceFactory(descriptors.orderGetOrder, baseClient.contract.orderGetOrder).getApiResource,
|
|
147
|
+
/** Get list of Orders of a Customer. */
|
|
148
|
+
orderListCustomerOrders: new ApiCallAsyncResourceFactory(descriptors.orderListCustomerOrders, baseClient.contract.orderListCustomerOrders).getApiResource,
|
|
149
|
+
/** Get list of Orders of a Project. */
|
|
150
|
+
orderListProjectOrders: new ApiCallAsyncResourceFactory(descriptors.orderListProjectOrders, baseClient.contract.orderListProjectOrders).getApiResource,
|
|
151
|
+
});
|
|
152
|
+
const buildMarketplaceApi = (baseClient) => ({
|
|
153
|
+
/** Get a Contributor. */
|
|
154
|
+
extensionGetContributor: new ApiCallAsyncResourceFactory(descriptors.extensionGetContributor, baseClient.marketplace.extensionGetContributor).getApiResource,
|
|
155
|
+
/** Get Contributor Billing Information. */
|
|
156
|
+
contributorGetBillingInformation: new ApiCallAsyncResourceFactory(descriptors.contributorGetBillingInformation, baseClient.marketplace.contributorGetBillingInformation).getApiResource,
|
|
157
|
+
/** Get the Stripe Billing Portal Link for a Customer */
|
|
158
|
+
contributorGetCustomerBillingPortalLink: new ApiCallAsyncResourceFactory(descriptors.contributorGetCustomerBillingPortalLink, baseClient.marketplace.contributorGetCustomerBillingPortalLink).getApiResource,
|
|
159
|
+
/** Get the Stripe Dashboard Link for a Contributor. */
|
|
160
|
+
contributorGetLoginLink: new ApiCallAsyncResourceFactory(descriptors.contributorGetLoginLink, baseClient.marketplace.contributorGetLoginLink).getApiResource,
|
|
161
|
+
/** List ContractPartners of the contributor. */
|
|
162
|
+
contributorListContractPartnersOfContributor: new ApiCallAsyncResourceFactory(descriptors.contributorListContractPartnersOfContributor, baseClient.marketplace.contributorListContractPartnersOfContributor).getApiResource,
|
|
163
|
+
/** List incoming Invoices of a Contributor. */
|
|
164
|
+
contributorListIncomingInvoices: new ApiCallAsyncResourceFactory(descriptors.contributorListIncomingInvoices, baseClient.marketplace.contributorListIncomingInvoices).getApiResource,
|
|
165
|
+
/** List all invoices on behalf of a contributor. */
|
|
166
|
+
contributorListOnbehalfInvoices: new ApiCallAsyncResourceFactory(descriptors.contributorListOnbehalfInvoices, baseClient.marketplace.contributorListOnbehalfInvoices).getApiResource,
|
|
167
|
+
/** Request an Access Token for the Incoming Invoice file. */
|
|
168
|
+
contributorReceiptGetFileAccessToken: new ApiCallAsyncResourceFactory(descriptors.contributorReceiptGetFileAccessToken, baseClient.marketplace.contributorReceiptGetFileAccessToken).getApiResource,
|
|
169
|
+
/** Check if an Extension is unchargable for this specific context or if it must be charged. */
|
|
170
|
+
extensionCheckExtensionIsChargable: new ApiCallAsyncResourceFactory(descriptors.extensionCheckExtensionIsChargable, baseClient.marketplace.extensionCheckExtensionIsChargable).getApiResource,
|
|
171
|
+
/** List ExtensionInstances. */
|
|
172
|
+
extensionListExtensionInstances: new ApiCallAsyncResourceFactory(descriptors.extensionListExtensionInstances, baseClient.marketplace.extensionListExtensionInstances).getApiResource,
|
|
173
|
+
/** Get an ExtensionInstance. */
|
|
174
|
+
extensionGetExtensionInstance: new ApiCallAsyncResourceFactory(descriptors.extensionGetExtensionInstance, baseClient.marketplace.extensionGetExtensionInstance).getApiResource,
|
|
175
|
+
/** Get Extension of own contributor. */
|
|
176
|
+
extensionGetOwnExtension: new ApiCallAsyncResourceFactory(descriptors.extensionGetOwnExtension, baseClient.marketplace.extensionGetOwnExtension).getApiResource,
|
|
177
|
+
/** Get all open extension orders for given customer */
|
|
178
|
+
extensionGetCustomerExtensionInstanceOrders: new ApiCallAsyncResourceFactory(descriptors.extensionGetCustomerExtensionInstanceOrders, baseClient.marketplace.extensionGetCustomerExtensionInstanceOrders).getApiResource,
|
|
179
|
+
/** Get the Contract Strategy of an Extension Instance */
|
|
180
|
+
extensionGetExtensionInstanceContract: new ApiCallAsyncResourceFactory(descriptors.extensionGetExtensionInstanceContract, baseClient.marketplace.extensionGetExtensionInstanceContract).getApiResource,
|
|
181
|
+
/** Get the ExtensionInstance of a specific customer and extension, if existing. */
|
|
182
|
+
extensionGetExtensionInstanceForCustomer: new ApiCallAsyncResourceFactory(descriptors.extensionGetExtensionInstanceForCustomer, baseClient.marketplace.extensionGetExtensionInstanceForCustomer).getApiResource,
|
|
183
|
+
/** Get the ExtensionInstance of a specific project and extension, if existing. */
|
|
184
|
+
extensionGetExtensionInstanceForProject: new ApiCallAsyncResourceFactory(descriptors.extensionGetExtensionInstanceForProject, baseClient.marketplace.extensionGetExtensionInstanceForProject).getApiResource,
|
|
185
|
+
/** Get an Extension. */
|
|
186
|
+
extensionGetExtension: new ApiCallAsyncResourceFactory(descriptors.extensionGetExtension, baseClient.marketplace.extensionGetExtension).getApiResource,
|
|
187
|
+
/** Get all open extension orders for given project */
|
|
188
|
+
extensionGetProjectExtensionInstanceOrders: new ApiCallAsyncResourceFactory(descriptors.extensionGetProjectExtensionInstanceOrders, baseClient.marketplace.extensionGetProjectExtensionInstanceOrders).getApiResource,
|
|
189
|
+
/** Get the public key to verify the webhook signature. */
|
|
190
|
+
extensionGetPublicKey: new ApiCallAsyncResourceFactory(descriptors.extensionGetPublicKey, baseClient.marketplace.extensionGetPublicKey).getApiResource,
|
|
191
|
+
/** List all Webhook Executions. */
|
|
192
|
+
extensionListAllExtensionInstanceWebhookExecutions: new ApiCallAsyncResourceFactory(descriptors.extensionListAllExtensionInstanceWebhookExecutions, baseClient.marketplace.extensionListAllExtensionInstanceWebhookExecutions).getApiResource,
|
|
193
|
+
/** List Contributors. */
|
|
194
|
+
extensionListContributors: new ApiCallAsyncResourceFactory(descriptors.extensionListContributors, baseClient.marketplace.extensionListContributors).getApiResource,
|
|
195
|
+
/** List Extensions. */
|
|
196
|
+
extensionListExtensions: new ApiCallAsyncResourceFactory(descriptors.extensionListExtensions, baseClient.marketplace.extensionListExtensions).getApiResource,
|
|
197
|
+
/** List Extensions of own contributor. */
|
|
198
|
+
extensionListOwnExtensions: new ApiCallAsyncResourceFactory(descriptors.extensionListOwnExtensions, baseClient.marketplace.extensionListOwnExtensions).getApiResource,
|
|
199
|
+
/** List Scopes. */
|
|
200
|
+
extensionListScopes: new ApiCallAsyncResourceFactory(descriptors.extensionListScopes, baseClient.marketplace.extensionListScopes).getApiResource,
|
|
201
|
+
/** Get payment method details */
|
|
202
|
+
customerGetPaymentMethod: new ApiCallAsyncResourceFactory(descriptors.marketplaceCustomerGetPaymentMethod, baseClient.marketplace.customerGetPaymentMethod).getApiResource,
|
|
203
|
+
});
|
|
204
|
+
const buildConversationApi = (baseClient) => ({
|
|
205
|
+
/** Get all conversation the authenticated user has created or has access to. */
|
|
206
|
+
listConversations: new ApiCallAsyncResourceFactory(descriptors.conversationListConversations, baseClient.conversation.listConversations).getApiResource,
|
|
207
|
+
/** Get all message of the conversation. */
|
|
208
|
+
listMessagesByConversation: new ApiCallAsyncResourceFactory(descriptors.conversationListMessagesByConversation, baseClient.conversation.listMessagesByConversation).getApiResource,
|
|
209
|
+
/** Get a specific conversation category. */
|
|
210
|
+
getCategory: new ApiCallAsyncResourceFactory(descriptors.conversationGetCategory, baseClient.conversation.getCategory).getApiResource,
|
|
211
|
+
/** Get members of a support conversation. */
|
|
212
|
+
getConversationMembers: new ApiCallAsyncResourceFactory(descriptors.conversationGetConversationMembers, baseClient.conversation.getConversationMembers).getApiResource,
|
|
213
|
+
/** Get preferences for customer conversations. */
|
|
214
|
+
getConversationPreferencesOfCustomer: new ApiCallAsyncResourceFactory(descriptors.conversationGetConversationPreferencesOfCustomer, baseClient.conversation.getConversationPreferencesOfCustomer).getApiResource,
|
|
215
|
+
/** Get a support conversation. */
|
|
216
|
+
getConversation: new ApiCallAsyncResourceFactory(descriptors.conversationGetConversation, baseClient.conversation.getConversation).getApiResource,
|
|
217
|
+
/** Request an access token for the File belonging to the Conversation. */
|
|
218
|
+
getFileAccessToken: new ApiCallAsyncResourceFactory(descriptors.conversationGetFileAccessToken, baseClient.conversation.getFileAccessToken).getApiResource,
|
|
219
|
+
/** Get all conversation categories. */
|
|
220
|
+
listCategories: new ApiCallAsyncResourceFactory(descriptors.conversationListCategories, baseClient.conversation.listCategories).getApiResource,
|
|
221
|
+
});
|
|
222
|
+
const buildCronjobApi = (baseClient) => ({
|
|
223
|
+
/** List Cronjobs belonging to a Project. */
|
|
224
|
+
listCronjobs: new ApiCallAsyncResourceFactory(descriptors.cronjobListCronjobs, baseClient.cronjob.listCronjobs).getApiResource,
|
|
225
|
+
/** List CronjobExecutions belonging to a Cronjob. */
|
|
226
|
+
listExecutions: new ApiCallAsyncResourceFactory(descriptors.cronjobListExecutions, baseClient.cronjob.listExecutions).getApiResource,
|
|
227
|
+
/** Get a Cronjob. */
|
|
228
|
+
getCronjob: new ApiCallAsyncResourceFactory(descriptors.cronjobGetCronjob, baseClient.cronjob.getCronjob).getApiResource,
|
|
229
|
+
/** Get a CronjobExecution analysis for failed executions. */
|
|
230
|
+
getExecutionAnalysis: new ApiCallAsyncResourceFactory(descriptors.cronjobGetExecutionAnalysis, baseClient.cronjob.getExecutionAnalysis).getApiResource,
|
|
231
|
+
/** Get a CronjobExecution. */
|
|
232
|
+
getExecution: new ApiCallAsyncResourceFactory(descriptors.cronjobGetExecution, baseClient.cronjob.getExecution).getApiResource,
|
|
233
|
+
});
|
|
234
|
+
const buildCustomerApi = (baseClient) => ({
|
|
235
|
+
/** List Invites belonging to a Customer. */
|
|
236
|
+
listInvitesForCustomer: new ApiCallAsyncResourceFactory(descriptors.customerListInvitesForCustomer, baseClient.customer.listInvitesForCustomer).getApiResource,
|
|
237
|
+
/** Get all customer profiles the authenticated user has access to. */
|
|
238
|
+
listCustomers: new ApiCallAsyncResourceFactory(descriptors.customerListCustomers, baseClient.customer.listCustomers).getApiResource,
|
|
239
|
+
/** Gets the Wallet of the Customer. */
|
|
240
|
+
getWallet: new ApiCallAsyncResourceFactory(descriptors.customerGetWallet, baseClient.customer.getWallet).getApiResource,
|
|
241
|
+
/** Get a CustomerInvite. */
|
|
242
|
+
getCustomerInvite: new ApiCallAsyncResourceFactory(descriptors.customerGetCustomerInvite, baseClient.customer.getCustomerInvite).getApiResource,
|
|
243
|
+
/** Get a CustomerMembership. */
|
|
244
|
+
getCustomerMembership: new ApiCallAsyncResourceFactory(descriptors.customerGetCustomerMembership, baseClient.customer.getCustomerMembership).getApiResource,
|
|
245
|
+
/** Get a customer profile. */
|
|
246
|
+
getCustomer: new ApiCallAsyncResourceFactory(descriptors.customerGetCustomer, baseClient.customer.getCustomer).getApiResource,
|
|
247
|
+
/** Get a CustomerInvite by token. */
|
|
248
|
+
getCustomerTokenInvite: new ApiCallAsyncResourceFactory(descriptors.customerGetCustomerTokenInvite, baseClient.customer.getCustomerTokenInvite).getApiResource,
|
|
249
|
+
/** Check if the customer profile has a valid contract partner configured. */
|
|
250
|
+
isCustomerLegallyCompetent: new ApiCallAsyncResourceFactory(descriptors.customerIsCustomerLegallyCompetent, baseClient.customer.isCustomerLegallyCompetent).getApiResource,
|
|
251
|
+
/** List CustomerInvites belonging to the executing user. */
|
|
252
|
+
listCustomerInvites: new ApiCallAsyncResourceFactory(descriptors.customerListCustomerInvites, baseClient.customer.listCustomerInvites).getApiResource,
|
|
253
|
+
/** List CustomerMemberships belonging to the executing user. */
|
|
254
|
+
listCustomerMemberships: new ApiCallAsyncResourceFactory(descriptors.customerListCustomerMemberships, baseClient.customer.listCustomerMemberships).getApiResource,
|
|
255
|
+
/** List Memberships belonging to a Customer. */
|
|
256
|
+
listMembershipsForCustomer: new ApiCallAsyncResourceFactory(descriptors.customerListMembershipsForCustomer, baseClient.customer.listMembershipsForCustomer).getApiResource,
|
|
257
|
+
});
|
|
258
|
+
const buildDatabaseApi = (baseClient) => ({
|
|
259
|
+
/** List MySQLDatabases belonging to a Project. */
|
|
260
|
+
listMysqlDatabases: new ApiCallAsyncResourceFactory(descriptors.databaseListMysqlDatabases, baseClient.database.listMysqlDatabases).getApiResource,
|
|
261
|
+
/** List MySQLUsers belonging to a Database. */
|
|
262
|
+
listMysqlUsers: new ApiCallAsyncResourceFactory(descriptors.databaseListMysqlUsers, baseClient.database.listMysqlUsers).getApiResource,
|
|
263
|
+
/** List RedisDatabases belonging to a Project. */
|
|
264
|
+
listRedisDatabases: new ApiCallAsyncResourceFactory(descriptors.databaseListRedisDatabases, baseClient.database.listRedisDatabases).getApiResource,
|
|
265
|
+
/** Get a MySQLDatabase. */
|
|
266
|
+
getMysqlDatabase: new ApiCallAsyncResourceFactory(descriptors.databaseGetMysqlDatabase, baseClient.database.getMysqlDatabase).getApiResource,
|
|
267
|
+
/** Get a MySQLUser. */
|
|
268
|
+
getMysqlUser: new ApiCallAsyncResourceFactory(descriptors.databaseGetMysqlUser, baseClient.database.getMysqlUser).getApiResource,
|
|
269
|
+
/** Get a RedisDatabase. */
|
|
270
|
+
getRedisDatabase: new ApiCallAsyncResourceFactory(descriptors.databaseGetRedisDatabase, baseClient.database.getRedisDatabase).getApiResource,
|
|
271
|
+
/** Get a MySQLUser's PhpMyAdmin-URL. */
|
|
272
|
+
getMysqlUserPhpMyAdminUrl: new ApiCallAsyncResourceFactory(descriptors.databaseGetMysqlUserPhpMyAdminUrl, baseClient.database.getMysqlUserPhpMyAdminUrl).getApiResource,
|
|
273
|
+
/** List available MySQL character sets and collations, optionally filtered by a MySQLVersion. */
|
|
274
|
+
listMysqlCharsets: new ApiCallAsyncResourceFactory(descriptors.databaseListMysqlCharsets, baseClient.database.listMysqlCharsets).getApiResource,
|
|
275
|
+
/** List MySQLVersions. */
|
|
276
|
+
listMysqlVersions: new ApiCallAsyncResourceFactory(descriptors.databaseListMysqlVersions, baseClient.database.listMysqlVersions).getApiResource,
|
|
277
|
+
/** List RedisVersions. */
|
|
278
|
+
listRedisVersions: new ApiCallAsyncResourceFactory(descriptors.databaseListRedisVersions, baseClient.database.listRedisVersions).getApiResource,
|
|
279
|
+
});
|
|
280
|
+
const buildDomainApi = (baseClient) => ({
|
|
281
|
+
/** List Domains */
|
|
282
|
+
listDomains: new ApiCallAsyncResourceFactory(descriptors.domainListDomains, baseClient.domain.listDomains).getApiResource,
|
|
283
|
+
/** Get a DNSZone. */
|
|
284
|
+
dnsGetDnsZone: new ApiCallAsyncResourceFactory(descriptors.dnsGetDnsZone, baseClient.domain.dnsGetDnsZone).getApiResource,
|
|
285
|
+
/** Get a zone file for a DNSZone. */
|
|
286
|
+
dnsGetZoneFile: new ApiCallAsyncResourceFactory(descriptors.dnsGetZoneFile, baseClient.domain.dnsGetZoneFile).getApiResource,
|
|
287
|
+
/** List DNSZones belonging to a Project. */
|
|
288
|
+
dnsListDnsZones: new ApiCallAsyncResourceFactory(descriptors.dnsListDnsZones, baseClient.domain.dnsListDnsZones).getApiResource,
|
|
289
|
+
/** Get a Domain. */
|
|
290
|
+
getDomain: new ApiCallAsyncResourceFactory(descriptors.domainGetDomain, baseClient.domain.getDomain).getApiResource,
|
|
291
|
+
/** Get a Contact-Verification. */
|
|
292
|
+
getContactVerification: new ApiCallAsyncResourceFactory(descriptors.domainGetContactVerification, baseClient.domain.getContactVerification).getApiResource,
|
|
293
|
+
/** Get the latest screenshot's FileReference belonging to a Domain. */
|
|
294
|
+
getLatestScreenshot: new ApiCallAsyncResourceFactory(descriptors.domainGetLatestScreenshot, baseClient.domain.getLatestScreenshot).getApiResource,
|
|
295
|
+
/** List Contact-Verifications belonging to the executing user. */
|
|
296
|
+
listContactVerifications: new ApiCallAsyncResourceFactory(descriptors.domainListContactVerifications, baseClient.domain.listContactVerifications).getApiResource,
|
|
297
|
+
/** List the contact schemas for a TLD. */
|
|
298
|
+
listTldContactSchemas: new ApiCallAsyncResourceFactory(descriptors.domainListTldContactSchemas, baseClient.domain.listTldContactSchemas).getApiResource,
|
|
299
|
+
/** List TLDs. */
|
|
300
|
+
listTlds: new ApiCallAsyncResourceFactory(descriptors.domainListTlds, baseClient.domain.listTlds).getApiResource,
|
|
301
|
+
/** List Domain-Migrations belonging to a Project. */
|
|
302
|
+
migrationListMigrationsByProjectId: new ApiCallAsyncResourceFactory(descriptors.domainMigrationListMigrationsByProjectId, baseClient.domain.migrationListMigrationsByProjectId).getApiResource,
|
|
303
|
+
/** Suggest a list of domains based on a prompt using AI. */
|
|
304
|
+
suggest: new ApiCallAsyncResourceFactory(descriptors.domainSuggest, baseClient.domain.suggest).getApiResource,
|
|
305
|
+
/** List Ingresses. */
|
|
306
|
+
ingressListIngresses: new ApiCallAsyncResourceFactory(descriptors.ingressListIngresses, baseClient.domain.ingressListIngresses).getApiResource,
|
|
307
|
+
/** Get an Ingress. */
|
|
308
|
+
ingressGetIngress: new ApiCallAsyncResourceFactory(descriptors.ingressGetIngress, baseClient.domain.ingressGetIngress).getApiResource,
|
|
309
|
+
/** List CertificateRequests belonging to a Project or an Ingress. */
|
|
310
|
+
sslListCertificateRequests: new ApiCallAsyncResourceFactory(descriptors.sslListCertificateRequests, baseClient.domain.sslListCertificateRequests).getApiResource,
|
|
311
|
+
/** Get a CertificateRequest. */
|
|
312
|
+
sslGetCertificateRequest: new ApiCallAsyncResourceFactory(descriptors.sslGetCertificateRequest, baseClient.domain.sslGetCertificateRequest).getApiResource,
|
|
313
|
+
/** Get a Certificate. */
|
|
314
|
+
sslGetCertificate: new ApiCallAsyncResourceFactory(descriptors.sslGetCertificate, baseClient.domain.sslGetCertificate).getApiResource,
|
|
315
|
+
/** List Certificates belonging to a Project or an Ingress. */
|
|
316
|
+
sslListCertificates: new ApiCallAsyncResourceFactory(descriptors.sslListCertificates, baseClient.domain.sslListCertificates).getApiResource,
|
|
317
|
+
});
|
|
318
|
+
const buildFileApi = (baseClient) => ({
|
|
319
|
+
/** Get a File's meta. */
|
|
320
|
+
getFileMeta: new ApiCallAsyncResourceFactory(descriptors.fileGetFileMeta, baseClient.file.getFileMeta).getApiResource,
|
|
321
|
+
/** Get a FileUploadToken's rules. */
|
|
322
|
+
getFileUploadTokenRules: new ApiCallAsyncResourceFactory(descriptors.fileGetFileUploadTokenRules, baseClient.file.getFileUploadTokenRules).getApiResource,
|
|
323
|
+
/** Get a FileUploadType's rules. */
|
|
324
|
+
getFileUploadTypeRules: new ApiCallAsyncResourceFactory(descriptors.fileGetFileUploadTypeRules, baseClient.file.getFileUploadTypeRules).getApiResource,
|
|
325
|
+
/** Get a File. */
|
|
326
|
+
getFile: new ApiCallAsyncResourceFactory(descriptors.fileGetFile, baseClient.file.getFile).getApiResource,
|
|
327
|
+
/** Get a File with user-friendly url. */
|
|
328
|
+
getFileWithName: new ApiCallAsyncResourceFactory(descriptors.fileGetFileWithName, baseClient.file.getFileWithName).getApiResource,
|
|
329
|
+
});
|
|
330
|
+
const buildLeadFyndrApi = (baseClient) => ({
|
|
331
|
+
/** Get your LeadFyndr request. */
|
|
332
|
+
leadfyndrGetLeadFyndrProfileRequest: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetLeadFyndrProfileRequest, baseClient.leadFyndr.leadfyndrGetLeadFyndrProfileRequest).getApiResource,
|
|
333
|
+
/** Get cities in DACH. */
|
|
334
|
+
leadfyndrGetCities: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetCities, baseClient.leadFyndr.leadfyndrGetCities).getApiResource,
|
|
335
|
+
/** Get lead tariff options. How many leads did you unlock this month? */
|
|
336
|
+
leadfyndrGetLeadFyndrProfileTariffOptions: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetLeadFyndrProfileTariffOptions, baseClient.leadFyndr.leadfyndrGetLeadFyndrProfileTariffOptions).getApiResource,
|
|
337
|
+
/** Get your LeadFyndr profile. */
|
|
338
|
+
leadfyndrGetLeadFyndrProfile: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetLeadFyndrProfile, baseClient.leadFyndr.leadfyndrGetLeadFyndrProfile).getApiResource,
|
|
339
|
+
/** Get a simple lead. Use the unlocked route for more detail leads. */
|
|
340
|
+
leadfyndrGetLead: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetLead, baseClient.leadFyndr.leadfyndrGetLead).getApiResource,
|
|
341
|
+
/** Get unlocked leads export history for the given customerId. */
|
|
342
|
+
leadfyndrGetLeadsExportHistory: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetLeadsExportHistory, baseClient.leadFyndr.leadfyndrGetLeadsExportHistory).getApiResource,
|
|
343
|
+
/** Get a detail of a unlocked lead. Organisation can unlock leads. */
|
|
344
|
+
leadfyndrGetUnlockedLead: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetUnlockedLead, baseClient.leadFyndr.leadfyndrGetUnlockedLead).getApiResource,
|
|
345
|
+
/** Get all leads. Use the unlocked routes for more lead details. */
|
|
346
|
+
leadfyndrListLeads: new ApiCallAsyncResourceFactory(descriptors.leadfyndrListLeads, baseClient.leadFyndr.leadfyndrListLeads).getApiResource,
|
|
347
|
+
/** Get all unlocked leads. Organisation can unlock leads. */
|
|
348
|
+
leadfyndrListUnlockedLeads: new ApiCallAsyncResourceFactory(descriptors.leadfyndrListUnlockedLeads, baseClient.leadFyndr.leadfyndrListUnlockedLeads).getApiResource,
|
|
349
|
+
});
|
|
350
|
+
const buildLicenseApi = (baseClient) => ({
|
|
351
|
+
/** Get a license. */
|
|
352
|
+
getLicense: new ApiCallAsyncResourceFactory(descriptors.licenseGetLicense, baseClient.license.getLicense).getApiResource,
|
|
353
|
+
/** List Licenses belonging to a Project. */
|
|
354
|
+
listLicensesForProject: new ApiCallAsyncResourceFactory(descriptors.licenseListLicensesForProject, baseClient.license.listLicensesForProject).getApiResource,
|
|
355
|
+
});
|
|
356
|
+
const buildMailApi = (baseClient) => ({
|
|
357
|
+
/** List DeliveryBoxes belonging to a Project. */
|
|
358
|
+
listDeliveryBoxes: new ApiCallAsyncResourceFactory(descriptors.mailListDeliveryBoxes, baseClient.mail.listDeliveryBoxes).getApiResource,
|
|
359
|
+
/** List MailAddresses belonging to a Project. */
|
|
360
|
+
listMailAddresses: new ApiCallAsyncResourceFactory(descriptors.mailListMailAddresses, baseClient.mail.listMailAddresses).getApiResource,
|
|
361
|
+
/** Get a DeliveryBox. */
|
|
362
|
+
getDeliveryBox: new ApiCallAsyncResourceFactory(descriptors.mailGetDeliveryBox, baseClient.mail.getDeliveryBox).getApiResource,
|
|
363
|
+
/** Get a MailAddress. */
|
|
364
|
+
getMailAddress: new ApiCallAsyncResourceFactory(descriptors.mailGetMailAddress, baseClient.mail.getMailAddress).getApiResource,
|
|
365
|
+
/** List backups belonging to a MailAddress. */
|
|
366
|
+
listBackupsForMailAddress: new ApiCallAsyncResourceFactory(descriptors.mailListBackupsForMailAddress, baseClient.mail.listBackupsForMailAddress).getApiResource,
|
|
367
|
+
/** List MailAddresses. */
|
|
368
|
+
listMailAddressesForUser: new ApiCallAsyncResourceFactory(descriptors.mailListMailAddressesForUser, baseClient.mail.listMailAddressesForUser).getApiResource,
|
|
369
|
+
/** List mail settings of a Project. */
|
|
370
|
+
listProjectMailSettings: new ApiCallAsyncResourceFactory(descriptors.mailListProjectMailSettings, baseClient.mail.listProjectMailSettings).getApiResource,
|
|
371
|
+
});
|
|
372
|
+
const buildMiscApi = (baseClient) => ({
|
|
373
|
+
/** List valid time zones. */
|
|
374
|
+
ellaneousListTimeZones: new ApiCallAsyncResourceFactory(descriptors.miscellaneousListTimeZones, baseClient.misc.ellaneousListTimeZones).getApiResource,
|
|
375
|
+
});
|
|
376
|
+
const buildNotificationApi = (baseClient) => ({
|
|
377
|
+
/** Getting the subscription status of the subscription. */
|
|
378
|
+
newsletterGetInfo: new ApiCallAsyncResourceFactory(descriptors.newsletterGetInfo, baseClient.notification.newsletterGetInfo).getApiResource,
|
|
379
|
+
/** Get the counts for unread notifications of the user. */
|
|
380
|
+
scountUnreadNotifications: new ApiCallAsyncResourceFactory(descriptors.notificationsCountUnreadNotifications, baseClient.notification.scountUnreadNotifications).getApiResource,
|
|
381
|
+
/** List all unread notifications. */
|
|
382
|
+
slistNotifications: new ApiCallAsyncResourceFactory(descriptors.notificationsListNotifications, baseClient.notification.slistNotifications).getApiResource,
|
|
383
|
+
});
|
|
384
|
+
const buildPageInsightsApi = (baseClient) => ({
|
|
385
|
+
/** Get detailed performance data for a given domain and path. */
|
|
386
|
+
pageinsightsGetPerformanceData: new ApiCallAsyncResourceFactory(descriptors.pageinsightsGetPerformanceData, baseClient.pageInsights.pageinsightsGetPerformanceData).getApiResource,
|
|
387
|
+
/** Get all data for a given strace. */
|
|
388
|
+
pageinsightsGetStraceData: new ApiCallAsyncResourceFactory(descriptors.pageinsightsGetStraceData, baseClient.pageInsights.pageinsightsGetStraceData).getApiResource,
|
|
389
|
+
/** List websites (specified as domain and path) from a project where performance data is available. */
|
|
390
|
+
pageinsightsListPerformanceDataForProject: new ApiCallAsyncResourceFactory(descriptors.pageinsightsListPerformanceDataForProject, baseClient.pageInsights.pageinsightsListPerformanceDataForProject).getApiResource,
|
|
391
|
+
});
|
|
392
|
+
const buildUserApi = (baseClient) => ({
|
|
393
|
+
/** Get a PasswordPolicy. */
|
|
394
|
+
passwordValidationGetPasswordPolicy: new ApiCallAsyncResourceFactory(descriptors.passwordValidationGetPasswordPolicy, baseClient.user.passwordValidationGetPasswordPolicy).getApiResource,
|
|
395
|
+
/** Get your verified Email-Address. */
|
|
396
|
+
getOwnEmail: new ApiCallAsyncResourceFactory(descriptors.userGetOwnEmail, baseClient.user.getOwnEmail).getApiResource,
|
|
397
|
+
/** Get your current multi factor auth status. */
|
|
398
|
+
getMfaStatus: new ApiCallAsyncResourceFactory(descriptors.userGetMfaStatus, baseClient.user.getMfaStatus).getApiResource,
|
|
399
|
+
/** List all of your ApiTokens. */
|
|
400
|
+
listApiTokens: new ApiCallAsyncResourceFactory(descriptors.userListApiTokens, baseClient.user.listApiTokens).getApiResource,
|
|
401
|
+
/** Get your stored ssh-keys. */
|
|
402
|
+
listSshKeys: new ApiCallAsyncResourceFactory(descriptors.userListSshKeys, baseClient.user.listSshKeys).getApiResource,
|
|
403
|
+
/** Get a specific ApiToken. */
|
|
404
|
+
getApiToken: new ApiCallAsyncResourceFactory(descriptors.userGetApiToken, baseClient.user.getApiToken).getApiResource,
|
|
405
|
+
/** Get a specific stored ssh-key. */
|
|
406
|
+
getSshKey: new ApiCallAsyncResourceFactory(descriptors.userGetSshKey, baseClient.user.getSshKey).getApiResource,
|
|
407
|
+
/** Check status of the current session. */
|
|
408
|
+
getCurrentSessionStatus: new ApiCallAsyncResourceFactory(descriptors.userGetCurrentSessionStatus, baseClient.user.getCurrentSessionStatus).getApiResource,
|
|
409
|
+
/** The timestamp of your latest password change. */
|
|
410
|
+
getPasswordUpdatedAt: new ApiCallAsyncResourceFactory(descriptors.userGetPasswordUpdatedAt, baseClient.user.getPasswordUpdatedAt).getApiResource,
|
|
411
|
+
/** Get personalized settings. */
|
|
412
|
+
getPersonalizedSettings: new ApiCallAsyncResourceFactory(descriptors.userGetPersonalizedSettings, baseClient.user.getPersonalizedSettings).getApiResource,
|
|
413
|
+
/** Get poll settings for the specified user. */
|
|
414
|
+
getPollStatus: new ApiCallAsyncResourceFactory(descriptors.userGetPollStatus, baseClient.user.getPollStatus).getApiResource,
|
|
415
|
+
/** Get a specific session. */
|
|
416
|
+
getSession: new ApiCallAsyncResourceFactory(descriptors.userGetSession, baseClient.user.getSession).getApiResource,
|
|
417
|
+
/** Get profile information for a user. */
|
|
418
|
+
getUser: new ApiCallAsyncResourceFactory(descriptors.userGetUser, baseClient.user.getUser).getApiResource,
|
|
419
|
+
/** Submitted feedback of the given user. */
|
|
420
|
+
listFeedback: new ApiCallAsyncResourceFactory(descriptors.userListFeedback, baseClient.user.listFeedback).getApiResource,
|
|
421
|
+
/** List all sessions. */
|
|
422
|
+
listSessions: new ApiCallAsyncResourceFactory(descriptors.userListSessions, baseClient.user.listSessions).getApiResource,
|
|
423
|
+
/** Obtain authorization from the resource owner. */
|
|
424
|
+
oauthGetAuthorization: new ApiCallAsyncResourceFactory(descriptors.userOauthGetAuthorization, baseClient.user.oauthGetAuthorization).getApiResource,
|
|
425
|
+
/** Request a support code. */
|
|
426
|
+
supportCodeRequest: new ApiCallAsyncResourceFactory(descriptors.userSupportCodeRequest, baseClient.user.supportCodeRequest).getApiResource,
|
|
427
|
+
});
|
|
428
|
+
const buildProjectApi = (baseClient) => ({
|
|
429
|
+
/** List Invites belonging to a Project. */
|
|
430
|
+
listInvitesForProject: new ApiCallAsyncResourceFactory(descriptors.projectListInvitesForProject, baseClient.project.listInvitesForProject).getApiResource,
|
|
431
|
+
/** Get a ProjectInvite. */
|
|
432
|
+
getProjectInvite: new ApiCallAsyncResourceFactory(descriptors.projectGetProjectInvite, baseClient.project.getProjectInvite).getApiResource,
|
|
433
|
+
/** Get a ProjectMembership */
|
|
434
|
+
getProjectMembership: new ApiCallAsyncResourceFactory(descriptors.projectGetProjectMembership, baseClient.project.getProjectMembership).getApiResource,
|
|
435
|
+
/** Get a Project. */
|
|
436
|
+
getProject: new ApiCallAsyncResourceFactory(descriptors.projectGetProject, baseClient.project.getProject).getApiResource,
|
|
437
|
+
/** Get a ProjectInvite by token. */
|
|
438
|
+
getProjectTokenInvite: new ApiCallAsyncResourceFactory(descriptors.projectGetProjectTokenInvite, baseClient.project.getProjectTokenInvite).getApiResource,
|
|
439
|
+
/** Get the executing user's membership in a Project. */
|
|
440
|
+
getSelfMembershipForProject: new ApiCallAsyncResourceFactory(descriptors.projectGetSelfMembershipForProject, baseClient.project.getSelfMembershipForProject).getApiResource,
|
|
441
|
+
/** Get a Server. */
|
|
442
|
+
getServer: new ApiCallAsyncResourceFactory(descriptors.projectGetServer, baseClient.project.getServer).getApiResource,
|
|
443
|
+
/** List Projects belonging to a Customer. */
|
|
444
|
+
listCustomerProjects: new ApiCallAsyncResourceFactory(descriptors.projectListCustomerProjects, baseClient.project.listCustomerProjects).getApiResource,
|
|
445
|
+
/** List Memberships belonging to a Project. */
|
|
446
|
+
listMembershipsForProject: new ApiCallAsyncResourceFactory(descriptors.projectListMembershipsForProject, baseClient.project.listMembershipsForProject).getApiResource,
|
|
447
|
+
/** Get the activities of a project. */
|
|
448
|
+
listProjectActivities: new ApiCallAsyncResourceFactory(descriptors.projectListProjectActivities, baseClient.project.listProjectActivities).getApiResource,
|
|
449
|
+
/** List ProjectInvites belonging to the executing user. */
|
|
450
|
+
listProjectInvites: new ApiCallAsyncResourceFactory(descriptors.projectListProjectInvites, baseClient.project.listProjectInvites).getApiResource,
|
|
451
|
+
/** List ProjectMemberships belonging to the executing user. */
|
|
452
|
+
listProjectMemberships: new ApiCallAsyncResourceFactory(descriptors.projectListProjectMemberships, baseClient.project.listProjectMemberships).getApiResource,
|
|
453
|
+
/** List Projects belonging to the executing user. */
|
|
454
|
+
listProjects: new ApiCallAsyncResourceFactory(descriptors.projectListProjects, baseClient.project.listProjects).getApiResource,
|
|
455
|
+
/** List Servers belonging to the executing user. */
|
|
456
|
+
listServers: new ApiCallAsyncResourceFactory(descriptors.projectListServers, baseClient.project.listServers).getApiResource,
|
|
457
|
+
/** Get storage space Statistics belonging to a Project. */
|
|
458
|
+
storagespaceGetProjectStatistics: new ApiCallAsyncResourceFactory(descriptors.storagespaceGetProjectStatistics, baseClient.project.storagespaceGetProjectStatistics).getApiResource,
|
|
459
|
+
/** Get storage space Statistics belonging to a Server. */
|
|
460
|
+
storagespaceGetServerStatistics: new ApiCallAsyncResourceFactory(descriptors.storagespaceGetServerStatistics, baseClient.project.storagespaceGetServerStatistics).getApiResource,
|
|
461
|
+
});
|
|
462
|
+
const buildProjectFileSystemApi = (baseClient) => ({
|
|
463
|
+
/** List directories belonging to a Project. */
|
|
464
|
+
getDirectories: new ApiCallAsyncResourceFactory(descriptors.projectFileSystemGetDirectories, baseClient.projectFileSystem.getDirectories).getApiResource,
|
|
465
|
+
/** Get a Project directory filesystem usage. */
|
|
466
|
+
getDiskUsage: new ApiCallAsyncResourceFactory(descriptors.projectFileSystemGetDiskUsage, baseClient.projectFileSystem.getDiskUsage).getApiResource,
|
|
467
|
+
/** Get a Project file's content. */
|
|
468
|
+
getFileContent: new ApiCallAsyncResourceFactory(descriptors.projectFileSystemGetFileContent, baseClient.projectFileSystem.getFileContent).getApiResource,
|
|
469
|
+
/** Get a Project's file/filesystem authorization token. */
|
|
470
|
+
getJwt: new ApiCallAsyncResourceFactory(descriptors.projectFileSystemGetJwt, baseClient.projectFileSystem.getJwt).getApiResource,
|
|
471
|
+
/** Get a Project file's information. */
|
|
472
|
+
listFiles: new ApiCallAsyncResourceFactory(descriptors.projectFileSystemListFiles, baseClient.projectFileSystem.listFiles).getApiResource,
|
|
473
|
+
});
|
|
474
|
+
const buildSshsftpUserApi = (baseClient) => ({
|
|
475
|
+
/** Get all SFTPUsers for a Project. */
|
|
476
|
+
sftpUserListSftpUsers: new ApiCallAsyncResourceFactory(descriptors.sftpUserListSftpUsers, baseClient.sshsftpUser.sftpUserListSftpUsers).getApiResource,
|
|
477
|
+
/** Get an SFTPUser. */
|
|
478
|
+
sftpUserGetSftpUser: new ApiCallAsyncResourceFactory(descriptors.sftpUserGetSftpUser, baseClient.sshsftpUser.sftpUserGetSftpUser).getApiResource,
|
|
479
|
+
/** Get all SSHUsers for a Project. */
|
|
480
|
+
sshUserListSshUsers: new ApiCallAsyncResourceFactory(descriptors.sshUserListSshUsers, baseClient.sshsftpUser.sshUserListSshUsers).getApiResource,
|
|
481
|
+
/** Get an SSHUser. */
|
|
482
|
+
sshUserGetSshUser: new ApiCallAsyncResourceFactory(descriptors.sshUserGetSshUser, baseClient.sshsftpUser.sshUserGetSshUser).getApiResource,
|
|
483
|
+
});
|
|
484
|
+
export class MittwaldAPIV3NextClientReact {
|
|
485
|
+
/** The AI hosting provides access to multiple large language and embedding models – GDPR compliant and hosted in Germany. */
|
|
486
|
+
aiHosting;
|
|
487
|
+
/** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
|
|
488
|
+
app;
|
|
489
|
+
/** The article API allows you to read article information. */
|
|
490
|
+
article;
|
|
491
|
+
/** The backup API allows you to manage your project backups. */
|
|
492
|
+
backup;
|
|
493
|
+
/** The container API allows you to manage your stacks, containers, volumes and registries. */
|
|
494
|
+
container;
|
|
495
|
+
/** The contract API allows you to manage your contracts and orders */
|
|
496
|
+
contract;
|
|
497
|
+
/** The marketplace API allows you to manage extensions and more information regaring the marketplace. */
|
|
498
|
+
marketplace;
|
|
499
|
+
/** The conversation API allows you to manage your support conversations. */
|
|
500
|
+
conversation;
|
|
501
|
+
/** The cronjob API allows you to manage cronjobs within a project. */
|
|
502
|
+
cronjob;
|
|
503
|
+
/** The customer API allows you to manage your own organizations and users. */
|
|
504
|
+
customer;
|
|
505
|
+
/** The database API allows you to manage your databases, like MySQL and Redis databases. */
|
|
506
|
+
database;
|
|
507
|
+
/** The domain API allows you to manage your domains, DNS records, SSL certificates and ingress resources. */
|
|
508
|
+
domain;
|
|
509
|
+
/** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
|
|
510
|
+
file;
|
|
511
|
+
/** The lead fyndr api allow you to manage you leads and your fyndr profile. */
|
|
512
|
+
leadFyndr;
|
|
513
|
+
/** The license API allows you to manage your paid licenses. */
|
|
514
|
+
license;
|
|
515
|
+
/** The mail API allows you to manage your mail accounts. */
|
|
516
|
+
mail;
|
|
517
|
+
/** API endpoints that are not related to any specific API domain */
|
|
518
|
+
misc;
|
|
519
|
+
/** The notification API allows you to manage your notifications. */
|
|
520
|
+
notification;
|
|
521
|
+
/** The page insights API allows you to get page insights information. */
|
|
522
|
+
pageInsights;
|
|
523
|
+
/** The user API allows you to manage your own user and access information of other users that might be visible to you. */
|
|
524
|
+
user;
|
|
525
|
+
/** The project API allows you to manage your projects, and also any kinds of user memberships concerning these projects. */
|
|
526
|
+
project;
|
|
527
|
+
/** The filesystem API allows you to directly access the filesystem of your project. */
|
|
528
|
+
projectFileSystem;
|
|
529
|
+
/** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
|
|
530
|
+
sshsftpUser;
|
|
531
|
+
constructor(baseClient) {
|
|
532
|
+
this.aiHosting = buildAiHostingApi(baseClient);
|
|
533
|
+
this.app = buildAppApi(baseClient);
|
|
534
|
+
this.article = buildArticleApi(baseClient);
|
|
535
|
+
this.backup = buildBackupApi(baseClient);
|
|
536
|
+
this.container = buildContainerApi(baseClient);
|
|
537
|
+
this.contract = buildContractApi(baseClient);
|
|
538
|
+
this.marketplace = buildMarketplaceApi(baseClient);
|
|
539
|
+
this.conversation = buildConversationApi(baseClient);
|
|
540
|
+
this.cronjob = buildCronjobApi(baseClient);
|
|
541
|
+
this.customer = buildCustomerApi(baseClient);
|
|
542
|
+
this.database = buildDatabaseApi(baseClient);
|
|
543
|
+
this.domain = buildDomainApi(baseClient);
|
|
544
|
+
this.file = buildFileApi(baseClient);
|
|
545
|
+
this.leadFyndr = buildLeadFyndrApi(baseClient);
|
|
546
|
+
this.license = buildLicenseApi(baseClient);
|
|
547
|
+
this.mail = buildMailApi(baseClient);
|
|
548
|
+
this.misc = buildMiscApi(baseClient);
|
|
549
|
+
this.notification = buildNotificationApi(baseClient);
|
|
550
|
+
this.pageInsights = buildPageInsightsApi(baseClient);
|
|
551
|
+
this.user = buildUserApi(baseClient);
|
|
552
|
+
this.project = buildProjectApi(baseClient);
|
|
553
|
+
this.projectFileSystem = buildProjectFileSystemApi(baseClient);
|
|
554
|
+
this.sshsftpUser = buildSshsftpUserApi(baseClient);
|
|
555
|
+
}
|
|
556
|
+
static fromBaseClient(baseClient) {
|
|
557
|
+
return new MittwaldAPIV3NextClientReact(baseClient);
|
|
558
|
+
}
|
|
559
|
+
}
|