@mittwald/api-client 0.0.0-development-e096ee7-20240924 → 0.0.0-development-84e90b6-20250514

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.
@@ -50,10 +50,10 @@ export class MittwaldAPIV2Client extends ApiClientBase {
50
50
  requestAppinstallationCopy: this.requestFunctionFactory(descriptors.appRequestAppinstallationCopy),
51
51
  /** Get runtime status belonging to an AppInstallation. */
52
52
  retrieveStatus: this.requestFunctionFactory(descriptors.appRetrieveStatus),
53
- /** Remove linkage between an AppInstallation and a Database. */
54
- unlinkDatabase: this.requestFunctionFactory(descriptors.appUnlinkDatabase),
55
53
  /** Create linkage between an AppInstallation and DatabaseUsers. */
56
54
  setDatabaseUsers: this.requestFunctionFactory(descriptors.appSetDatabaseUsers),
55
+ /** Remove linkage between an AppInstallation and a Database. */
56
+ unlinkDatabase: this.requestFunctionFactory(descriptors.appUnlinkDatabase),
57
57
  };
58
58
  /** The article API allows you to read article information. */
59
59
  article = {
@@ -123,6 +123,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
123
123
  listStacks: this.requestFunctionFactory(descriptors.containerListStacks),
124
124
  /** List Volumes belonging to a Project. */
125
125
  listVolumes: this.requestFunctionFactory(descriptors.containerListVolumes),
126
+ /** Pulls the latest version of the Service's image and recreates the Service. */
127
+ pullImageForService: this.requestFunctionFactory(descriptors.containerPullImageForService),
126
128
  /** Recreate a Service. */
127
129
  recreateService: this.requestFunctionFactory(descriptors.containerRecreateService),
128
130
  /** Restart a started Service. */
@@ -195,12 +197,34 @@ export class MittwaldAPIV2Client extends ApiClientBase {
195
197
  };
196
198
  /** The marketplace API allows you to manage extensions and more information regaring the marketplace. */
197
199
  marketplace = {
200
+ /** Get Contributor Billing Information. */
201
+ contributorGetBillingInformation: this.requestFunctionFactory(descriptors.contributorGetBillingInformation),
202
+ /** Get the Stripe Billing Portal Link for a Customer */
203
+ contributorGetCustomerBillingPortalLink: this.requestFunctionFactory(descriptors.contributorGetCustomerBillingPortalLink),
204
+ /** Get the Stripe Dashboard Link for a Contributor. */
205
+ contributorGetLoginLink: this.requestFunctionFactory(descriptors.contributorGetLoginLink),
206
+ /** List incoming Invoices of a Contributor. */
207
+ contributorListIncomingInvoices: this.requestFunctionFactory(descriptors.contributorListIncomingInvoices),
208
+ /** List all invoices on behalf of a contributor. */
209
+ contributorListOnbehalfInvoices: this.requestFunctionFactory(descriptors.contributorListOnbehalfInvoices),
210
+ /** Request an Access Token for the Incoming Invoice file. */
211
+ contributorReceiptGetFileAccessToken: this.requestFunctionFactory(descriptors.contributorReceiptGetFileAccessToken),
198
212
  /** Rotate the secret for an extension instance. */
199
213
  contributorRotateSecretForExtensionInstance: this.requestFunctionFactory(descriptors.contributorRotateSecretForExtensionInstance),
200
214
  /** Authenticate your external application using the extensionInstanceSecret. */
201
215
  extensionAuthenticateInstance: this.requestFunctionFactory(descriptors.extensionAuthenticateInstance),
216
+ /** Authenticate your external application using a session token and an extension secret */
217
+ extensionAuthenticateWithSessionToken: this.requestFunctionFactory(descriptors.extensionAuthenticateWithSessionToken),
218
+ /** Schedule an Extension Instance Termination for the next possible date. */
219
+ extensionScheduleExtensionTermination: this.requestFunctionFactory(descriptors.extensionScheduleExtensionTermination),
220
+ /** Cancel an Extension Instance Termination. */
221
+ extensionCancelExtensionTermination: this.requestFunctionFactory(descriptors.extensionCancelExtensionTermination),
222
+ /** Change the context of an Extension. */
223
+ extensionChangeContext: this.requestFunctionFactory(descriptors.extensionChangeContext),
202
224
  /** Consent to extension scopes. */
203
225
  extensionConsentToExtensionScopes: this.requestFunctionFactory(descriptors.extensionConsentToExtensionScopes),
226
+ /** Create the OnboardingProcess of a Contributor. */
227
+ extensionCreateContributorOnboardingProcess: this.requestFunctionFactory(descriptors.extensionCreateContributorOnboardingProcess),
204
228
  /** List ExtensionInstances. */
205
229
  extensionListExtensionInstances: this.requestFunctionFactory(descriptors.extensionListExtensionInstances),
206
230
  /** Create an ExtensionInstance. */
@@ -209,24 +233,72 @@ export class MittwaldAPIV2Client extends ApiClientBase {
209
233
  extensionCreateRetrievalKey: this.requestFunctionFactory(descriptors.extensionCreateRetrievalKey),
210
234
  /** Get an ExtensionInstance. */
211
235
  extensionGetExtensionInstance: this.requestFunctionFactory(descriptors.extensionGetExtensionInstance),
212
- /** Delete an ExtensionInstance. */
236
+ /** Delete a free ExtensionInstance. If the Extension is chargable the contract must be terminated instead. */
213
237
  extensionDeleteExtensionInstance: this.requestFunctionFactory(descriptors.extensionDeleteExtensionInstance),
238
+ /** Get Extension of own contributor. */
239
+ extensionGetOwnExtension: this.requestFunctionFactory(descriptors.extensionGetOwnExtension),
240
+ /** Delete an extension. */
241
+ extensionDeleteExtension: this.requestFunctionFactory(descriptors.extensionDeleteExtension),
242
+ /** Patch Extension. */
243
+ extensionPatchExtension: this.requestFunctionFactory(descriptors.extensionPatchExtension),
214
244
  /** Disable an ExtensionInstance. */
215
245
  extensionDisableExtensionInstance: this.requestFunctionFactory(descriptors.extensionDisableExtensionInstance),
216
246
  /** Dry run a webhook with random or given values. */
217
247
  extensionDryRunWebhook: this.requestFunctionFactory(descriptors.extensionDryRunWebhook),
218
248
  /** Enable an ExtensionInstance. */
219
249
  extensionEnableExtensionInstance: this.requestFunctionFactory(descriptors.extensionEnableExtensionInstance),
250
+ /** Generate an Extension secret for the given Extension. */
251
+ extensionGenerateExtensionSecret: this.requestFunctionFactory(descriptors.extensionGenerateExtensionSecret),
252
+ /** Generate a session token to transmit it to the extensions frontend fragment. */
253
+ extensionGenerateSessionToken: this.requestFunctionFactory(descriptors.extensionGenerateSessionToken),
220
254
  /** Get a Contributor. */
221
255
  extensionGetContributor: this.requestFunctionFactory(descriptors.extensionGetContributor),
256
+ /** Get the Contract Strategy of an Extension Instance */
257
+ extensionGetExtensionInstanceContract: this.requestFunctionFactory(descriptors.extensionGetExtensionInstanceContract),
258
+ /** Update or Create Contract for existing Extension Instances. */
259
+ extensionUpdateExtensionInstanceContract: this.requestFunctionFactory(descriptors.extensionUpdateExtensionInstanceContract),
260
+ /** Get the ExtensionInstance of a specific customer and extension, if existing. */
261
+ extensionGetExtensionInstanceForCustomer: this.requestFunctionFactory(descriptors.extensionGetExtensionInstanceForCustomer),
262
+ /** Get the ExtensionInstance of a specific project and extension, if existing. */
263
+ extensionGetExtensionInstanceForProject: this.requestFunctionFactory(descriptors.extensionGetExtensionInstanceForProject),
222
264
  /** Get an Extension. */
223
265
  extensionGetExtension: this.requestFunctionFactory(descriptors.extensionGetExtension),
224
266
  /** Get the public key to verify the webhook signature. */
225
267
  extensionGetPublicKey: this.requestFunctionFactory(descriptors.extensionGetPublicKey),
268
+ /** Invalidate the given Extension secret immediately. */
269
+ extensionInvalidateExtensionSecret: this.requestFunctionFactory(descriptors.extensionInvalidateExtensionSecret),
226
270
  /** List Contributors. */
227
271
  extensionListContributors: this.requestFunctionFactory(descriptors.extensionListContributors),
228
272
  /** List Extensions. */
229
273
  extensionListExtensions: this.requestFunctionFactory(descriptors.extensionListExtensions),
274
+ /** List Extensions of own contributor. */
275
+ extensionListOwnExtensions: this.requestFunctionFactory(descriptors.extensionListOwnExtensions),
276
+ /** Register an Extension. */
277
+ extensionRegisterExtension: this.requestFunctionFactory(descriptors.extensionRegisterExtension),
278
+ /** List Scopes. */
279
+ extensionListScopes: this.requestFunctionFactory(descriptors.extensionListScopes),
280
+ /** Order Extension with saved payment method */
281
+ extensionOrderExtension: this.requestFunctionFactory(descriptors.extensionOrderExtension),
282
+ /** Remove an asset of an extension. */
283
+ extensionRemoveAsset: this.requestFunctionFactory(descriptors.extensionRemoveAsset),
284
+ /** Add a logo to an extension. */
285
+ extensionRequestLogoUpload: this.requestFunctionFactory(descriptors.extensionRequestLogoUpload),
286
+ /** Remove the logo of an extension. */
287
+ extensionRemoveLogo: this.requestFunctionFactory(descriptors.extensionRemoveLogo),
288
+ /** Add an asset to an extension. */
289
+ extensionRequestAssetUpload: this.requestFunctionFactory(descriptors.extensionRequestAssetUpload),
290
+ /** Start the verification process of an Extension. */
291
+ extensionRequestExtensionVerification: this.requestFunctionFactory(descriptors.extensionRequestExtensionVerification),
292
+ /** Publish or withdraw an Extension. */
293
+ extensionSetExtensionPublishedState: this.requestFunctionFactory(descriptors.extensionSetExtensionPublishedState),
294
+ /** Start a checkout process for an extension. */
295
+ extensionStartExtensionCheckout: this.requestFunctionFactory(descriptors.extensionStartExtensionCheckout),
296
+ /** Creates or Updates Pricing for an Extension. */
297
+ extensionUpdateExtensionPricing: this.requestFunctionFactory(descriptors.extensionUpdateExtensionPricing),
298
+ /** Get payment method details */
299
+ customerGetPaymentMethod: this.requestFunctionFactory(descriptors.marketplaceCustomerGetPaymentMethod),
300
+ /** Get the link to update the marketplace payment method */
301
+ customerUpdatePaymentMethod: this.requestFunctionFactory(descriptors.marketplaceCustomerUpdatePaymentMethod),
230
302
  };
231
303
  /** The conversation API allows you to manage your support conversations. */
232
304
  conversation = {
@@ -286,12 +358,20 @@ export class MittwaldAPIV2Client extends ApiClientBase {
286
358
  customer = {
287
359
  /** Accept a CustomerInvite. */
288
360
  acceptCustomerInvite: this.requestFunctionFactory(descriptors.customerAcceptCustomerInvite),
361
+ /** List Invites belonging to a Customer. */
362
+ listInvitesForCustomer: this.requestFunctionFactory(descriptors.customerListInvitesForCustomer),
289
363
  /** Create a CustomerInvite. */
290
364
  createCustomerInvite: this.requestFunctionFactory(descriptors.customerCreateCustomerInvite),
291
365
  /** Get all customer profiles the authenticated user has access to. */
292
366
  listCustomers: this.requestFunctionFactory(descriptors.customerListCustomers),
293
367
  /** Create a new customer profile. */
294
368
  createCustomer: this.requestFunctionFactory(descriptors.customerCreateCustomer),
369
+ /** Lets us know your idea for our recommendation programm. */
370
+ createRecommendationSuggestion: this.requestFunctionFactory(descriptors.customerCreateRecommendationSuggestion),
371
+ /** Gets the Wallet of the Customer. */
372
+ getWallet: this.requestFunctionFactory(descriptors.customerGetWallet),
373
+ /** Create the Wallet for the Customer. */
374
+ createWallet: this.requestFunctionFactory(descriptors.customerCreateWallet),
295
375
  /** Decline a CustomerInvite. */
296
376
  declineCustomerInvite: this.requestFunctionFactory(descriptors.customerDeclineCustomerInvite),
297
377
  /** Get a CustomerInvite. */
@@ -312,16 +392,16 @@ export class MittwaldAPIV2Client extends ApiClientBase {
312
392
  deleteCustomer: this.requestFunctionFactory(descriptors.customerDeleteCustomer),
313
393
  /** Get a CustomerInvite by token. */
314
394
  getCustomerTokenInvite: this.requestFunctionFactory(descriptors.customerGetCustomerTokenInvite),
395
+ /** Get your LeadFyndr request. */
396
+ getLeadFyndrProfileRequest: this.requestFunctionFactory(descriptors.customerGetLeadFyndrProfileRequest),
397
+ /** Get your LeadFyndr profile. */
398
+ getLeadFyndrProfile: this.requestFunctionFactory(descriptors.customerGetLeadFyndrProfile),
315
399
  /** Check if the customer profile has a valid contract partner configured. */
316
400
  isCustomerLegallyCompetent: this.requestFunctionFactory(descriptors.customerIsCustomerLegallyCompetent),
317
- /** Leave a Customer. */
318
- leaveCustomer: this.requestFunctionFactory(descriptors.customerLeaveCustomer),
319
401
  /** List CustomerInvites belonging to the executing user. */
320
402
  listCustomerInvites: this.requestFunctionFactory(descriptors.customerListCustomerInvites),
321
403
  /** List CustomerMemberships belonging to the executing user. */
322
404
  listCustomerMemberships: this.requestFunctionFactory(descriptors.customerListCustomerMemberships),
323
- /** List Invites belonging to a Customer. */
324
- listInvitesForCustomer: this.requestFunctionFactory(descriptors.customerListInvitesForCustomer),
325
405
  /** List Memberships belonging to a Customer. */
326
406
  listMembershipsForCustomer: this.requestFunctionFactory(descriptors.customerListMembershipsForCustomer),
327
407
  /** Request a new avatar upload for the customer profile. */
@@ -382,25 +462,16 @@ export class MittwaldAPIV2Client extends ApiClientBase {
382
462
  /** Update a RedisDatabase's description. */
383
463
  updateRedisDatabaseDescription: this.requestFunctionFactory(descriptors.databaseUpdateRedisDatabaseDescription),
384
464
  };
385
- /** The notification API allows you to manage your notifications. */
386
- notification = {
387
- /** Subscribe a user to the mStudio newsletter. */
388
- newsletterSubscribeUser: this.requestFunctionFactory(descriptors.newsletterSubscribeUser),
389
- /** Getting the subscription status of the subscription. */
390
- newsletterGetInfo: this.requestFunctionFactory(descriptors.newsletterGetInfo),
391
- /** Unsubscribe a user from the mStudio newsletter. */
392
- newsletterUnsubscribeUser: this.requestFunctionFactory(descriptors.newsletterUnsubscribeUser),
393
- /** Get the counts for unread notifications of the user. */
394
- scountUnreadNotifications: this.requestFunctionFactory(descriptors.notificationsCountUnreadNotifications),
395
- /** List all unread notifications. */
396
- slistNotifications: this.requestFunctionFactory(descriptors.notificationsListNotifications),
397
- /** Mark all notifications as read. */
398
- sreadAllNotifications: this.requestFunctionFactory(descriptors.notificationsReadAllNotifications),
399
- /** Mark notification as read. */
400
- sreadNotification: this.requestFunctionFactory(descriptors.notificationsReadNotification),
401
- };
402
465
  /** The domain API allows you to manage your domains, DNS records, SSL certificates and ingress resources. */
403
466
  domain = {
467
+ /** List Domains */
468
+ listDomains: this.requestFunctionFactory(descriptors.domainListDomains),
469
+ /** Update the nameservers of a Domain. */
470
+ updateDomainNameservers: this.requestFunctionFactory(descriptors.domainUpdateDomainNameservers),
471
+ /** Update the paths of an Ingress. */
472
+ ingressUpdateIngressPaths: this.requestFunctionFactory(descriptors.ingressUpdateIngressPaths),
473
+ /** Update the tls settings of an Ingress. */
474
+ ingressUpdateIngressTls: this.requestFunctionFactory(descriptors.ingressUpdateIngressTls),
404
475
  /** Create a DNSZone. */
405
476
  dnsCreateDnsZone: this.requestFunctionFactory(descriptors.dnsCreateDnsZone),
406
477
  /** Get a DNSZone. */
@@ -417,14 +488,10 @@ export class MittwaldAPIV2Client extends ApiClientBase {
417
488
  abortDomainDeclaration: this.requestFunctionFactory(descriptors.domainAbortDomainDeclaration),
418
489
  /** Check if a Domain is available to register. */
419
490
  checkDomainRegistrability: this.requestFunctionFactory(descriptors.domainCheckDomainRegistrability),
420
- /** List Domains */
421
- listDomains: this.requestFunctionFactory(descriptors.domainListDomains),
422
491
  /** Check if a Domain is available to transfer. */
423
492
  checkDomainTransferability: this.requestFunctionFactory(descriptors.domainCheckDomainTransferability),
424
493
  /** Create an auth code for a Domains transfer-out process. */
425
494
  createDomainAuthCode: this.requestFunctionFactory(descriptors.domainCreateDomainAuthCode),
426
- /** Update the nameservers of a Domain. */
427
- updateDomainNameservers: this.requestFunctionFactory(descriptors.domainUpdateDomainNameservers),
428
495
  /** Get a Domain. */
429
496
  getDomain: this.requestFunctionFactory(descriptors.domainGetDomain),
430
497
  /** Delete a Domain. */
@@ -457,12 +524,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
457
524
  ingressIngressVerifyOwnership: this.requestFunctionFactory(descriptors.ingressIngressVerifyOwnership),
458
525
  /** List Ingresses compatible with a certificate. */
459
526
  ingressListIngressesCompatibleWithCertificate: this.requestFunctionFactory(descriptors.ingressListIngressesCompatibleWithCertificate),
460
- /** Update the paths of an Ingress. */
461
- ingressUpdateIngressPaths: this.requestFunctionFactory(descriptors.ingressUpdateIngressPaths),
462
527
  /** Request the ACME certificate issuance of an Ingress. */
463
528
  ingressRequestIngressAcmeCertificateIssuance: this.requestFunctionFactory(descriptors.ingressRequestIngressAcmeCertificateIssuance),
464
- /** Update the tls settings of an Ingress. */
465
- ingressUpdateIngressTls: this.requestFunctionFactory(descriptors.ingressUpdateIngressTls),
466
529
  /** Check the replacement of a Certificate. */
467
530
  sslCheckReplaceCertificate: this.requestFunctionFactory(descriptors.sslCheckReplaceCertificate),
468
531
  /** List CertificateRequests belonging to a Project or an Ingress. */
@@ -484,23 +547,18 @@ export class MittwaldAPIV2Client extends ApiClientBase {
484
547
  /** Update the certificate of a CertificateRequest. */
485
548
  sslSetCertificateRequestCertificate: this.requestFunctionFactory(descriptors.sslSetCertificateRequestCertificate),
486
549
  };
487
- /** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
488
- file = {
489
- /** Create a File. */
490
- createFile: this.requestFunctionFactory(descriptors.fileCreateFile),
491
- /** Get a File's meta. */
492
- getFileMeta: this.requestFunctionFactory(descriptors.fileGetFileMeta),
493
- /** Get a FileUploadToken's rules. */
494
- getFileUploadTokenRules: this.requestFunctionFactory(descriptors.fileGetFileUploadTokenRules),
495
- /** Get a FileUploadType's rules. */
496
- getFileUploadTypeRules: this.requestFunctionFactory(descriptors.fileGetFileUploadTypeRules),
497
- /** Get a File. */
498
- getFile: this.requestFunctionFactory(descriptors.fileGetFile),
499
- /** Get a File with user-friendly url. */
500
- getFileWithName: this.requestFunctionFactory(descriptors.fileGetFileWithName),
501
- };
502
550
  /** The mail API allows you to manage your mail accounts. */
503
551
  mail = {
552
+ /** Update the autoresponder of a MailAddress. */
553
+ updateMailAddressAutoresponder: this.requestFunctionFactory(descriptors.mailUpdateMailAddressAutoresponder),
554
+ /** Update the forward addresses of a MailAddresses. */
555
+ updateMailAddressForwardAddresses: this.requestFunctionFactory(descriptors.mailUpdateMailAddressForwardAddresses),
556
+ /** Update the password for a MailAddress. */
557
+ updateMailAddressPassword: this.requestFunctionFactory(descriptors.mailUpdateMailAddressPassword),
558
+ /** Update the quota of a MailAddress. */
559
+ updateMailAddressQuota: this.requestFunctionFactory(descriptors.mailUpdateMailAddressQuota),
560
+ /** Update the spam protection of a MailAddress. */
561
+ updateMailAddressSpamProtection: this.requestFunctionFactory(descriptors.mailUpdateMailAddressSpamProtection),
504
562
  /** List DeliveryBoxes belonging to a Project. */
505
563
  listDeliveryBoxes: this.requestFunctionFactory(descriptors.mailListDeliveryBoxes),
506
564
  /** Create a DeliveryBox. */
@@ -527,27 +585,160 @@ export class MittwaldAPIV2Client extends ApiClientBase {
527
585
  migrationListMigrations: this.requestFunctionFactory(descriptors.mailMigrationListMigrations),
528
586
  /** Request a Mail Migration between two projects. */
529
587
  migrationRequestMailMigration: this.requestFunctionFactory(descriptors.mailMigrationRequestMailMigration),
588
+ /** Request to restore a backup for a MailAddress */
589
+ requestMailAddressBackup: this.requestFunctionFactory(descriptors.mailRequestMailAddressBackup),
530
590
  /** Update the description of a DeliveryBox. */
531
591
  updateDeliveryBoxDescription: this.requestFunctionFactory(descriptors.mailUpdateDeliveryBoxDescription),
532
592
  /** Update the password of a DeliveryBox. */
533
593
  updateDeliveryBoxPassword: this.requestFunctionFactory(descriptors.mailUpdateDeliveryBoxPassword),
534
594
  /** Update a MailAddress. */
535
595
  updateMailAddressAddress: this.requestFunctionFactory(descriptors.mailUpdateMailAddressAddress),
536
- /** Update the autoresponder of a MailAddress. */
537
- updateMailAddressAutoresponder: this.requestFunctionFactory(descriptors.mailUpdateMailAddressAutoresponder),
538
- /** Update the catchall of a MailAddress. */
596
+ /** Update the catch-all of a MailAddress. */
539
597
  updateMailAddressCatchAll: this.requestFunctionFactory(descriptors.mailUpdateMailAddressCatchAll),
540
- /** Update the forward addresses of a MailAddresses. */
541
- updateMailAddressForwardAddresses: this.requestFunctionFactory(descriptors.mailUpdateMailAddressForwardAddresses),
542
- /** Update the password for a MailAddress. */
543
- updateMailAddressPassword: this.requestFunctionFactory(descriptors.mailUpdateMailAddressPassword),
544
- /** Update the quota of a MailAddress. */
545
- updateMailAddressQuota: this.requestFunctionFactory(descriptors.mailUpdateMailAddressQuota),
546
- /** Update the spam protection of a MailAddress. */
547
- updateMailAddressSpamProtection: this.requestFunctionFactory(descriptors.mailUpdateMailAddressSpamProtection),
548
598
  /** Update a mail setting of a Project. */
549
599
  updateProjectMailSetting: this.requestFunctionFactory(descriptors.mailUpdateProjectMailSetting),
550
600
  };
601
+ /** The notification API allows you to manage your notifications. */
602
+ notification = {
603
+ /** Subscribe a user to the mStudio newsletter. */
604
+ newsletterSubscribeUser: this.requestFunctionFactory(descriptors.newsletterSubscribeUser),
605
+ /** Getting the subscription status of the subscription. */
606
+ newsletterGetInfo: this.requestFunctionFactory(descriptors.newsletterGetInfo),
607
+ /** Unsubscribe a user from the mStudio newsletter. */
608
+ newsletterUnsubscribeUser: this.requestFunctionFactory(descriptors.newsletterUnsubscribeUser),
609
+ /** Get the counts for unread notifications of the user. */
610
+ scountUnreadNotifications: this.requestFunctionFactory(descriptors.notificationsCountUnreadNotifications),
611
+ /** List all unread notifications. */
612
+ slistNotifications: this.requestFunctionFactory(descriptors.notificationsListNotifications),
613
+ /** Mark all notifications as read. */
614
+ sreadAllNotifications: this.requestFunctionFactory(descriptors.notificationsReadAllNotifications),
615
+ /** Mark notification as read. */
616
+ sreadNotification: this.requestFunctionFactory(descriptors.notificationsReadNotification),
617
+ };
618
+ /** The user API allows you to manage your own user and access information of other users that might be visible to you. */
619
+ user = {
620
+ /** Update your account information. */
621
+ updateAccount: this.requestFunctionFactory(descriptors.userUpdateAccount),
622
+ /** Add phone number and start verification process. */
623
+ addPhoneNumber: this.requestFunctionFactory(descriptors.userAddPhoneNumber),
624
+ /** Remove phone number. */
625
+ removePhoneNumber: this.requestFunctionFactory(descriptors.userRemovePhoneNumber),
626
+ /** Validate your second factor. */
627
+ authenticateMfa: this.requestFunctionFactory(descriptors.userAuthenticateMfa),
628
+ /** Authenticate yourself to get an access token. */
629
+ authenticate: this.requestFunctionFactory(descriptors.userAuthenticate),
630
+ /** Authenticate an user with an access token retrieval key. */
631
+ authenticateWithAccessTokenRetrievalKey: this.requestFunctionFactory(descriptors.userAuthenticateWithAccessTokenRetrievalKey),
632
+ /** Get your verified Email-Address. */
633
+ getOwnEmail: this.requestFunctionFactory(descriptors.userGetOwnEmail),
634
+ /** Change your Email-Address. */
635
+ changeEmail: this.requestFunctionFactory(descriptors.userChangeEmail),
636
+ /** Change your password. */
637
+ changePassword: this.requestFunctionFactory(descriptors.userChangePassword),
638
+ /** Check token for validity. */
639
+ checkToken: this.requestFunctionFactory(descriptors.userCheckToken),
640
+ /** Get your current multi factor auth status. */
641
+ getMfaStatus: this.requestFunctionFactory(descriptors.userGetMfaStatus),
642
+ /** Reset RecoveryCodes for MFA. */
643
+ resetRecoverycodes: this.requestFunctionFactory(descriptors.userResetRecoverycodes),
644
+ /** Confirm Multi Factor Authentication. */
645
+ confirmMfa: this.requestFunctionFactory(descriptors.userConfirmMfa),
646
+ /** Disable Multi Factor Authentication. */
647
+ disableMfa: this.requestFunctionFactory(descriptors.userDisableMfa),
648
+ /** Confirm password reset. */
649
+ confirmPasswordReset: this.requestFunctionFactory(descriptors.userConfirmPasswordReset),
650
+ /** List all of your ApiTokens. */
651
+ listApiTokens: this.requestFunctionFactory(descriptors.userListApiTokens),
652
+ /** Store a new ApiToken. */
653
+ createApiToken: this.requestFunctionFactory(descriptors.userCreateApiToken),
654
+ /** Submit your user feedback. */
655
+ createFeedback: this.requestFunctionFactory(descriptors.userCreateFeedback),
656
+ /** Get your stored ssh-keys. */
657
+ listSshKeys: this.requestFunctionFactory(descriptors.userListSshKeys),
658
+ /** Store a new ssh-key. */
659
+ createSshKey: this.requestFunctionFactory(descriptors.userCreateSshKey),
660
+ /** Get a specific ApiToken. */
661
+ getApiToken: this.requestFunctionFactory(descriptors.userGetApiToken),
662
+ /** Update an existing `ApiToken`. */
663
+ editApiToken: this.requestFunctionFactory(descriptors.userEditApiToken),
664
+ /** Deletes an ApiToken. */
665
+ deleteApiToken: this.requestFunctionFactory(descriptors.userDeleteApiToken),
666
+ /** Get a specific stored ssh-key. */
667
+ getSshKey: this.requestFunctionFactory(descriptors.userGetSshKey),
668
+ /** Edit a stored ssh-key. */
669
+ editSshKey: this.requestFunctionFactory(descriptors.userEditSshKey),
670
+ /** Remove a ssh-key. */
671
+ deleteSshKey: this.requestFunctionFactory(descriptors.userDeleteSshKey),
672
+ /** Delete your account and all your personal data. */
673
+ deleteUser: this.requestFunctionFactory(descriptors.userDeleteUser),
674
+ /** The timestamp of your latest password change. */
675
+ getPasswordUpdatedAt: this.requestFunctionFactory(descriptors.userGetPasswordUpdatedAt),
676
+ /** Get personalized settings. */
677
+ getPersonalizedSettings: this.requestFunctionFactory(descriptors.userGetPersonalizedSettings),
678
+ /** Update personalized GUI settings. */
679
+ updatePersonalizedSettings: this.requestFunctionFactory(descriptors.userUpdatePersonalizedSettings),
680
+ /** Get poll settings for the specified user. */
681
+ getPollStatus: this.requestFunctionFactory(descriptors.userGetPollStatus),
682
+ /** Store new or update poll settings. */
683
+ postPollStatus: this.requestFunctionFactory(descriptors.userPostPollStatus),
684
+ /** Get a specific session. */
685
+ getSession: this.requestFunctionFactory(descriptors.userGetSession),
686
+ /** Terminate a specific Session. */
687
+ terminateSession: this.requestFunctionFactory(descriptors.userTerminateSession),
688
+ /** Get profile information for a user. */
689
+ getUser: this.requestFunctionFactory(descriptors.userGetUser),
690
+ /** Change personal information. */
691
+ updatePersonalInformation: this.requestFunctionFactory(descriptors.userUpdatePersonalInformation),
692
+ /** Initialize Multi Factor Authentication. If successful, it needs to be confirmed, before usage of mfa. */
693
+ initMfa: this.requestFunctionFactory(descriptors.userInitMfa),
694
+ /** Initialize password reset process. */
695
+ initPasswordReset: this.requestFunctionFactory(descriptors.userInitPasswordReset),
696
+ /** Submitted feedback of the given user. */
697
+ listFeedback: this.requestFunctionFactory(descriptors.userListFeedback),
698
+ /** List all sessions. */
699
+ listSessions: this.requestFunctionFactory(descriptors.userListSessions),
700
+ /** Refresh a session. */
701
+ refreshSession: this.requestFunctionFactory(descriptors.userRefreshSession),
702
+ /** Terminate all sessions, except the current session. */
703
+ terminateAllSessions: this.requestFunctionFactory(descriptors.userTerminateAllSessions),
704
+ /** Terminate session and invalidate access token. */
705
+ logout: this.requestFunctionFactory(descriptors.userLogout),
706
+ /** Obtain authorization from the resource owner. */
707
+ oauthGetAuthorization: this.requestFunctionFactory(descriptors.userOauthGetAuthorization),
708
+ /** Retrieve Access Token from Authorization Code. */
709
+ oauthRetrieveAccessToken: this.requestFunctionFactory(descriptors.userOauthRetrieveAccessToken),
710
+ /** Register with email and password. */
711
+ register: this.requestFunctionFactory(descriptors.userRegister),
712
+ /** Request a new avatar image upload. */
713
+ requestAvatarUpload: this.requestFunctionFactory(descriptors.userRequestAvatarUpload),
714
+ /** Remove Avatar. */
715
+ removeAvatar: this.requestFunctionFactory(descriptors.userRemoveAvatar),
716
+ /** Resend the Email-Address verification email. */
717
+ resendVerificationEmail: this.requestFunctionFactory(descriptors.userResendVerificationEmail),
718
+ /** Request a support code. */
719
+ supportCodeRequest: this.requestFunctionFactory(descriptors.userSupportCodeRequest),
720
+ /** Verify an added Email-Address. */
721
+ verifyEmail: this.requestFunctionFactory(descriptors.userVerifyEmail),
722
+ /** Verify phone number. */
723
+ verifyPhoneNumber: this.requestFunctionFactory(descriptors.userVerifyPhoneNumber),
724
+ /** Verify your registration. */
725
+ verifyRegistration: this.requestFunctionFactory(descriptors.userVerifyRegistration),
726
+ };
727
+ /** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
728
+ file = {
729
+ /** Create a File. */
730
+ createFile: this.requestFunctionFactory(descriptors.fileCreateFile),
731
+ /** Get a File's meta. */
732
+ getFileMeta: this.requestFunctionFactory(descriptors.fileGetFileMeta),
733
+ /** Get a FileUploadToken's rules. */
734
+ getFileUploadTokenRules: this.requestFunctionFactory(descriptors.fileGetFileUploadTokenRules),
735
+ /** Get a FileUploadType's rules. */
736
+ getFileUploadTypeRules: this.requestFunctionFactory(descriptors.fileGetFileUploadTypeRules),
737
+ /** Get a File. */
738
+ getFile: this.requestFunctionFactory(descriptors.fileGetFile),
739
+ /** Get a File with user-friendly url. */
740
+ getFileWithName: this.requestFunctionFactory(descriptors.fileGetFileWithName),
741
+ };
551
742
  /** The page insights API allows you to get page insights information. */
552
743
  pageInsights = {
553
744
  /** Get detailed performance data for a given domain and path. */
@@ -599,8 +790,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
599
790
  getSelfMembershipForProject: this.requestFunctionFactory(descriptors.projectGetSelfMembershipForProject),
600
791
  /** Get a Server. */
601
792
  getServer: this.requestFunctionFactory(descriptors.projectGetServer),
602
- /** Leave a Project. */
603
- leaveProject: this.requestFunctionFactory(descriptors.projectLeaveProject),
604
793
  /** List Memberships belonging to a Project. */
605
794
  listMembershipsForProject: this.requestFunctionFactory(descriptors.projectListMembershipsForProject),
606
795
  /** List ProjectInvites belonging to the executing user. */
@@ -617,6 +806,14 @@ export class MittwaldAPIV2Client extends ApiClientBase {
617
806
  updateProjectDescription: this.requestFunctionFactory(descriptors.projectUpdateProjectDescription),
618
807
  /** Update a Servers's description. */
619
808
  updateServerDescription: this.requestFunctionFactory(descriptors.projectUpdateServerDescription),
809
+ /** Get storage space Statistics belonging to a Project. */
810
+ storagespaceGetProjectStatistics: this.requestFunctionFactory(descriptors.storagespaceGetProjectStatistics),
811
+ /** Get storage space Statistics belonging to a Server. */
812
+ storagespaceGetServerStatistics: this.requestFunctionFactory(descriptors.storagespaceGetServerStatistics),
813
+ /** Update a Project's storage space notification threshold. */
814
+ storagespaceReplaceProjectNotificationThreshold: this.requestFunctionFactory(descriptors.storagespaceReplaceProjectNotificationThreshold),
815
+ /** Update a Server's storage space notification threshold. */
816
+ storagespaceReplaceServerNotificationThreshold: this.requestFunctionFactory(descriptors.storagespaceReplaceServerNotificationThreshold),
620
817
  };
621
818
  /** The filesystem API allows you to directly access the filesystem of your project. */
622
819
  projectFileSystem = {
@@ -661,116 +858,12 @@ export class MittwaldAPIV2Client extends ApiClientBase {
661
858
  /** Update an SSHUser. */
662
859
  sshUserUpdateSshUser: this.requestFunctionFactory(descriptors.sshUserUpdateSshUser),
663
860
  };
664
- /** The user API allows you to manage your own user and access information of other users that might be visible to you. */
665
- user = {
666
- /** Add phone number and start verification process. */
667
- addPhoneNumber: this.requestFunctionFactory(descriptors.userAddPhoneNumber),
668
- /** Remove phone number. */
669
- removePhoneNumber: this.requestFunctionFactory(descriptors.userRemovePhoneNumber),
670
- /** Validate your second factor. */
671
- authenticateMfa: this.requestFunctionFactory(descriptors.userAuthenticateMfa),
672
- /** Authenticate yourself to get an access token. */
673
- authenticate: this.requestFunctionFactory(descriptors.userAuthenticate),
674
- /** Authenticate an user with an access token retrieval key. */
675
- authenticateWithAccessTokenRetrievalKey: this.requestFunctionFactory(descriptors.userAuthenticateWithAccessTokenRetrievalKey),
676
- /** Get your verified Email-Address. */
677
- getOwnEmail: this.requestFunctionFactory(descriptors.userGetOwnEmail),
678
- /** Change your Email-Address. */
679
- changeEmail: this.requestFunctionFactory(descriptors.userChangeEmail),
680
- /** Change your password. */
681
- changePassword: this.requestFunctionFactory(descriptors.userChangePassword),
682
- /** Check token for validity. */
683
- checkToken: this.requestFunctionFactory(descriptors.userCheckToken),
684
- /** Get your current multi factor auth status. */
685
- getMfaStatus: this.requestFunctionFactory(descriptors.userGetMfaStatus),
686
- /** Reset RecoveryCodes for MFA. */
687
- resetRecoverycodes: this.requestFunctionFactory(descriptors.userResetRecoverycodes),
688
- /** Confirm Multi Factor Authentication. */
689
- confirmMfa: this.requestFunctionFactory(descriptors.userConfirmMfa),
690
- /** Disable Multi Factor Authentication. */
691
- disableMfa: this.requestFunctionFactory(descriptors.userDisableMfa),
692
- /** Confirm password reset. */
693
- confirmPasswordReset: this.requestFunctionFactory(descriptors.userConfirmPasswordReset),
694
- /** List all of your ApiTokens. */
695
- listApiTokens: this.requestFunctionFactory(descriptors.userListApiTokens),
696
- /** Store a new ApiToken. */
697
- createApiToken: this.requestFunctionFactory(descriptors.userCreateApiToken),
698
- /** Submit your user feedback. */
699
- createFeedback: this.requestFunctionFactory(descriptors.userCreateFeedback),
700
- /** Get your stored ssh-keys. */
701
- listSshKeys: this.requestFunctionFactory(descriptors.userListSshKeys),
702
- /** Store a new ssh-key. */
703
- createSshKey: this.requestFunctionFactory(descriptors.userCreateSshKey),
704
- /** Get a specific ApiToken. */
705
- getApiToken: this.requestFunctionFactory(descriptors.userGetApiToken),
706
- /** Update an existing `ApiToken`. */
707
- editApiToken: this.requestFunctionFactory(descriptors.userEditApiToken),
708
- /** Deletes an ApiToken. */
709
- deleteApiToken: this.requestFunctionFactory(descriptors.userDeleteApiToken),
710
- /** Get a specific stored ssh-key. */
711
- getSshKey: this.requestFunctionFactory(descriptors.userGetSshKey),
712
- /** Edit a stored ssh-key. */
713
- editSshKey: this.requestFunctionFactory(descriptors.userEditSshKey),
714
- /** Remove a ssh-key. */
715
- deleteSshKey: this.requestFunctionFactory(descriptors.userDeleteSshKey),
716
- /** Delete your account and all your personal data. */
717
- deleteUser: this.requestFunctionFactory(descriptors.userDeleteUser),
718
- /** Get your account information. */
719
- getOwnAccount: this.requestFunctionFactory(descriptors.userGetOwnAccount),
720
- /** Update your account information. */
721
- updateAccount: this.requestFunctionFactory(descriptors.userUpdateAccount),
722
- /** The timestamp of your latest password change. */
723
- getPasswordUpdatedAt: this.requestFunctionFactory(descriptors.userGetPasswordUpdatedAt),
724
- /** Get personalized settings. */
725
- getPersonalizedSettings: this.requestFunctionFactory(descriptors.userGetPersonalizedSettings),
726
- /** Update personalized GUI settings. */
727
- updatePersonalizedSettings: this.requestFunctionFactory(descriptors.userUpdatePersonalizedSettings),
728
- /** Get poll settings for the specified user. */
729
- getPollStatus: this.requestFunctionFactory(descriptors.userGetPollStatus),
730
- /** Store new or update poll settings. */
731
- postPollStatus: this.requestFunctionFactory(descriptors.userPostPollStatus),
732
- /** Get a specific session. */
733
- getSession: this.requestFunctionFactory(descriptors.userGetSession),
734
- /** Terminate a specific Session. */
735
- terminateSession: this.requestFunctionFactory(descriptors.userTerminateSession),
736
- /** Get profile information for a user. */
737
- getUser: this.requestFunctionFactory(descriptors.userGetUser),
738
- /** Change personal information. */
739
- updatePersonalInformation: this.requestFunctionFactory(descriptors.userUpdatePersonalInformation),
740
- /** Initialize Multi Factor Authentication. If successful, it needs to be confirmed, before usage of mfa. */
741
- initMfa: this.requestFunctionFactory(descriptors.userInitMfa),
742
- /** Initialize password reset process. */
743
- initPasswordReset: this.requestFunctionFactory(descriptors.userInitPasswordReset),
744
- /** Submitted feedback of the given user. */
745
- listFeedback: this.requestFunctionFactory(descriptors.userListFeedback),
746
- /** List all sessions. */
747
- listSessions: this.requestFunctionFactory(descriptors.userListSessions),
748
- /** Refresh a session. */
749
- refreshSession: this.requestFunctionFactory(descriptors.userRefreshSession),
750
- /** Terminate all sessions, except the current session. */
751
- terminateAllSessions: this.requestFunctionFactory(descriptors.userTerminateAllSessions),
752
- /** Terminate session and invalidate access token. */
753
- logout: this.requestFunctionFactory(descriptors.userLogout),
754
- /** Obtain authorization from the resource owner. */
755
- oauthGetAuthorization: this.requestFunctionFactory(descriptors.userOauthGetAuthorization),
756
- /** Retrieve Access Token from Authorization Code. */
757
- oauthRetrieveAccessToken: this.requestFunctionFactory(descriptors.userOauthRetrieveAccessToken),
758
- /** Register with email and password. */
759
- register: this.requestFunctionFactory(descriptors.userRegister),
760
- /** Request a new avatar image upload. */
761
- requestAvatarUpload: this.requestFunctionFactory(descriptors.userRequestAvatarUpload),
762
- /** Remove Avatar. */
763
- removeAvatar: this.requestFunctionFactory(descriptors.userRemoveAvatar),
764
- /** Resend the Email-Address verification email. */
765
- resendVerificationEmail: this.requestFunctionFactory(descriptors.userResendVerificationEmail),
766
- /** Request a support code. */
767
- supportCodeRequest: this.requestFunctionFactory(descriptors.userSupportCodeRequest),
768
- /** Verify an added Email-Address. */
769
- verifyEmail: this.requestFunctionFactory(descriptors.userVerifyEmail),
770
- /** Verify phone number. */
771
- verifyPhoneNumber: this.requestFunctionFactory(descriptors.userVerifyPhoneNumber),
772
- /** Verify your registration. */
773
- verifyRegistration: this.requestFunctionFactory(descriptors.userVerifyRegistration),
861
+ /** API endpoints that are not related to any specific API domain */
862
+ misc = {
863
+ /** Check if an address exists. */
864
+ verificationVerifyAddress: this.requestFunctionFactory(descriptors.verificationVerifyAddress),
865
+ /** Check if a company exists. */
866
+ verificationVerifyCompany: this.requestFunctionFactory(descriptors.verificationVerifyCompany),
774
867
  };
775
868
  }
776
869
  export default MittwaldAPIV2Client;