@mittwald/api-client 1.0.3 → 1.0.4

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.
@@ -107,12 +107,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
107
107
  getNextTerminationDateForItem: this.requestFunctionFactory(descriptors.contractGetNextTerminationDateForItem),
108
108
  /** Return a list of Contracts for the given Customer. */
109
109
  listContracts: this.requestFunctionFactory(descriptors.contractListContracts),
110
- /** Return the Contract for the given Domain. */
111
- deprecatedContractGetDetailOfContractByDomain: this.requestFunctionFactory(descriptors.deprecatedContractGetDetailOfContractByDomain),
112
- /** Return the Contract for the given Project. */
113
- deprecatedContractGetDetailOfContractByProject: this.requestFunctionFactory(descriptors.deprecatedContractGetDetailOfContractByProject),
114
- /** Return the Contract for the given Server. */
115
- deprecatedContractGetDetailOfContractByServer: this.requestFunctionFactory(descriptors.deprecatedContractGetDetailOfContractByServer),
116
110
  /** Get details of an Invoice. */
117
111
  invoiceDetailOfInvoice: this.requestFunctionFactory(descriptors.invoiceDetailOfInvoice),
118
112
  /** Get InvoiceSettings of a Customer. */
@@ -189,10 +183,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
189
183
  /** Accept a CustomerInvite. */
190
184
  acceptCustomerInvite: this.requestFunctionFactory(descriptors.customerAcceptCustomerInvite),
191
185
  /** Get all customer categories. */
192
- listOfCustomerCategoriesDeprecated: this.requestFunctionFactory(descriptors.customerListOfCustomerCategoriesDeprecated),
193
- /** Create a new customer category. */
194
- createCategoryDeprecated: this.requestFunctionFactory(descriptors.customerCreateCategoryDeprecated),
195
- /** Get all customer categories. */
196
186
  listOfCustomerCategories: this.requestFunctionFactory(descriptors.customerListOfCustomerCategories),
197
187
  /** Create a new customer category. */
198
188
  createCategory: this.requestFunctionFactory(descriptors.customerCreateCategory),
@@ -205,12 +195,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
205
195
  /** Decline a CustomerInvite. */
206
196
  declineCustomerInvite: this.requestFunctionFactory(descriptors.customerDeclineCustomerInvite),
207
197
  /** Get a customer category. */
208
- detailOfCustomerCategoryDeprecated: this.requestFunctionFactory(descriptors.customerDetailOfCustomerCategoryDeprecated),
209
- /** Update a customer category. */
210
- updateCategoryDeprecated: this.requestFunctionFactory(descriptors.customerUpdateCategoryDeprecated),
211
- /** Delete a customer category. */
212
- deleteCategoryDeprecated: this.requestFunctionFactory(descriptors.customerDeleteCategoryDeprecated),
213
- /** Get a customer category. */
214
198
  getCustomerCategory: this.requestFunctionFactory(descriptors.customerGetCustomerCategory),
215
199
  /** Update a customer category. */
216
200
  updateCategory: this.requestFunctionFactory(descriptors.customerUpdateCategory),
@@ -302,156 +286,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
302
286
  /** Update a RedisDatabase's description. */
303
287
  updateRedisDatabaseDescription: this.requestFunctionFactory(descriptors.databaseUpdateRedisDatabaseDescription),
304
288
  };
