@mittwald/api-client 1.0.6 → 2.0.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.
@@ -540,81 +540,83 @@ class MittwaldAPIV2Client extends api_client_commons_1.ApiClientBase {
540
540
  addPhoneNumber: this.requestFunctionFactory(descriptors.userAddPhoneNumber),
541
541
  /** Remove phone number. */
542
542
  removePhoneNumber: this.requestFunctionFactory(descriptors.userRemovePhoneNumber),
543
- /** Authenticate yourself to get an access token. */
544
- authenticate: this.requestFunctionFactory(descriptors.userAuthenticate),
545
543
  /** Validate your second factor. */
546
544
  authenticateMfa: this.requestFunctionFactory(descriptors.userAuthenticateMfa),
547
- /** Get your primary verified Email-Address */
548
- getEmail: this.requestFunctionFactory(descriptors.userGetEmail),
549
- /** Change your Email-Address */
545
+ /** Authenticate yourself to get an access token. */
546
+ authenticate: this.requestFunctionFactory(descriptors.userAuthenticate),
547
+ /** Get your verified Email-Address. */
548
+ getOwnEmail: this.requestFunctionFactory(descriptors.userGetOwnEmail),
549
+ /** Change your Email-Address. */
550
550
  changeEmail: this.requestFunctionFactory(descriptors.userChangeEmail),
551
- /** The timestamp of your latest password change */
552
- getPasswordUpdatedAt: this.requestFunctionFactory(descriptors.userGetPasswordUpdatedAt),
553
- /** Change your password */
551
+ /** Change your password. */
554
552
  changePassword: this.requestFunctionFactory(descriptors.userChangePassword),
555
- /** Get your profile information */
556
- getOwnProfile: this.requestFunctionFactory(descriptors.userGetOwnProfile),
557
- /** Change your profile information */
558
- changeProfile: this.requestFunctionFactory(descriptors.userChangeProfile),
559
- /** Delete your profile and all your personal data */
560
- deleteProfile: this.requestFunctionFactory(descriptors.userDeleteProfile),
561
- /** Check a token for validity */
553
+ /** Check token for validity. */
562
554
  checkToken: this.requestFunctionFactory(descriptors.userCheckToken),
563
- /** Confirm Multi Factor Authentication */
555
+ /** Get your current multi factor auth status. */
556
+ getMfaStatus: this.requestFunctionFactory(descriptors.userGetMfaStatus),
557
+ /** Reset RecoveryCodes for MFA. */
558
+ resetRecoverycodes: this.requestFunctionFactory(descriptors.userResetRecoverycodes),
559
+ /** Confirm Multi Factor Authentication. */
564
560
  confirmMfa: this.requestFunctionFactory(descriptors.userConfirmMfa),
565
- /** Confirm password reset */
561
+ /** Disable Multi Factor Authentication. */
562
+ disableMfa: this.requestFunctionFactory(descriptors.userDisableMfa),
563
+ /** Confirm password reset. */
566
564
  confirmPasswordReset: this.requestFunctionFactory(descriptors.userConfirmPasswordReset),
567
- /** List all ApiTokens of the user */
565
+ /** List all of your ApiTokens. */
568
566
  listApiTokens: this.requestFunctionFactory(descriptors.userListApiTokens),
569
- /** Store a new ApiToken */
567
+ /** Store a new ApiToken. */
570
568
  createApiToken: this.requestFunctionFactory(descriptors.userCreateApiToken),
571
569
  /** Submit your user feedback. */
572
570
  createFeedback: this.requestFunctionFactory(descriptors.userCreateFeedback),
573
571
  /** Create a new issue. */
574
572
  createIssue: this.requestFunctionFactory(descriptors.userCreateIssue),
575
- /** Get your stored ssh keys */
573
+ /** Get your stored ssh-keys. */
576
574
  listSshKeys: this.requestFunctionFactory(descriptors.userListSshKeys),
577
- /** Store a new SSH key */
575
+ /** Store a new ssh-key. */
578
576
  createSshKey: this.requestFunctionFactory(descriptors.userCreateSshKey),
579
- /** Get a specific ApiToken */
577
+ /** Get a specific ApiToken. */
580
578
  getApiToken: this.requestFunctionFactory(descriptors.userGetApiToken),
581
- /** Update an existing `ApiToken` */
579
+ /** Update an existing `ApiToken`. */
582
580
  editApiToken: this.requestFunctionFactory(descriptors.userEditApiToken),
583
- /** Deletes an ApiToken */
581
+ /** Deletes an ApiToken. */
584
582
  deleteApiToken: this.requestFunctionFactory(descriptors.userDeleteApiToken),
585
- /** Get a specific stored SshKey */
583
+ /** Get a specific stored ssh-key. */
586
584
  getSshKey: this.requestFunctionFactory(descriptors.userGetSshKey),
587
- /** Edit a stored SshKey */
585
+ /** Edit a stored ssh-key. */
588
586
  editSshKey: this.requestFunctionFactory(descriptors.userEditSshKey),
589
- /** Remove a SSH-key */
587
+ /** Remove a ssh-key. */
590
588
  deleteSshKey: this.requestFunctionFactory(descriptors.userDeleteSshKey),
591
- /** Get your current multi factor auth status */
592
- getMfaStatus: this.requestFunctionFactory(descriptors.userGetMfaStatus),
593
- /** Initialize Multi Factor Authentication. If successfull, it needs to be confirmed, before usage of mfa. */
594
- initMfa: this.requestFunctionFactory(descriptors.userInitMfa),
595
- /** Disable Multi Factor Authentication. */
596
- disableMfa: this.requestFunctionFactory(descriptors.userDisableMfa),
589
+ /** Delete your account and all your personal data. */
590
+ deleteUser: this.requestFunctionFactory(descriptors.userDeleteUser),
591
+ /** Get your account information. */
592
+ getOwnAccount: this.requestFunctionFactory(descriptors.userGetOwnAccount),
593
+ /** Update your account information. */
594
+ updateAccount: this.requestFunctionFactory(descriptors.userUpdateAccount),
595
+ /** The timestamp of your latest password change. */
596
+ getPasswordUpdatedAt: this.requestFunctionFactory(descriptors.userGetPasswordUpdatedAt),
597
597
  /** Get personalized settings. */
598
598
  getPersonalizedSettings: this.requestFunctionFactory(descriptors.userGetPersonalizedSettings),
599
599
  /** Update personalized GUI settings. */
600
600
  updatePersonalizedSettings: this.requestFunctionFactory(descriptors.userUpdatePersonalizedSettings),
601
- /** Get a specific Session */
601
+ /** Get a specific session. */
602
602
  getSession: this.requestFunctionFactory(descriptors.userGetSession),
603
- /** Terminate a specific Session */
603
+ /** Terminate a specific Session. */
604
604
  terminateSession: this.requestFunctionFactory(descriptors.userTerminateSession),
605
605
  /** Get profile information for a user. */
606
606
  getUser: this.requestFunctionFactory(descriptors.userGetUser),
607
607
  /** Change personal information. */
608
608
  updatePersonalInformation: this.requestFunctionFactory(descriptors.userUpdatePersonalInformation),
609
- /** Initialize password reset process */
609
+ /** Initialize Multi Factor Authentication. If successful, it needs to be confirmed, before usage of mfa. */
610
+ initMfa: this.requestFunctionFactory(descriptors.userInitMfa),
611
+ /** Initialize password reset process. */
610
612
  initPasswordReset: this.requestFunctionFactory(descriptors.userInitPasswordReset),
611
613
  /** Submitted feedback of the given user. */
612
614
  listFeedback: this.requestFunctionFactory(descriptors.userListFeedback),
613
- /** List all active sessions */
615
+ /** List all sessions. */
614
616
  listSessions: this.requestFunctionFactory(descriptors.userListSessions),
615
- /** Terminate all sessions, except the current Session */
617
+ /** Terminate all sessions, except the current session. */
616
618
  terminateAllSessions: this.requestFunctionFactory(descriptors.userTerminateAllSessions),
617
- /** Terminate session and invalidate access token */
619
+ /** Terminate session and invalidate access token. */
618
620
  logout: this.requestFunctionFactory(descriptors.userLogout),
619
621
  /** Register with email and password. */
620
622
  register: this.requestFunctionFactory(descriptors.userRegister),
@@ -622,17 +624,15 @@ class MittwaldAPIV2Client extends api_client_commons_1.ApiClientBase {
622
624
  requestAvatarUpload: this.requestFunctionFactory(descriptors.userRequestAvatarUpload),
623
625
  /** Remove Avatar. */
624
626
  removeAvatar: this.requestFunctionFactory(descriptors.userRemoveAvatar),
625
- /** Resend the Email-Address verification email */
627
+ /** Resend the Email-Address verification email. */
626
628
  resendVerificationEmail: this.requestFunctionFactory(descriptors.userResendVerificationEmail),
627
- /** Reset RecoveryCodes for MFA */
628
- resetRecoverycodes: this.requestFunctionFactory(descriptors.userResetRecoverycodes),
629
- /** Request a support code */
629
+ /** Request a support code. */
630
630
  supportCodeRequest: this.requestFunctionFactory(descriptors.userSupportCodeRequest),
631
- /** Verify an added Email-Address */
631
+ /** Verify an added Email-Address. */
632
632
  verifyEmail: this.requestFunctionFactory(descriptors.userVerifyEmail),
633
633
  /** Verify phone number. */
634
634
  verifyPhoneNumber: this.requestFunctionFactory(descriptors.userVerifyPhoneNumber),
635
- /** Verify your registration */
635
+ /** Verify your registration. */
636
636
  verifyRegistration: this.requestFunctionFactory(descriptors.userVerifyRegistration),
637
637
  };
638
638
  }