@mittwald/api-client 3.0.29 → 3.1.2

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.
@@ -2,31 +2,31 @@ import { ApiCallAsyncResourceFactory } from "@mittwald/api-client-commons/react"
2
2
  import * as descriptors from "./descriptors.js";
3
3
  export * from "@mittwald/react-use-promise/types";
4
4
  const buildAppApi = (baseClient) => ({
5
- /** get a specific `App` */
5
+ /** Get a specific `App`. */
6
6
  getApp: new ApiCallAsyncResourceFactory(descriptors.appGetApp, baseClient.app.getApp).getApiResource,
7
- /** get a specific `AppInstallation` */
7
+ /** Get a specific `AppInstallation`. */
8
8
  getAppinstallation: new ApiCallAsyncResourceFactory(descriptors.appGetAppinstallation, baseClient.app.getAppinstallation).getApiResource,
9
- /** get a specific `AppVersion` */
9
+ /** Get a specific `AppVersion`. */
10
10
  getAppversion: new ApiCallAsyncResourceFactory(descriptors.appGetAppversion, baseClient.app.getAppversion).getApiResource,
11
- /** get the missing requirements of an appInstallation for a specific target AppVersion */
11
+ /** Get the missing requirements of an appInstallation for a specific target AppVersion. */
12
12
  getMissingDependenciesForAppinstallation: new ApiCallAsyncResourceFactory(descriptors.appGetMissingDependenciesForAppinstallation, baseClient.app.getMissingDependenciesForAppinstallation).getApiResource,
13
- /** get a specific `SystemSoftware` */
13
+ /** Get a specific `SystemSoftware`. */
14
14
  getSystemsoftware: new ApiCallAsyncResourceFactory(descriptors.appGetSystemsoftware, baseClient.app.getSystemsoftware).getApiResource,
15
- /** get a specific `SystemSoftwareVersion` */
15
+ /** Get a specific `SystemSoftwareVersion`. */
16
16
  getSystemsoftwareversion: new ApiCallAsyncResourceFactory(descriptors.appGetSystemsoftwareversion, baseClient.app.getSystemsoftwareversion).getApiResource,
17
- /** get all `AppInstallations` inside a specific `Project` */
17
+ /** Get all `AppInstallations` inside a specific `Project`. */
18
18
  listAppinstallations: new ApiCallAsyncResourceFactory(descriptors.appListAppinstallations, baseClient.app.listAppinstallations).getApiResource,
19
- /** get all available `Apps` */
19
+ /** Get all available `Apps`. */
20
20
  listApps: new ApiCallAsyncResourceFactory(descriptors.appListApps, baseClient.app.listApps).getApiResource,
21
- /** get all `AppVersions` of a specific `App` */
21
+ /** Get all `AppVersions` of a specific `App`. */
22
22
  listAppversions: new ApiCallAsyncResourceFactory(descriptors.appListAppversions, baseClient.app.listAppversions).getApiResource,
23
- /** get all available `SystemSoftware` */
23
+ /** Get all available `SystemSoftware`. */
24
24
  listSystemsoftwares: new ApiCallAsyncResourceFactory(descriptors.appListSystemsoftwares, baseClient.app.listSystemsoftwares).getApiResource,
25
- /** get all available `SystemSoftwareVersions` of a specific `SystemSoftware` */
25
+ /** Get all available `SystemSoftwareVersions` of a specific `SystemSoftware`. */
26
26
  listSystemsoftwareversions: new ApiCallAsyncResourceFactory(descriptors.appListSystemsoftwareversions, baseClient.app.listSystemsoftwareversions).getApiResource,
27
- /** get all update candidates for a specific `AppVersion` */
27
+ /** Get all update candidates for a specific `AppVersion`. */
28
28
  listUpdateCandidatesForAppversion: new ApiCallAsyncResourceFactory(descriptors.appListUpdateCandidatesForAppversion, baseClient.app.listUpdateCandidatesForAppversion).getApiResource,
29
- /** get runtime status of a specific `AppInstallation` */
29
+ /** Get runtime status of a specific `AppInstallation`. */
30
30
  retrieveStatus: new ApiCallAsyncResourceFactory(descriptors.appRetrieveStatus, baseClient.app.retrieveStatus).getApiResource,
31
31
  });