305
- /** The notification API allows you to manage your notifications. */
306
- notification = {
307
- /** getting the subscription status of the subscription */
308
- deprecatedNewsletterGetInfo: this.requestFunctionFactory(descriptors.deprecatedNewsletterGetInfo),
309
- /** Unsubscribe a user from the mStudio newsletter. */
310
- deprecatedNewsletterUnsubscribeUser: this.requestFunctionFactory(descriptors.deprecatedNewsletterUnsubscribeUser),
311
- /** subscribe a user to the mStudio newsletter */
312
- deprecatedNewsletterSubscribeUser: this.requestFunctionFactory(descriptors.deprecatedNewsletterSubscribeUser),
313
- /** Getting the subscription status of the subscription. */
314
- newsletterGetInfo: this.requestFunctionFactory(descriptors.newsletterGetInfo),
315
- /** Unsubscribe a user from the mStudio newsletter. */
316
- newsletterUnsubscribeUser: this.requestFunctionFactory(descriptors.newsletterUnsubscribeUser),
317
- /** Subscribe a user to the mStudio newsletter. */
318
- newsletterSubscribeUser: this.requestFunctionFactory(descriptors.newsletterSubscribeUser),
319
- /** Get the counts for unread notifications of the user. */
320
- scountUnreadNotifications: this.requestFunctionFactory(descriptors.notificationsCountUnreadNotifications),
321
- /** List all unread notifications */
322
- slistNotifications: this.requestFunctionFactory(descriptors.notificationsListNotifications),
323
- /** Mark all notifications as read. */
324
- sreadAllNotifications: this.requestFunctionFactory(descriptors.notificationsReadAllNotifications),
325
- /** Mark notification as read. */
326
- sreadNotification: this.requestFunctionFactory(descriptors.notificationsReadNotification),
327
- };
328
- /** The user API allows you to manage your own user and access information of other users that might be visible to you. */
329
- user = {
330
- /** Request a new avatar upload */
331
- deprecatedUserServiceAvatarRequestUpload: this.requestFunctionFactory(descriptors.deprecatedUserServiceAvatarRequestUpload),
332
- /** Remove Avatar */
333
- deprecatedUserServiceAvatarRemove: this.requestFunctionFactory(descriptors.deprecatedUserServiceAvatarRemove),
334
- /** Returns your submitted feedback */
335
- deprecatedUserServiceFeedbackList: this.requestFunctionFactory(descriptors.deprecatedUserServiceFeedbackList),
336
- /** Submit user feedback */
337
- deprecatedUserServiceFeedbackCreate: this.requestFunctionFactory(descriptors.deprecatedUserServiceFeedbackCreate),
338
- /** create a new issue */
339
- deprecatedUserServiceIssueNew: this.requestFunctionFactory(descriptors.deprecatedUserServiceIssueNew),
340
- /** Get profile information for the specified user if the user is related to the executing user */
341
- deprecatedUserServiceUserGet: this.requestFunctionFactory(descriptors.deprecatedUserServiceUserGet),
342
- /** Change your personal information */
343
- deprecatedUserServicePersonalInformationUpdate: this.requestFunctionFactory(descriptors.deprecatedUserServicePersonalInformationUpdate),
344
- /** Get personalized settings for the user executing the request */
345
- deprecatedUserServicePersonalizedSettingsGet: this.requestFunctionFactory(descriptors.deprecatedUserServicePersonalizedSettingsGet),
346
- /** update personalized settings */
347
- deprecatedUserServicePersonalizedSettingsUpdate: this.requestFunctionFactory(descriptors.deprecatedUserServicePersonalizedSettingsUpdate),
348
- /** Add phone number and init verification process */
349
- deprecatedUserServicePhoneNumberAdd: this.requestFunctionFactory(descriptors.deprecatedUserServicePhoneNumberAdd),
350
- /** remove your PhoneNumber */
351
- deprecatedUserServicePhoneNumberRemove: this.requestFunctionFactory(descriptors.deprecatedUserServicePhoneNumberRemove),
352
- /** Verify phone number */
353
- deprecatedUserServicePhoneNumberVerify: this.requestFunctionFactory(descriptors.deprecatedUserServicePhoneNumberVerify),
354
- /** Get profile information for the executing user */
355
- deprecatedUserServiceUserGetOwn: this.requestFunctionFactory(descriptors.deprecatedUserServiceUserGetOwn),
356
- /** Add phone number and start verification process. */
357
- addPhoneNumber: this.requestFunctionFactory(descriptors.userAddPhoneNumber),
358
- /** Remove phone number. */
359
- removePhoneNumber: this.requestFunctionFactory(descriptors.userRemovePhoneNumber),
360
- /** Authenticate yourself to get an access token. */
361
- authenticate: this.requestFunctionFactory(descriptors.userAuthenticate),
362
- /** Validate your second factor. */
363
- authenticateMfa: this.requestFunctionFactory(descriptors.userAuthenticateMfa),
364
- /** Get your primary verified Email-Address */
365
- getEmail: this.requestFunctionFactory(descriptors.userGetEmail),
366
- /** Change your Email-Address */
367
- changeEmail: this.requestFunctionFactory(descriptors.userChangeEmail),
368
- /** The timestamp of your latest password change */
369
- getPasswordUpdatedAt: this.requestFunctionFactory(descriptors.userGetPasswordUpdatedAt),
370
- /** Change your password */
371
- changePassword: this.requestFunctionFactory(descriptors.userChangePassword),
372
- /** Get your profile information */
373
- getOwnProfile: this.requestFunctionFactory(descriptors.userGetOwnProfile),
374
- /** Change your profile information */
375
- changeProfile: this.requestFunctionFactory(descriptors.userChangeProfile),
376
- /** Delete your profile and all your personal data */
377
- deleteProfile: this.requestFunctionFactory(descriptors.userDeleteProfile),
378
- /** Check a token for validity */
379
- checkToken: this.requestFunctionFactory(descriptors.userCheckToken),
380
- /** Confirm Multi Factor Authentication */
381
- confirmMfa: this.requestFunctionFactory(descriptors.userConfirmMfa),
382
- /** Confirm password reset */
383
- confirmPasswordReset: this.requestFunctionFactory(descriptors.userConfirmPasswordReset),
384
- /** List all ApiTokens of the user */
385
- listApiTokens: this.requestFunctionFactory(descriptors.userListApiTokens),
386
- /** Store a new ApiToken */
387
- createApiToken: this.requestFunctionFactory(descriptors.userCreateApiToken),
388
- /** Submit your user feedback. */
389
- createFeedback: this.requestFunctionFactory(descriptors.userCreateFeedback),
390
- /** Create a new issue. */
391
- createIssue: this.requestFunctionFactory(descriptors.userCreateIssue),
392
- /** Get your stored ssh keys */
393
- listSshKeys: this.requestFunctionFactory(descriptors.userListSshKeys),
394
- /** Store a new SSH key */
395
- createSshKey: this.requestFunctionFactory(descriptors.userCreateSshKey),
396
- /** Get a specific ApiToken */
397
- getApiToken: this.requestFunctionFactory(descriptors.userGetApiToken),
398
- /** Update an existing `ApiToken` */
399
- editApiToken: this.requestFunctionFactory(descriptors.userEditApiToken),
400
- /** Deletes an ApiToken */
401
- deleteApiToken: this.requestFunctionFactory(descriptors.userDeleteApiToken),
402
- /** Get a specific stored SshKey */
403
- getSshKey: this.requestFunctionFactory(descriptors.userGetSshKey),
404
- /** Edit a stored SshKey */
405
- editSshKey: this.requestFunctionFactory(descriptors.userEditSshKey),
406
- /** Remove a SSH-key */
407
- deleteSshKey: this.requestFunctionFactory(descriptors.userDeleteSshKey),
408
- /** Get your current multi factor auth status */
409
- getMfaStatus: this.requestFunctionFactory(descriptors.userGetMfaStatus),
410
- /** Initialize Multi Factor Authentication. If successfull, it needs to be confirmed, before usage of mfa. */
411
- initMfa: this.requestFunctionFactory(descriptors.userInitMfa),
412
- /** Disable Multi Factor Authentication. */
413
- disableMfa: this.requestFunctionFactory(descriptors.userDisableMfa),
414
- /** Get personalized settings. */
415
- getPersonalizedSettings: this.requestFunctionFactory(descriptors.userGetPersonalizedSettings),
416
- /** Update personalized GUI settings. */
417
- updatePersonalizedSettings: this.requestFunctionFactory(descriptors.userUpdatePersonalizedSettings),
418
- /** Get a specific Session */
419
- getSession: this.requestFunctionFactory(descriptors.userGetSession),
420
- /** Terminate a specific Session */
421
- terminateSession: this.requestFunctionFactory(descriptors.userTerminateSession),
422
- /** Get profile information for a user. */
423
- getUser: this.requestFunctionFactory(descriptors.userGetUser),
424
- /** Change personal information. */
425
- updatePersonalInformation: this.requestFunctionFactory(descriptors.userUpdatePersonalInformation),
426
- /** Initialize password reset process */
427
- initPasswordReset: this.requestFunctionFactory(descriptors.userInitPasswordReset),
428
- /** Submitted feedback of the given user. */
429
- listFeedback: this.requestFunctionFactory(descriptors.userListFeedback),
430
- /** List all active sessions */
431
- listSessions: this.requestFunctionFactory(descriptors.userListSessions),
432
- /** Terminate all sessions, except the current Session */
433
- terminateAllSessions: this.requestFunctionFactory(descriptors.userTerminateAllSessions),
434
- /** Terminate session and invalidate access token */
435
- logout: this.requestFunctionFactory(descriptors.userLogout),
436
- /** Register with email and password. */
437
- register: this.requestFunctionFactory(descriptors.userRegister),
438
- /** Request a new avatar image upload. */
439
- requestAvatarUpload: this.requestFunctionFactory(descriptors.userRequestAvatarUpload),
440
- /** Remove Avatar. */
441
- removeAvatar: this.requestFunctionFactory(descriptors.userRemoveAvatar),
442
- /** Resend the Email-Address verification email */
443
- resendVerificationEmail: this.requestFunctionFactory(descriptors.userResendVerificationEmail),
444
- /** Reset RecoveryCodes for MFA */
445
- resetRecoverycodes: this.requestFunctionFactory(descriptors.userResetRecoverycodes),
446
- /** Request a support code */
447
- supportCodeRequest: this.requestFunctionFactory(descriptors.userSupportCodeRequest),
448
- /** Verify an added Email-Address */
449
- verifyEmail: this.requestFunctionFactory(descriptors.userVerifyEmail),
450
- /** Verify phone number. */
451
- verifyPhoneNumber: this.requestFunctionFactory(descriptors.userVerifyPhoneNumber),
452
- /** Verify your registration */
453
- verifyRegistration: this.requestFunctionFactory(descriptors.userVerifyRegistration),
454
- };
455
289
  /** The domain API allows you to manage your domains, DNS records and ingress resources. */
