@fusionauth/typescript-client 1.33.0 → 1.37.0

package/build/src/FusionAuthClient.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
-* Copyright (c) 2019, FusionAuth, All Rights Reserved
+* Copyright (c) 2019-2022, FusionAuth, All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -139,9 +139,9 @@ class FusionAuthClient {
     /**
      * 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.
+     * your password, you must obtain a Trust 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.
+     * An HTTP status code of 400 with a general error code of [TrustTokenRequired] 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>>}
@@ -156,9 +156,9 @@ class FusionAuthClient {
     /**
      * 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.
+     * your password, you must obtain a Trust 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.
+     * An HTTP status code of 400 with a general error code of [TrustTokenRequired] 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>>}
@@ -173,9 +173,9 @@ class FusionAuthClient {
     /**
      * 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.
+     * your password, you must obtain a Trust 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.
+     * An HTTP status code of 400 with a general error code of [TrustTokenRequired] 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>>}
@@ -1613,6 +1613,22 @@ class FusionAuthClient {
             .withMethod("PUT")
             .go();
     }
+    /**
+     * Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When using
+     * FusionAuth's SSO or your own, you should call this if the user is already logged in centrally, but accesses an
+     * application where they no longer have a session. This helps correctly track login counts, times and helps with
+     * reporting.
+     *
+     * @param {LoginPingRequest} request The login request that contains the user credentials used to log them in.
+     * @returns {Promise<ClientResponse<LoginResponse>>}
+     */
+    loginPingWithRequest(request) {
+        return this.start()
+            .withUri('/api/login')
+            .withJSONBody(request)
+            .withMethod("PUT")
+            .go();
+    }
     /**
      * The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the
      * client and revoke the refresh token stored. This API does nothing if the request does not contain an access
@@ -2220,7 +2236,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.
@@ -2234,7 +2250,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>>}
@@ -2248,7 +2264,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.
@@ -2276,7 +2292,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the applications.
+     * Retrieves all the applications.
      *
      * @returns {Promise<ClientResponse<ApplicationResponse>>}
      */
@@ -2313,7 +2329,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the connectors.
+     * Retrieves all the connectors.
      *
      * @returns {Promise<ClientResponse<ConnectorResponse>>}
      */
@@ -2337,7 +2353,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the consent.
+     * Retrieves all the consent.
      *
      * @returns {Promise<ClientResponse<ConsentResponse>>}
      */
@@ -2394,7 +2410,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the email templates.
+     * Retrieves all the email templates.
      *
      * @returns {Promise<ClientResponse<EmailTemplateResponse>>}
      */
@@ -2449,7 +2465,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the Entity Types.
+     * Retrieves all the Entity Types.
      *
      * @returns {Promise<ClientResponse<EntityTypeResponse>>}
      */
@@ -2473,7 +2489,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>>}
@@ -2486,7 +2502,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>>}
@@ -2525,7 +2541,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the forms fields
+     * Retrieves all the forms fields
      *
      * @returns {Promise<ClientResponse<FormFieldResponse>>}
      */
@@ -2536,7 +2552,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the forms.
+     * Retrieves all the forms.
      *
      * @returns {Promise<ClientResponse<FormResponse>>}
      */
@@ -2560,7 +2576,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the groups.
+     * Retrieves all the groups.
      *
      * @returns {Promise<ClientResponse<GroupResponse>>}
      */
@@ -2612,7 +2628,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the identity providers.
+     * Retrieves all the identity providers.
      *
      * @returns {Promise<ClientResponse<IdentityProviderResponse>>}
      */
@@ -2623,7 +2639,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.
@@ -2638,7 +2654,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>>}
      */
@@ -2650,7 +2666,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>>}
      */
@@ -2734,7 +2750,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the keys.
+     * Retrieves all the keys.
      *
      * @returns {Promise<ClientResponse<KeyResponse>>}
      */
@@ -2758,7 +2774,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the lambdas.
+     * Retrieves all the lambdas.
      *
      * @returns {Promise<ClientResponse<LambdaResponse>>}
      */
@@ -2769,7 +2785,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>>}
@@ -2826,7 +2842,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the message templates.
+     * Retrieves all the message templates.
      *
      * @returns {Promise<ClientResponse<MessageTemplateResponse>>}
      */
@@ -2850,7 +2866,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the messengers.
+     * Retrieves all the messengers.
      *
      * @returns {Promise<ClientResponse<MessengerResponse>>}
      */
@@ -2933,7 +2949,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>>}
@@ -2983,15 +2999,15 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token, if you have that, you already have what you need..
+     * Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token. If you have that, you already have what you need.
      *
-     * @param {UUID} userId The Id of the user.
+     * @param {UUID} tokenId The Id of the token.
      * @returns {Promise<ClientResponse<RefreshTokenResponse>>}
      */
