@fusionauth/typescript-client 1.59.0 → 1.61.0

package/build/src/FusionAuthClient.d.ts

@@ -138,10 +138,22 @@ export declare class FusionAuthClient {
      *
      * 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.
+     * @param {string} loginId The loginId (email or username) of the User that you intend to change the password for.
      * @returns {Promise<ClientResponse<void>>}
      */
     checkChangePasswordUsingLoginId(loginId: string): Promise<ClientResponse<void>>;
+    /**
+     * 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 Trust Request Id by completing a Two-Factor Step-Up authentication.
+     *
+     * 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.
+     * @param {Array<String>} loginIdTypes The identity types that FusionAuth will compare the loginId to.
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    checkChangePasswordUsingLoginIdAndLoginIdTypes(loginId: string, loginIdTypes: Array<String>): Promise<ClientResponse<void>>;
     /**
      * Make a Client Credentials grant request to obtain an access token.
      *
@@ -2012,7 +2024,7 @@ export declare class FusionAuthClient {
      * 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.
+     * @param {Array<String>} loginIdTypes The identity types that FusionAuth will compare the loginId to.
      * @returns {Promise<ClientResponse<UserResponse>>}
      */
     retrieveUserByLoginIdWithLoginIdTypes(loginId: string, loginIdTypes: Array<String>): Promise<ClientResponse<UserResponse>>;
@@ -2128,7 +2140,7 @@ export declare class FusionAuthClient {
      * @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.
+     * @param {Array<String>} loginIdTypes The identity types that FusionAuth will compare the loginId to.
      * @returns {Promise<ClientResponse<LoginReportResponse>>}
      */
     retrieveUserLoginReportByLoginIdAndLoginIdTypes(applicationId: UUID, loginId: string, start: number, end: number, loginIdTypes: Array<String>): Promise<ClientResponse<LoginReportResponse>>;
@@ -4983,7 +4995,7 @@ export interface GoogleIdentityProviderProperties {
     button?: string;
 }
 /**
- * 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">
@@ -5050,7 +5062,6 @@ export interface GroupMember {
     groupId?: UUID;
     id?: UUID;
     insertInstant?: number;
-    user?: User;
     userId?: UUID;
 }
 /**
@@ -6354,6 +6365,9 @@ export declare enum OAuthErrorReason {
     access_token_required = "access_token_required",
     refresh_token_not_found = "refresh_token_not_found",
     refresh_token_type_not_supported = "refresh_token_type_not_supported",
+    id_token_invalid = "id_token_invalid",
+    unsupported_token_type = "unsupported_token_type",
+    token_type_hint_mismatch = "token_type_hint_mismatch",
     invalid_client_id = "invalid_client_id",
     invalid_expires_in = "invalid_expires_in",
     invalid_user_credentials = "invalid_user_credentials",
@@ -6363,6 +6377,7 @@ export declare enum OAuthErrorReason {
     invalid_pkce_code_verifier = "invalid_pkce_code_verifier",
     invalid_pkce_code_challenge = "invalid_pkce_code_challenge",
     invalid_pkce_code_challenge_method = "invalid_pkce_code_challenge_method",
+    invalid_prompt = "invalid_prompt",
     invalid_redirect_uri = "invalid_redirect_uri",
     invalid_response_mode = "invalid_response_mode",
     invalid_response_type = "invalid_response_type",
@@ -6408,13 +6423,24 @@ export declare enum OAuthErrorReason {
     unknown = "unknown",
     missing_required_scope = "missing_required_scope",
     unknown_scope = "unknown_scope",
-    consent_canceled = "consent_canceled"
+    consent_canceled = "consent_canceled",
+    authentication_required = "authentication_required",
+    email_verification_required = "email_verification_required",
+    multi_factor_challenge_required = "multi_factor_challenge_required",
+    phone_verification_required = "phone_verification_required",
+    registration_missing_requirement = "registration_missing_requirement",
+    registration_required = "registration_required",
+    registration_verification_required = "registration_verification_required",
+    consent_required = "consent_required"
 }
 export declare enum OAuthErrorType {
     invalid_request = "invalid_request",
     invalid_client = "invalid_client",
     invalid_grant = "invalid_grant",
     invalid_token = "invalid_token",
+    consent_required = "consent_required",
+    interaction_required = "interaction_required",
+    login_required = "login_required",
     unauthorized_client = "unauthorized_client",
     invalid_scope = "invalid_scope",
     server_error = "server_error",

package/build/src/FusionAuthClient.js

@@ -237,13 +237,32 @@ class FusionAuthClient {
      *
      * 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.
+     * @param {string} loginId The loginId (email or username) 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)
+            .withParameter('loginId', loginId)
+            .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 Trust Request Id by completing a Two-Factor Step-Up authentication.
+     *
+     * 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.
+     * @param {Array<String>} loginIdTypes The identity types that FusionAuth will compare the loginId to.
+     * @returns {Promise<ClientResponse<void>>}
+     */
+    checkChangePasswordUsingLoginIdAndLoginIdTypes(loginId, loginIdTypes) {
+        return this.start()
+            .withUri('/api/user/change-password')
+            .withParameter('loginId', loginId)
+            .withParameter('loginIdTypes', loginIdTypes)
             .withMethod("GET")
             .go();
     }
@@ -3670,7 +3689,7 @@ class FusionAuthClient {
      * 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.
+     * @param {Array<String>} loginIdTypes The identity types that FusionAuth will compare the loginId to.
      * @returns {Promise<ClientResponse<UserResponse>>}
      */
     retrieveUserByLoginIdWithLoginIdTypes(loginId, loginIdTypes) {
@@ -3880,7 +3899,7 @@ class FusionAuthClient {
      * @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.
+     * @param {Array<String>} loginIdTypes The identity types that FusionAuth will compare the loginId to.
      * @returns {Promise<ClientResponse<LoginReportResponse>>}
      */
     retrieveUserLoginReportByLoginIdAndLoginIdTypes(applicationId, loginId, start, end, loginIdTypes) {
@@ -5746,7 +5765,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">
@@ -5987,6 +6006,9 @@ 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";
@@ -5996,6 +6018,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";
@@ -6042,6 +6065,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) {
@@ -6049,6 +6080,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";