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