@fusionauth/typescript-client 1.58.2 → 1.60.0

package/build/src/FusionAuthClient.js

@@ -15,7 +15,7 @@
 * language governing permissions and limitations under the License.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebhookEventResult = exports.WebhookAttemptResult = exports.WebAuthnWorkflow = exports.VerificationStrategy = exports.UserVerificationRequirement = exports.UserState = exports.UserActionPhase = exports.UnverifiedBehavior = exports.UnknownScopePolicy = exports.TransactionType = exports.TokenType = exports.ThemeType = exports.UniqueUsernameStrategy = exports.SystemTrustedProxyConfigurationPolicy = exports.SteamAPIMode = exports.Sort = exports.SecureGeneratorType = exports.SAMLv2DestinationAssertionPolicy = exports.ResidentKeyRequirement = exports.RefreshTokenUsagePolicy = exports.RefreshTokenExpirationPolicy = exports.ReactorFeatureStatus = exports.RateLimitedRequestType = exports.PublicKeyCredentialType = exports.ProofKeyForCodeExchangePolicy = exports.BreachMatchMode = exports.BreachAction = exports.ObjectState = exports.Oauth2AuthorizedURLValidationPolicy = exports.OAuthScopeHandlingPolicy = exports.OAuthScopeConsentMode = exports.OAuthErrorType = exports.OAuthErrorReason = exports.OAuthApplicationRelationship = exports.MultiFactorLoginPolicy = exports.MessengerType = exports.MessageType = exports.LogoutBehavior = exports.LambdaType = exports.LambdaEngineType = exports.LDAPSecurityMethod = exports.KeyUse = exports.KeyType = exports.KeyAlgorithm = exports.IdentityProviderType = exports.ClientAuthenticationMethod = exports.IdentityProviderLoginMethod = exports.IdentityProviderLinkingStrategy = exports.IPAccessControlEntryAction = exports.HTTPMethod = exports.GrantType = exports.FormType = exports.FormFieldAdminPolicy = exports.FormDataType = exports.FormControl = exports.FamilyRole = exports.ExpiryUnit = exports.EventType = exports.EventLogType = exports.EmailSecurityType = exports.DeviceType = exports.CoseKeyType = exports.CoseEllipticCurve = exports.CoseAlgorithmIdentifier = exports.ContentStatus = exports.ConsentStatus = exports.ConnectorType = exports.ClientAuthenticationPolicy = exports.ChangePasswordReason = exports.CaptchaMethod = exports.CanonicalizationMethod = exports.BreachedPasswordStatus = exports.TOTPAlgorithm = exports.AuthenticatorAttachmentPreference = exports.AuthenticatorAttachment = exports.AuthenticationThreats = exports.AttestationType = exports.AttestationConveyancePreference = exports.ApplicationMultiFactorTrustPolicy = exports.XMLSignatureLocation = exports.SAMLLogoutBehavior = exports.RegistrationType = exports.LoginIdType = exports.Algorithm = exports.FusionAuthClient = void 0;