456
290
  domain = {
457
291
  /** updates a-records for a specific zone */
@@ -579,6 +413,23 @@ export class MittwaldAPIV2Client extends ApiClientBase {
579
413
  /** Update whitelist for a given project ID */
580
414
  projectsettingUpdateWhitelist: this.requestFunctionFactory(descriptors.mailProjectsettingUpdateWhitelist),
581
415
  };
416
+ /** The notification API allows you to manage your notifications. */
417
+ notification = {
418
+ /** Getting the subscription status of the subscription. */
419
+ newsletterGetInfo: this.requestFunctionFactory(descriptors.newsletterGetInfo),
420
+ /** Unsubscribe a user from the mStudio newsletter. */
421
+ newsletterUnsubscribeUser: this.requestFunctionFactory(descriptors.newsletterUnsubscribeUser),
422
+ /** Subscribe a user to the mStudio newsletter. */
423
+ newsletterSubscribeUser: this.requestFunctionFactory(descriptors.newsletterSubscribeUser),
424
+ /** Get the counts for unread notifications of the user. */
425
+ scountUnreadNotifications: this.requestFunctionFactory(descriptors.notificationsCountUnreadNotifications),
426
+ /** List all unread notifications */
427
+ slistNotifications: this.requestFunctionFactory(descriptors.notificationsListNotifications),
428
+ /** Mark all notifications as read. */
429
+ sreadAllNotifications: this.requestFunctionFactory(descriptors.notificationsReadAllNotifications),
430
+ /** Mark notification as read. */
431
+ sreadNotification: this.requestFunctionFactory(descriptors.notificationsReadNotification),
432
+ };
582
433
  /** The project API allows you to manage your projects, and also any kinds of user memberships concerning these projects. */
583
434
  project = {
584
435
  /** Accept a ProjectInvite. */
@@ -674,5 +525,106 @@ export class MittwaldAPIV2Client extends ApiClientBase {
674
525
  /** Update an SSHUser. */
675
526
  sshUserUpdateSshUser: this.requestFunctionFactory(descriptors.sshUserUpdateSshUser),
676
527
  };
528
+ /** The user API allows you to manage your own user and access information of other users that might be visible to you. */
529
+ user = {
530
+ /** Add phone number and start verification process. */
531
+ addPhoneNumber: this.requestFunctionFactory(descriptors.userAddPhoneNumber),
532
+ /** Remove phone number. */
533
+ removePhoneNumber: this.requestFunctionFactory(descriptors.userRemovePhoneNumber),
534
+ /** Authenticate yourself to get an access token. */
535
+ authenticate: this.requestFunctionFactory(descriptors.userAuthenticate),
536
+ /** Validate your second factor. */
537
+ authenticateMfa: this.requestFunctionFactory(descriptors.userAuthenticateMfa),
538
+ /** Get your primary verified Email-Address */
539
+ getEmail: this.requestFunctionFactory(descriptors.userGetEmail),
540
+ /** Change your Email-Address */
541
+ changeEmail: this.requestFunctionFactory(descriptors.userChangeEmail),
542
+ /** The timestamp of your latest password change */
543
+ getPasswordUpdatedAt: this.requestFunctionFactory(descriptors.userGetPasswordUpdatedAt),
544
+ /** Change your password */
545
+ changePassword: this.requestFunctionFactory(descriptors.userChangePassword),
546
+ /** Get your profile information */
547
+ getOwnProfile: this.requestFunctionFactory(descriptors.userGetOwnProfile),
548
+ /** Change your profile information */
549
+ changeProfile: this.requestFunctionFactory(descriptors.userChangeProfile),
550
+ /** Delete your profile and all your personal data */
551
+ deleteProfile: this.requestFunctionFactory(descriptors.userDeleteProfile),
552
+ /** Check a token for validity */
553
+ checkToken: this.requestFunctionFactory(descriptors.userCheckToken),
554
+ /** Confirm Multi Factor Authentication */
555
+ confirmMfa: this.requestFunctionFactory(descriptors.userConfirmMfa),
556
+ /** Confirm password reset */
557
+ confirmPasswordReset: this.requestFunctionFactory(descriptors.userConfirmPasswordReset),
558
+ /** List all ApiTokens of the user */
559
+ listApiTokens: this.requestFunctionFactory(descriptors.userListApiTokens),
560
+ /** Store a new ApiToken */
561
+ createApiToken: this.requestFunctionFactory(descriptors.userCreateApiToken),
562
+ /** Submit your user feedback. */
563
+ createFeedback: this.requestFunctionFactory(descriptors.userCreateFeedback),
564
+ /** Create a new issue. */
565
+ createIssue: this.requestFunctionFactory(descriptors.userCreateIssue),
566
+ /** Get your stored ssh keys */
567
+ listSshKeys: this.requestFunctionFactory(descriptors.userListSshKeys),
568
+ /** Store a new SSH key */
569
+ createSshKey: this.requestFunctionFactory(descriptors.userCreateSshKey),
570
+ /** Get a specific ApiToken */
571
+ getApiToken: this.requestFunctionFactory(descriptors.userGetApiToken),
572
+ /** Update an existing `ApiToken` */
573
+ editApiToken: this.requestFunctionFactory(descriptors.userEditApiToken),
574
+ /** Deletes an ApiToken */
575
+ deleteApiToken: this.requestFunctionFactory(descriptors.userDeleteApiToken),
576
+ /** Get a specific stored SshKey */
577
+ getSshKey: this.requestFunctionFactory(descriptors.userGetSshKey),
578
+ /** Edit a stored SshKey */
579
+ editSshKey: this.requestFunctionFactory(descriptors.userEditSshKey),
580
+ /** Remove a SSH-key */
581
+ deleteSshKey: this.requestFunctionFactory(descriptors.userDeleteSshKey),
582
+ /** Get your current multi factor auth status */
583
+ getMfaStatus: this.requestFunctionFactory(descriptors.userGetMfaStatus),
584
+ /** Initialize Multi Factor Authentication. If successfull, it needs to be confirmed, before usage of mfa. */
585
+ initMfa: this.requestFunctionFactory(descriptors.userInitMfa),
586
+ /** Disable Multi Factor Authentication. */
587
+ disableMfa: this.requestFunctionFactory(descriptors.userDisableMfa),
588
+ /** Get personalized settings. */
589
+ getPersonalizedSettings: this.requestFunctionFactory(descriptors.userGetPersonalizedSettings),
590
+ /** Update personalized GUI settings. */
591
+ updatePersonalizedSettings: this.requestFunctionFactory(descriptors.userUpdatePersonalizedSettings),
592
+ /** Get a specific Session */
593
+ getSession: this.requestFunctionFactory(descriptors.userGetSession),
594
+ /** Terminate a specific Session */
595
+ terminateSession: this.requestFunctionFactory(descriptors.userTerminateSession),
596
+ /** Get profile information for a user. */
597
+ getUser: this.requestFunctionFactory(descriptors.userGetUser),
598
+ /** Change personal information. */
599
+ updatePersonalInformation: this.requestFunctionFactory(descriptors.userUpdatePersonalInformation),
600
+ /** Initialize password reset process */
601
+ initPasswordReset: this.requestFunctionFactory(descriptors.userInitPasswordReset),
602
+ /** Submitted feedback of the given user. */
603
+ listFeedback: this.requestFunctionFactory(descriptors.userListFeedback),
604
+ /** List all active sessions */
605
+ listSessions: this.requestFunctionFactory(descriptors.userListSessions),
606
+ /** Terminate all sessions, except the current Session */
607
+ terminateAllSessions: this.requestFunctionFactory(descriptors.userTerminateAllSessions),
608
+ /** Terminate session and invalidate access token */
609
+ logout: this.requestFunctionFactory(descriptors.userLogout),
610
+ /** Register with email and password. */
611
+ register: this.requestFunctionFactory(descriptors.userRegister),
612
+ /** Request a new avatar image upload. */
613
+ requestAvatarUpload: this.requestFunctionFactory(descriptors.userRequestAvatarUpload),
614
+ /** Remove Avatar. */
615
+ removeAvatar: this.requestFunctionFactory(descriptors.userRemoveAvatar),
616
+ /** Resend the Email-Address verification email */
617
+ resendVerificationEmail: this.requestFunctionFactory(descriptors.userResendVerificationEmail),
618
+ /** Reset RecoveryCodes for MFA */
619
+ resetRecoverycodes: this.requestFunctionFactory(descriptors.userResetRecoverycodes),
620
+ /** Request a support code */
621
+ supportCodeRequest: this.requestFunctionFactory(descriptors.userSupportCodeRequest),
622
+ /** Verify an added Email-Address */
623
+ verifyEmail: this.requestFunctionFactory(descriptors.userVerifyEmail),
624
+ /** Verify phone number. */
625
+ verifyPhoneNumber: this.requestFunctionFactory(descriptors.userVerifyPhoneNumber),
626
+ /** Verify your registration */
627
+ verifyRegistration: this.requestFunctionFactory(descriptors.userVerifyRegistration),
628
+ };
677
629
  }
678
630
  export default MittwaldAPIV2Client;