Improve Guardian section

Author: nikolaseu

src/main/java/com/auth0/client/mgmt/GuardianEntity.java

@@ -23,10 +23,10 @@ public class GuardianEntity extends BaseManagementEntity {
 
     /**
      * Create a new Guardian Enrollment Ticket. A token with scope create:guardian_enrollment_tickets is needed.
-     * See https://auth0.com/docs/api/management/v2#!/Guardian/post_ticket
      *
      * @param enrollmentTicket the enrollment ticket data to set.
      * @return a Request to execute.
+     * @see <a href="https://auth0.com/docs/api/management/v2#!/Guardian/post_ticket">Management API2 docs</a>
      */
     public Request<EnrollmentTicket> createEnrollmentTicket(EnrollmentTicket enrollmentTicket) {
         Asserts.assertNotNull(enrollmentTicket, "enrollment ticket");
@@ -46,10 +46,10 @@ public Request<EnrollmentTicket> createEnrollmentTicket(EnrollmentTicket enrollm
 
     /**
      * Delete an existing Guardian Enrollment. A token with scope delete:guardian_enrollments is needed.
-     * See https://auth0.com/docs/api/management/v2#!/Guardian/delete_enrollments_by_id
      *
      * @param enrollmentId the id of the enrollment to retrieve.
      * @return a Request to execute.
+     * @see <a href="https://auth0.com/docs/api/management/v2#!/Guardian/delete_enrollments_by_id">Management API2 docs</a>
      */
     public Request deleteEnrollment(String enrollmentId) {
         Asserts.assertNotNull(enrollmentId, "enrollment id");
@@ -66,10 +66,11 @@ public Request deleteEnrollment(String enrollmentId) {
     }
 
     /**
-     * Request the Guardian enrollment and verification Templates. A token with scope read:guardian_factors is needed.
-     * See https://auth0.com/docs/api/management/v2#!/Guardian/get_templates
+     * Request the Guardian SMS enrollment and verification templates.
+     * A token with scope read:guardian_factors is needed.
      *
      * @return a Request to execute.
+     * @see <a href="https://auth0.com/docs/api/management/v2#!/Guardian/get_templates">Management API2 docs</a>
      */
     public Request<GuardianTemplates> getTemplates() {
         String url = baseUrl
@@ -84,11 +85,12 @@ public Request<GuardianTemplates> getTemplates() {
     }
 
     /**
-     * Updates the existing Guardian enrollment and verification Templates. A token with scope update:guardian_factors is needed.
-     * See https://auth0.com/docs/api/management/v2#!/Guardian/put_templates
+     * Updates the existing Guardian SMS enrollment and verification templates.
+     * A token with scope update:guardian_factors is needed.
      *
      * @param guardianTemplates the templates data to set.
      * @return a Request to execute.
+     * @see <a href="https://auth0.com/docs/api/management/v2#!/Guardian/put_templates">Management API2 docs</a>
      */
     public Request<GuardianTemplates> updateTemplates(GuardianTemplates guardianTemplates) {
         Asserts.assertNotNull(guardianTemplates, "guardian templates");
@@ -107,9 +109,9 @@ public Request<GuardianTemplates> updateTemplates(GuardianTemplates guardianTemp
 
     /**
      * Request all the Guardian Factors. A token with scope read:guardian_factors is needed.
-     * See https://auth0.com/docs/api/management/v2#!/Guardian/get_factors
      *
      * @return a Request to execute.
+     * @see <a href="https://auth0.com/docs/api/management/v2#!/Guardian/get_factors">Management API2 docs</a>
      */
     public Request<List<Factor>> listFactors() {
         String url = baseUrl
@@ -125,11 +127,11 @@ public Request<List<Factor>> listFactors() {
 
     /**
      * Update an existing Guardian Factor. A token with scope update:guardian_factors is needed.
-     * See https://auth0.com/docs/api/management/v2#!/Guardian/put_factors_by_name
      *
      * @param name    the name of the Factor to update.
      * @param enabled whether to enable or disable the Factor.
      * @return a Request to execute.
+     * @see <a href="https://auth0.com/docs/api/management/v2#!/Guardian/put_factors_by_name">Management API2 docs</a>
      */
     public Request<Factor> updateFactor(String name, Boolean enabled) {
         Asserts.assertNotNull(name, "name");
@@ -149,10 +151,10 @@ public Request<Factor> updateFactor(String name, Boolean enabled) {
     }
 
     /**
-     * Request the Guardian's Twilio Factor Provider. A token with scope read:guardian_factors is needed.
-     * See https://auth0.com/docs/api/management/v2#!/Guardian/get_twilio
+     * Request Guardian's Twilio SMS Factor Provider settings. A token with scope read:guardian_factors is needed.
      *
      * @return a Request to execute.
+     * @see <a href="https://auth0.com/docs/api/management/v2#!/Guardian/get_twilio">Management API2 docs</a>
      */
     public Request<TwilioFactorProvider> getTwilioFactorProvider() {
 
@@ -168,11 +170,11 @@ public Request<TwilioFactorProvider> getTwilioFactorProvider() {
     }
 
     /**
-     * Update the existing Guardian's Twilio Factor Provider. A token with scope update:guardian_factors is needed.
-     * See https://auth0.com/docs/api/management/v2#!/Guardian/put_twilio
+     * Update Guardian's Twilio SMS Factor Provider. A token with scope update:guardian_factors is needed.
      *
      * @param provider the provider data to set.
      * @return a Request to execute.
+     * @see <a href="https://auth0.com/docs/api/management/v2#!/Guardian/put_twilio">Management API2 docs</a>
      */
     public Request<TwilioFactorProvider> updateTwilioFactorProvider(TwilioFactorProvider provider) {
         Asserts.assertNotNull(provider, "provider");
@@ -190,10 +192,21 @@ public Request<TwilioFactorProvider> updateTwilioFactorProvider(TwilioFactorProv
     }
 
     /**
-     * Request the Guardian's Sns Factor Provider. A token with scope read:guardian_factors is needed.
-     * See https://auth0.com/docs/api/management/v2#!/Guardian/get_sns
+     * Reset Guardian's Twilio SMS Factor Provider to the defaults.
+     * A token with scope update:guardian_factors is needed.
      *
      * @return a Request to execute.
+     * @see <a href="https://auth0.com/docs/api/management/v2#!/Guardian/put_twilio">Management API2 docs</a>
+     */
+    public Request<TwilioFactorProvider> resetTwilioFactorProvider() {
+        return updateTwilioFactorProvider(new TwilioFactorProvider(null, null, null, null));
+    }
+
+    /**
+     * Request Guardian's SNS push-notification Factor Provider. A token with scope read:guardian_factors is needed.
+     *
+     * @return a Request to execute.
+     * @see <a href="https://auth0.com/docs/api/management/v2#!/Guardian/get_sns">Management API2 docs</a>
      */
     public Request<SNSFactorProvider> getSNSFactorProvider() {
 
@@ -209,11 +222,11 @@ public Request<SNSFactorProvider> getSNSFactorProvider() {
     }
 
     /**
-     * Update the existing Guardian's Sns Factor Provider. A token with scope update:guardian_factors is needed.
-     * See https://auth0.com/docs/api/management/v2#!/Guardian/put_sns
+     * Update Guardian's SNS push-notification Factor Provider. A token with scope update:guardian_factors is needed.
      *
      * @param provider the provider data to set.
      * @return a Request to execute.
+     * @see <a href="https://auth0.com/docs/api/management/v2#!/Guardian/put_sns">Management API2 docs</a>
      */
     public Request<SNSFactorProvider> updateSNSFactorProvider(SNSFactorProvider provider) {
         Asserts.assertNotNull(provider, "provider");
@@ -229,4 +242,15 @@ public Request<SNSFactorProvider> updateSNSFactorProvider(SNSFactorProvider prov
         request.setBody(provider);
         return request;
     }
+
+    /**
+     * Reset Guardian's SNS push-notification Factor Provider to the defaults.
+     * A token with scope update:guardian_factors is needed.
+     *
+     * @return a Request to execute.
+     * @see <a href="https://auth0.com/docs/api/management/v2#!/Guardian/put_sns">Management API2 docs</a>
+     */
+    public Request<SNSFactorProvider> resetSNSFactorProvider() {
+        return updateSNSFactorProvider(new SNSFactorProvider(null, null, null, null, null));
+    }
 }

src/main/java/com/auth0/client/mgmt/UsersEntity.java

@@ -228,11 +228,11 @@ public Request deleteMultifactorProvider(String userId, String provider) {
     }
 
     /**
-     * Rotates a User's Recovery Code. A token with scope update:users is needed.
-     * See https://auth0.com/docs/api/management/v2#!/Users/post_recovery_code_regeneration
+     * Rotates a User's Guardian recovery code. A token with scope update:users is needed.
      *
      * @param userId the user id
      * @return a Request to execute.
+     * @see <a href="https://auth0.com/docs/api/management/v2#!/Users/post_recovery_code_regeneration">Management API2 docs</a>
      */
     public Request<RecoveryCode> rotateRecoveryCode(String userId) {
         Asserts.assertNotNull(userId, "user id");

src/main/java/com/auth0/json/mgmt/guardian/Enrollment.java

@@ -67,7 +67,7 @@ public String getType() {
     }
 
     /**
-     * Getter for the enrollment name. This is usually the phone number.
+     * Getter for the enrollment name. This is usually the phone name. Only for 'guardian' enrollments.
      *
      * @return the name.
      */
@@ -77,7 +77,7 @@ public String getName() {
     }
 
     /**
-     * Getter for the device identifier. This is usually the phone identifier.
+     * Getter for the device identifier. This is usually a unique phone identifier. Only for 'guardian' enrollments.
      *
      * @return the identifier.
      */
@@ -87,7 +87,7 @@ public String getIdentifier() {
     }
 
     /**
-     * Getter for the phone number.
+     * Getter for the phone number. Only for 'sms' enrollments.
      *
      * @return the phone number.
      */

src/main/java/com/auth0/json/mgmt/guardian/EnrollmentTicket.java

@@ -25,12 +25,37 @@ public class EnrollmentTicket {
     private String ticketUrl;
 
     /**
-     * Creates a new instance of the Enrollment Ticket for a given User. You can then specify the email and sendMail
+     * Creates a new instance of the Enrollment Ticket for a given User.
      *
      * @param userId the user id
      */
     public EnrollmentTicket(String userId) {
+        this(userId, null, null);
+    }
+
+    /**
+     * Creates a new instance of the Enrollment Ticket for a given User, specifying if you want the ticket to also be
+     * sent to the user by email.
+     *
+     * @param userId the user id
+     * @param sendEmail whether the ticket should also be sent to the user by email
+     */
+    public EnrollmentTicket(String userId, Boolean sendEmail) {
+        this(userId, sendEmail, null);
+    }
+
+    /**
+     * Creates a new instance of the Enrollment Ticket for a given User, specifying if you want the ticket to also be
+     * sent to the specified email address.
+     *
+     * @param userId the user id
+     * @param sendEmail whether the ticket should also be sent to the user by email
+     * @param email the email where the ticket will be sent.
+     */
+    public EnrollmentTicket(String userId, Boolean sendEmail, String email) {
         this.userId = userId;
+        this.sendEmail = sendEmail;
+        this.email = email;
     }
 
     @JsonCreator
@@ -43,6 +68,7 @@ public EnrollmentTicket(String userId) {
      * Getter for the id of the User this ticket was made for.
      *
      * @return the user id.
+     * @deprecated
      */
     @JsonProperty("user_id")
     public String getUserId() {
@@ -53,6 +79,7 @@ public String getUserId() {
      * Setter for the id of the user this ticket is meant to.
      *
      * @param userId the user id to set.
+     * @deprecated use the constructor instead
      */
     @JsonProperty("user_id")
     public void setUserId(String userId) {
@@ -63,6 +90,7 @@ public void setUserId(String userId) {
      * Whether to send and email for enrollment or not.
      *
      * @return true is this ticket will send an email upon enrollment, false otherwise.
+     * @deprecated
      */
     @JsonProperty("send_mail")
     public Boolean willSendEmail() {
@@ -73,6 +101,7 @@ public Boolean willSendEmail() {
      * Sets whether to send and email for enrollment or not.
      *
      * @param sendEmail whether this ticket will send an email upon enrollment or not.
+     * @deprecated use the constructor instead
      */
     @JsonProperty("send_mail")
     public void setSendEmail(Boolean sendEmail) {
@@ -83,6 +112,7 @@ public void setSendEmail(Boolean sendEmail) {
      * Getter for the email to which the ticket will be sent.
      *
      * @return the email.
+     * @deprecated
      */
     @JsonProperty("email")
     public String getEmail() {
@@ -93,6 +123,7 @@ public String getEmail() {
      * Setter for the email to which the ticket will be sent.
      *
      * @param email the email to sent the ticket to.
+     * @deprecated use the constructor instead
      */
     @JsonProperty("email")
     public void setEmail(String email) {

src/main/java/com/auth0/json/mgmt/guardian/Factor.java

@@ -56,7 +56,7 @@ public Boolean isTrialExpired() {
     }
 
     /**
-     * Getter fot the name of this factor.
+     * Getter for the name of this factor.
      *
      * @return the factor name.
      */

src/main/java/com/auth0/json/mgmt/guardian/GuardianTemplates.java

@@ -6,7 +6,7 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 /**
- * Class that represents an Auth0 Guardian Templates object. Related to the {@link com.auth0.client.mgmt.GuardianEntity} entity.
+ * Class that represents an Auth0 Guardian SMS Templates object. Related to the {@link com.auth0.client.mgmt.GuardianEntity} entity.
  */
 @SuppressWarnings({"unused", "WeakerAccess"})
 @JsonIgnoreProperties(ignoreUnknown = true)
@@ -25,7 +25,7 @@ public GuardianTemplates(@JsonProperty("enrollment_message") String enrollmentMe
     }
 
     /**
-     * Getter for the message to send when the user is invited to enroll with a phone number.
+     * Getter for the message to send when the user enrolls with SMS.
      *
      * @return the message to send upon enrollment.
      */
@@ -35,7 +35,7 @@ public String getEnrollmentMessage() {
     }
 
     /**
-     * Setter for the message to send when the user is invited to enroll with a phone number.
+     * Setter for the message to send when the user enrolls with SMS.
      *
      * @param enrollmentMessage the message to send upon enrollment.
      */
@@ -45,7 +45,7 @@ public void setEnrollmentMessage(String enrollmentMessage) {
     }
 
     /**
-     * Getter for the message to send when the user is prompted to verify their account.
+     * Getter for the message to send when the user is prompted to verify their account via SMS.
      *
      * @return the message to send upon verification.
      */
@@ -55,7 +55,7 @@ public String getVerificationMessage() {
     }
 
     /**
-     * Setter for the message to send when the user is prompted to verify their account.
+     * Setter for the message to send when the user is prompted to verify their account via SMS.
      *
      * @param verificationMessage the message to send upon verification.
      */