@fusionauth/typescript-client 1.32.1 → 1.36.0

package/build/src/FusionAuthClient.js

@@ -106,6 +106,9 @@ class FusionAuthClient {
      * Changes a user's password using the change password Id. This usually occurs after an email has been sent to the user
      * and they clicked on a link to reset their password.
      *
+     * As of version 1.32.2, prefer sending the changePasswordId in the request body. To do this, omit the first parameter, and set
+     * the value in the request body.
+     *
      * @param {string} changePasswordId The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.
      * @param {ChangePasswordRequest} request The change password request that contains all of the information used to change the password.
      * @returns {Promise<ClientResponse<ChangePasswordResponse>>}
@@ -133,6 +136,57 @@ class FusionAuthClient {
             .withMethod("POST")
             .go();
     }
+    /**
+     * Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
+     * When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
+     * your password, you must obtain a Truest Token by completing a Two-Factor Step-Up authentication.
+     *
+     * An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
+     *
+     * @param {string} changePasswordId The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    checkChangePasswordUsingId(changePasswordId) {
+        return this.startAnonymous()
+            .withUri('/api/user/change-password')
+            .withUriSegment(changePasswordId)
+            .withMethod("GET")
+            .go();
+    }
+    /**
+     * Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
+     * When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
+     * your password, you must obtain a Truest Token by completing a Two-Factor Step-Up authentication.
+     *
+     * An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
+     *
+     * @param {string} encodedJWT The encoded JWT (access token).
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    checkChangePasswordUsingJWT(encodedJWT) {
+        return this.startAnonymous()
+            .withUri('/api/user/change-password')
+            .withAuthorization('Bearer ' + encodedJWT)
+            .withMethod("GET")
+            .go();
+    }
+    /**
+     * Check to see if the user must obtain a Trust Request Id in order to complete a change password request.
+     * When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
+     * your password, you must obtain a Truest Request Id by completing a Two-Factor Step-Up authentication.
+     *
+     * An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
+     *
+     * @param {string} loginId The loginId of the User that you intend to change the password for.
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    checkChangePasswordUsingLoginId(loginId) {
+        return this.start()
+            .withUri('/api/user/change-password')
+            .withParameter('username', loginId)
+            .withMethod("GET")
+            .go();
+    }
     /**
      * Adds a comment to the user's account.
      *
@@ -2166,7 +2220,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the actions for the user with the given Id. This will return all time based actions that are active,
+     * Retrieves all the actions for the user with the given Id. This will return all time based actions that are active,
      * and inactive as well as non-time based actions.
      *
      * @param {UUID} userId The Id of the user to fetch the actions for.
@@ -2180,7 +2234,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the actions for the user with the given Id that are currently preventing the User from logging in.
+     * Retrieves all the actions for the user with the given Id that are currently preventing the User from logging in.
      *
      * @param {UUID} userId The Id of the user to fetch the actions for.
      * @returns {Promise<ClientResponse<ActionResponse>>}
@@ -2194,7 +2248,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the actions for the user with the given Id that are currently active.
+     * Retrieves all the actions for the user with the given Id that are currently active.
      * An active action means one that is time based and has not been canceled, and has not ended.
      *
      * @param {UUID} userId The Id of the user to fetch the actions for.
@@ -2222,7 +2276,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the applications.
+     * Retrieves all the applications.
      *
      * @returns {Promise<ClientResponse<ApplicationResponse>>}
      */
@@ -2259,7 +2313,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the connectors.
+     * Retrieves all the connectors.
      *
      * @returns {Promise<ClientResponse<ConnectorResponse>>}
      */
@@ -2283,7 +2337,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the consent.
+     * Retrieves all the consent.
      *
      * @returns {Promise<ClientResponse<ConsentResponse>>}
      */
@@ -2340,7 +2394,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the email templates.
+     * Retrieves all the email templates.
      *
      * @returns {Promise<ClientResponse<EmailTemplateResponse>>}
      */
@@ -2395,7 +2449,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the Entity Types.
+     * Retrieves all the Entity Types.
      *
      * @returns {Promise<ClientResponse<EntityTypeResponse>>}
      */
@@ -2419,7 +2473,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the families that a user belongs to.
+     * Retrieves all the families that a user belongs to.
      *
      * @param {UUID} userId The User's id
      * @returns {Promise<ClientResponse<FamilyResponse>>}
@@ -2432,7 +2486,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the members of a family by the unique Family Id.
+     * Retrieves all the members of a family by the unique Family Id.
      *
      * @param {UUID} familyId The unique Id of the Family.
      * @returns {Promise<ClientResponse<FamilyResponse>>}
@@ -2471,7 +2525,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the forms fields
+     * Retrieves all the forms fields
      *
      * @returns {Promise<ClientResponse<FormFieldResponse>>}
      */
@@ -2482,7 +2536,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the forms.
+     * Retrieves all the forms.
      *
      * @returns {Promise<ClientResponse<FormResponse>>}
      */
@@ -2506,7 +2560,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the groups.
+     * Retrieves all the groups.
      *
      * @returns {Promise<ClientResponse<GroupResponse>>}
      */
@@ -2558,7 +2612,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the identity providers.
+     * Retrieves all the identity providers.
      *
      * @returns {Promise<ClientResponse<IdentityProviderResponse>>}
      */
@@ -2569,7 +2623,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the actions for the user with the given Id that are currently inactive.
+     * Retrieves all the actions for the user with the given Id that are currently inactive.
      * An inactive action means one that is time based and has been canceled or has expired, or is not time based.
      *
      * @param {UUID} userId The Id of the user to fetch the actions for.
@@ -2584,7 +2638,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the applications that are currently inactive.
+     * Retrieves all the applications that are currently inactive.
      *
      * @returns {Promise<ClientResponse<ApplicationResponse>>}
      */
@@ -2596,7 +2650,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the user actions that are currently inactive.
+     * Retrieves all the user actions that are currently inactive.
      *
      * @returns {Promise<ClientResponse<UserActionResponse>>}
      */
@@ -2680,7 +2734,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the keys.
+     * Retrieves all the keys.
      *
      * @returns {Promise<ClientResponse<KeyResponse>>}
      */
@@ -2704,7 +2758,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the lambdas.
+     * Retrieves all the lambdas.
      *
      * @returns {Promise<ClientResponse<LambdaResponse>>}
      */
@@ -2715,7 +2769,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the lambdas for the provided type.
+     * Retrieves all the lambdas for the provided type.
      *
      * @param {LambdaType} type The type of the lambda to return.
      * @returns {Promise<ClientResponse<LambdaResponse>>}
@@ -2772,7 +2826,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the message templates.
+     * Retrieves all the message templates.
      *
      * @returns {Promise<ClientResponse<MessageTemplateResponse>>}
      */
@@ -2796,7 +2850,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the messengers.
+     * Retrieves all the messengers.
      *
      * @returns {Promise<ClientResponse<MessengerResponse>>}
      */
@@ -2879,7 +2933,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the children for the given parent email address.
+     * Retrieves all the children for the given parent email address.
      *
      * @param {string} parentEmail The email of the parent.
      * @returns {Promise<ClientResponse<PendingResponse>>}
@@ -3024,7 +3078,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the tenants.
+     * Retrieves all the tenants.
      *
      * @returns {Promise<ClientResponse<TenantResponse>>}
      */
@@ -3048,7 +3102,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the themes.
+     * Retrieves all the themes.
      *
      * @returns {Promise<ClientResponse<ThemeResponse>>}
      */
@@ -3136,7 +3190,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the user actions.
+     * Retrieves all the user actions.
      *
      * @returns {Promise<ClientResponse<UserActionResponse>>}
      */
@@ -3214,7 +3268,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the comments for the user with the given Id.
+     * Retrieves all the comments for the user with the given Id.
      *
      * @param {UUID} userId The Id of the user.
      * @returns {Promise<ClientResponse<UserCommentResponse>>}
@@ -3240,7 +3294,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the consents for a User.
+     * Retrieves all the consents for a User.
      *
      * @param {UUID} userId The User's Id
      * @returns {Promise<ClientResponse<UserConsentResponse>>}
@@ -3614,6 +3668,19 @@ class FusionAuthClient {
             .withMethod("POST")
             .go();
     }
+    /**
+     * Searches group members with the specified criteria and pagination.
+     *
+     * @param {GroupMemberSearchRequest} request The search criteria and pagination information.
+     * @returns {Promise<ClientResponse<GroupMemberSearchResponse>>}
+     */
+    searchGroupMembers(request) {
+        return this.start()
+            .withUri('/api/group/member/search')
+            .withJSONBody(request)
+            .withMethod("POST")
+            .go();
+    }
     /**
      * Searches the IP Access Control Lists with the specified criteria and pagination.
      *
@@ -4044,6 +4111,19 @@ class FusionAuthClient {
             .withMethod("PUT")
             .go();
     }
+    /**
+     * Creates a member in a group.
+     *
+     * @param {MemberRequest} request The request object that contains all the information used to create the group member(s).
+     * @returns {Promise<ClientResponse<MemberResponse>>}
+     */
+    updateGroupMembers(request) {
+        return this.start()
+            .withUri('/api/group/member')
+            .withJSONBody(request)
+            .withMethod("PUT")
+            .go();
+    }
     /**
      * Updates the IP Access Control List with the given Id.
      *
@@ -4620,10 +4700,12 @@ var EventType;
     EventType["UserDeactivate"] = "user.deactivate";
     EventType["UserDelete"] = "user.delete";
     EventType["UserDeleteComplete"] = "user.delete.complete";
-    EventType["UserLoginIdDuplicateOnCreate"] = "user.loginId.duplicate.create";
-    EventType["UserLoginIdDuplicateOnUpdate"] = "user.loginId.duplicate.update";
     EventType["UserEmailUpdate"] = "user.email.update";
     EventType["UserEmailVerified"] = "user.email.verified";
+    EventType["UserIdentityProviderLink"] = "user.identity-provider.link";
+    EventType["UserIdentityProviderUnlink"] = "user.identity-provider.unlink";
+    EventType["UserLoginIdDuplicateOnCreate"] = "user.loginId.duplicate.create";
+    EventType["UserLoginIdDuplicateOnUpdate"] = "user.loginId.duplicate.update";
     EventType["UserLoginFailed"] = "user.login.failed";
     EventType["UserLoginNewDevice"] = "user.login.new-device";
     EventType["UserLoginSuccess"] = "user.login.success";
@@ -4822,6 +4904,14 @@ var KeyUse;
     KeyUse["SignAndVerify"] = "SignAndVerify";
     KeyUse["VerifyOnly"] = "VerifyOnly";
 })(KeyUse = exports.KeyUse || (exports.KeyUse = {}));
+/**
+ * @author Daniel DeGroff
+ */
+var LambdaEngineType;
+(function (LambdaEngineType) {
+    LambdaEngineType["GraalJS"] = "GraalJS";
+    LambdaEngineType["Nashorn"] = "Nashorn";
+})(LambdaEngineType = exports.LambdaEngineType || (exports.LambdaEngineType = {}));
 /**
  * The types of lambdas that indicate how they are invoked by FusionAuth.
  *
@@ -4848,6 +4938,10 @@ var LambdaType;
     LambdaType["TwitchReconcile"] = "TwitchReconcile";
     LambdaType["XboxReconcile"] = "XboxReconcile";
     LambdaType["ClientCredentialsJWTPopulate"] = "ClientCredentialsJWTPopulate";
+    LambdaType["SCIMServerGroupRequestConverter"] = "SCIMServerGroupRequestConverter";
+    LambdaType["SCIMServerGroupResponseConverter"] = "SCIMServerGroupResponseConverter";
+    LambdaType["SCIMServerUserRequestConverter"] = "SCIMServerUserRequestConverter";
+    LambdaType["SCIMServerUserResponseConverter"] = "SCIMServerUserResponseConverter";
 })(LambdaType = exports.LambdaType || (exports.LambdaType = {}));
 var LDAPSecurityMethod;
 (function (LDAPSecurityMethod) {