-    retrieveRefreshTokenById(userId) {
+    retrieveRefreshTokenById(tokenId) {
         return this.start()
             .withUri('/api/jwt/refresh')
-            .withUriSegment(userId)
+            .withUriSegment(tokenId)
             .withMethod("GET")
             .go();
     }
@@ -3078,7 +3094,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the tenants.
+     * Retrieves all the tenants.
      *
      * @returns {Promise<ClientResponse<TenantResponse>>}
      */
@@ -3102,7 +3118,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the themes.
+     * Retrieves all the themes.
      *
      * @returns {Promise<ClientResponse<ThemeResponse>>}
      */
@@ -3137,6 +3153,26 @@ class FusionAuthClient {
             .withMethod("GET")
             .go();
     }
+    /**
+     * Retrieve a user's two-factor status.
+     *
+     * This can be used to see if a user will need to complete a two-factor challenge to complete a login,
+     * and optionally identify the state of the two-factor trust across various applications.
+     *
+     * @param {UUID} userId The user Id to retrieve the Two-Factor status.
+     * @param {UUID} applicationId The optional applicationId to verify.
+     * @param {string} twoFactorTrustId The optional two-factor trust Id to verify.
+     * @returns {Promise<ClientResponse<TwoFactorStatusResponse>>}
+     */
+    retrieveTwoFactorStatus(userId, applicationId, twoFactorTrustId) {
+        return this.start()
+            .withUri('/api/two-factor/status')
+            .withParameter('userId', userId)
+            .withParameter('applicationId', applicationId)
+            .withUriSegment(twoFactorTrustId)
+            .withMethod("GET")
+            .go();
+    }
     /**
      * Retrieves the user for the given Id.
      *
@@ -3190,7 +3226,7 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Retrieves all of the user actions.
+     * Retrieves all the user actions.
      *
      * @returns {Promise<ClientResponse<UserActionResponse>>}
      */
@@ -3268,7 +3304,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>>}
@@ -3294,7 +3330,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>>}
@@ -3668,6 +3704,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.
      *
@@ -4098,6 +4147,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.
      *
@@ -4437,6 +4499,21 @@ class FusionAuthClient {
             .withMethod("POST")
             .go();
     }
+    /**
+     * Administratively verify a user's email address. Use this method to bypass email verification for the user.
+     *
+     * The request body will contain the userId to be verified. An API key is required when sending the userId in the request body.
+     *
+     * @param {VerifyEmailRequest} request The request that contains the userId to verify.
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    verifyEmailAddressByUserId(request) {
+        return this.start()
+            .withUri('/api/user/verify-email')
+            .withJSONBody(request)
+            .withMethod("POST")
+            .go();
+    }
     /**
      * Confirms an application registration. The Id given is usually from an email sent to the user.
      *
@@ -4510,11 +4587,23 @@ var Algorithm;
     Algorithm["HS256"] = "HS256";
     Algorithm["HS384"] = "HS384";
     Algorithm["HS512"] = "HS512";
+    Algorithm["PS256"] = "PS256";
+    Algorithm["PS384"] = "PS384";
+    Algorithm["PS512"] = "PS512";
     Algorithm["RS256"] = "RS256";
     Algorithm["RS384"] = "RS384";
     Algorithm["RS512"] = "RS512";
     Algorithm["none"] = "none";
 })(Algorithm = exports.Algorithm || (exports.Algorithm = {}));
+/**
+ * @author Daniel DeGroff
+ */
+var ApplicationMultiFactorTrustPolicy;
+(function (ApplicationMultiFactorTrustPolicy) {
+    ApplicationMultiFactorTrustPolicy["Any"] = "Any";
+    ApplicationMultiFactorTrustPolicy["This"] = "This";
+    ApplicationMultiFactorTrustPolicy["None"] = "None";
+})(ApplicationMultiFactorTrustPolicy = exports.ApplicationMultiFactorTrustPolicy || (exports.ApplicationMultiFactorTrustPolicy = {}));
 /**
  * @author Brett Pontarelli
  */
@@ -4674,10 +4763,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";
@@ -4802,6 +4893,7 @@ var HTTPMethod;
 var IdentityProviderLinkingStrategy;
 (function (IdentityProviderLinkingStrategy) {
     IdentityProviderLinkingStrategy["CreatePendingLink"] = "CreatePendingLink";
+    IdentityProviderLinkingStrategy["Disabled"] = "Disabled";
     IdentityProviderLinkingStrategy["LinkAnonymously"] = "LinkAnonymously";
     IdentityProviderLinkingStrategy["LinkByEmail"] = "LinkByEmail";
     IdentityProviderLinkingStrategy["LinkByEmailForExistingUser"] = "LinkByEmailForExistingUser";
@@ -4876,6 +4968,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.
  *
@@ -4902,6 +5002,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) {
@@ -4938,6 +5042,14 @@ var MessengerType;
     MessengerType["Kafka"] = "Kafka";
     MessengerType["Twilio"] = "Twilio";
 })(MessengerType = exports.MessengerType || (exports.MessengerType = {}));
+/**
+ * @author Daniel DeGroff
+ */
+var MultiFactorLoginPolicy;
+(function (MultiFactorLoginPolicy) {
+    MultiFactorLoginPolicy["Disabled"] = "Disabled";
+    MultiFactorLoginPolicy["Enabled"] = "Enabled";
+})(MultiFactorLoginPolicy = exports.MultiFactorLoginPolicy || (exports.MultiFactorLoginPolicy = {}));
 var OAuthErrorReason;
 (function (OAuthErrorReason) {
     OAuthErrorReason["auth_code_not_found"] = "auth_code_not_found";