@fusionauth/typescript-client 1.29.0 → 1.31.0

package/build/src/FusionAuthClient.js

@@ -382,6 +382,21 @@ class FusionAuthClient {
             .withMethod("POST")
             .go();
     }
+    /**
+     * Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.
+     *
+     * @param {UUID} accessControlListId (Optional) The Id for the IP Access Control List. If not provided a secure random UUID will be generated.
+     * @param {IPAccessControlListRequest} request The request object that contains all of the information used to create the IP Access Control List.
+     * @returns {Promise<ClientResponse<IPAccessControlListResponse>>}
+     */
+    createIPAccessControlList(accessControlListId, request) {
+        return this.start()
+            .withUri('/api/ip-acl')
+            .withUriSegment(accessControlListId)
+            .withJSONBody(request)
+            .withMethod("POST")
+            .go();
+    }
     /**
      * Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.
      *
@@ -843,6 +858,19 @@ class FusionAuthClient {
             .withMethod("DELETE")
             .go();
     }
+    /**
+     * Deletes the IP Access Control List for the given Id.
+     *
+     * @param {UUID} ipAccessControlListId The Id of the IP Access Control List to delete.
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    deleteIPAccessControlList(ipAccessControlListId) {
+        return this.start()
+            .withUri('/api/ip-acl')
+            .withUriSegment(ipAccessControlListId)
+            .withMethod("DELETE")
+            .go();
+    }
     /**
      * Deletes the identity provider for the given Id.
      *
@@ -924,7 +952,25 @@ class FusionAuthClient {
             .go();
     }
     /**
-     * Deletes the tenant for the given Id.
+     * Deletes the user registration for the given user and application along with the given JSON body that contains the event information.
+     *
+     * @param {UUID} userId The Id of the user whose registration is being deleted.
+     * @param {UUID} applicationId The Id of the application to remove the registration for.
+     * @param {RegistrationDeleteRequest} request The request body that contains the event information.
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    deleteRegistrationWithRequest(userId, applicationId, request) {
+        return this.start()
+            .withUri('/api/user/registration')
+            .withUriSegment(userId)
+            .withUriSegment(applicationId)
+            .withJSONBody(request)
+            .withMethod("DELETE")
+            .go();
+    }
+    /**
+     * Deletes the tenant based on the given Id on the URL. This permanently deletes all information, metrics, reports and data associated
+     * with the tenant and everything under the tenant (applications, users, etc).
      *
      * @param {UUID} tenantId The Id of the tenant to delete.
      * @returns {Promise<ClientResponse<void>>}
@@ -951,6 +997,22 @@ class FusionAuthClient {
             .withMethod("DELETE")
             .go();
     }
+    /**
+     * Deletes the tenant based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated
+     * with the tenant and everything under the tenant (applications, users, etc).
+     *
+     * @param {UUID} tenantId The Id of the tenant to delete.
+     * @param {TenantDeleteRequest} request The request object that contains all of the information used to delete the user.
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    deleteTenantWithRequest(tenantId, request) {
+        return this.start()
+            .withUri('/api/tenant')
+            .withUriSegment(tenantId)
+            .withJSONBody(request)
+            .withMethod("DELETE")
+            .go();
+    }
     /**
      * Deletes the theme for the given Id.
      *
@@ -1024,6 +1086,22 @@ class FusionAuthClient {
             .withMethod("DELETE")
             .go();
     }
+    /**
+     * Deletes the user based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated
+     * with the user.
+     *
+     * @param {UUID} userId The Id of the user to delete (required).
+     * @param {UserDeleteSingleRequest} request The request object that contains all of the information used to delete the user.
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    deleteUserWithRequest(userId, request) {
+        return this.start()
+            .withUri('/api/user')
+            .withUriSegment(userId)
+            .withJSONBody(request)
+            .withMethod("DELETE")
+            .go();
+    }
     /**
      * Deletes the users with the given ids, or users matching the provided JSON query or queryString.
      * The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.
@@ -1084,12 +1162,27 @@ class FusionAuthClient {
     disableTwoFactor(userId, methodId, code) {
         return this.start()
             .withUri('/api/user/two-factor')
-            .withParameter('userId', userId)
+            .withUriSegment(userId)
             .withParameter('methodId', methodId)
             .withParameter('code', code)
             .withMethod("DELETE")
             .go();
     }
+    /**
+     * Disable Two Factor authentication for a user using a JSON body rather than URL parameters.
+     *
+     * @param {UUID} userId The Id of the User for which you're disabling Two Factor authentication.
+     * @param {TwoFactorDisableRequest} request The request information that contains the code and methodId along with any event information.
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    disableTwoFactorWithRequest(userId, request) {
+        return this.start()
+            .withUri('/api/user/two-factor')
+            .withUriSegment(userId)
+            .withJSONBody(request)
+            .withMethod("DELETE")
+            .go();
+    }
     /**
      * Enable Two Factor authentication for a user.
      *
@@ -1486,6 +1579,20 @@ class FusionAuthClient {
             .withMethod("POST")
             .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 takes the refresh token in the JSON body.
+     *
+     * @param {LogoutRequest} request The request object that contains all of the information used to logout the user.
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    logoutWithRequest(request) {
+        return this.startAnonymous()
+            .withUri('/api/logout')
+            .withJSONBody(request)
+            .withMethod("POST")
+            .go();
+    }
     /**
      * Retrieves the identity provider for the given domain. A 200 response code indicates the domain is managed
      * by a registered identity provider. A 404 indicates the domain is not managed.
@@ -2409,6 +2516,19 @@ class FusionAuthClient {
             .withMethod("GET")
             .go();
     }
+    /**
+     * Retrieves the IP Access Control List with the given Id.
+     *
+     * @param {UUID} ipAccessControlListId The Id of the IP Access Control List.
+     * @returns {Promise<ClientResponse<IPAccessControlListResponse>>}
+     */
+    retrieveIPAccessControlList(ipAccessControlListId) {
+        return this.start()
+            .withUri('/api/ip-acl')
+            .withUriSegment(ipAccessControlListId)
+            .withMethod("GET")
+            .go();
+    }
     /**
      * Retrieves the identity provider for the given id or all of the identity providers if the id is null.
      *
@@ -2771,6 +2891,17 @@ class FusionAuthClient {
             .withMethod("GET")
             .go();
     }
+    /**
+     * Retrieves the FusionAuth Reactor metrics.
+     *
+     * @returns {Promise<ClientResponse<ReactorMetricsResponse>>}
+     */
+    retrieveReactorMetrics() {
+        return this.start()
+            .withUri('/api/reactor/metrics')
+            .withMethod("GET")
+            .go();
+    }
     /**
      * Retrieves the FusionAuth Reactor status.
      *
@@ -3378,6 +3509,20 @@ class FusionAuthClient {
             .withMethod("DELETE")
             .go();
     }
+    /**
+     * Revokes refresh tokens using the information in the JSON body. The handling for this method is the same as the revokeRefreshToken method
+     * and is based on the information you provide in the RefreshDeleteRequest object. See that method for additional information.
+     *
+     * @param {RefreshTokenRevokeRequest} request The request information used to revoke the refresh tokens.
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    revokeRefreshTokensWithRequest(request) {
+        return this.start()
+            .withUri('/api/jwt/refresh')
+            .withJSONBody(request)
+            .withMethod("DELETE")
+            .go();
+    }
     /**
      * Revokes a single User consent by Id.
      *
@@ -3469,6 +3614,19 @@ class FusionAuthClient {
             .withMethod("POST")
             .go();
     }
+    /**
+     * Searches the IP Access Control Lists with the specified criteria and pagination.
+     *
+     * @param {IPAccessControlListSearchRequest} request The search criteria and pagination information.
+     * @returns {Promise<ClientResponse<IPAccessControlListSearchResponse>>}
+     */
+    searchIPAccessControlLists(request) {
+        return this.start()
+            .withUri('/api/ip-acl/search')
+            .withJSONBody(request)
+            .withMethod("POST")
+            .go();
+    }
     /**
      * Searches the login records with the specified criteria and pagination.
      *
@@ -3886,6 +4044,21 @@ class FusionAuthClient {
             .withMethod("PUT")
             .go();
     }
+    /**
+     * Updates the IP Access Control List with the given Id.
+     *
+     * @param {UUID} accessControlListId The Id of the IP Access Control List to update.
+     * @param {IPAccessControlListRequest} request The request that contains all of the new IP Access Control List information.
+     * @returns {Promise<ClientResponse<IPAccessControlListResponse>>}
+     */
+    updateIPAccessControlList(accessControlListId, request) {
+        return this.start()
+            .withUri('/api/ip-acl')
+            .withUriSegment(accessControlListId)
+            .withJSONBody(request)
+            .withMethod("PUT")
+            .go();
+    }
     /**
      * Updates the identity provider with the given Id.
      *
@@ -4155,6 +4328,27 @@ class FusionAuthClient {
             .withMethod("GET")
             .go();
     }
+    /**
+     * It's a JWT vending machine!
+     *
+     * Issue a new access token (JWT) with the provided claims in the request. This JWT is not scoped to a tenant or user, it is a free form
+     * token that will contain what claims you provide.
+     * <p>
+     * The iat, exp and jti claims will be added by FusionAuth, all other claims must be provided by the caller.
+     *
+     * If a TTL is not provided in the request, the TTL will be retrieved from the default Tenant or the Tenant specified on the request either
+     * by way of the X-FusionAuth-TenantId request header, or a tenant scoped API key.
+     *
+     * @param {JWTVendRequest} request The request that contains all of the claims for this JWT.
+     * @returns {Promise<ClientResponse<JWTVendResponse>>}
+     */
+    vendJWT(request) {
+        return this.start()
+            .withUri('/api/jwt/vend')
+            .withJSONBody(request)
+            .withMethod("POST")
+            .go();
+    }
     /**
      * Confirms a email verification. The Id given is usually from an email sent to the user.
      *
@@ -4267,6 +4461,13 @@ var Algorithm;
     Algorithm["RS512"] = "RS512";
     Algorithm["none"] = "none";
 })(Algorithm = exports.Algorithm || (exports.Algorithm = {}));
+/**
+ * @author Brett Pontarelli
+ */
+var AuthenticationThreats;
+(function (AuthenticationThreats) {
+    AuthenticationThreats["ImpossibleTravel"] = "ImpossibleTravel";
+})(AuthenticationThreats = exports.AuthenticationThreats || (exports.AuthenticationThreats = {}));
 var BreachAction;
 (function (BreachAction) {
     BreachAction["Off"] = "Off";
@@ -4303,6 +4504,16 @@ var CanonicalizationMethod;
     CanonicalizationMethod["inclusive"] = "inclusive";
     CanonicalizationMethod["inclusive_with_comments"] = "inclusive_with_comments";
 })(CanonicalizationMethod = exports.CanonicalizationMethod || (exports.CanonicalizationMethod = {}));
