@fusionauth/typescript-client 1.31.0 → 1.34.0

package/build/src/FusionAuthClient.js

@@ -76,7 +76,7 @@ class FusionAuthClient {
      * Adds a user to an existing family. The family id must be specified.
      *
      * @param {UUID} familyId The id of the family.
-     * @param {FamilyRequest} request The request object that contains all of the information used to determine which user to add to the family.
+     * @param {FamilyRequest} request The request object that contains all the information used to determine which user to add to the family.
      * @returns {Promise<ClientResponse<FamilyResponse>>}
      */
     addUserToFamily(familyId, request) {
@@ -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,10 +136,61 @@ 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.
      *
-     * @param {UserCommentRequest} request The request object that contains all of the information used to create the user comment.
+     * @param {UserCommentRequest} request The request object that contains all the information used to create the user comment.
      * @returns {Promise<ClientResponse<void>>}
      */
     commentOnUser(request) {
@@ -169,7 +223,7 @@ class FusionAuthClient {
      * Creates an application. You can optionally specify an Id for the application, if not provided one will be generated.
      *
      * @param {UUID} applicationId (Optional) The Id to use for the application. If not provided a secure random UUID will be generated.
-     * @param {ApplicationRequest} request The request object that contains all of the information used to create the application.
+     * @param {ApplicationRequest} request The request object that contains all the information used to create the application.
      * @returns {Promise<ClientResponse<ApplicationResponse>>}
      */
     createApplication(applicationId, request) {
@@ -186,7 +240,7 @@ class FusionAuthClient {
      *
      * @param {UUID} applicationId The Id of the application to create the role on.
      * @param {UUID} roleId (Optional) The Id of the role. If not provided a secure random UUID will be generated.
-     * @param {ApplicationRequest} request The request object that contains all of the information used to create the application role.
+     * @param {ApplicationRequest} request The request object that contains all the information used to create the application role.
      * @returns {Promise<ClientResponse<ApplicationResponse>>}
      */
     createApplicationRole(applicationId, roleId, request) {
@@ -204,7 +258,7 @@ class FusionAuthClient {
      * make changes to the FusionAuth database. When using the FusionAuth App web interface, any changes are automatically
      * written to the audit log. However, if you are accessing the API, you must write the audit logs yourself.
      *
-     * @param {AuditLogRequest} request The request object that contains all of the information used to create the audit log entry.
+     * @param {AuditLogRequest} request The request object that contains all the information used to create the audit log entry.
      * @returns {Promise<ClientResponse<AuditLogResponse>>}
      */
     createAuditLog(request) {
@@ -218,7 +272,7 @@ class FusionAuthClient {
      * Creates a connector.  You can optionally specify an Id for the connector, if not provided one will be generated.
      *
      * @param {UUID} connectorId (Optional) The Id for the connector. If not provided a secure random UUID will be generated.
-     * @param {ConnectorRequest} request The request object that contains all of the information used to create the connector.
+     * @param {ConnectorRequest} request The request object that contains all the information used to create the connector.
      * @returns {Promise<ClientResponse<ConnectorResponse>>}
      */
     createConnector(connectorId, request) {
@@ -233,7 +287,7 @@ class FusionAuthClient {
      * Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.
      *
      * @param {UUID} consentId (Optional) The Id for the consent. If not provided a secure random UUID will be generated.
-     * @param {ConsentRequest} request The request object that contains all of the information used to create the consent.
+     * @param {ConsentRequest} request The request object that contains all the information used to create the consent.
      * @returns {Promise<ClientResponse<ConsentResponse>>}
      */
     createConsent(consentId, request) {
@@ -248,7 +302,7 @@ class FusionAuthClient {
      * Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
      *
      * @param {UUID} emailTemplateId (Optional) The Id for the template. If not provided a secure random UUID will be generated.
-     * @param {EmailTemplateRequest} request The request object that contains all of the information used to create the email template.
+     * @param {EmailTemplateRequest} request The request object that contains all the information used to create the email template.
      * @returns {Promise<ClientResponse<EmailTemplateResponse>>}
      */
     createEmailTemplate(emailTemplateId, request) {
@@ -263,7 +317,7 @@ class FusionAuthClient {
      * Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated.
      *
      * @param {UUID} entityId (Optional) The Id for the Entity. If not provided a secure random UUID will be generated.
-     * @param {EntityRequest} request The request object that contains all of the information used to create the Entity.
+     * @param {EntityRequest} request The request object that contains all the information used to create the Entity.
      * @returns {Promise<ClientResponse<EntityResponse>>}
      */
     createEntity(entityId, request) {
@@ -278,7 +332,7 @@ class FusionAuthClient {
      * Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated.
      *
      * @param {UUID} entityTypeId (Optional) The Id for the Entity Type. If not provided a secure random UUID will be generated.
-     * @param {EntityTypeRequest} request The request object that contains all of the information used to create the Entity Type.
+     * @param {EntityTypeRequest} request The request object that contains all the information used to create the Entity Type.
      * @returns {Promise<ClientResponse<EntityTypeResponse>>}
      */
     createEntityType(entityTypeId, request) {
@@ -295,7 +349,7 @@ class FusionAuthClient {
      *
      * @param {UUID} entityTypeId The Id of the entity type to create the permission on.
      * @param {UUID} permissionId (Optional) The Id of the permission. If not provided a secure random UUID will be generated.
-     * @param {EntityTypeRequest} request The request object that contains all of the information used to create the permission.
+     * @param {EntityTypeRequest} request The request object that contains all the information used to create the permission.
      * @returns {Promise<ClientResponse<EntityTypeResponse>>}
      */
     createEntityTypePermission(entityTypeId, permissionId, request) {
@@ -313,7 +367,7 @@ class FusionAuthClient {
      * family, if not provided one will be generated.
      *
      * @param {UUID} familyId (Optional) The id for the family. If not provided a secure random UUID will be generated.
-     * @param {FamilyRequest} request The request object that contains all of the information used to create the family.
+     * @param {FamilyRequest} request The request object that contains all the information used to create the family.
      * @returns {Promise<ClientResponse<FamilyResponse>>}
      */
     createFamily(familyId, request) {
@@ -328,7 +382,7 @@ class FusionAuthClient {
      * Creates a form.  You can optionally specify an Id for the form, if not provided one will be generated.
      *
      * @param {UUID} formId (Optional) The Id for the form. If not provided a secure random UUID will be generated.
-     * @param {FormRequest} request The request object that contains all of the information used to create the form.
+     * @param {FormRequest} request The request object that contains all the information used to create the form.
      * @returns {Promise<ClientResponse<FormResponse>>}
      */
     createForm(formId, request) {
@@ -343,7 +397,7 @@ class FusionAuthClient {
      * Creates a form field.  You can optionally specify an Id for the form, if not provided one will be generated.
      *
      * @param {UUID} fieldId (Optional) The Id for the form field. If not provided a secure random UUID will be generated.
-     * @param {FormFieldRequest} request The request object that contains all of the information used to create the form field.
+     * @param {FormFieldRequest} request The request object that contains all the information used to create the form field.
      * @returns {Promise<ClientResponse<FormFieldResponse>>}
      */
     createFormField(fieldId, request) {
@@ -358,7 +412,7 @@ class FusionAuthClient {
      * Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
      *
      * @param {UUID} groupId (Optional) The Id for the group. If not provided a secure random UUID will be generated.
-     * @param {GroupRequest} request The request object that contains all of the information used to create the group.
+     * @param {GroupRequest} request The request object that contains all the information used to create the group.
      * @returns {Promise<ClientResponse<GroupResponse>>}
      */
     createGroup(groupId, request) {
@@ -372,7 +426,7 @@ class FusionAuthClient {
     /**
      * Creates a member in a group.
      *
-     * @param {MemberRequest} request The request object that contains all of the information used to create the group member(s).
+     * @param {MemberRequest} request The request object that contains all the information used to create the group member(s).
      * @returns {Promise<ClientResponse<MemberResponse>>}
      */
     createGroupMembers(request) {
@@ -386,7 +440,7 @@ class FusionAuthClient {
      * 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.
+     * @param {IPAccessControlListRequest} request The request object that contains all the information used to create the IP Access Control List.
      * @returns {Promise<ClientResponse<IPAccessControlListResponse>>}
      */
     createIPAccessControlList(accessControlListId, request) {
@@ -401,7 +455,7 @@ class FusionAuthClient {
      * Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.
      *
      * @param {UUID} identityProviderId (Optional) The Id of the identity provider. If not provided a secure random UUID will be generated.
-     * @param {IdentityProviderRequest} request The request object that contains all of the information used to create the identity provider.
+     * @param {IdentityProviderRequest} request The request object that contains all the information used to create the identity provider.
      * @returns {Promise<ClientResponse<IdentityProviderResponse>>}
      */
     createIdentityProvider(identityProviderId, request) {
@@ -416,7 +470,7 @@ class FusionAuthClient {
      * Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated.
      *
      * @param {UUID} lambdaId (Optional) The Id for the lambda. If not provided a secure random UUID will be generated.
-     * @param {LambdaRequest} request The request object that contains all of the information used to create the lambda.
+     * @param {LambdaRequest} request The request object that contains all the information used to create the lambda.
      * @returns {Promise<ClientResponse<LambdaResponse>>}
      */
     createLambda(lambdaId, request) {
@@ -431,7 +485,7 @@ class FusionAuthClient {
      * Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated.
      *
      * @param {UUID} messageTemplateId (Optional) The Id for the template. If not provided a secure random UUID will be generated.
-     * @param {MessageTemplateRequest} request The request object that contains all of the information used to create the message template.
+     * @param {MessageTemplateRequest} request The request object that contains all the information used to create the message template.
      * @returns {Promise<ClientResponse<MessageTemplateResponse>>}
      */
     createMessageTemplate(messageTemplateId, request) {
@@ -446,7 +500,7 @@ class FusionAuthClient {
      * Creates a messenger.  You can optionally specify an Id for the messenger, if not provided one will be generated.
      *
      * @param {UUID} messengerId (Optional) The Id for the messenger. If not provided a secure random UUID will be generated.
-     * @param {MessengerRequest} request The request object that contains all of the information used to create the messenger.
+     * @param {MessengerRequest} request The request object that contains all the information used to create the messenger.
      * @returns {Promise<ClientResponse<MessengerResponse>>}
      */
     createMessenger(messengerId, request) {
@@ -461,7 +515,7 @@ class FusionAuthClient {
      * Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.
      *
      * @param {UUID} tenantId (Optional) The Id for the tenant. If not provided a secure random UUID will be generated.
-     * @param {TenantRequest} request The request object that contains all of the information used to create the tenant.
+     * @param {TenantRequest} request The request object that contains all the information used to create the tenant.
      * @returns {Promise<ClientResponse<TenantResponse>>}
      */
     createTenant(tenantId, request) {
@@ -476,7 +530,7 @@ class FusionAuthClient {
      * Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated.
      *
      * @param {UUID} themeId (Optional) The Id for the theme. If not provided a secure random UUID will be generated.
-     * @param {ThemeRequest} request The request object that contains all of the information used to create the theme.
+     * @param {ThemeRequest} request The request object that contains all the information used to create the theme.
      * @returns {Promise<ClientResponse<ThemeResponse>>}
      */
     createTheme(themeId, request) {
@@ -491,7 +545,7 @@ class FusionAuthClient {
      * Creates a user. You can optionally specify an Id for the user, if not provided one will be generated.
      *
      * @param {UUID} userId (Optional) The Id for the user. If not provided a secure random UUID will be generated.
-     * @param {UserRequest} request The request object that contains all of the information used to create the user.
+     * @param {UserRequest} request The request object that contains all the information used to create the user.
      * @returns {Promise<ClientResponse<UserResponse>>}
      */
     createUser(userId, request) {
@@ -507,7 +561,7 @@ class FusionAuthClient {
      * that the user action can be applied to any user.
      *
      * @param {UUID} userActionId (Optional) The Id for the user action. If not provided a secure random UUID will be generated.
-     * @param {UserActionRequest} request The request object that contains all of the information used to create the user action.
+     * @param {UserActionRequest} request The request object that contains all the information used to create the user action.
      * @returns {Promise<ClientResponse<UserActionResponse>>}
      */
     createUserAction(userActionId, request) {
@@ -523,7 +577,7 @@ class FusionAuthClient {
      * successfully. Anytime after that the user action reason can be used.
      *
      * @param {UUID} userActionReasonId (Optional) The Id for the user action reason. If not provided a secure random UUID will be generated.
-     * @param {UserActionReasonRequest} request The request object that contains all of the information used to create the user action reason.
+     * @param {UserActionReasonRequest} request The request object that contains all the information used to create the user action reason.
      * @returns {Promise<ClientResponse<UserActionReasonResponse>>}
      */
     createUserActionReason(userActionReasonId, request) {
@@ -552,7 +606,7 @@ class FusionAuthClient {
     /**
      * Link an external user from a 3rd party identity provider to a FusionAuth user.
      *
-     * @param {IdentityProviderLinkRequest} request The request object that contains all of the information used to link the FusionAuth user.
+     * @param {IdentityProviderLinkRequest} request The request object that contains all the information used to link the FusionAuth user.
      * @returns {Promise<ClientResponse<IdentityProviderLinkResponse>>}
      */
     createUserLink(request) {
@@ -566,7 +620,7 @@ class FusionAuthClient {
      * Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
      *
      * @param {UUID} webhookId (Optional) The Id for the webhook. If not provided a secure random UUID will be generated.
-     * @param {WebhookRequest} request The request object that contains all of the information used to create the webhook.
+     * @param {WebhookRequest} request The request object that contains all the information used to create the webhook.
      * @returns {Promise<ClientResponse<WebhookResponse>>}
      */
     createWebhook(webhookId, request) {
@@ -1002,7 +1056,7 @@ class FusionAuthClient {
      * 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.
+     * @param {TenantDeleteRequest} request The request object that contains all the information used to delete the user.
      * @returns {Promise<ClientResponse<void>>}
      */
     deleteTenantWithRequest(tenantId, request) {
@@ -1091,7 +1145,7 @@ class FusionAuthClient {
      * 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.
+     * @param {UserDeleteSingleRequest} request The request object that contains all the information used to delete the user.
      * @returns {Promise<ClientResponse<void>>}
      */
     deleteUserWithRequest(userId, request) {
@@ -1343,7 +1397,7 @@ class FusionAuthClient {
      * Generate a new RSA or EC key pair or an HMAC secret.
      *
      * @param {UUID} keyId (Optional) The Id for the key. If not provided a secure random UUID will be generated.
-     * @param {KeyRequest} request The request object that contains all of the information used to create the key.
+     * @param {KeyRequest} request The request object that contains all the information used to create the key.
      * @returns {Promise<ClientResponse<KeyResponse>>}
      */
     generateKey(keyId, request) {
@@ -1432,7 +1486,7 @@ class FusionAuthClient {
      * Import an existing RSA or EC key pair or an HMAC secret.
      *
      * @param {UUID} keyId (Optional) The Id for the key. If not provided a secure random UUID will be generated.
-     * @param {KeyRequest} request The request object that contains all of the information used to create the key.
+     * @param {KeyRequest} request The request object that contains all the information used to create the key.
      * @returns {Promise<ClientResponse<KeyResponse>>}
      */
     importKey(keyId, request) {
@@ -1583,7 +1637,7 @@ class FusionAuthClient {
      * 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.
+     * @param {LogoutRequest} request The request object that contains all the information used to logout the user.
      * @returns {Promise<ClientResponse<void>>}
      */
     logoutWithRequest(request) {
@@ -3743,7 +3797,7 @@ class FusionAuthClient {
     /**
      * Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
      *
-     * @param {TwoFactorSendRequest} request The request object that contains all of the information used to send the code.
+     * @param {TwoFactorSendRequest} request The request object that contains all the information used to send the code.
      * @returns {Promise<ClientResponse<void>>}
      *
      * @deprecated This method has been renamed to sendTwoFactorCodeForEnableDisable, use that method instead.
@@ -3758,7 +3812,7 @@ class FusionAuthClient {
     /**
      * Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
      *
-     * @param {TwoFactorSendRequest} request The request object that contains all of the information used to send the code.
+     * @param {TwoFactorSendRequest} request The request object that contains all the information used to send the code.
      * @returns {Promise<ClientResponse<void>>}
      */
     sendTwoFactorCodeForEnableDisable(request) {
@@ -3862,7 +3916,7 @@ class FusionAuthClient {
      * Updates an API key by given id
      *
      * @param {UUID} apiKeyId The Id of the API key to update.
-     * @param {APIKeyRequest} request The request object that contains all of the information used to create the API Key.
+     * @param {APIKeyRequest} request The request object that contains all the information used to create the API Key.
      * @returns {Promise<ClientResponse<APIKeyResponse>>}
      */
     updateAPIKey(apiKeyId, request) {
@@ -4284,7 +4338,7 @@ class FusionAuthClient {
      * Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity.
      *
      * @param {UUID} entityId The Id of the Entity that the User/Entity is being granted access to.
-     * @param {EntityGrantRequest} request The request object that contains all of the information used to create the Entity Grant.
+     * @param {EntityGrantRequest} request The request object that contains all the information used to create the Entity Grant.
      * @returns {Promise<ClientResponse<void>>}
      */
     upsertEntityGrant(entityId, request) {