+exports.WebhookEventResult = exports.WebhookAttemptResult = exports.WebAuthnWorkflow = exports.VerificationStrategy = exports.UserVerificationRequirement = exports.UserState = exports.UserActionPhase = exports.UnverifiedBehavior = exports.UnknownScopePolicy = exports.TransactionType = exports.TokenType = exports.ThemeType = exports.UniqueUsernameStrategy = exports.SystemTrustedProxyConfigurationPolicy = exports.SteamAPIMode = exports.Sort = exports.SendSetPasswordIdentityType = exports.SecureGeneratorType = exports.SAMLv2DestinationAssertionPolicy = exports.ResidentKeyRequirement = exports.RefreshTokenUsagePolicy = exports.RefreshTokenExpirationPolicy = exports.ReactorFeatureStatus = exports.PublicKeyCredentialType = exports.ProofKeyForCodeExchangePolicy = exports.PasswordlessStrategy = exports.BreachMatchMode = exports.BreachAction = exports.ObjectState = exports.Oauth2AuthorizedURLValidationPolicy = exports.OAuthScopeHandlingPolicy = exports.OAuthScopeConsentMode = exports.OAuthErrorType = exports.OAuthErrorReason = exports.OAuthApplicationRelationship = exports.MultiFactorLoginPolicy = exports.MessengerType = exports.MessageType = exports.LogoutBehavior = exports.LambdaType = exports.LambdaEngineType = exports.LDAPSecurityMethod = exports.KeyUse = exports.KeyType = exports.KeyAlgorithm = exports.IdentityVerifiedReason = exports.IdentityProviderType = exports.ClientAuthenticationMethod = exports.IdentityProviderLoginMethod = exports.IdentityProviderLinkingStrategy = exports.IPAccessControlEntryAction = exports.HTTPMethod = exports.GrantType = exports.FormType = exports.FormFieldAdminPolicy = exports.FormDataType = exports.FormControl = exports.FamilyRole = exports.ExpiryUnit = exports.EventType = exports.EventLogType = exports.EmailSecurityType = exports.DeviceType = exports.CoseKeyType = exports.CoseEllipticCurve = exports.CoseAlgorithmIdentifier = exports.ContentStatus = exports.ConsentStatus = exports.ConnectorType = exports.ClientAuthenticationPolicy = exports.ChangePasswordReason = exports.CaptchaMethod = exports.CanonicalizationMethod = exports.BreachedPasswordStatus = exports.TOTPAlgorithm = exports.AuthenticatorAttachmentPreference = exports.AuthenticatorAttachment = exports.AuthenticationThreats = exports.AttestationType = exports.AttestationConveyancePreference = exports.ApplicationMultiFactorTrustPolicy = exports.XMLSignatureLocation = exports.SAMLLogoutBehavior = exports.RegistrationType = exports.LoginIdType = exports.Algorithm = exports.FusionAuthClient = void 0;
 const DefaultRESTClientBuilder_1 = require("./DefaultRESTClientBuilder");
 const url_1 = require("url");
 class FusionAuthClient {
@@ -282,6 +282,19 @@ class FusionAuthClient {
             .withMethod("POST")
             .go();
     }
+    /**
+     * Completes verification of an identity using verification codes from the Verify Start API.
+     *
+     * @param {VerifyCompleteRequest} request The identity verify complete request that contains all the information used to verify the identity.
+     * @returns {Promise<ClientResponse<VerifyCompleteResponse>>}
+     */
+    completeVerifyIdentity(request) {
+        return this.start()
+            .withUri('/api/identity/verify/complete')
+            .withJSONBody(request)
+            .withMethod("POST")
+            .go();
+    }
     /**
      * Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge without logging the user in
      *
@@ -3653,6 +3666,21 @@ class FusionAuthClient {
             .withMethod("GET")
             .go();
     }
+    /**
+     * Retrieves the user for the loginId, using specific loginIdTypes.
+     *
+     * @param {string} loginId The email or username of the user.
+     * @param {Array<String>} loginIdTypes the identity types that FusionAuth will compare the loginId to.
+     * @returns {Promise<ClientResponse<UserResponse>>}
+     */
+    retrieveUserByLoginIdWithLoginIdTypes(loginId, loginIdTypes) {
+        return this.start()
+            .withUri('/api/user')
+            .withParameter('loginId', loginId)
+            .withParameter('loginIdTypes', loginIdTypes)
+            .withMethod("GET")
+            .go();
+    }
     /**
      * Retrieves the user for the given username.
      *
@@ -3844,6 +3872,28 @@ class FusionAuthClient {
             .withMethod("GET")
             .go();
     }
+    /**
+     * Retrieves the login report between the two instants for a particular user by login Id, using specific loginIdTypes. If you specify an application id, it will only return the
+     * login counts for that application.
+     *
+     * @param {UUID} applicationId (Optional) The application id.
+     * @param {string} loginId The userId id.
+     * @param {number} start The start instant as UTC milliseconds since Epoch.
+     * @param {number} end The end instant as UTC milliseconds since Epoch.
+     * @param {Array<String>} loginIdTypes the identity types that FusionAuth will compare the loginId to.
+     * @returns {Promise<ClientResponse<LoginReportResponse>>}
+     */
+    retrieveUserLoginReportByLoginIdAndLoginIdTypes(applicationId, loginId, start, end, loginIdTypes) {
+        return this.start()
+            .withUri('/api/report/login')
+            .withParameter('applicationId', applicationId)
+            .withParameter('loginId', loginId)
+            .withParameter('start', start)
+            .withParameter('end', end)
+            .withParameter('loginIdTypes', loginIdTypes)
+            .withMethod("GET")
+            .go();
+    }
     /**
      * Retrieves the last number of login records for a user.
      *
@@ -4527,6 +4577,19 @@ class FusionAuthClient {
             .withMethod("POST")
             .go();
     }
+    /**
+     * Send a verification code using the appropriate transport for the identity type being verified.
+     *
+     * @param {VerifySendRequest} request The identity verify send request that contains all the information used send the code.
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    sendVerifyIdentity(request) {
+        return this.start()
+            .withUri('/api/identity/verify/send')
+            .withJSONBody(request)
+            .withMethod("POST")
+            .go();
+    }
     /**
      * Begins a login request for a 3rd party login that requires user interaction such as HYPR.
      *
@@ -4573,6 +4636,20 @@ class FusionAuthClient {
             .withMethod("POST")
             .go();
     }
+    /**
+     * Start a verification of an identity by generating a code. This code can be sent to the User using the Verify Send API
+     * Verification Code API or using a mechanism outside of FusionAuth. The verification is completed by using the Verify Complete API with this code.
+     *
+     * @param {VerifyStartRequest} request The identity verify start request that contains all the information used to begin the request.
+     * @returns {Promise<ClientResponse<VerifyStartResponse>>}
+     */
+    startVerifyIdentity(request) {
+        return this.start()
+            .withUri('/api/identity/verify/start')
+            .withJSONBody(request)
+            .withMethod("POST")
+            .go();
+    }
     /**
      * Start a WebAuthn authentication ceremony by generating a new challenge for the user
      *
@@ -5198,6 +5275,19 @@ class FusionAuthClient {
             .withMethod("POST")
             .go();
     }
+    /**
+     * Administratively verify a user identity.
+     *
+     * @param {VerifyRequest} request The identity verify request that contains information to verify the identity.
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    verifyIdentity(request) {
+        return this.start()
+            .withUri('/api/identity/verify')
+            .withJSONBody(request)
+            .withMethod("POST")
+            .go();
+    }
     /**
      * Confirms an application registration. The Id given is usually from an email sent to the user.
      *
@@ -5279,9 +5369,11 @@ var Algorithm;
     Algorithm["RS512"] = "RS512";
     Algorithm["none"] = "none";
 })(Algorithm = exports.Algorithm || (exports.Algorithm = {}));
+//      This is separate from IdentityType.
 var LoginIdType;
 (function (LoginIdType) {
     LoginIdType["email"] = "email";
+    LoginIdType["phoneNumber"] = "phoneNumber";
     LoginIdType["username"] = "username";
 })(LoginIdType = exports.LoginIdType || (exports.LoginIdType = {}));
 var RegistrationType;
@@ -5588,6 +5680,8 @@ var EventType;
     EventType["UserUpdate"] = "user.update";
     EventType["UserUpdateComplete"] = "user.update.complete";
     EventType["Test"] = "test";
+    EventType["UserIdentityVerified"] = "user.identity.verified";
+    EventType["UserIdentityUpdate"] = "user.identity.update";
 })(EventType = exports.EventType || (exports.EventType = {}));
 /**
  * @author Brian Pontarelli
@@ -5630,6 +5724,7 @@ var FormDataType;
     FormDataType["date"] = "date";
     FormDataType["email"] = "email";
     FormDataType["number"] = "number";
+    FormDataType["phoneNumber"] = "phoneNumber";
     FormDataType["string"] = "string";
 })(FormDataType = exports.FormDataType || (exports.FormDataType = {}));
 /**
@@ -5651,7 +5746,7 @@ var FormType;
     FormType["selfServiceUser"] = "selfServiceUser";
 })(FormType = exports.FormType || (exports.FormType = {}));
 /**
- * Authorization Grant types as defined by the <a href="https://tools.ietf.org/html/rfc6749">The OAuth 2.0 Authorization
+ * Authorization Grant types as defined by the <a href="https://tools.ietf.org/html/rfc6749">OAuth 2.0 Authorization
  * Framework - RFC 6749</a>.
  * <p>
  * Specific names as defined by <a href="https://tools.ietf.org/html/rfc7591#section-4.1">
@@ -5743,6 +5838,23 @@ var IdentityProviderType;
     IdentityProviderType["Twitter"] = "Twitter";
     IdentityProviderType["Xbox"] = "Xbox";
 })(IdentityProviderType = exports.IdentityProviderType || (exports.IdentityProviderType = {}));
+/**
+ * Models the reason that {@link UserIdentity#verified} was set to true or false.
+ *
+ * @author Brady Wied
+ */
+var IdentityVerifiedReason;
+(function (IdentityVerifiedReason) {
+    IdentityVerifiedReason["Skipped"] = "Skipped";
+    IdentityVerifiedReason["Trusted"] = "Trusted";
+    IdentityVerifiedReason["Unverifiable"] = "Unverifiable";
+    IdentityVerifiedReason["Implicit"] = "Implicit";
+    IdentityVerifiedReason["Pending"] = "Pending";
+    IdentityVerifiedReason["Completed"] = "Completed";
+    IdentityVerifiedReason["Disabled"] = "Disabled";
+    IdentityVerifiedReason["Administrative"] = "Administrative";
+    IdentityVerifiedReason["Import"] = "Import";
+})(IdentityVerifiedReason = exports.IdentityVerifiedReason || (exports.IdentityVerifiedReason = {}));
 var KeyAlgorithm;
 (function (KeyAlgorithm) {
     KeyAlgorithm["ES256"] = "ES256";
@@ -5875,7 +5987,11 @@ var OAuthErrorReason;
     OAuthErrorReason["access_token_required"] = "access_token_required";
     OAuthErrorReason["refresh_token_not_found"] = "refresh_token_not_found";
     OAuthErrorReason["refresh_token_type_not_supported"] = "refresh_token_type_not_supported";
+    OAuthErrorReason["id_token_invalid"] = "id_token_invalid";
+    OAuthErrorReason["unsupported_token_type"] = "unsupported_token_type";
+    OAuthErrorReason["token_type_hint_mismatch"] = "token_type_hint_mismatch";
     OAuthErrorReason["invalid_client_id"] = "invalid_client_id";
+    OAuthErrorReason["invalid_expires_in"] = "invalid_expires_in";
     OAuthErrorReason["invalid_user_credentials"] = "invalid_user_credentials";
     OAuthErrorReason["invalid_grant_type"] = "invalid_grant_type";
     OAuthErrorReason["invalid_origin"] = "invalid_origin";
@@ -5883,6 +5999,7 @@ var OAuthErrorReason;
     OAuthErrorReason["invalid_pkce_code_verifier"] = "invalid_pkce_code_verifier";
     OAuthErrorReason["invalid_pkce_code_challenge"] = "invalid_pkce_code_challenge";
     OAuthErrorReason["invalid_pkce_code_challenge_method"] = "invalid_pkce_code_challenge_method";
+    OAuthErrorReason["invalid_prompt"] = "invalid_prompt";
     OAuthErrorReason["invalid_redirect_uri"] = "invalid_redirect_uri";
     OAuthErrorReason["invalid_response_mode"] = "invalid_response_mode";
     OAuthErrorReason["invalid_response_type"] = "invalid_response_type";
@@ -5929,6 +6046,14 @@ var OAuthErrorReason;
     OAuthErrorReason["missing_required_scope"] = "missing_required_scope";
     OAuthErrorReason["unknown_scope"] = "unknown_scope";
     OAuthErrorReason["consent_canceled"] = "consent_canceled";
+    OAuthErrorReason["authentication_required"] = "authentication_required";
+    OAuthErrorReason["email_verification_required"] = "email_verification_required";
+    OAuthErrorReason["multi_factor_challenge_required"] = "multi_factor_challenge_required";
+    OAuthErrorReason["phone_verification_required"] = "phone_verification_required";
+    OAuthErrorReason["registration_missing_requirement"] = "registration_missing_requirement";
+    OAuthErrorReason["registration_required"] = "registration_required";
+    OAuthErrorReason["registration_verification_required"] = "registration_verification_required";
+    OAuthErrorReason["consent_required"] = "consent_required";
 })(OAuthErrorReason = exports.OAuthErrorReason || (exports.OAuthErrorReason = {}));
 var OAuthErrorType;
 (function (OAuthErrorType) {
@@ -5936,6 +6061,9 @@ var OAuthErrorType;
     OAuthErrorType["invalid_client"] = "invalid_client";
     OAuthErrorType["invalid_grant"] = "invalid_grant";
     OAuthErrorType["invalid_token"] = "invalid_token";
+    OAuthErrorType["consent_required"] = "consent_required";
+    OAuthErrorType["interaction_required"] = "interaction_required";
+    OAuthErrorType["login_required"] = "login_required";
     OAuthErrorType["unauthorized_client"] = "unauthorized_client";
     OAuthErrorType["invalid_scope"] = "invalid_scope";
     OAuthErrorType["server_error"] = "server_error";
@@ -6002,6 +6130,14 @@ var BreachMatchMode;
     BreachMatchMode["Medium"] = "Medium";
     BreachMatchMode["High"] = "High";
 })(BreachMatchMode = exports.BreachMatchMode || (exports.BreachMatchMode = {}));
+/**
+ * @author Daniel DeGroff
+ */
+var PasswordlessStrategy;
+(function (PasswordlessStrategy) {
+    PasswordlessStrategy["ClickableLink"] = "ClickableLink";
+    PasswordlessStrategy["FormField"] = "FormField";
+})(PasswordlessStrategy = exports.PasswordlessStrategy || (exports.PasswordlessStrategy = {}));
 /**
  * @author Brett Guy
  */
@@ -6020,18 +6156,6 @@ var PublicKeyCredentialType;
 (function (PublicKeyCredentialType) {
     PublicKeyCredentialType["publicKey"] = "public-key";
 })(PublicKeyCredentialType = exports.PublicKeyCredentialType || (exports.PublicKeyCredentialType = {}));
-/**
- * @author Daniel DeGroff
- */
-var RateLimitedRequestType;
-(function (RateLimitedRequestType) {
-    RateLimitedRequestType["FailedLogin"] = "FailedLogin";
-    RateLimitedRequestType["ForgotPassword"] = "ForgotPassword";
-    RateLimitedRequestType["SendEmailVerification"] = "SendEmailVerification";
-    RateLimitedRequestType["SendPasswordless"] = "SendPasswordless";
-    RateLimitedRequestType["SendRegistrationVerification"] = "SendRegistrationVerification";
-    RateLimitedRequestType["SendTwoFactor"] = "SendTwoFactor";
-})(RateLimitedRequestType = exports.RateLimitedRequestType || (exports.RateLimitedRequestType = {}));
 /**
  * @author Brian Pontarelli
  */
@@ -6091,6 +6215,16 @@ var SecureGeneratorType;
     SecureGeneratorType["randomAlpha"] = "randomAlpha";
     SecureGeneratorType["randomAlphaNumeric"] = "randomAlphaNumeric";
 })(SecureGeneratorType = exports.SecureGeneratorType || (exports.SecureGeneratorType = {}));
+/**
+ * Used to indicate which identity type a password "request" might go to. It could be
+ * used for send set passwords or send password resets.
+ */
+var SendSetPasswordIdentityType;
+(function (SendSetPasswordIdentityType) {
+    SendSetPasswordIdentityType["email"] = "email";
+    SendSetPasswordIdentityType["phone"] = "phone";
+    SendSetPasswordIdentityType["doNotSend"] = "doNotSend";
+})(SendSetPasswordIdentityType = exports.SendSetPasswordIdentityType || (exports.SendSetPasswordIdentityType = {}));
 /**
  * @author Daniel DeGroff
  */