32
32
  const buildArticleApi = (baseClient) => ({
@@ -201,6 +201,44 @@ const buildNotificationApi = (baseClient) => ({
201
201
  /** List all unread notifications. */
202
202
  slistNotifications: new ApiCallAsyncResourceFactory(descriptors.notificationsListNotifications, baseClient.notification.slistNotifications).getApiResource,
203
203
  });
204
+ const buildPageInsightsApi = (baseClient) => ({
205
+ /** Get detailed performance data for a given domain and path. */
206
+ pageinsightsGetPerformanceData: new ApiCallAsyncResourceFactory(descriptors.pageinsightsGetPerformanceData, baseClient.pageInsights.pageinsightsGetPerformanceData).getApiResource,
207
+ /** List websites (specified as domain and path) from a project where performance data is available. */
208
+ pageinsightsListPerformanceDataForProject: new ApiCallAsyncResourceFactory(descriptors.pageinsightsListPerformanceDataForProject, baseClient.pageInsights.pageinsightsListPerformanceDataForProject).getApiResource,
209
+ });
210
+ const buildUserApi = (baseClient) => ({
211
+ /** Get a password policy. */
212
+ passwordValidationGetPasswordPolicy: new ApiCallAsyncResourceFactory(descriptors.passwordValidationGetPasswordPolicy, baseClient.user.passwordValidationGetPasswordPolicy).getApiResource,
213
+ /** Get your verified Email-Address. */
214
+ getOwnEmail: new ApiCallAsyncResourceFactory(descriptors.userGetOwnEmail, baseClient.user.getOwnEmail).getApiResource,
215
+ /** Get your current multi factor auth status. */
216
+ getMfaStatus: new ApiCallAsyncResourceFactory(descriptors.userGetMfaStatus, baseClient.user.getMfaStatus).getApiResource,
217
+ /** List all of your ApiTokens. */
218
+ listApiTokens: new ApiCallAsyncResourceFactory(descriptors.userListApiTokens, baseClient.user.listApiTokens).getApiResource,
219
+ /** Get your stored ssh-keys. */
220
+ listSshKeys: new ApiCallAsyncResourceFactory(descriptors.userListSshKeys, baseClient.user.listSshKeys).getApiResource,
221
+ /** Get a specific ApiToken. */
222
+ getApiToken: new ApiCallAsyncResourceFactory(descriptors.userGetApiToken, baseClient.user.getApiToken).getApiResource,
223
+ /** Get a specific stored ssh-key. */
224
+ getSshKey: new ApiCallAsyncResourceFactory(descriptors.userGetSshKey, baseClient.user.getSshKey).getApiResource,
225
+ /** Get your account information. */
226
+ getOwnAccount: new ApiCallAsyncResourceFactory(descriptors.userGetOwnAccount, baseClient.user.getOwnAccount).getApiResource,
227
+ /** The timestamp of your latest password change. */
228
+ getPasswordUpdatedAt: new ApiCallAsyncResourceFactory(descriptors.userGetPasswordUpdatedAt, baseClient.user.getPasswordUpdatedAt).getApiResource,
229
+ /** Get personalized settings. */
230
+ getPersonalizedSettings: new ApiCallAsyncResourceFactory(descriptors.userGetPersonalizedSettings, baseClient.user.getPersonalizedSettings).getApiResource,
231
+ /** Get a specific session. */
232
+ getSession: new ApiCallAsyncResourceFactory(descriptors.userGetSession, baseClient.user.getSession).getApiResource,
233
+ /** Get profile information for a user. */
234
+ getUser: new ApiCallAsyncResourceFactory(descriptors.userGetUser, baseClient.user.getUser).getApiResource,
235
+ /** Submitted feedback of the given user. */
236
+ listFeedback: new ApiCallAsyncResourceFactory(descriptors.userListFeedback, baseClient.user.listFeedback).getApiResource,
237
+ /** List all sessions. */
238
+ listSessions: new ApiCallAsyncResourceFactory(descriptors.userListSessions, baseClient.user.listSessions).getApiResource,
239
+ /** Request a support code. */
240
+ supportCodeRequest: new ApiCallAsyncResourceFactory(descriptors.userSupportCodeRequest, baseClient.user.supportCodeRequest).getApiResource,
241
+ });
204
242
  const buildProjectApi = (baseClient) => ({
205
243
  /** Get a ProjectInvite. */
206
244
  getProjectInvite: new ApiCallAsyncResourceFactory(descriptors.projectGetProjectInvite, baseClient.project.getProjectInvite).getApiResource,
@@ -249,36 +287,6 @@ const buildSshsftpUserApi = (baseClient) => ({
249
287
  /** Get an SSHUser. */
250
288
  sshUserGetSshUser: new ApiCallAsyncResourceFactory(descriptors.sshUserGetSshUser, baseClient.sshsftpUser.sshUserGetSshUser).getApiResource,
251
289
  });
252
- const buildUserApi = (baseClient) => ({
253
- /** Get your verified Email-Address. */
254
- getOwnEmail: new ApiCallAsyncResourceFactory(descriptors.userGetOwnEmail, baseClient.user.getOwnEmail).getApiResource,
255
- /** Get your current multi factor auth status. */
256
- getMfaStatus: new ApiCallAsyncResourceFactory(descriptors.userGetMfaStatus, baseClient.user.getMfaStatus).getApiResource,
257
- /** List all of your ApiTokens. */
258
- listApiTokens: new ApiCallAsyncResourceFactory(descriptors.userListApiTokens, baseClient.user.listApiTokens).getApiResource,
259
- /** Get your stored ssh-keys. */
260
- listSshKeys: new ApiCallAsyncResourceFactory(descriptors.userListSshKeys, baseClient.user.listSshKeys).getApiResource,
261
- /** Get a specific ApiToken. */
262
- getApiToken: new ApiCallAsyncResourceFactory(descriptors.userGetApiToken, baseClient.user.getApiToken).getApiResource,
263
- /** Get a specific stored ssh-key. */
264
- getSshKey: new ApiCallAsyncResourceFactory(descriptors.userGetSshKey, baseClient.user.getSshKey).getApiResource,
265
- /** Get your account information. */
266
- getOwnAccount: new ApiCallAsyncResourceFactory(descriptors.userGetOwnAccount, baseClient.user.getOwnAccount).getApiResource,
267
- /** The timestamp of your latest password change. */
268
- getPasswordUpdatedAt: new ApiCallAsyncResourceFactory(descriptors.userGetPasswordUpdatedAt, baseClient.user.getPasswordUpdatedAt).getApiResource,
269
- /** Get personalized settings. */
270
- getPersonalizedSettings: new ApiCallAsyncResourceFactory(descriptors.userGetPersonalizedSettings, baseClient.user.getPersonalizedSettings).getApiResource,
271
- /** Get a specific session. */
272
- getSession: new ApiCallAsyncResourceFactory(descriptors.userGetSession, baseClient.user.getSession).getApiResource,
273
- /** Get profile information for a user. */
274
- getUser: new ApiCallAsyncResourceFactory(descriptors.userGetUser, baseClient.user.getUser).getApiResource,
275
- /** Submitted feedback of the given user. */
276
- listFeedback: new ApiCallAsyncResourceFactory(descriptors.userListFeedback, baseClient.user.listFeedback).getApiResource,
277
- /** List all sessions. */
278
- listSessions: new ApiCallAsyncResourceFactory(descriptors.userListSessions, baseClient.user.listSessions).getApiResource,
279
- /** Request a support code. */
280
- supportCodeRequest: new ApiCallAsyncResourceFactory(descriptors.userSupportCodeRequest, baseClient.user.supportCodeRequest).getApiResource,
281
- });
282
290
  export class MittwaldAPIV2ClientReact {
283
291
  /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
284
292
  app;
@@ -304,14 +312,16 @@ export class MittwaldAPIV2ClientReact {
304
312
  mail;
305
313
  /** The notification API allows you to manage your notifications. */
306
314
  notification;
315
+ /** The page insights API allows you to get page insights information. */
316
+ pageInsights;
317
+ /** The user API allows you to manage your own user and access information of other users that might be visible to you. */
318
+ user;
307
319
  /** The project API allows you to manage your projects, and also any kinds of user memberships concerning these projects. */
308
320
  project;
309
321
  /** The filesystem API allows you to directly access the filesystem of your project. */
310
322
  projectFileSystem;
311
323
  /** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
312
324
  sshsftpUser;
313
- /** The user API allows you to manage your own user and access information of other users that might be visible to you. */
314
- user;
315
325
  constructor(baseClient) {
316
326
  this.app = buildAppApi(baseClient);
317
327
  this.article = buildArticleApi(baseClient);
@@ -325,10 +335,11 @@ export class MittwaldAPIV2ClientReact {
325
335
  this.file = buildFileApi(baseClient);
326
336
  this.mail = buildMailApi(baseClient);
327
337
  this.notification = buildNotificationApi(baseClient);
338
+ this.pageInsights = buildPageInsightsApi(baseClient);
339
+ this.user = buildUserApi(baseClient);
328
340
  this.project = buildProjectApi(baseClient);
329
341
  this.projectFileSystem = buildProjectFileSystemApi(baseClient);
330
342
  this.sshsftpUser = buildSshsftpUserApi(baseClient);
331
- this.user = buildUserApi(baseClient);
332
343
  }
333
344
  static fromBaseClient(baseClient) {
334
345
  return new MittwaldAPIV2ClientReact(baseClient);