+/**
+ * @author Brett Pontarelli
+ */
+var CaptchaMethod;
+(function (CaptchaMethod) {
+    CaptchaMethod["GoogleRecaptchaV2"] = "GoogleRecaptchaV2";
+    CaptchaMethod["GoogleRecaptchaV3"] = "GoogleRecaptchaV3";
+    CaptchaMethod["HCaptcha"] = "HCaptcha";
+    CaptchaMethod["HCaptchaEnterprise"] = "HCaptchaEnterprise";
+})(CaptchaMethod = exports.CaptchaMethod || (exports.CaptchaMethod = {}));
 /**
  * @author Trevor Smith
  */
@@ -4396,24 +4607,44 @@ var EventLogType;
  */
 var EventType;
 (function (EventType) {
-    EventType["UserDelete"] = "user.delete";
-    EventType["UserCreate"] = "user.create";
-    EventType["UserUpdate"] = "user.update";
-    EventType["UserDeactivate"] = "user.deactivate";
-    EventType["UserBulkCreate"] = "user.bulk.create";
-    EventType["UserReactivate"] = "user.reactivate";
-    EventType["UserAction"] = "user.action";
+    EventType["JWTPublicKeyUpdate"] = "jwt.public-key.update";
     EventType["JWTRefreshTokenRevoke"] = "jwt.refresh-token.revoke";
     EventType["JWTRefresh"] = "jwt.refresh";
-    EventType["JWTPublicKeyUpdate"] = "jwt.public-key.update";
-    EventType["UserLoginSuccess"] = "user.login.success";
+    EventType["AuditLogCreate"] = "audit-log.create";
+    EventType["EventLogCreate"] = "event-log.create";
+    EventType["KickstartSuccess"] = "kickstart.success";
+    EventType["UserAction"] = "user.action";
+    EventType["UserBulkCreate"] = "user.bulk.create";
+    EventType["UserCreate"] = "user.create";
+    EventType["UserCreateComplete"] = "user.create.complete";
+    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["UserLoginFailed"] = "user.login.failed";
+    EventType["UserLoginNewDevice"] = "user.login.new-device";
+    EventType["UserLoginSuccess"] = "user.login.success";
+    EventType["UserLoginSuspicious"] = "user.login.suspicious";
+    EventType["UserPasswordBreach"] = "user.password.breach";
+    EventType["UserPasswordResetSend"] = "user.password.reset.send";
+    EventType["UserPasswordResetStart"] = "user.password.reset.start";
+    EventType["UserPasswordResetSuccess"] = "user.password.reset.success";
+    EventType["UserPasswordUpdate"] = "user.password.update";
+    EventType["UserReactivate"] = "user.reactivate";
     EventType["UserRegistrationCreate"] = "user.registration.create";
-    EventType["UserRegistrationUpdate"] = "user.registration.update";
+    EventType["UserRegistrationCreateComplete"] = "user.registration.create.complete";
     EventType["UserRegistrationDelete"] = "user.registration.delete";
+    EventType["UserRegistrationDeleteComplete"] = "user.registration.delete.complete";
+    EventType["UserRegistrationUpdate"] = "user.registration.update";
+    EventType["UserRegistrationUpdateComplete"] = "user.registration.update.complete";
     EventType["UserRegistrationVerified"] = "user.registration.verified";
-    EventType["UserEmailVerified"] = "user.email.verified";
-    EventType["UserPasswordBreach"] = "user.password.breach";
+    EventType["UserTwoFactorMethodAdd"] = "user.two-factor.method.add";
+    EventType["UserTwoFactorMethodRemove"] = "user.two-factor.method.remove";
+    EventType["UserUpdate"] = "user.update";
+    EventType["UserUpdateComplete"] = "user.update.complete";
     EventType["Test"] = "test";
 })(EventType = exports.EventType || (exports.EventType = {}));
 /**
@@ -4554,6 +4785,14 @@ var IdentityProviderType;
     IdentityProviderType["Twitter"] = "Twitter";
     IdentityProviderType["Xbox"] = "Xbox";
 })(IdentityProviderType = exports.IdentityProviderType || (exports.IdentityProviderType = {}));
+/**
+ * @author Brett Guy
+ */
+var IPAccessControlEntryAction;
+(function (IPAccessControlEntryAction) {
+    IPAccessControlEntryAction["Allow"] = "Allow";
+    IPAccessControlEntryAction["Block"] = "Block";
+})(IPAccessControlEntryAction = exports.IPAccessControlEntryAction || (exports.IPAccessControlEntryAction = {}));
 var KeyAlgorithm;
 (function (KeyAlgorithm) {
     KeyAlgorithm["ES256"] = "ES256";
@@ -4738,6 +4977,18 @@ var ProofKeyForCodeExchangePolicy;
     ProofKeyForCodeExchangePolicy["NotRequired"] = "NotRequired";
     ProofKeyForCodeExchangePolicy["NotRequiredWhenUsingClientAuthentication"] = "NotRequiredWhenUsingClientAuthentication";
 })(ProofKeyForCodeExchangePolicy = exports.ProofKeyForCodeExchangePolicy || (exports.ProofKeyForCodeExchangePolicy = {}));
+/**
+ * @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
  */
@@ -4746,6 +4997,7 @@ var ReactorFeatureStatus;
     ReactorFeatureStatus["ACTIVE"] = "ACTIVE";
     ReactorFeatureStatus["DISCONNECTED"] = "DISCONNECTED";
     ReactorFeatureStatus["PENDING"] = "PENDING";
+    ReactorFeatureStatus["DISABLED"] = "DISABLED";
     ReactorFeatureStatus["UNKNOWN"] = "UNKNOWN";
 })(ReactorFeatureStatus = exports.ReactorFeatureStatus || (exports.ReactorFeatureStatus = {}));
 /**