import IRESTClientBuilder from "./IRESTClientBuilder";
import ClientResponse from "./ClientResponse";
import { RequestCredentials } from "node-fetch";
export declare class FusionAuthClient {
    apiKey: string;
    host: string;
    tenantId?: string;
    clientBuilder: IRESTClientBuilder;
    credentials: RequestCredentials;
    constructor(apiKey: string, host: string, tenantId?: string);
    /**
     * Sets the tenant id, that will be included in the X-FusionAuth-TenantId header.
     *
     * @param {string | null} tenantId The value of the X-FusionAuth-TenantId header.
     * @returns {FusionAuthClient}
     */
    setTenantId(tenantId: string | null): FusionAuthClient;
    /**
     * Sets whether and how cookies will be sent with each request.
     *
     * @param value The value that indicates whether and how cookies will be sent.
     * @returns {FusionAuthClient}
     */
    setRequestCredentials(value: RequestCredentials): FusionAuthClient;
    /**
     * Takes an action on a user. The user being actioned is called the "actionee" and the user taking the action is called the
     * "actioner". Both user ids are required in the request object.
     *
     * @param {ActionRequest} request The action request that includes all the information about the action being taken including
     *    the Id of the action, any options and the duration (if applicable).
     * @returns {Promise<ClientResponse<ActionResponse>>}
     */
    actionUser(request: ActionRequest): Promise<ClientResponse<ActionResponse>>;
    /**
     * Activates the FusionAuth Reactor using a license Id and optionally a license text (for air-gapped deployments)
     *
     * @param {ReactorRequest} request An optional request that contains the license text to activate Reactor (useful for air-gap deployments of FusionAuth).
     * @returns {Promise<ClientResponse<void>>}
     */
    activateReactor(request: ReactorRequest): Promise<ClientResponse<void>>;
    /**
     * 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 the information used to determine which user to add to the family.
     * @returns {Promise<ClientResponse<FamilyResponse>>}
     */
    addUserToFamily(familyId: UUID, request: FamilyRequest): Promise<ClientResponse<FamilyResponse>>;
    /**
     * Approve a device grant.
     *
     * @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate.
     * @param {string} client_secret (Optional) The client secret. This value will be required if client authentication is enabled.
     * @param {string} token The access token used to identify the user.
     * @param {string} user_code The end-user verification code.
     * @returns {Promise<ClientResponse<DeviceApprovalResponse>>}
     */
    approveDevice(client_id: string, client_secret: string, token: string, user_code: string): Promise<ClientResponse<DeviceApprovalResponse>>;
    /**
     * Approve a device grant.
     *
     * @param {DeviceApprovalRequest} request The request object containing the device approval information and optional tenantId.
     * @returns {Promise<ClientResponse<DeviceApprovalResponse>>}
     */
    approveDeviceWithRequest(request: DeviceApprovalRequest): Promise<ClientResponse<DeviceApprovalResponse>>;
    /**
     * Cancels the user action.
     *
     * @param {UUID} actionId The action Id of the action to cancel.
     * @param {ActionRequest} request The action request that contains the information about the cancellation.
     * @returns {Promise<ClientResponse<ActionResponse>>}
     */
    cancelAction(actionId: UUID, request: ActionRequest): Promise<ClientResponse<ActionResponse>>;
    /**
     * 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 the information used to change the password.
     * @returns {Promise<ClientResponse<ChangePasswordResponse>>}
     */
    changePassword(changePasswordId: string, request: ChangePasswordRequest): Promise<ClientResponse<ChangePasswordResponse>>;
    /**
     * Changes a user's password using their access token (JWT) instead of the changePasswordId
     * A common use case for this method will be if you want to allow the user to change their own password.
     *
     * Remember to send refreshToken in the request body if you want to get a new refresh token when login using the returned oneTimePassword.
     *
     * @param {string} encodedJWT The encoded JWT (access token).
     * @param {ChangePasswordRequest} request The change password request that contains all the information used to change the password.
     * @returns {Promise<ClientResponse<ChangePasswordResponse>>}
     *
     * @deprecated This method has been renamed to changePasswordUsingJWT, use that method instead.
     */
    changePasswordByJWT(encodedJWT: string, request: ChangePasswordRequest): Promise<ClientResponse<ChangePasswordResponse>>;
    /**
     * Changes a user's password using their identity (loginId and password). Using a loginId instead of the changePasswordId
     * bypasses the email verification and allows a password to be changed directly without first calling the #forgotPassword
     * method.
     *
     * @param {ChangePasswordRequest} request The change password request that contains all the information used to change the password.
     * @returns {Promise<ClientResponse<void>>}
     */
    changePasswordByIdentity(request: ChangePasswordRequest): Promise<ClientResponse<void>>;
    /**
     * Changes a user's password using their access token (JWT) instead of the changePasswordId
     * A common use case for this method will be if you want to allow the user to change their own password.
     *
     * Remember to send refreshToken in the request body if you want to get a new refresh token when login using the returned oneTimePassword.
     *
     * @param {string} encodedJWT The encoded JWT (access token).
     * @param {ChangePasswordRequest} request The change password request that contains all the information used to change the password.
     * @returns {Promise<ClientResponse<ChangePasswordResponse>>}
     */
    changePasswordUsingJWT(encodedJWT: string, request: ChangePasswordRequest): Promise<ClientResponse<ChangePasswordResponse>>;
    /**
     * 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 Trust Token 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} 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: string): Promise<ClientResponse<void>>;
    /**
     * 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 Trust Token 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} 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 {string} ipAddress (Optional) IP address of the user changing their password. This is used for MFA risk assessment.
     * @returns {Promise<ClientResponse<void>>}
     */
    checkChangePasswordUsingIdAndIPAddress(changePasswordId: string, ipAddress: string): Promise<ClientResponse<void>>;
    /**
     * 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 Trust Token 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} encodedJWT The encoded JWT (access token).
     * @returns {Promise<ClientResponse<void>>}
     */
    checkChangePasswordUsingJWT(encodedJWT: string): Promise<ClientResponse<void>>;
    /**
     * 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 Trust Token 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} encodedJWT The encoded JWT (access token).
     * @param {string} ipAddress (Optional) IP address of the user changing their password. This is used for MFA risk assessment.
     * @returns {Promise<ClientResponse<void>>}
     */
    checkChangePasswordUsingJWTAndIPAddress(encodedJWT: string, ipAddress: 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 (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 (email or username) of the User that you intend to change the password for.
     * @param {string} ipAddress (Optional) IP address of the user changing their password. This is used for MFA risk assessment.
     * @returns {Promise<ClientResponse<void>>}
     */
    checkChangePasswordUsingLoginIdAndIPAddress(loginId: string, ipAddress: 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>>;
    /**
     * 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.
     * @param {string} ipAddress (Optional) IP address of the user changing their password. This is used for MFA risk assessment.
     * @returns {Promise<ClientResponse<void>>}
     */
    checkChangePasswordUsingLoginIdAndLoginIdTypesAndIPAddress(loginId: string, loginIdTypes: Array<String>, ipAddress: string): Promise<ClientResponse<void>>;
    /**
     * Make a Client Credentials grant request to obtain an access token.
     *
     * @param {string} client_id (Optional) The client identifier. The client Id is the Id of the FusionAuth Entity in which you are attempting to authenticate.
     *    This parameter is optional when Basic Authorization is used to authenticate this request.
     * @param {string} client_secret (Optional) The client secret used to authenticate this request.
     *    This parameter is optional when Basic Authorization is used to authenticate this request.
     * @param {string} scope (Optional) This parameter is used to indicate which target entity you are requesting access. To request access to an entity, use the format target-entity:&lt;target-entity-id&gt;:&lt;roles&gt;. Roles are an optional comma separated list.
     * @returns {Promise<ClientResponse<AccessToken>>}
     */
    clientCredentialsGrant(client_id: string, client_secret: string, scope: string): Promise<ClientResponse<AccessToken>>;
    /**
     * Make a Client Credentials grant request to obtain an access token.
     *
     * @param {ClientCredentialsGrantRequest} request The client credentials grant request containing client authentication, scope and optional tenantId.
     * @returns {Promise<ClientResponse<AccessToken>>}
     */
    clientCredentialsGrantWithRequest(request: ClientCredentialsGrantRequest): Promise<ClientResponse<AccessToken>>;
    /**
     * Adds a comment to the user's account.
     *
     * @param {UserCommentRequest} request The request object that contains all the information used to create the user comment.
     * @returns {Promise<ClientResponse<UserCommentResponse>>}
     */
    commentOnUser(request: UserCommentRequest): Promise<ClientResponse<UserCommentResponse>>;
    /**
     * 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: VerifyCompleteRequest): Promise<ClientResponse<VerifyCompleteResponse>>;
    /**
     * Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge without logging the user in
     *
     * @param {WebAuthnLoginRequest} request An object containing data necessary for completing the authentication ceremony
     * @returns {Promise<ClientResponse<WebAuthnAssertResponse>>}
     */
    completeWebAuthnAssertion(request: WebAuthnLoginRequest): Promise<ClientResponse<WebAuthnAssertResponse>>;
    /**
     * Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge and then login the user in
     *
     * @param {WebAuthnLoginRequest} request An object containing data necessary for completing the authentication ceremony
     * @returns {Promise<ClientResponse<LoginResponse>>}
     */
    completeWebAuthnLogin(request: WebAuthnLoginRequest): Promise<ClientResponse<LoginResponse>>;
    /**
     * Complete a WebAuthn registration ceremony by validating the client request and saving the new credential
     *
     * @param {WebAuthnRegisterCompleteRequest} request An object containing data necessary for completing the registration ceremony
     * @returns {Promise<ClientResponse<WebAuthnRegisterCompleteResponse>>}
     */
    completeWebAuthnRegistration(request: WebAuthnRegisterCompleteRequest): Promise<ClientResponse<WebAuthnRegisterCompleteResponse>>;
    /**
     * Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated.
     * an API key can only be created with equal or lesser authority. An API key cannot create another API key unless it is granted
     * to that API key.
     *
     * If an API key is locked to a tenant, it can only create API Keys for that same tenant.
     *
     * @param {UUID} keyId (Optional) The unique Id of the API key. If not provided a secure random Id will be generated.
     * @param {APIKeyRequest} request The request object that contains all the information needed to create the APIKey.
     * @returns {Promise<ClientResponse<APIKeyResponse>>}
     */
    createAPIKey(keyId: UUID, request: APIKeyRequest): Promise<ClientResponse<APIKeyResponse>>;
    /**
     * 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 the information used to create the application.
     * @returns {Promise<ClientResponse<ApplicationResponse>>}
     */
    createApplication(applicationId: UUID, request: ApplicationRequest): Promise<ClientResponse<ApplicationResponse>>;
    /**
     * Creates a new role for an application. You must specify the Id of the application you are creating the role for.
     * You can optionally specify an Id for the role inside the ApplicationRole object itself, if not provided one will be generated.
     *
     * @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 the information used to create the application role.
     * @returns {Promise<ClientResponse<ApplicationResponse>>}
     */
    createApplicationRole(applicationId: UUID, roleId: UUID, request: ApplicationRequest): Promise<ClientResponse<ApplicationResponse>>;
    /**
     * Creates an audit log with the message and user name (usually an email). Audit logs should be written anytime you
     * 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 the information used to create the audit log entry.
     * @returns {Promise<ClientResponse<AuditLogResponse>>}
     */
    createAuditLog(request: AuditLogRequest): Promise<ClientResponse<AuditLogResponse>>;
    /**
     * 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 the information used to create the connector.
     * @returns {Promise<ClientResponse<ConnectorResponse>>}
     */
    createConnector(connectorId: UUID, request: ConnectorRequest): Promise<ClientResponse<ConnectorResponse>>;
    /**
     * 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 the information used to create the consent.
     * @returns {Promise<ClientResponse<ConsentResponse>>}
     */
    createConsent(consentId: UUID, request: ConsentRequest): Promise<ClientResponse<ConsentResponse>>;
    /**
     * 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 the information used to create the email template.
     * @returns {Promise<ClientResponse<EmailTemplateResponse>>}
     */
    createEmailTemplate(emailTemplateId: UUID, request: EmailTemplateRequest): Promise<ClientResponse<EmailTemplateResponse>>;
    /**
     * 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 the information used to create the Entity.
     * @returns {Promise<ClientResponse<EntityResponse>>}
     */
    createEntity(entityId: UUID, request: EntityRequest): Promise<ClientResponse<EntityResponse>>;
    /**
     * 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 the information used to create the Entity Type.
     * @returns {Promise<ClientResponse<EntityTypeResponse>>}
     */
    createEntityType(entityTypeId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
    /**
     * Creates a new permission for an entity type. You must specify the Id of the entity type you are creating the permission for.
     * You can optionally specify an Id for the permission inside the EntityTypePermission object itself, if not provided one will be generated.
     *
     * @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 the information used to create the permission.
     * @returns {Promise<ClientResponse<EntityTypeResponse>>}
     */
    createEntityTypePermission(entityTypeId: UUID, permissionId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
    /**
     * Creates a family with the user Id in the request as the owner and sole member of the family. You can optionally specify an Id for the
     * 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 the information used to create the family.
     * @returns {Promise<ClientResponse<FamilyResponse>>}
     */
    createFamily(familyId: UUID, request: FamilyRequest): Promise<ClientResponse<FamilyResponse>>;
    /**
     * 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 the information used to create the form.
     * @returns {Promise<ClientResponse<FormResponse>>}
     */
    createForm(formId: UUID, request: FormRequest): Promise<ClientResponse<FormResponse>>;
    /**
     * 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 the information used to create the form field.
     * @returns {Promise<ClientResponse<FormFieldResponse>>}
     */
    createFormField(fieldId: UUID, request: FormFieldRequest): Promise<ClientResponse<FormFieldResponse>>;
    /**
     * 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 the information used to create the group.
     * @returns {Promise<ClientResponse<GroupResponse>>}
     */
    createGroup(groupId: UUID, request: GroupRequest): Promise<ClientResponse<GroupResponse>>;
    /**
     * 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>>}
     */
    createGroupMembers(request: MemberRequest): Promise<ClientResponse<MemberResponse>>;
    /**
     * 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 the information used to create the IP Access Control List.
     * @returns {Promise<ClientResponse<IPAccessControlListResponse>>}
     */
    createIPAccessControlList(accessControlListId: UUID, request: IPAccessControlListRequest): Promise<ClientResponse<IPAccessControlListResponse>>;
    /**
     * 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 the information used to create the identity provider.
     * @returns {Promise<ClientResponse<IdentityProviderResponse>>}
     */
    createIdentityProvider(identityProviderId: UUID, request: IdentityProviderRequest): Promise<ClientResponse<IdentityProviderResponse>>;
    /**
     * 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 the information used to create the lambda.
     * @returns {Promise<ClientResponse<LambdaResponse>>}
     */
    createLambda(lambdaId: UUID, request: LambdaRequest): Promise<ClientResponse<LambdaResponse>>;
    /**
     * 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 the information used to create the message template.
     * @returns {Promise<ClientResponse<MessageTemplateResponse>>}
     */
    createMessageTemplate(messageTemplateId: UUID, request: MessageTemplateRequest): Promise<ClientResponse<MessageTemplateResponse>>;
    /**
     * 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 the information used to create the messenger.
     * @returns {Promise<ClientResponse<MessengerResponse>>}
     */
    createMessenger(messengerId: UUID, request: MessengerRequest): Promise<ClientResponse<MessengerResponse>>;
    /**
     * Creates a new custom OAuth scope for an application. You must specify the Id of the application you are creating the scope for.
     * You can optionally specify an Id for the OAuth scope on the URL, if not provided one will be generated.
     *
     * @param {UUID} applicationId The Id of the application to create the OAuth scope on.
     * @param {UUID} scopeId (Optional) The Id of the OAuth scope. If not provided a secure random UUID will be generated.
     * @param {ApplicationOAuthScopeRequest} request The request object that contains all the information used to create the OAuth OAuth scope.
     * @returns {Promise<ClientResponse<ApplicationOAuthScopeResponse>>}
     */
    createOAuthScope(applicationId: UUID, scopeId: UUID, request: ApplicationOAuthScopeRequest): Promise<ClientResponse<ApplicationOAuthScopeResponse>>;
    /**
     * 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 the information used to create the tenant.
     * @returns {Promise<ClientResponse<TenantResponse>>}
     */
    createTenant(tenantId: UUID, request: TenantRequest): Promise<ClientResponse<TenantResponse>>;
    /**
     * Creates a tenant manager identity provider type configuration for the given identity provider type.
     *
     * @param {IdentityProviderType} type The type of the identity provider.
     * @param {TenantManagerIdentityProviderTypeConfigurationRequest} request The request object that contains all the information used to create the tenant manager identity provider type configuration.
     * @returns {Promise<ClientResponse<TenantManagerIdentityProviderTypeConfigurationResponse>>}
     */
    createTenantManagerIdentityProviderTypeConfiguration(type: IdentityProviderType, request: TenantManagerIdentityProviderTypeConfigurationRequest): Promise<ClientResponse<TenantManagerIdentityProviderTypeConfigurationResponse>>;
    /**
     * 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 the information used to create the theme.
     * @returns {Promise<ClientResponse<ThemeResponse>>}
     */
    createTheme(themeId: UUID, request: ThemeRequest): Promise<ClientResponse<ThemeResponse>>;
    /**
     * 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 the information used to create the user.
     * @returns {Promise<ClientResponse<UserResponse>>}
     */
    createUser(userId: UUID, request: UserRequest): Promise<ClientResponse<UserResponse>>;
    /**
     * Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after
     * 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 the information used to create the user action.
     * @returns {Promise<ClientResponse<UserActionResponse>>}
     */
    createUserAction(userActionId: UUID, request: UserActionRequest): Promise<ClientResponse<UserActionResponse>>;
    /**
     * Creates a user reason. This user action reason cannot be used when actioning a user until this call completes
     * 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 the information used to create the user action reason.
     * @returns {Promise<ClientResponse<UserActionReasonResponse>>}
     */
    createUserActionReason(userActionReasonId: UUID, request: UserActionReasonRequest): Promise<ClientResponse<UserActionReasonResponse>>;
    /**
     * Creates a single User consent.
     *
     * @param {UUID} userConsentId (Optional) The Id for the User consent. If not provided a secure random UUID will be generated.
     * @param {UserConsentRequest} request The request that contains the user consent information.
     * @returns {Promise<ClientResponse<UserConsentResponse>>}
     */
    createUserConsent(userConsentId: UUID, request: UserConsentRequest): Promise<ClientResponse<UserConsentResponse>>;
    /**
     * Link an external user from a 3rd party identity provider to a 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: IdentityProviderLinkRequest): Promise<ClientResponse<IdentityProviderLinkResponse>>;
    /**
     * 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 the information used to create the webhook.
     * @returns {Promise<ClientResponse<WebhookResponse>>}
     */
    createWebhook(webhookId: UUID, request: WebhookRequest): Promise<ClientResponse<WebhookResponse>>;
    /**
     * Deactivates the application with the given Id.
     *
     * @param {UUID} applicationId The Id of the application to deactivate.
     * @returns {Promise<ClientResponse<void>>}
     */
    deactivateApplication(applicationId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deactivates the FusionAuth Reactor.
     *
     * @returns {Promise<ClientResponse<void>>}
     */
    deactivateReactor(): Promise<ClientResponse<void>>;
    /**
     * Deactivates the user with the given Id.
     *
     * @param {UUID} userId The Id of the user to deactivate.
     * @returns {Promise<ClientResponse<void>>}
     */
    deactivateUser(userId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deactivates the user action with the given Id.
     *
     * @param {UUID} userActionId The Id of the user action to deactivate.
     * @returns {Promise<ClientResponse<void>>}
     */
    deactivateUserAction(userActionId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deactivates the users with the given Ids.
     *
     * @param {Array<string>} userIds The ids of the users to deactivate.
     * @returns {Promise<ClientResponse<UserDeleteResponse>>}
     *
     * @deprecated This method has been renamed to deactivateUsersByIds, use that method instead.
     */
    deactivateUsers(userIds: Array<string>): Promise<ClientResponse<UserDeleteResponse>>;
    /**
     * Deactivates the users with the given Ids.
     *
     * @param {Array<string>} userIds The ids of the users to deactivate.
     * @returns {Promise<ClientResponse<UserDeleteResponse>>}
     */
    deactivateUsersByIds(userIds: Array<string>): Promise<ClientResponse<UserDeleteResponse>>;
    /**
     * Deletes the API key for the given Id.
     *
     * @param {UUID} keyId The Id of the authentication API key to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteAPIKey(keyId: UUID): Promise<ClientResponse<void>>;
    /**
     * Hard deletes an application. This is a dangerous operation and should not be used in most circumstances. This will
     * delete the application, any registrations for that application, metrics and reports for the application, all the
     * roles for the application, and any other data associated with the application. This operation could take a very
     * long time, depending on the amount of data in your database.
     *
     * @param {UUID} applicationId The Id of the application to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteApplication(applicationId: UUID): Promise<ClientResponse<void>>;
    /**
     * Hard deletes an application role. This is a dangerous operation and should not be used in most circumstances. This
     * permanently removes the given role from all users that had it.
     *
     * @param {UUID} applicationId The Id of the application that the role belongs to.
     * @param {UUID} roleId The Id of the role to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteApplicationRole(applicationId: UUID, roleId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the connector for the given Id.
     *
     * @param {UUID} connectorId The Id of the connector to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteConnector(connectorId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the consent for the given Id.
     *
     * @param {UUID} consentId The Id of the consent to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteConsent(consentId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the email template for the given Id.
     *
     * @param {UUID} emailTemplateId The Id of the email template to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteEmailTemplate(emailTemplateId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the Entity for the given Id.
     *
     * @param {UUID} entityId The Id of the Entity to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteEntity(entityId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes an Entity Grant for the given User or Entity.
     *
     * @param {UUID} entityId The Id of the Entity that the Entity Grant is being deleted for.
     * @param {UUID} recipientEntityId (Optional) The Id of the Entity that the Entity Grant is for.
     * @param {UUID} userId (Optional) The Id of the User that the Entity Grant is for.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteEntityGrant(entityId: UUID, recipientEntityId: UUID, userId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the Entity Type for the given Id.
     *
     * @param {UUID} entityTypeId The Id of the Entity Type to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteEntityType(entityTypeId: UUID): Promise<ClientResponse<void>>;
    /**
     * Hard deletes a permission. This is a dangerous operation and should not be used in most circumstances. This
     * permanently removes the given permission from all grants that had it.
     *
     * @param {UUID} entityTypeId The Id of the entityType the the permission belongs to.
     * @param {UUID} permissionId The Id of the permission to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteEntityTypePermission(entityTypeId: UUID, permissionId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the form for the given Id.
     *
     * @param {UUID} formId The Id of the form to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteForm(formId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the form field for the given Id.
     *
     * @param {UUID} fieldId The Id of the form field to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteFormField(fieldId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the group for the given Id.
     *
     * @param {UUID} groupId The Id of the group to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteGroup(groupId: UUID): Promise<ClientResponse<void>>;
    /**
     * Removes users as members of a group.
     *
     * @param {MemberDeleteRequest} request The member request that contains all the information used to remove members to the group.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteGroupMembers(request: MemberDeleteRequest): Promise<ClientResponse<void>>;
    /**
     * 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: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the identity provider for the given Id.
     *
     * @param {UUID} identityProviderId The Id of the identity provider to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteIdentityProvider(identityProviderId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the key for the given Id.
     *
     * @param {UUID} keyId The Id of the key to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteKey(keyId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the lambda for the given Id.
     *
     * @param {UUID} lambdaId The Id of the lambda to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteLambda(lambdaId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the message template for the given Id.
     *
     * @param {UUID} messageTemplateId The Id of the message template to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteMessageTemplate(messageTemplateId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the messenger for the given Id.
     *
     * @param {UUID} messengerId The Id of the messenger to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteMessenger(messengerId: UUID): Promise<ClientResponse<void>>;
    /**
     * Hard deletes a custom OAuth scope.
     * OAuth workflows that are still requesting the deleted OAuth scope may fail depending on the application's unknown scope policy.
     *
     * @param {UUID} applicationId The Id of the application that the OAuth scope belongs to.
     * @param {UUID} scopeId The Id of the OAuth scope to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteOAuthScope(applicationId: UUID, scopeId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the user registration for the given user and application.
     *
     * @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.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteRegistration(userId: UUID, applicationId: UUID): Promise<ClientResponse<void>>;
    /**
     * 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: UUID, applicationId: UUID, request: RegistrationDeleteRequest): Promise<ClientResponse<void>>;
    /**
     * 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>>}
     */
    deleteTenant(tenantId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the tenant for the given Id asynchronously.
     * This method is helpful if you do not want to wait for the delete operation to complete.
     *
     * @param {UUID} tenantId The Id of the tenant to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteTenantAsync(tenantId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the tenant manager identity provider type configuration for the given identity provider type.
     *
     * @param {IdentityProviderType} type The type of the identity provider.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteTenantManagerIdentityProviderTypeConfiguration(type: IdentityProviderType): Promise<ClientResponse<void>>;
    /**
     * 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 the information used to delete the user.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteTenantWithRequest(tenantId: UUID, request: TenantDeleteRequest): Promise<ClientResponse<void>>;
    /**
     * Deletes the theme for the given Id.
     *
     * @param {UUID} themeId The Id of the theme to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteTheme(themeId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the user for the given Id. This permanently deletes all information, metrics, reports and data associated
     * with the user.
     *
     * @param {UUID} userId The Id of the user to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteUser(userId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the user action for the given Id. This permanently deletes the user action and also any history and logs of
     * the action being applied to any users.
     *
     * @param {UUID} userActionId The Id of the user action to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteUserAction(userActionId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the user action reason for the given Id.
     *
     * @param {UUID} userActionReasonId The Id of the user action reason to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteUserActionReason(userActionReasonId: UUID): Promise<ClientResponse<void>>;
    /**
     * Remove an existing link that has been made from a 3rd party identity provider to a FusionAuth user.
     *
     * @param {UUID} identityProviderId The unique Id of the identity provider.
     * @param {string} identityProviderUserId The unique Id of the user in the 3rd party identity provider to unlink.
     * @param {UUID} userId The unique Id of the FusionAuth user to unlink.
     * @returns {Promise<ClientResponse<IdentityProviderLinkResponse>>}
     */
    deleteUserLink(identityProviderId: UUID, identityProviderUserId: string, userId: UUID): Promise<ClientResponse<IdentityProviderLinkResponse>>;
    /**
     * 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 the information used to delete the user.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteUserWithRequest(userId: UUID, request: UserDeleteSingleRequest): Promise<ClientResponse<void>>;
    /**
     * 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.
     *
     * This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body.
     * Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.
     *
     * @param {UserDeleteRequest} request The UserDeleteRequest.
     * @returns {Promise<ClientResponse<UserDeleteResponse>>}
     *
     * @deprecated This method has been renamed to deleteUsersByQuery, use that method instead.
     */
    deleteUsers(request: UserDeleteRequest): Promise<ClientResponse<UserDeleteResponse>>;
    /**
     * 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.
     *
     * This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body.
     * Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.
     *
     * @param {UserDeleteRequest} request The UserDeleteRequest.
     * @returns {Promise<ClientResponse<UserDeleteResponse>>}
     */
    deleteUsersByQuery(request: UserDeleteRequest): Promise<ClientResponse<UserDeleteResponse>>;
    /**
     * Deletes the WebAuthn credential for the given Id.
     *
     * @param {UUID} id The Id of the WebAuthn credential to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteWebAuthnCredential(id: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes all of the WebAuthn credentials for the given User Id.
     *
     * @param {UUID} userId The unique Id of the User to delete WebAuthn passkeys for.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteWebAuthnCredentialsForUser(userId: UUID): Promise<ClientResponse<void>>;
    /**
     * Deletes the webhook for the given Id.
     *
     * @param {UUID} webhookId The Id of the webhook to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    deleteWebhook(webhookId: UUID): Promise<ClientResponse<void>>;
    /**
     * Start the Device Authorization flow using form-encoded parameters
     *
     * @param {string} client_id The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate.
     * @param {string} client_secret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
     * @param {string} scope (Optional) A space-delimited string of the requested scopes. Defaults to all scopes configured in the Application's OAuth configuration.
     * @returns {Promise<ClientResponse<DeviceResponse>>}
     */
    deviceAuthorize(client_id: string, client_secret: string, scope: string): Promise<ClientResponse<DeviceResponse>>;
    /**
     * Start the Device Authorization flow using a request body
     *
     * @param {DeviceAuthorizationRequest} request The device authorization request containing client authentication, scope, and optional device metadata.
     * @returns {Promise<ClientResponse<DeviceResponse>>}
     */
    deviceAuthorizeWithRequest(request: DeviceAuthorizationRequest): Promise<ClientResponse<DeviceResponse>>;
    /**
     * Disable two-factor authentication for a user.
     *
     * @param {UUID} userId The Id of the User for which you're disabling two-factor authentication.
     * @param {string} methodId The two-factor method identifier you wish to disable
     * @param {string} code The two-factor code used verify the the caller knows the two-factor secret.
     * @returns {Promise<ClientResponse<void>>}
     */
    disableTwoFactor(userId: UUID, methodId: string, code: string): Promise<ClientResponse<void>>;
    /**
     * 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: UUID, request: TwoFactorDisableRequest): Promise<ClientResponse<void>>;
    /**
     * Enable two-factor authentication for a user.
     *
     * @param {UUID} userId The Id of the user to enable two-factor authentication.
     * @param {TwoFactorRequest} request The two-factor enable request information.
     * @returns {Promise<ClientResponse<TwoFactorResponse>>}
     */
    enableTwoFactor(userId: UUID, request: TwoFactorRequest): Promise<ClientResponse<TwoFactorResponse>>;
    /**
     * Exchanges an OAuth authorization code for an access token.
     * Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token.
     *
     * @param {string} code The authorization code returned on the /oauth2/authorize response.
     * @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate.
     *    This parameter is optional when Basic Authorization is used to authenticate this request.
     * @param {string} client_secret (Optional) The client secret. This value will be required if client authentication is enabled.
     * @param {string} redirect_uri The URI to redirect to upon a successful request.
     * @returns {Promise<ClientResponse<AccessToken>>}
     */
    exchangeOAuthCodeForAccessToken(code: string, client_id: string, client_secret: string, redirect_uri: string): Promise<ClientResponse<AccessToken>>;
    /**
     * Exchanges an OAuth authorization code and code_verifier for an access token.
     * Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint and a code_verifier for an access token.
     *
     * @param {string} code The authorization code returned on the /oauth2/authorize response.
     * @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
     *    This parameter is optional when Basic Authorization is used to authenticate this request.
     * @param {string} client_secret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
     * @param {string} redirect_uri The URI to redirect to upon a successful request.
     * @param {string} code_verifier The random string generated previously. Will be compared with the code_challenge sent previously, which allows the OAuth provider to authenticate your app.
     * @returns {Promise<ClientResponse<AccessToken>>}
     */
    exchangeOAuthCodeForAccessTokenUsingPKCE(code: string, client_id: string, client_secret: string, redirect_uri: string, code_verifier: string): Promise<ClientResponse<AccessToken>>;
    /**
     * Exchanges an OAuth authorization code and code_verifier for an access token.
     * Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint and a code_verifier for an access token.
     *
     * @param {OAuthCodePKCEAccessTokenRequest} request The PKCE OAuth code access token exchange request.
     * @returns {Promise<ClientResponse<AccessToken>>}
     */
    exchangeOAuthCodeForAccessTokenUsingPKCEWithRequest(request: OAuthCodePKCEAccessTokenRequest): Promise<ClientResponse<AccessToken>>;
    /**
     * Exchanges an OAuth authorization code for an access token.
     * Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token.
     *
     * @param {OAuthCodeAccessTokenRequest} request The OAuth code access token exchange request.
     * @returns {Promise<ClientResponse<AccessToken>>}
     */
    exchangeOAuthCodeForAccessTokenWithRequest(request: OAuthCodeAccessTokenRequest): Promise<ClientResponse<AccessToken>>;
    /**
     * Exchange a Refresh Token for an Access Token.
     * If you will be using the Refresh Token Grant, you will make a request to the Token endpoint to exchange the user’s refresh token for an access token.
     *
     * @param {string} refresh_token The refresh token that you would like to use to exchange for an access token.
     * @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
     *    This parameter is optional when Basic Authorization is used to authenticate this request.
     * @param {string} client_secret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
     * @param {string} scope (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.
     * @param {string} user_code (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.
     * @returns {Promise<ClientResponse<AccessToken>>}
     */
    exchangeRefreshTokenForAccessToken(refresh_token: string, client_id: string, client_secret: string, scope: string, user_code: string): Promise<ClientResponse<AccessToken>>;
    /**
     * Exchange a Refresh Token for an Access Token.
     * If you will be using the Refresh Token Grant, you will make a request to the Token endpoint to exchange the user’s refresh token for an access token.
     *
     * @param {RefreshTokenAccessTokenRequest} request The refresh token access token exchange request.
     * @returns {Promise<ClientResponse<AccessToken>>}
     */
    exchangeRefreshTokenForAccessTokenWithRequest(request: RefreshTokenAccessTokenRequest): Promise<ClientResponse<AccessToken>>;
    /**
     * Exchange a refresh token for a new JWT.
     *
     * @param {RefreshRequest} request The refresh request.
     * @returns {Promise<ClientResponse<JWTRefreshResponse>>}
     */
    exchangeRefreshTokenForJWT(request: RefreshRequest): Promise<ClientResponse<JWTRefreshResponse>>;
    /**
     * Exchange User Credentials for a Token.
     * If you will be using the Resource Owner Password Credential Grant, you will make a request to the Token endpoint to exchange the user’s email and password for an access token.
     *
     * @param {string} username The login identifier of the user. The login identifier can be either the email or the username.
     * @param {string} password The user’s password.
     * @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
     *    This parameter is optional when Basic Authorization is used to authenticate this request.
     * @param {string} client_secret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
     * @param {string} scope (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.
     * @param {string} user_code (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.
     * @returns {Promise<ClientResponse<AccessToken>>}
     */
    exchangeUserCredentialsForAccessToken(username: string, password: string, client_id: string, client_secret: string, scope: string, user_code: string): Promise<ClientResponse<AccessToken>>;
    /**
     * Exchange User Credentials for a Token.
     * If you will be using the Resource Owner Password Credential Grant, you will make a request to the Token endpoint to exchange the user’s email and password for an access token.
     *
     * @param {UserCredentialsAccessTokenRequest} request The user credentials access token exchange request.
     * @returns {Promise<ClientResponse<AccessToken>>}
     */
    exchangeUserCredentialsForAccessTokenWithRequest(request: UserCredentialsAccessTokenRequest): Promise<ClientResponse<AccessToken>>;
    /**
     * Begins the forgot password sequence, which kicks off an email to the user so that they can reset their password.
     *
     * @param {ForgotPasswordRequest} request The request that contains the information about the user so that they can be emailed.
     * @returns {Promise<ClientResponse<ForgotPasswordResponse>>}
     */
    forgotPassword(request: ForgotPasswordRequest): Promise<ClientResponse<ForgotPasswordResponse>>;
    /**
     * Generate a new Email Verification Id to be used with the Verify Email API. This API will not attempt to send an
     * email to the User. This API may be used to collect the verificationId for use with a third party system.
     *
     * @param {string} email The email address of the user that needs a new verification email.
     * @returns {Promise<ClientResponse<VerifyEmailResponse>>}
     */
    generateEmailVerificationId(email: string): Promise<ClientResponse<VerifyEmailResponse>>;
    /**
     * 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 the information used to create the key.
     * @returns {Promise<ClientResponse<KeyResponse>>}
     */
    generateKey(keyId: UUID, request: KeyRequest): Promise<ClientResponse<KeyResponse>>;
    /**
     * Generate a new Application Registration Verification Id to be used with the Verify Registration API. This API will not attempt to send an
     * email to the User. This API may be used to collect the verificationId for use with a third party system.
     *
     * @param {string} email The email address of the user that needs a new verification email.
     * @param {UUID} applicationId The Id of the application to be verified.
     * @returns {Promise<ClientResponse<VerifyRegistrationResponse>>}
     */
    generateRegistrationVerificationId(email: string, applicationId: UUID): Promise<ClientResponse<VerifyRegistrationResponse>>;
    /**
     * Generate two-factor recovery codes for a user. Generating two-factor recovery codes will invalidate any existing recovery codes.
     *
     * @param {UUID} userId The Id of the user to generate new Two Factor recovery codes.
     * @returns {Promise<ClientResponse<TwoFactorRecoveryCodeResponse>>}
     */
    generateTwoFactorRecoveryCodes(userId: UUID): Promise<ClientResponse<TwoFactorRecoveryCodeResponse>>;
    /**
     * Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain
     * both the secret and a Base32 encoded form of the secret which can be shown to a User when using a 2 Step Authentication
     * application such as Google Authenticator.
     *
     * @returns {Promise<ClientResponse<SecretResponse>>}
     */
    generateTwoFactorSecret(): Promise<ClientResponse<SecretResponse>>;
    /**
     * Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain
     * both the secret and a Base32 encoded form of the secret which can be shown to a User when using a 2 Step Authentication
     * application such as Google Authenticator.
     *
     * @param {string} encodedJWT The encoded JWT (access token).
     * @returns {Promise<ClientResponse<SecretResponse>>}
     */
    generateTwoFactorSecretUsingJWT(encodedJWT: string): Promise<ClientResponse<SecretResponse>>;
    /**
     * Handles login via third-parties including Social login, external OAuth and OpenID Connect, and other
     * login systems.
     *
     * @param {IdentityProviderLoginRequest} request The third-party login request that contains information from the third-party login
     *    providers that FusionAuth uses to reconcile the user's account.
     * @returns {Promise<ClientResponse<LoginResponse>>}
     */
    identityProviderLogin(request: IdentityProviderLoginRequest): Promise<ClientResponse<LoginResponse>>;
    /**
     * 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 the information used to create the key.
     * @returns {Promise<ClientResponse<KeyResponse>>}
     */
    importKey(keyId: UUID, request: KeyRequest): Promise<ClientResponse<KeyResponse>>;
    /**
     * Bulk imports refresh tokens. This request performs minimal validation and runs batch inserts of refresh tokens with the
     * expectation that each token represents a user that already exists and is registered for the corresponding FusionAuth
     * Application. This is done to increases the insert performance.
     *
     * Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic
     * explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response
     * body with specific validation errors. This will slow the request down but will allow you to identify the cause of
     * the failure. See the validateDbConstraints request parameter.
     *
     * @param {RefreshTokenImportRequest} request The request that contains all the information about all the refresh tokens to import.
     * @returns {Promise<ClientResponse<void>>}
     */
    importRefreshTokens(request: RefreshTokenImportRequest): Promise<ClientResponse<void>>;
    /**
     * Bulk imports users. This request performs minimal validation and runs batch inserts of users with the expectation
     * that each user does not yet exist and each registration corresponds to an existing FusionAuth Application. This is done to
     * increases the insert performance.
     *
     * Therefore, if you encounter an error due to a database key violation, the response will likely offer
     * a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response
     * body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See
     * the validateDbConstraints request parameter.
     *
     * @param {ImportRequest} request The request that contains all the information about all the users to import.
     * @returns {Promise<ClientResponse<void>>}
     */
    importUsers(request: ImportRequest): Promise<ClientResponse<void>>;
    /**
     * Import a WebAuthn credential
     *
     * @param {WebAuthnCredentialImportRequest} request An object containing data necessary for importing the credential
     * @returns {Promise<ClientResponse<void>>}
     */
    importWebAuthnCredential(request: WebAuthnCredentialImportRequest): Promise<ClientResponse<void>>;
    /**
     * Inspect an access token issued as the result of the User based grant such as the Authorization Code Grant, Implicit Grant, the User Credentials Grant or the Refresh Grant.
     *
     * @param {string} client_id The unique client identifier. The client Id is the Id of the FusionAuth Application for which this token was generated.
     * @param {string} token The access token returned by this OAuth provider as the result of a successful client credentials grant.
     * @returns {Promise<ClientResponse<IntrospectResponse>>}
     */
    introspectAccessToken(client_id: string, token: string): Promise<ClientResponse<IntrospectResponse>>;
    /**
     * Inspect an access token issued as the result of the User based grant such as the Authorization Code Grant, Implicit Grant, the User Credentials Grant or the Refresh Grant.
     *
     * @param {AccessTokenIntrospectRequest} request The access token introspection request.
     * @returns {Promise<ClientResponse<IntrospectResponse>>}
     */
    introspectAccessTokenWithRequest(request: AccessTokenIntrospectRequest): Promise<ClientResponse<IntrospectResponse>>;
    /**
     * Inspect an access token issued as the result of the Client Credentials Grant.
     *
     * @param {string} token The access token returned by this OAuth provider as the result of a successful client credentials grant.
     * @returns {Promise<ClientResponse<IntrospectResponse>>}
     */
    introspectClientCredentialsAccessToken(token: string): Promise<ClientResponse<IntrospectResponse>>;
    /**
     * Inspect an access token issued as the result of the Client Credentials Grant.
     *
     * @param {ClientCredentialsAccessTokenIntrospectRequest} request The client credentials access token.
     * @returns {Promise<ClientResponse<IntrospectResponse>>}
     */
    introspectClientCredentialsAccessTokenWithRequest(request: ClientCredentialsAccessTokenIntrospectRequest): Promise<ClientResponse<IntrospectResponse>>;
    /**
     * Issue a new access token (JWT) for the requested Application after ensuring the provided JWT is valid. A valid
     * access token is properly signed and not expired.
     * <p>
     * This API may be used in an SSO configuration to issue new tokens for another application after the user has
     * obtained a valid token from authentication.
     *
     * @param {UUID} applicationId The Application Id for which you are requesting a new access token be issued.
     * @param {string} encodedJWT The encoded JWT (access token).
     * @param {string} refreshToken (Optional) An existing refresh token used to request a refresh token in addition to a JWT in the response.
     *    <p>The target application represented by the applicationId request parameter must have refresh
     *    tokens enabled in order to receive a refresh token in the response.</p>
     * @returns {Promise<ClientResponse<IssueResponse>>}
     */
    issueJWT(applicationId: UUID, encodedJWT: string, refreshToken: string): Promise<ClientResponse<IssueResponse>>;
    /**
     * Authenticates a user to FusionAuth.
     *
     * This API optionally requires an API key. See <code>Application.loginConfiguration.requireAuthentication</code>.
     *
     * @param {LoginRequest} request The login request that contains the user credentials used to log them in.
     * @returns {Promise<ClientResponse<LoginResponse>>}
     */
    login(request: LoginRequest): Promise<ClientResponse<LoginResponse>>;
    /**
     * 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 {UUID} userId The Id of the user that was logged in.
     * @param {UUID} applicationId The Id of the application that they logged into.
     * @param {string} callerIPAddress (Optional) The IP address of the end-user that is logging in. If a null value is provided
     *    the IP address will be that of the client or last proxy that sent the request.
     * @returns {Promise<ClientResponse<LoginResponse>>}
     */
    loginPing(userId: UUID, applicationId: UUID, callerIPAddress: string): Promise<ClientResponse<LoginResponse>>;
    /**
     * 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: LoginPingRequest): Promise<ClientResponse<LoginResponse>>;
    /**
     * 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
     * token or refresh token cookies.
     *
     * @param {boolean} global When this value is set to true all the refresh tokens issued to the owner of the
     *    provided token will be revoked.
     * @param {string} refreshToken (Optional) The refresh_token as a request parameter instead of coming in via a cookie.
     *    If provided this takes precedence over the cookie.
     * @returns {Promise<ClientResponse<void>>}
     */
    logout(global: boolean, refreshToken: string): Promise<ClientResponse<void>>;
    /**
     * 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 the information used to logout the user.
     * @returns {Promise<ClientResponse<void>>}
     */
    logoutWithRequest(request: LogoutRequest): Promise<ClientResponse<void>>;
    /**
     * Retrieves any global identity providers 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.
     *
     * @param {string} domain The domain or email address to lookup.
     * @returns {Promise<ClientResponse<LookupResponse>>}
     */
    lookupIdentityProvider(domain: string): Promise<ClientResponse<LookupResponse>>;
    /**
     * Retrieves the identity provider for the given domain and tenantId. A 200 response code indicates the domain is managed
     * by a registered identity provider. A 404 indicates the domain is not managed.
     *
     * @param {string} domain The domain or email address to lookup.
     * @param {UUID} tenantId If provided, the API searches for an identity provider scoped to the corresponding tenant that manages the requested domain.
     *    If no result is found, the API then searches for global identity providers.
     * @returns {Promise<ClientResponse<LookupResponse>>}
     */
    lookupIdentityProviderByTenantId(domain: string, tenantId: UUID): Promise<ClientResponse<LookupResponse>>;
    /**
     * Modifies a temporal user action by changing the expiration of the action and optionally adding a comment to the
     * action.
     *
     * @param {UUID} actionId The Id of the action to modify. This is technically the user action log Id.
     * @param {ActionRequest} request The request that contains all the information about the modification.
     * @returns {Promise<ClientResponse<ActionResponse>>}
     */
    modifyAction(actionId: UUID, request: ActionRequest): Promise<ClientResponse<ActionResponse>>;
    /**
     * Complete a login request using a passwordless code
     *
     * @param {PasswordlessLoginRequest} request The passwordless login request that contains all the information used to complete login.
     * @returns {Promise<ClientResponse<LoginResponse>>}
     */
    passwordlessLogin(request: PasswordlessLoginRequest): Promise<ClientResponse<LoginResponse>>;
    /**
     * Updates an API key with the given Id.
     *
     * @param {UUID} keyId The Id of the API key. If not provided a secure random api key will be generated.
     * @param {APIKeyRequest} request The request object that contains all the information needed to create the API key.
     * @returns {Promise<ClientResponse<APIKeyResponse>>}
     */
    patchAPIKey(keyId: UUID, request: APIKeyRequest): Promise<ClientResponse<APIKeyResponse>>;
    /**
     * Updates, via PATCH, the application with the given Id.
     *
     * @param {UUID} applicationId The Id of the application to update.
     * @param {ApplicationRequest} request The request that contains just the new application information.
     * @returns {Promise<ClientResponse<ApplicationResponse>>}
     */
    patchApplication(applicationId: UUID, request: ApplicationRequest): Promise<ClientResponse<ApplicationResponse>>;
    /**
     * Updates, via PATCH, the application role with the given Id for the application.
     *
     * @param {UUID} applicationId The Id of the application that the role belongs to.
     * @param {UUID} roleId The Id of the role to update.
     * @param {ApplicationRequest} request The request that contains just the new role information.
     * @returns {Promise<ClientResponse<ApplicationResponse>>}
     */
    patchApplicationRole(applicationId: UUID, roleId: UUID, request: ApplicationRequest): Promise<ClientResponse<ApplicationResponse>>;
    /**
     * Updates, via PATCH, the connector with the given Id.
     *
     * @param {UUID} connectorId The Id of the connector to update.
     * @param {ConnectorRequest} request The request that contains just the new connector information.
     * @returns {Promise<ClientResponse<ConnectorResponse>>}
     */
    patchConnector(connectorId: UUID, request: ConnectorRequest): Promise<ClientResponse<ConnectorResponse>>;
    /**
     * Updates, via PATCH, the consent with the given Id.
     *
     * @param {UUID} consentId The Id of the consent to update.
     * @param {ConsentRequest} request The request that contains just the new consent information.
     * @returns {Promise<ClientResponse<ConsentResponse>>}
     */
    patchConsent(consentId: UUID, request: ConsentRequest): Promise<ClientResponse<ConsentResponse>>;
    /**
     * Updates, via PATCH, the email template with the given Id.
     *
     * @param {UUID} emailTemplateId The Id of the email template to update.
     * @param {EmailTemplateRequest} request The request that contains just the new email template information.
     * @returns {Promise<ClientResponse<EmailTemplateResponse>>}
     */
    patchEmailTemplate(emailTemplateId: UUID, request: EmailTemplateRequest): Promise<ClientResponse<EmailTemplateResponse>>;
    /**
     * Updates, via PATCH, the Entity with the given Id.
     *
     * @param {UUID} entityId The Id of the Entity Type to update.
     * @param {EntityRequest} request The request that contains just the new Entity information.
     * @returns {Promise<ClientResponse<EntityResponse>>}
     */
    patchEntity(entityId: UUID, request: EntityRequest): Promise<ClientResponse<EntityResponse>>;
    /**
     * Updates, via PATCH, the Entity Type with the given Id.
     *
     * @param {UUID} entityTypeId The Id of the Entity Type to update.
     * @param {EntityTypeRequest} request The request that contains just the new Entity Type information.
     * @returns {Promise<ClientResponse<EntityTypeResponse>>}
     */
    patchEntityType(entityTypeId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
    /**
     * Patches the permission with the given Id for the entity type.
     *
     * @param {UUID} entityTypeId The Id of the entityType that the permission belongs to.
     * @param {UUID} permissionId The Id of the permission to patch.
     * @param {EntityTypeRequest} request The request that contains the new permission information.
     * @returns {Promise<ClientResponse<EntityTypeResponse>>}
     */
    patchEntityTypePermission(entityTypeId: UUID, permissionId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
    /**
     * Patches the form with the given Id.
     *
     * @param {UUID} formId The Id of the form to patch.
     * @param {FormRequest} request The request object that contains the new form information.
     * @returns {Promise<ClientResponse<FormResponse>>}
     */
    patchForm(formId: UUID, request: FormRequest): Promise<ClientResponse<FormResponse>>;
    /**
     * Patches the form field with the given Id.
     *
     * @param {UUID} fieldId The Id of the form field to patch.
     * @param {FormFieldRequest} request The request object that contains the new form field information.
     * @returns {Promise<ClientResponse<FormFieldResponse>>}
     */
    patchFormField(fieldId: UUID, request: FormFieldRequest): Promise<ClientResponse<FormFieldResponse>>;
    /**
     * Updates, via PATCH, the group with the given Id.
     *
     * @param {UUID} groupId The Id of the group to update.
     * @param {GroupRequest} request The request that contains just the new group information.
     * @returns {Promise<ClientResponse<GroupResponse>>}
     */
    patchGroup(groupId: UUID, request: GroupRequest): Promise<ClientResponse<GroupResponse>>;
    /**
     * Update the IP Access Control List with the given Id.
     *
     * @param {UUID} accessControlListId The Id of the IP Access Control List to patch.
     * @param {IPAccessControlListRequest} request The request that contains the new IP Access Control List information.
     * @returns {Promise<ClientResponse<IPAccessControlListResponse>>}
     */
    patchIPAccessControlList(accessControlListId: UUID, request: IPAccessControlListRequest): Promise<ClientResponse<IPAccessControlListResponse>>;
    /**
     * Updates, via PATCH, the identity provider with the given Id.
     *
     * @param {UUID} identityProviderId The Id of the identity provider to update.
     * @param {IdentityProviderRequest} request The request object that contains just the updated identity provider information.
     * @returns {Promise<ClientResponse<IdentityProviderResponse>>}
     */
    patchIdentityProvider(identityProviderId: UUID, request: IdentityProviderRequest): Promise<ClientResponse<IdentityProviderResponse>>;
    /**
     * Updates, via PATCH, the available integrations.
     *
     * @param {IntegrationRequest} request The request that contains just the new integration information.
     * @returns {Promise<ClientResponse<IntegrationResponse>>}
     */
    patchIntegrations(request: IntegrationRequest): Promise<ClientResponse<IntegrationResponse>>;
    /**
     * Updates, via PATCH, the lambda with the given Id.
     *
     * @param {UUID} lambdaId The Id of the lambda to update.
     * @param {LambdaRequest} request The request that contains just the new lambda information.
     * @returns {Promise<ClientResponse<LambdaResponse>>}
     */
    patchLambda(lambdaId: UUID, request: LambdaRequest): Promise<ClientResponse<LambdaResponse>>;
    /**
     * Updates, via PATCH, the message template with the given Id.
     *
     * @param {UUID} messageTemplateId The Id of the message template to update.
     * @param {MessageTemplateRequest} request The request that contains just the new message template information.
     * @returns {Promise<ClientResponse<MessageTemplateResponse>>}
     */
    patchMessageTemplate(messageTemplateId: UUID, request: MessageTemplateRequest): Promise<ClientResponse<MessageTemplateResponse>>;
    /**
     * Updates, via PATCH, the messenger with the given Id.
     *
     * @param {UUID} messengerId The Id of the messenger to update.
     * @param {MessengerRequest} request The request that contains just the new messenger information.
     * @returns {Promise<ClientResponse<MessengerResponse>>}
     */
    patchMessenger(messengerId: UUID, request: MessengerRequest): Promise<ClientResponse<MessengerResponse>>;
    /**
     * Updates, via PATCH, the custom OAuth scope with the given Id for the application.
     *
     * @param {UUID} applicationId The Id of the application that the OAuth scope belongs to.
     * @param {UUID} scopeId The Id of the OAuth scope to update.
     * @param {ApplicationOAuthScopeRequest} request The request that contains just the new OAuth scope information.
     * @returns {Promise<ClientResponse<ApplicationOAuthScopeResponse>>}
     */
    patchOAuthScope(applicationId: UUID, scopeId: UUID, request: ApplicationOAuthScopeRequest): Promise<ClientResponse<ApplicationOAuthScopeResponse>>;
    /**
     * Updates, via PATCH, the registration for the user with the given Id and the application defined in the request.
     *
     * @param {UUID} userId The Id of the user whose registration is going to be updated.
     * @param {RegistrationRequest} request The request that contains just the new registration information.
     * @returns {Promise<ClientResponse<RegistrationResponse>>}
     */
    patchRegistration(userId: UUID, request: RegistrationRequest): Promise<ClientResponse<RegistrationResponse>>;
    /**
     * Updates, via PATCH, the system configuration.
     *
     * @param {SystemConfigurationRequest} request The request that contains just the new system configuration information.
     * @returns {Promise<ClientResponse<SystemConfigurationResponse>>}
     */
    patchSystemConfiguration(request: SystemConfigurationRequest): Promise<ClientResponse<SystemConfigurationResponse>>;
    /**
     * Updates, via PATCH, the tenant with the given Id.
     *
     * @param {UUID} tenantId The Id of the tenant to update.
     * @param {TenantRequest} request The request that contains just the new tenant information.
     * @returns {Promise<ClientResponse<TenantResponse>>}
     */
    patchTenant(tenantId: UUID, request: TenantRequest): Promise<ClientResponse<TenantResponse>>;
    /**
     * Updates, via PATCH, the Tenant Manager configuration.
     *
     * @param {TenantManagerConfigurationRequest} request The request that contains just the new Tenant Manager configuration information.
     * @returns {Promise<ClientResponse<TenantManagerConfigurationResponse>>}
     */
    patchTenantManagerConfiguration(request: TenantManagerConfigurationRequest): Promise<ClientResponse<TenantManagerConfigurationResponse>>;
    /**
     * Patches the tenant manager identity provider type configuration for the given identity provider type.
     *
     * @param {IdentityProviderType} type The type of the identity provider.
     * @param {TenantManagerIdentityProviderTypeConfigurationRequest} request The request object that contains the new tenant manager identity provider type configuration information.
     * @returns {Promise<ClientResponse<TenantManagerIdentityProviderTypeConfigurationResponse>>}
     */
    patchTenantManagerIdentityProviderTypeConfiguration(type: IdentityProviderType, request: TenantManagerIdentityProviderTypeConfigurationRequest): Promise<ClientResponse<TenantManagerIdentityProviderTypeConfigurationResponse>>;
    /**
     * Updates, via PATCH, the theme with the given Id.
     *
     * @param {UUID} themeId The Id of the theme to update.
     * @param {ThemeRequest} request The request that contains just the new theme information.
     * @returns {Promise<ClientResponse<ThemeResponse>>}
     */
    patchTheme(themeId: UUID, request: ThemeRequest): Promise<ClientResponse<ThemeResponse>>;
    /**
     * Updates, via PATCH, the user with the given Id.
     *
     * @param {UUID} userId The Id of the user to update.
     * @param {UserRequest} request The request that contains just the new user information.
     * @returns {Promise<ClientResponse<UserResponse>>}
     */
    patchUser(userId: UUID, request: UserRequest): Promise<ClientResponse<UserResponse>>;
    /**
     * Updates, via PATCH, the user action with the given Id.
     *
     * @param {UUID} userActionId The Id of the user action to update.
     * @param {UserActionRequest} request The request that contains just the new user action information.
     * @returns {Promise<ClientResponse<UserActionResponse>>}
     */
    patchUserAction(userActionId: UUID, request: UserActionRequest): Promise<ClientResponse<UserActionResponse>>;
    /**
     * Updates, via PATCH, the user action reason with the given Id.
     *
     * @param {UUID} userActionReasonId The Id of the user action reason to update.
     * @param {UserActionReasonRequest} request The request that contains just the new user action reason information.
     * @returns {Promise<ClientResponse<UserActionReasonResponse>>}
     */
    patchUserActionReason(userActionReasonId: UUID, request: UserActionReasonRequest): Promise<ClientResponse<UserActionReasonResponse>>;
    /**
     * Updates, via PATCH, a single User consent by Id.
     *
     * @param {UUID} userConsentId The User Consent Id
     * @param {UserConsentRequest} request The request that contains just the new user consent information.
     * @returns {Promise<ClientResponse<UserConsentResponse>>}
     */
    patchUserConsent(userConsentId: UUID, request: UserConsentRequest): Promise<ClientResponse<UserConsentResponse>>;
    /**
     * Patches the webhook with the given Id.
     *
     * @param {UUID} webhookId The Id of the webhook to update.
     * @param {WebhookRequest} request The request that contains the new webhook information.
     * @returns {Promise<ClientResponse<WebhookResponse>>}
     */
    patchWebhook(webhookId: UUID, request: WebhookRequest): Promise<ClientResponse<WebhookResponse>>;
    /**
     * Reactivates the application with the given Id.
     *
     * @param {UUID} applicationId The Id of the application to reactivate.
     * @returns {Promise<ClientResponse<ApplicationResponse>>}
     */
    reactivateApplication(applicationId: UUID): Promise<ClientResponse<ApplicationResponse>>;
    /**
     * Reactivates the user with the given Id.
     *
     * @param {UUID} userId The Id of the user to reactivate.
     * @returns {Promise<ClientResponse<UserResponse>>}
     */
    reactivateUser(userId: UUID): Promise<ClientResponse<UserResponse>>;
    /**
     * Reactivates the user action with the given Id.
     *
     * @param {UUID} userActionId The Id of the user action to reactivate.
     * @returns {Promise<ClientResponse<UserActionResponse>>}
     */
    reactivateUserAction(userActionId: UUID): Promise<ClientResponse<UserActionResponse>>;
    /**
     * Reconcile a User to FusionAuth using JWT issued from another Identity Provider.
     *
     * @param {IdentityProviderLoginRequest} request The reconcile request that contains the data to reconcile the User.
     * @returns {Promise<ClientResponse<LoginResponse>>}
     */
    reconcileJWT(request: IdentityProviderLoginRequest): Promise<ClientResponse<LoginResponse>>;
    /**
     * Request a refresh of the Entity search index. This API is not generally necessary and the search index will become consistent in a
     * reasonable amount of time. There may be scenarios where you may wish to manually request an index refresh. One example may be
     * if you are using the Search API or Delete Tenant API immediately following a Entity Create etc, you may wish to request a refresh to
     *  ensure the index immediately current before making a query request to the search index.
     *
     * @returns {Promise<ClientResponse<void>>}
     */
    refreshEntitySearchIndex(): Promise<ClientResponse<void>>;
    /**
     * Request a refresh of the User search index. This API is not generally necessary and the search index will become consistent in a
     * reasonable amount of time. There may be scenarios where you may wish to manually request an index refresh. One example may be
     * if you are using the Search API or Delete Tenant API immediately following a User Create etc, you may wish to request a refresh to
     *  ensure the index immediately current before making a query request to the search index.
     *
     * @returns {Promise<ClientResponse<void>>}
     */
    refreshUserSearchIndex(): Promise<ClientResponse<void>>;
    /**
     * Regenerates any keys that are used by the FusionAuth Reactor.
     *
     * @returns {Promise<ClientResponse<void>>}
     */
    regenerateReactorKeys(): Promise<ClientResponse<void>>;
    /**
     * Registers a user for an application. If you provide the User and the UserRegistration object on this request, it
     * will create the user as well as register them for the application. This is called a Full Registration. However, if
     * you only provide the UserRegistration object, then the user must already exist and they will be registered for the
     * application. The user Id can also be provided and it will either be used to look up an existing user or it will be
     * used for the newly created User.
     *
     * @param {UUID} userId (Optional) The Id of the user being registered for the application and optionally created.
     * @param {RegistrationRequest} request The request that optionally contains the User and must contain the UserRegistration.
     * @returns {Promise<ClientResponse<RegistrationResponse>>}
     */
    register(userId: UUID, request: RegistrationRequest): Promise<ClientResponse<RegistrationResponse>>;
    /**
     * Requests Elasticsearch to delete and rebuild the index for FusionAuth users or entities. Be very careful when running this request as it will
     * increase the CPU and I/O load on your database until the operation completes. Generally speaking you do not ever need to run this operation unless
     * instructed by FusionAuth support, or if you are migrating a database another system and you are not brining along the Elasticsearch index.
     *
     * You have been warned.
     *
     * @param {ReindexRequest} request The request that contains the index name.
     * @returns {Promise<ClientResponse<void>>}
     */
    reindex(request: ReindexRequest): Promise<ClientResponse<void>>;
    /**
     * Removes a user from the family with the given Id.
     *
     * @param {UUID} familyId The Id of the family to remove the user from.
     * @param {UUID} userId The Id of the user to remove from the family.
     * @returns {Promise<ClientResponse<void>>}
     */
    removeUserFromFamily(familyId: UUID, userId: UUID): Promise<ClientResponse<void>>;
    /**
     * Re-sends the verification email to the user.
     *
     * @param {string} email The email address of the user that needs a new verification email.
     * @returns {Promise<ClientResponse<VerifyEmailResponse>>}
     */
    resendEmailVerification(email: string): Promise<ClientResponse<VerifyEmailResponse>>;
    /**
     * Re-sends the verification email to the user. If the Application has configured a specific email template this will be used
     * instead of the tenant configuration.
     *
     * @param {UUID} applicationId The unique Application Id to used to resolve an application specific email template.
     * @param {string} email The email address of the user that needs a new verification email.
     * @returns {Promise<ClientResponse<VerifyEmailResponse>>}
     */
    resendEmailVerificationWithApplicationTemplate(applicationId: UUID, email: string): Promise<ClientResponse<VerifyEmailResponse>>;
    /**
     * Re-sends the application registration verification email to the user.
     *
     * @param {string} email The email address of the user that needs a new verification email.
     * @param {UUID} applicationId The Id of the application to be verified.
     * @returns {Promise<ClientResponse<VerifyRegistrationResponse>>}
     */
    resendRegistrationVerification(email: string, applicationId: UUID): Promise<ClientResponse<VerifyRegistrationResponse>>;
    /**
     * Retrieves an authentication API key for the given Id.
     *
     * @param {UUID} keyId The Id of the API key to retrieve.
     * @returns {Promise<ClientResponse<APIKeyResponse>>}
     */
    retrieveAPIKey(keyId: UUID): Promise<ClientResponse<APIKeyResponse>>;
    /**
     * Retrieves a single action log (the log of a user action that was taken on a user previously) for the given Id.
     *
     * @param {UUID} actionId The Id of the action to retrieve.
     * @returns {Promise<ClientResponse<ActionResponse>>}
     */
    retrieveAction(actionId: UUID): Promise<ClientResponse<ActionResponse>>;
    /**
     * 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.
     * @returns {Promise<ClientResponse<ActionResponse>>}
     */
    retrieveActions(userId: UUID): Promise<ClientResponse<ActionResponse>>;
    /**
     * 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>>}
     */
    retrieveActionsPreventingLogin(userId: UUID): Promise<ClientResponse<ActionResponse>>;
    /**
     * 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.
     * @returns {Promise<ClientResponse<ActionResponse>>}
     */
    retrieveActiveActions(userId: UUID): Promise<ClientResponse<ActionResponse>>;
    /**
     * Retrieves the application for the given Id or all the applications if the Id is null.
     *
     * @param {UUID} applicationId (Optional) The application Id.
     * @returns {Promise<ClientResponse<ApplicationResponse>>}
     */
    retrieveApplication(applicationId: UUID): Promise<ClientResponse<ApplicationResponse>>;
    /**
     * Retrieves all the applications.
     *
     * @returns {Promise<ClientResponse<ApplicationResponse>>}
     */
    retrieveApplications(): Promise<ClientResponse<ApplicationResponse>>;
    /**
     * Retrieves a single audit log for the given Id.
     *
     * @param {number} auditLogId The Id of the audit log to retrieve.
     * @returns {Promise<ClientResponse<AuditLogResponse>>}
     */
    retrieveAuditLog(auditLogId: number): Promise<ClientResponse<AuditLogResponse>>;
    /**
     * Retrieves the connector with the given Id.
     *
     * @param {UUID} connectorId The Id of the connector.
     * @returns {Promise<ClientResponse<ConnectorResponse>>}
     */
    retrieveConnector(connectorId: UUID): Promise<ClientResponse<ConnectorResponse>>;
    /**
     * Retrieves all the connectors.
     *
     * @returns {Promise<ClientResponse<ConnectorResponse>>}
     */
    retrieveConnectors(): Promise<ClientResponse<ConnectorResponse>>;
    /**
     * Retrieves the Consent for the given Id.
     *
     * @param {UUID} consentId The Id of the consent.
     * @returns {Promise<ClientResponse<ConsentResponse>>}
     */
    retrieveConsent(consentId: UUID): Promise<ClientResponse<ConsentResponse>>;
    /**
     * Retrieves all the consent.
     *
     * @returns {Promise<ClientResponse<ConsentResponse>>}
     */
    retrieveConsents(): Promise<ClientResponse<ConsentResponse>>;
    /**
     * Retrieves the daily active user report between the two instants. If you specify an application Id, it will only
     * return the daily active counts for that application.
     *
     * @param {UUID} applicationId (Optional) The application Id.
     * @param {number} start The start instant as UTC milliseconds since Epoch.
     * @param {number} end The end instant as UTC milliseconds since Epoch.
     * @returns {Promise<ClientResponse<DailyActiveUserReportResponse>>}
     */
    retrieveDailyActiveReport(applicationId: UUID, start: number, end: number): Promise<ClientResponse<DailyActiveUserReportResponse>>;
    /**
     * Retrieves the email template for the given Id. If you don't specify the Id, this will return all the email templates.
     *
     * @param {UUID} emailTemplateId (Optional) The Id of the email template.
     * @returns {Promise<ClientResponse<EmailTemplateResponse>>}
     */
    retrieveEmailTemplate(emailTemplateId: UUID): Promise<ClientResponse<EmailTemplateResponse>>;
    /**
     * Creates a preview of the email template provided in the request. This allows you to preview an email template that
     * hasn't been saved to the database yet. The entire email template does not need to be provided on the request. This
     * will create the preview based on whatever is given.
     *
     * @param {PreviewRequest} request The request that contains the email template and optionally a locale to render it in.
     * @returns {Promise<ClientResponse<PreviewResponse>>}
     */
    retrieveEmailTemplatePreview(request: PreviewRequest): Promise<ClientResponse<PreviewResponse>>;
    /**
     * Retrieves all the email templates.
     *
     * @returns {Promise<ClientResponse<EmailTemplateResponse>>}
     */
    retrieveEmailTemplates(): Promise<ClientResponse<EmailTemplateResponse>>;
    /**
     * Retrieves the Entity for the given Id.
     *
     * @param {UUID} entityId The Id of the Entity.
     * @returns {Promise<ClientResponse<EntityResponse>>}
     */
    retrieveEntity(entityId: UUID): Promise<ClientResponse<EntityResponse>>;
    /**
     * Retrieves an Entity Grant for the given Entity and User/Entity.
     *
     * @param {UUID} entityId The Id of the Entity.
     * @param {UUID} recipientEntityId (Optional) The Id of the Entity that the Entity Grant is for.
     * @param {UUID} userId (Optional) The Id of the User that the Entity Grant is for.
     * @returns {Promise<ClientResponse<EntityGrantResponse>>}
     */
    retrieveEntityGrant(entityId: UUID, recipientEntityId: UUID, userId: UUID): Promise<ClientResponse<EntityGrantResponse>>;
    /**
     * Retrieves the Entity Type for the given Id.
     *
     * @param {UUID} entityTypeId The Id of the Entity Type.
     * @returns {Promise<ClientResponse<EntityTypeResponse>>}
     */
    retrieveEntityType(entityTypeId: UUID): Promise<ClientResponse<EntityTypeResponse>>;
    /**
     * Retrieves all the Entity Types.
     *
     * @returns {Promise<ClientResponse<EntityTypeResponse>>}
     */
    retrieveEntityTypes(): Promise<ClientResponse<EntityTypeResponse>>;
    /**
     * Retrieves a single event log for the given Id.
     *
     * @param {number} eventLogId The Id of the event log to retrieve.
     * @returns {Promise<ClientResponse<EventLogResponse>>}
     */
    retrieveEventLog(eventLogId: number): Promise<ClientResponse<EventLogResponse>>;
    /**
     * Retrieves all the families that a user belongs to.
     *
     * @param {UUID} userId The User's id
     * @returns {Promise<ClientResponse<FamilyResponse>>}
     */
    retrieveFamilies(userId: UUID): Promise<ClientResponse<FamilyResponse>>;
    /**
     * 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>>}
     */
    retrieveFamilyMembersByFamilyId(familyId: UUID): Promise<ClientResponse<FamilyResponse>>;
    /**
     * Retrieves the form with the given Id.
     *
     * @param {UUID} formId The Id of the form.
     * @returns {Promise<ClientResponse<FormResponse>>}
     */
    retrieveForm(formId: UUID): Promise<ClientResponse<FormResponse>>;
    /**
     * Retrieves the form field with the given Id.
     *
     * @param {UUID} fieldId The Id of the form field.
     * @returns {Promise<ClientResponse<FormFieldResponse>>}
     */
    retrieveFormField(fieldId: UUID): Promise<ClientResponse<FormFieldResponse>>;
    /**
     * Retrieves all the forms fields
     *
     * @returns {Promise<ClientResponse<FormFieldResponse>>}
     */
    retrieveFormFields(): Promise<ClientResponse<FormFieldResponse>>;
    /**
     * Retrieves all the forms.
     *
     * @returns {Promise<ClientResponse<FormResponse>>}
     */
    retrieveForms(): Promise<ClientResponse<FormResponse>>;
    /**
     * Retrieves the group for the given Id.
     *
     * @param {UUID} groupId The Id of the group.
     * @returns {Promise<ClientResponse<GroupResponse>>}
     */
    retrieveGroup(groupId: UUID): Promise<ClientResponse<GroupResponse>>;
    /**
     * Retrieves all the groups.
     *
     * @returns {Promise<ClientResponse<GroupResponse>>}
     */
    retrieveGroups(): Promise<ClientResponse<GroupResponse>>;
    /**
     * 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: UUID): Promise<ClientResponse<IPAccessControlListResponse>>;
    /**
     * Retrieves the identity provider for the given Id or all the identity providers if the Id is null.
     *
     * @param {UUID} identityProviderId The identity provider Id.
     * @returns {Promise<ClientResponse<IdentityProviderResponse>>}
     */
    retrieveIdentityProvider(identityProviderId: UUID): Promise<ClientResponse<IdentityProviderResponse>>;
    /**
     * Retrieves one or more identity provider for the given type. For types such as Google, Facebook, Twitter and LinkedIn, only a single
     * identity provider can exist. For types such as OpenID Connect and SAMLv2 more than one identity provider can be configured so this request
     * may return multiple identity providers.
     *
     * @param {IdentityProviderType} type The type of the identity provider.
     * @returns {Promise<ClientResponse<IdentityProviderResponse>>}
     */
    retrieveIdentityProviderByType(type: IdentityProviderType): Promise<ClientResponse<IdentityProviderResponse>>;
    /**
     * Retrieves the results for an identity provider connection test.
     *
     * @param {string} connectionTestId The connection test id to retrieve results for.
     * @returns {Promise<ClientResponse<IdentityProviderConnectionTestResponse>>}
     */
    retrieveIdentityProviderConnectionTestResults(connectionTestId: string): Promise<ClientResponse<IdentityProviderConnectionTestResponse>>;
    /**
     * Retrieves all the identity providers.
     *
     * @returns {Promise<ClientResponse<IdentityProviderResponse>>}
     */
    retrieveIdentityProviders(): Promise<ClientResponse<IdentityProviderResponse>>;
    /**
     * 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.
     * @returns {Promise<ClientResponse<ActionResponse>>}
     */
    retrieveInactiveActions(userId: UUID): Promise<ClientResponse<ActionResponse>>;
    /**
     * Retrieves all the applications that are currently inactive.
     *
     * @returns {Promise<ClientResponse<ApplicationResponse>>}
     */
    retrieveInactiveApplications(): Promise<ClientResponse<ApplicationResponse>>;
    /**
     * Retrieves all the user actions that are currently inactive.
     *
     * @returns {Promise<ClientResponse<UserActionResponse>>}
     */
    retrieveInactiveUserActions(): Promise<ClientResponse<UserActionResponse>>;
    /**
     * Retrieves the available integrations.
     *
     * @returns {Promise<ClientResponse<IntegrationResponse>>}
     */
    retrieveIntegration(): Promise<ClientResponse<IntegrationResponse>>;
    /**
     * Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id (kid).
     *
     * @param {string} keyId The Id of the public key (kid).
     * @returns {Promise<ClientResponse<PublicKeyResponse>>}
     */
    retrieveJWTPublicKey(keyId: string): Promise<ClientResponse<PublicKeyResponse>>;
    /**
     * Retrieves the Public Key configured for verifying the JSON Web Tokens (JWT) issued by the Login API by the Application Id.
     *
     * @param {string} applicationId The Id of the Application for which this key is used.
     * @returns {Promise<ClientResponse<PublicKeyResponse>>}
     */
    retrieveJWTPublicKeyByApplicationId(applicationId: string): Promise<ClientResponse<PublicKeyResponse>>;
    /**
     * Retrieves all Public Keys configured for verifying JSON Web Tokens (JWT).
     *
     * @returns {Promise<ClientResponse<PublicKeyResponse>>}
     */
    retrieveJWTPublicKeys(): Promise<ClientResponse<PublicKeyResponse>>;
    /**
     * Returns public keys used by FusionAuth to cryptographically verify JWTs using the JSON Web Key format.
     *
     * @returns {Promise<ClientResponse<JWKSResponse>>}
     */
    retrieveJsonWebKeySet(): Promise<ClientResponse<JWKSResponse>>;
    /**
     * Retrieves the key for the given Id.
     *
     * @param {UUID} keyId The Id of the key.
     * @returns {Promise<ClientResponse<KeyResponse>>}
     */
    retrieveKey(keyId: UUID): Promise<ClientResponse<KeyResponse>>;
    /**
     * Retrieves all the keys.
     *
     * @returns {Promise<ClientResponse<KeyResponse>>}
     */
    retrieveKeys(): Promise<ClientResponse<KeyResponse>>;
    /**
     * Retrieves the lambda for the given Id.
     *
     * @param {UUID} lambdaId The Id of the lambda.
     * @returns {Promise<ClientResponse<LambdaResponse>>}
     */
    retrieveLambda(lambdaId: UUID): Promise<ClientResponse<LambdaResponse>>;
    /**
     * Retrieves all the lambdas.
     *
     * @returns {Promise<ClientResponse<LambdaResponse>>}
     */
    retrieveLambdas(): Promise<ClientResponse<LambdaResponse>>;
    /**
     * Retrieves all the lambdas for the provided type.
     *
     * @param {LambdaType} type The type of the lambda to return.
     * @returns {Promise<ClientResponse<LambdaResponse>>}
     */
    retrieveLambdasByType(type: LambdaType): Promise<ClientResponse<LambdaResponse>>;
    /**
     * Retrieves the login report between the two instants. If you specify an application Id, it will only return the
     * login counts for that application.
     *
     * @param {UUID} applicationId (Optional) The application Id.
     * @param {number} start The start instant as UTC milliseconds since Epoch.
     * @param {number} end The end instant as UTC milliseconds since Epoch.
     * @returns {Promise<ClientResponse<LoginReportResponse>>}
     */
    retrieveLoginReport(applicationId: UUID, start: number, end: number): Promise<ClientResponse<LoginReportResponse>>;
    /**
     * Retrieves the message template for the given Id. If you don't specify the Id, this will return all the message templates.
     *
     * @param {UUID} messageTemplateId (Optional) The Id of the message template.
     * @returns {Promise<ClientResponse<MessageTemplateResponse>>}
     */
    retrieveMessageTemplate(messageTemplateId: UUID): Promise<ClientResponse<MessageTemplateResponse>>;
    /**
     * Creates a preview of the message template provided in the request, normalized to a given locale.
     *
     * @param {PreviewMessageTemplateRequest} request The request that contains the email template and optionally a locale to render it in.
     * @returns {Promise<ClientResponse<PreviewMessageTemplateResponse>>}
     */
    retrieveMessageTemplatePreview(request: PreviewMessageTemplateRequest): Promise<ClientResponse<PreviewMessageTemplateResponse>>;
    /**
     * Retrieves all the message templates.
     *
     * @returns {Promise<ClientResponse<MessageTemplateResponse>>}
     */
    retrieveMessageTemplates(): Promise<ClientResponse<MessageTemplateResponse>>;
    /**
     * Retrieves the messenger with the given Id.
     *
     * @param {UUID} messengerId The Id of the messenger.
     * @returns {Promise<ClientResponse<MessengerResponse>>}
     */
    retrieveMessenger(messengerId: UUID): Promise<ClientResponse<MessengerResponse>>;
    /**
     * Retrieves all the messengers.
     *
     * @returns {Promise<ClientResponse<MessengerResponse>>}
     */
    retrieveMessengers(): Promise<ClientResponse<MessengerResponse>>;
    /**
     * Retrieves the monthly active user report between the two instants. If you specify an application Id, it will only
     * return the monthly active counts for that application.
     *
     * @param {UUID} applicationId (Optional) The application Id.
     * @param {number} start The start instant as UTC milliseconds since Epoch.
     * @param {number} end The end instant as UTC milliseconds since Epoch.
     * @returns {Promise<ClientResponse<MonthlyActiveUserReportResponse>>}
     */
    retrieveMonthlyActiveReport(applicationId: UUID, start: number, end: number): Promise<ClientResponse<MonthlyActiveUserReportResponse>>;
    /**
     * Retrieves a custom OAuth scope.
     *
     * @param {UUID} applicationId The Id of the application that the OAuth scope belongs to.
     * @param {UUID} scopeId The Id of the OAuth scope to retrieve.
     * @returns {Promise<ClientResponse<ApplicationOAuthScopeResponse>>}
     */
    retrieveOAuthScope(applicationId: UUID, scopeId: UUID): Promise<ClientResponse<ApplicationOAuthScopeResponse>>;
    /**
     * Retrieves the Oauth2 configuration for the application for the given Application Id.
     *
     * @param {UUID} applicationId The Id of the Application to retrieve OAuth configuration.
     * @returns {Promise<ClientResponse<OAuthConfigurationResponse>>}
     */
    retrieveOauthConfiguration(applicationId: UUID): Promise<ClientResponse<OAuthConfigurationResponse>>;
    /**
     * Returns the well known OpenID Configuration JSON document
     *
     * @returns {Promise<ClientResponse<OpenIdConfiguration>>}
     */
    retrieveOpenIdConfiguration(): Promise<ClientResponse<OpenIdConfiguration>>;
    /**
     * Retrieves the password validation rules for a specific tenant. This method requires a tenantId to be provided
     * through the use of a Tenant scoped API key or an HTTP header X-FusionAuth-TenantId to specify the Tenant Id.
     *
     * This API does not require an API key.
     *
     * @returns {Promise<ClientResponse<PasswordValidationRulesResponse>>}
     */
    retrievePasswordValidationRules(): Promise<ClientResponse<PasswordValidationRulesResponse>>;
    /**
     * Retrieves the password validation rules for a specific tenant.
     *
     * This API does not require an API key.
     *
     * @param {UUID} tenantId The Id of the tenant.
     * @returns {Promise<ClientResponse<PasswordValidationRulesResponse>>}
     */
    retrievePasswordValidationRulesWithTenantId(tenantId: UUID): Promise<ClientResponse<PasswordValidationRulesResponse>>;
    /**
     * Retrieves all the children for the given parent email address.
     *
     * @param {string} parentEmail The email of the parent.
     * @returns {Promise<ClientResponse<PendingResponse>>}
     */
    retrievePendingChildren(parentEmail: string): Promise<ClientResponse<PendingResponse>>;
    /**
     * Retrieve a pending identity provider link. This is useful to validate a pending link and retrieve meta-data about the identity provider link.
     *
     * @param {string} pendingLinkId The pending link Id.
     * @param {UUID} userId The optional userId. When provided additional meta-data will be provided to identify how many links if any the user already has.
     * @returns {Promise<ClientResponse<IdentityProviderPendingLinkResponse>>}
     */
    retrievePendingLink(pendingLinkId: string, userId: UUID): Promise<ClientResponse<IdentityProviderPendingLinkResponse>>;
    /**
     * Retrieves the FusionAuth Reactor metrics.
     *
     * @returns {Promise<ClientResponse<ReactorMetricsResponse>>}
     */
    retrieveReactorMetrics(): Promise<ClientResponse<ReactorMetricsResponse>>;
    /**
     * Retrieves the FusionAuth Reactor status.
     *
     * @returns {Promise<ClientResponse<ReactorResponse>>}
     */
    retrieveReactorStatus(): Promise<ClientResponse<ReactorResponse>>;
    /**
     * Retrieves the last number of login records.
     *
     * @param {number} offset The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.
     * @param {number} limit (Optional, defaults to 10) The number of records to retrieve.
     * @returns {Promise<ClientResponse<RecentLoginResponse>>}
     */
    retrieveRecentLogins(offset: number, limit: number): Promise<ClientResponse<RecentLoginResponse>>;
    /**
     * 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} tokenId The Id of the token.
     * @returns {Promise<ClientResponse<RefreshTokenResponse>>}
     */
    retrieveRefreshTokenById(tokenId: UUID): Promise<ClientResponse<RefreshTokenResponse>>;
    /**
     * Retrieves the refresh tokens that belong to the user with the given Id.
     *
     * @param {UUID} userId The Id of the user.
     * @returns {Promise<ClientResponse<RefreshTokenResponse>>}
     */
    retrieveRefreshTokens(userId: UUID): Promise<ClientResponse<RefreshTokenResponse>>;
    /**
     * Retrieves the user registration for the user with the given Id and the given application Id.
     *
     * @param {UUID} userId The Id of the user.
     * @param {UUID} applicationId The Id of the application.
     * @returns {Promise<ClientResponse<RegistrationResponse>>}
     */
    retrieveRegistration(userId: UUID, applicationId: UUID): Promise<ClientResponse<RegistrationResponse>>;
    /**
     * Retrieves the registration report between the two instants. If you specify an application Id, it will only return
     * the registration counts for that application.
     *
     * @param {UUID} applicationId (Optional) The application Id.
     * @param {number} start The start instant as UTC milliseconds since Epoch.
     * @param {number} end The end instant as UTC milliseconds since Epoch.
     * @returns {Promise<ClientResponse<RegistrationReportResponse>>}
     */
    retrieveRegistrationReport(applicationId: UUID, start: number, end: number): Promise<ClientResponse<RegistrationReportResponse>>;
    /**
     * Retrieve the status of a re-index process. A status code of 200 indicates the re-index is in progress, a status code of
     * 404 indicates no re-index is in progress.
     *
     * @returns {Promise<ClientResponse<void>>}
     */
    retrieveReindexStatus(): Promise<ClientResponse<void>>;
    /**
     * Retrieves the system configuration.
     *
     * @returns {Promise<ClientResponse<SystemConfigurationResponse>>}
     */
    retrieveSystemConfiguration(): Promise<ClientResponse<SystemConfigurationResponse>>;
    /**
     * Retrieves the FusionAuth system health. This API will return 200 if the system is healthy, and 500 if the system is un-healthy.
     *
     * @returns {Promise<ClientResponse<void>>}
     */
    retrieveSystemHealth(): Promise<ClientResponse<void>>;
    /**
     * Retrieves the FusionAuth system status. This request is anonymous and does not require an API key. When an API key is not provided the response will contain a single value in the JSON response indicating the current health check.
     *
     * @returns {Promise<ClientResponse<StatusResponse>>}
     */
    retrieveSystemStatus(): Promise<ClientResponse<StatusResponse>>;
    /**
     * Retrieves the FusionAuth system status using an API key. Using an API key will cause the response to include the product version, health checks and various runtime metrics.
     *
     * @returns {Promise<ClientResponse<StatusResponse>>}
     */
    retrieveSystemStatusUsingAPIKey(): Promise<ClientResponse<StatusResponse>>;
    /**
     * Retrieves the tenant for the given Id.
     *
     * @param {UUID} tenantId The Id of the tenant.
     * @returns {Promise<ClientResponse<TenantResponse>>}
     */
    retrieveTenant(tenantId: UUID): Promise<ClientResponse<TenantResponse>>;
    /**
     * Retrieves the Tenant Manager configuration.
     *
     * @returns {Promise<ClientResponse<TenantManagerConfigurationResponse>>}
     */
    retrieveTenantManagerConfiguration(): Promise<ClientResponse<TenantManagerConfigurationResponse>>;
    /**
     * Retrieves all the tenants.
     *
     * @returns {Promise<ClientResponse<TenantResponse>>}
     */
    retrieveTenants(): Promise<ClientResponse<TenantResponse>>;
    /**
     * Retrieves the theme for the given Id.
     *
     * @param {UUID} themeId The Id of the theme.
     * @returns {Promise<ClientResponse<ThemeResponse>>}
     */
    retrieveTheme(themeId: UUID): Promise<ClientResponse<ThemeResponse>>;
    /**
     * Retrieves all the themes.
     *
     * @returns {Promise<ClientResponse<ThemeResponse>>}
     */
    retrieveThemes(): Promise<ClientResponse<ThemeResponse>>;
    /**
     * Retrieves the totals report. This contains all the total counts for each application and the global registration
     * count.
     *
     * @returns {Promise<ClientResponse<TotalsReportResponse>>}
     */
    retrieveTotalReport(): Promise<ClientResponse<TotalsReportResponse>>;
    /**
     * Retrieves the totals report. This allows excluding applicationTotals from the report. An empty list will include the applicationTotals.
     *
     * @param {Array<String>} excludes List of fields to exclude in the response. Currently only allows applicationTotals.
     * @returns {Promise<ClientResponse<TotalsReportResponse>>}
     */
    retrieveTotalReportWithExcludes(excludes: Array<String>): Promise<ClientResponse<TotalsReportResponse>>;
    /**
     * Retrieve two-factor recovery codes for a user.
     *
     * @param {UUID} userId The Id of the user to retrieve Two Factor recovery codes.
     * @returns {Promise<ClientResponse<TwoFactorRecoveryCodeResponse>>}
     */
    retrieveTwoFactorRecoveryCodes(userId: UUID): Promise<ClientResponse<TwoFactorRecoveryCodeResponse>>;
    /**
     * 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: UUID, applicationId: UUID, twoFactorTrustId: string): Promise<ClientResponse<TwoFactorStatusResponse>>;
    /**
     * 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. This operation
     * provides more payload options than retrieveTwoFactorStatus.
     *
     * @param {TwoFactorStatusRequest} request The request object that contains all the information used to check the status.
     * @returns {Promise<ClientResponse<TwoFactorStatusResponse>>}
     */
    retrieveTwoFactorStatusWithRequest(request: TwoFactorStatusRequest): Promise<ClientResponse<TwoFactorStatusResponse>>;
    /**
     * Retrieves the user for the given Id.
     *
     * @param {UUID} userId The Id of the user.
     * @returns {Promise<ClientResponse<UserResponse>>}
     */
    retrieveUser(userId: UUID): Promise<ClientResponse<UserResponse>>;
    /**
     * Retrieves the user action for the given Id. If you pass in null for the Id, this will return all the user
     * actions.
     *
     * @param {UUID} userActionId (Optional) The Id of the user action.
     * @returns {Promise<ClientResponse<UserActionResponse>>}
     */
    retrieveUserAction(userActionId: UUID): Promise<ClientResponse<UserActionResponse>>;
    /**
     * Retrieves the user action reason for the given Id. If you pass in null for the Id, this will return all the user
     * action reasons.
     *
     * @param {UUID} userActionReasonId (Optional) The Id of the user action reason.
     * @returns {Promise<ClientResponse<UserActionReasonResponse>>}
     */
    retrieveUserActionReason(userActionReasonId: UUID): Promise<ClientResponse<UserActionReasonResponse>>;
    /**
     * Retrieves all the user action reasons.
     *
     * @returns {Promise<ClientResponse<UserActionReasonResponse>>}
     */
    retrieveUserActionReasons(): Promise<ClientResponse<UserActionReasonResponse>>;
    /**
     * Retrieves all the user actions.
     *
     * @returns {Promise<ClientResponse<UserActionResponse>>}
     */
    retrieveUserActions(): Promise<ClientResponse<UserActionResponse>>;
    /**
     * Retrieves the user by a change password Id. The intended use of this API is to retrieve a user after the forgot
     * password workflow has been initiated and you may not know the user's email or username.
     *
     * @param {string} changePasswordId The unique change password Id that was sent via email or returned by the Forgot Password API.
     * @returns {Promise<ClientResponse<UserResponse>>}
     */
    retrieveUserByChangePasswordId(changePasswordId: string): Promise<ClientResponse<UserResponse>>;
    /**
     * Retrieves the user for the given email.
     *
     * @param {string} email The email of the user.
     * @returns {Promise<ClientResponse<UserResponse>>}
     */
    retrieveUserByEmail(email: string): Promise<ClientResponse<UserResponse>>;
    /**
     * Retrieves the user for the loginId. The loginId can be either the username or the email.
     *
     * @param {string} loginId The email or username of the user.
     * @returns {Promise<ClientResponse<UserResponse>>}
     */
    retrieveUserByLoginId(loginId: string): Promise<ClientResponse<UserResponse>>;
    /**
     * 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: string, loginIdTypes: Array<String>): Promise<ClientResponse<UserResponse>>;
    /**
     * Retrieves the user for the given username.
     *
     * @param {string} username The username of the user.
     * @returns {Promise<ClientResponse<UserResponse>>}
     */
    retrieveUserByUsername(username: string): Promise<ClientResponse<UserResponse>>;
    /**
     * Retrieves the user by a verificationId. The intended use of this API is to retrieve a user after the forgot
     * password workflow has been initiated and you may not know the user's email or username.
     *
     * @param {string} verificationId The unique verification Id that has been set on the user object.
     * @returns {Promise<ClientResponse<UserResponse>>}
     */
    retrieveUserByVerificationId(verificationId: string): Promise<ClientResponse<UserResponse>>;
    /**
     * Retrieve a user_code that is part of an in-progress Device Authorization Grant.
     *
     * This API is useful if you want to build your own login workflow to complete a device grant.
     *
     * @param {string} client_id The client Id.
     * @param {string} client_secret The client Id.
     * @param {string} user_code The end-user verification code.
     * @returns {Promise<ClientResponse<void>>}
     */
    retrieveUserCode(client_id: string, client_secret: string, user_code: string): Promise<ClientResponse<void>>;
    /**
     * Retrieve a user_code that is part of an in-progress Device Authorization Grant.
     *
     * This API is useful if you want to build your own login workflow to complete a device grant.
     *
     * This request will require an API key.
     *
     * @param {string} user_code The end-user verification code.
     * @returns {Promise<ClientResponse<void>>}
     */
    retrieveUserCodeUsingAPIKey(user_code: string): Promise<ClientResponse<void>>;
    /**
     * Retrieve a user_code that is part of an in-progress Device Authorization Grant.
     *
     * This API is useful if you want to build your own login workflow to complete a device grant.
     *
     * This request will require an API key.
     *
     * @param {RetrieveUserCodeUsingAPIKeyRequest} request The user code retrieval request including optional tenantId.
     * @returns {Promise<ClientResponse<void>>}
     */
    retrieveUserCodeUsingAPIKeyWithRequest(request: RetrieveUserCodeUsingAPIKeyRequest): Promise<ClientResponse<void>>;
    /**
     * Retrieve a user_code that is part of an in-progress Device Authorization Grant.
     *
     * This API is useful if you want to build your own login workflow to complete a device grant.
     *
     * @param {RetrieveUserCodeRequest} request The user code retrieval request.
     * @returns {Promise<ClientResponse<void>>}
     */
    retrieveUserCodeWithRequest(request: RetrieveUserCodeRequest): Promise<ClientResponse<void>>;
    /**
     * Retrieves all the comments for the user with the given Id.
     *
     * @param {UUID} userId The Id of the user.
     * @returns {Promise<ClientResponse<UserCommentResponse>>}
     */
    retrieveUserComments(userId: UUID): Promise<ClientResponse<UserCommentResponse>>;
    /**
     * Retrieve a single User consent by Id.
     *
     * @param {UUID} userConsentId The User consent Id
     * @returns {Promise<ClientResponse<UserConsentResponse>>}
     */
    retrieveUserConsent(userConsentId: UUID): Promise<ClientResponse<UserConsentResponse>>;
    /**
     * Retrieves all the consents for a User.
     *
     * @param {UUID} userId The User's Id
     * @returns {Promise<ClientResponse<UserConsentResponse>>}
     */
    retrieveUserConsents(userId: UUID): Promise<ClientResponse<UserConsentResponse>>;
    /**
     * Call the UserInfo endpoint to retrieve User Claims from the access token issued by FusionAuth.
     *
     * @param {string} encodedJWT The encoded JWT (access token).
     * @returns {Promise<ClientResponse<UserinfoResponse>>}
     */
    retrieveUserInfoFromAccessToken(encodedJWT: string): Promise<ClientResponse<UserinfoResponse>>;
    /**
     * Retrieve a single Identity Provider user (link).
     *
     * @param {UUID} identityProviderId The unique Id of the identity provider.
     * @param {string} identityProviderUserId The unique Id of the user in the 3rd party identity provider.
     * @param {UUID} userId The unique Id of the FusionAuth user.
     * @returns {Promise<ClientResponse<IdentityProviderLinkResponse>>}
     */
    retrieveUserLink(identityProviderId: UUID, identityProviderUserId: string, userId: UUID): Promise<ClientResponse<IdentityProviderLinkResponse>>;
    /**
     * Retrieve all Identity Provider users (links) for the user. Specify the optional identityProviderId to retrieve links for a particular IdP.
     *
     * @param {UUID} identityProviderId (Optional) The unique Id of the identity provider. Specify this value to reduce the links returned to those for a particular IdP.
     * @param {UUID} userId The unique Id of the user.
     * @returns {Promise<ClientResponse<IdentityProviderLinkResponse>>}
     */
    retrieveUserLinksByUserId(identityProviderId: UUID, userId: UUID): Promise<ClientResponse<IdentityProviderLinkResponse>>;
    /**
     * Retrieves the login report between the two instants for a particular user by Id. If you specify an application Id, it will only return the
     * login counts for that application.
     *
     * @param {UUID} applicationId (Optional) The application Id.
     * @param {UUID} userId 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.
     * @returns {Promise<ClientResponse<LoginReportResponse>>}
     */
    retrieveUserLoginReport(applicationId: UUID, userId: UUID, start: number, end: number): Promise<ClientResponse<LoginReportResponse>>;
    /**
     * Retrieves the login report between the two instants for a particular user by login Id. 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.
     * @returns {Promise<ClientResponse<LoginReportResponse>>}
     */
    retrieveUserLoginReportByLoginId(applicationId: UUID, loginId: string, start: number, end: number): Promise<ClientResponse<LoginReportResponse>>;
    /**
     * 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: UUID, loginId: string, start: number, end: number, loginIdTypes: Array<String>): Promise<ClientResponse<LoginReportResponse>>;
    /**
     * Retrieves the last number of login records for a user.
     *
     * @param {UUID} userId The Id of the user.
     * @param {number} offset The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.
     * @param {number} limit (Optional, defaults to 10) The number of records to retrieve.
     * @returns {Promise<ClientResponse<RecentLoginResponse>>}
     */
    retrieveUserRecentLogins(userId: UUID, offset: number, limit: number): Promise<ClientResponse<RecentLoginResponse>>;
    /**
     * Retrieves the FusionAuth version string.
     *
     * @returns {Promise<ClientResponse<VersionResponse>>}
     */
    retrieveVersion(): Promise<ClientResponse<VersionResponse>>;
    /**
     * Retrieves the WebAuthn credential for the given Id.
     *
     * @param {UUID} id The Id of the WebAuthn credential.
     * @returns {Promise<ClientResponse<WebAuthnCredentialResponse>>}
     */
    retrieveWebAuthnCredential(id: UUID): Promise<ClientResponse<WebAuthnCredentialResponse>>;
    /**
     * Retrieves all WebAuthn credentials for the given user.
     *
     * @param {UUID} userId The user's ID.
     * @returns {Promise<ClientResponse<WebAuthnCredentialResponse>>}
     */
    retrieveWebAuthnCredentialsForUser(userId: UUID): Promise<ClientResponse<WebAuthnCredentialResponse>>;
    /**
     * Retrieves the webhook for the given Id. If you pass in null for the Id, this will return all the webhooks.
     *
     * @param {UUID} webhookId (Optional) The Id of the webhook.
     * @returns {Promise<ClientResponse<WebhookResponse>>}
     */
    retrieveWebhook(webhookId: UUID): Promise<ClientResponse<WebhookResponse>>;
    /**
     * Retrieves a single webhook attempt log for the given Id.
     *
     * @param {UUID} webhookAttemptLogId The Id of the webhook attempt log to retrieve.
     * @returns {Promise<ClientResponse<WebhookAttemptLogResponse>>}
     */
    retrieveWebhookAttemptLog(webhookAttemptLogId: UUID): Promise<ClientResponse<WebhookAttemptLogResponse>>;
    /**
     * Retrieves a single webhook event log for the given Id.
     *
     * @param {UUID} webhookEventLogId The Id of the webhook event log to retrieve.
     * @returns {Promise<ClientResponse<WebhookEventLogResponse>>}
     */
    retrieveWebhookEventLog(webhookEventLogId: UUID): Promise<ClientResponse<WebhookEventLogResponse>>;
    /**
     * Retrieves all the webhooks.
     *
     * @returns {Promise<ClientResponse<WebhookResponse>>}
     */
    retrieveWebhooks(): Promise<ClientResponse<WebhookResponse>>;
    /**
     * Revokes refresh tokens.
     *
     * Usage examples:
     *   - Delete a single refresh token, pass in only the token.
     *       revokeRefreshToken(token)
     *
     *   - Delete all refresh tokens for a user, pass in only the userId.
     *       revokeRefreshToken(null, userId)
     *
     *   - Delete all refresh tokens for a user for a specific application, pass in both the userId and the applicationId.
     *       revokeRefreshToken(null, userId, applicationId)
     *
     *   - Delete all refresh tokens for an application
     *       revokeRefreshToken(null, null, applicationId)
     *
     * Note: <code>null</code> may be handled differently depending upon the programming language.
     *
     * See also: (method names may vary by language... but you'll figure it out)
     *
     *  - revokeRefreshTokenById
     *  - revokeRefreshTokenByToken
     *  - revokeRefreshTokensByUserId
     *  - revokeRefreshTokensByApplicationId
     *  - revokeRefreshTokensByUserIdForApplication
     *
     * @param {string} token (Optional) The refresh token to delete.
     * @param {UUID} userId (Optional) The user Id whose tokens to delete.
     * @param {UUID} applicationId (Optional) The application Id of the tokens to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    revokeRefreshToken(token: string, userId: UUID, applicationId: UUID): Promise<ClientResponse<void>>;
    /**
     * Revokes a single refresh token by the unique Id. The unique Id is not sensitive as it cannot be used to obtain another JWT.
     *
     * @param {UUID} tokenId The unique Id of the token to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    revokeRefreshTokenById(tokenId: UUID): Promise<ClientResponse<void>>;
    /**
     * Revokes a single refresh token by using the actual refresh token value. This refresh token value is sensitive, so  be careful with this API request.
     *
     * @param {string} token The refresh token to delete.
     * @returns {Promise<ClientResponse<void>>}
     */
    revokeRefreshTokenByToken(token: string): Promise<ClientResponse<void>>;
    /**
     * Revoke all refresh tokens that belong to an application by applicationId.
     *
     * @param {UUID} applicationId The unique Id of the application that you want to delete all refresh tokens for.
     * @returns {Promise<ClientResponse<void>>}
     */
    revokeRefreshTokensByApplicationId(applicationId: UUID): Promise<ClientResponse<void>>;
    /**
     * Revoke all refresh tokens that belong to a user by user Id.
     *
     * @param {UUID} userId The unique Id of the user that you want to delete all refresh tokens for.
     * @returns {Promise<ClientResponse<void>>}
     */
    revokeRefreshTokensByUserId(userId: UUID): Promise<ClientResponse<void>>;
    /**
     * Revoke all refresh tokens that belong to a user by user Id for a specific application by applicationId.
     *
     * @param {UUID} userId The unique Id of the user that you want to delete all refresh tokens for.
     * @param {UUID} applicationId The unique Id of the application that you want to delete refresh tokens for.
     * @returns {Promise<ClientResponse<void>>}
     */
    revokeRefreshTokensByUserIdForApplication(userId: UUID, applicationId: UUID): Promise<ClientResponse<void>>;
    /**
     * 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: RefreshTokenRevokeRequest): Promise<ClientResponse<void>>;
    /**
     * Revokes a single User consent by Id.
     *
     * @param {UUID} userConsentId The User Consent Id
     * @returns {Promise<ClientResponse<void>>}
     */
    revokeUserConsent(userConsentId: UUID): Promise<ClientResponse<void>>;
    /**
     * Searches applications with the specified criteria and pagination.
     *
     * @param {ApplicationSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<ApplicationSearchResponse>>}
     */
    searchApplications(request: ApplicationSearchRequest): Promise<ClientResponse<ApplicationSearchResponse>>;
    /**
     * Searches the audit logs with the specified criteria and pagination.
     *
     * @param {AuditLogSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<AuditLogSearchResponse>>}
     */
    searchAuditLogs(request: AuditLogSearchRequest): Promise<ClientResponse<AuditLogSearchResponse>>;
    /**
     * Searches consents with the specified criteria and pagination.
     *
     * @param {ConsentSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<ConsentSearchResponse>>}
     */
    searchConsents(request: ConsentSearchRequest): Promise<ClientResponse<ConsentSearchResponse>>;
    /**
     * Searches email templates with the specified criteria and pagination.
     *
     * @param {EmailTemplateSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<EmailTemplateSearchResponse>>}
     */
    searchEmailTemplates(request: EmailTemplateSearchRequest): Promise<ClientResponse<EmailTemplateSearchResponse>>;
    /**
     * Searches entities with the specified criteria and pagination.
     *
     * @param {EntitySearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<EntitySearchResponse>>}
     */
    searchEntities(request: EntitySearchRequest): Promise<ClientResponse<EntitySearchResponse>>;
    /**
     * Retrieves the entities for the given Ids. If any Id is invalid, it is ignored.
     *
     * @param {Array<string>} ids The entity ids to search for.
     * @returns {Promise<ClientResponse<EntitySearchResponse>>}
     */
    searchEntitiesByIds(ids: Array<string>): Promise<ClientResponse<EntitySearchResponse>>;
    /**
     * Searches Entity Grants with the specified criteria and pagination.
     *
     * @param {EntityGrantSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<EntityGrantSearchResponse>>}
     */
    searchEntityGrants(request: EntityGrantSearchRequest): Promise<ClientResponse<EntityGrantSearchResponse>>;
    /**
     * Searches the entity types with the specified criteria and pagination.
     *
     * @param {EntityTypeSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<EntityTypeSearchResponse>>}
     */
    searchEntityTypes(request: EntityTypeSearchRequest): Promise<ClientResponse<EntityTypeSearchResponse>>;
    /**
     * Searches the event logs with the specified criteria and pagination.
     *
     * @param {EventLogSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<EventLogSearchResponse>>}
     */
    searchEventLogs(request: EventLogSearchRequest): Promise<ClientResponse<EventLogSearchResponse>>;
    /**
     * Searches group members with the specified criteria and pagination.
     *
     * @param {GroupMemberSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<GroupMemberSearchResponse>>}
     */
    searchGroupMembers(request: GroupMemberSearchRequest): Promise<ClientResponse<GroupMemberSearchResponse>>;
    /**
     * Searches groups with the specified criteria and pagination.
     *
     * @param {GroupSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<GroupSearchResponse>>}
     */
    searchGroups(request: GroupSearchRequest): Promise<ClientResponse<GroupSearchResponse>>;
    /**
     * 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: IPAccessControlListSearchRequest): Promise<ClientResponse<IPAccessControlListSearchResponse>>;
    /**
     * Searches identity providers with the specified criteria and pagination.
     *
     * @param {IdentityProviderSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<IdentityProviderSearchResponse>>}
     */
    searchIdentityProviders(request: IdentityProviderSearchRequest): Promise<ClientResponse<IdentityProviderSearchResponse>>;
    /**
     * Searches keys with the specified criteria and pagination.
     *
     * @param {KeySearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<KeySearchResponse>>}
     */
    searchKeys(request: KeySearchRequest): Promise<ClientResponse<KeySearchResponse>>;
    /**
     * Searches lambdas with the specified criteria and pagination.
     *
     * @param {LambdaSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<LambdaSearchResponse>>}
     */
    searchLambdas(request: LambdaSearchRequest): Promise<ClientResponse<LambdaSearchResponse>>;
    /**
     * Searches the login records with the specified criteria and pagination.
     *
     * @param {LoginRecordSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<LoginRecordSearchResponse>>}
     */
    searchLoginRecords(request: LoginRecordSearchRequest): Promise<ClientResponse<LoginRecordSearchResponse>>;
    /**
     * Searches tenants with the specified criteria and pagination.
     *
     * @param {TenantSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<TenantSearchResponse>>}
     */
    searchTenants(request: TenantSearchRequest): Promise<ClientResponse<TenantSearchResponse>>;
    /**
     * Searches themes with the specified criteria and pagination.
     *
     * @param {ThemeSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<ThemeSearchResponse>>}
     */
    searchThemes(request: ThemeSearchRequest): Promise<ClientResponse<ThemeSearchResponse>>;
    /**
     * Searches user comments with the specified criteria and pagination.
     *
     * @param {UserCommentSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<UserCommentSearchResponse>>}
     */
    searchUserComments(request: UserCommentSearchRequest): Promise<ClientResponse<UserCommentSearchResponse>>;
    /**
     * Retrieves the users for the given Ids. If any Id is invalid, it is ignored.
     *
     * @param {Array<string>} ids The user ids to search for.
     * @returns {Promise<ClientResponse<SearchResponse>>}
     *
     * @deprecated This method has been renamed to searchUsersByIds, use that method instead.
     */
    searchUsers(ids: Array<string>): Promise<ClientResponse<SearchResponse>>;
    /**
     * Retrieves the users for the given Ids. If any Id is invalid, it is ignored.
     *
     * @param {Array<string>} ids The user Ids to search for.
     * @returns {Promise<ClientResponse<SearchResponse>>}
     */
    searchUsersByIds(ids: Array<string>): Promise<ClientResponse<SearchResponse>>;
    /**
     * Retrieves the users for the given search criteria and pagination.
     *
     * @param {SearchRequest} request The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow,
     *    and sortFields.
     * @returns {Promise<ClientResponse<SearchResponse>>}
     */
    searchUsersByQuery(request: SearchRequest): Promise<ClientResponse<SearchResponse>>;
    /**
     * Retrieves the users for the given search criteria and pagination.
     *
     * @param {SearchRequest} request The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow,
     *    and sortFields.
     * @returns {Promise<ClientResponse<SearchResponse>>}
     *
     * @deprecated This method has been renamed to searchUsersByQuery, use that method instead.
     */
    searchUsersByQueryString(request: SearchRequest): Promise<ClientResponse<SearchResponse>>;
    /**
     * Searches the webhook event logs with the specified criteria and pagination.
     *
     * @param {WebhookEventLogSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<WebhookEventLogSearchResponse>>}
     */
    searchWebhookEventLogs(request: WebhookEventLogSearchRequest): Promise<ClientResponse<WebhookEventLogSearchResponse>>;
    /**
     * Searches webhooks with the specified criteria and pagination.
     *
     * @param {WebhookSearchRequest} request The search criteria and pagination information.
     * @returns {Promise<ClientResponse<WebhookSearchResponse>>}
     */
    searchWebhooks(request: WebhookSearchRequest): Promise<ClientResponse<WebhookSearchResponse>>;
    /**
     * Send an email using an email template Id. You can optionally provide <code>requestData</code> to access key value
     * pairs in the email template.
     *
     * @param {UUID} emailTemplateId The Id for the template.
     * @param {SendRequest} request The send email request that contains all the information used to send the email.
     * @returns {Promise<ClientResponse<SendResponse>>}
     */
    sendEmail(emailTemplateId: UUID, request: SendRequest): Promise<ClientResponse<SendResponse>>;
    /**
     * Sends out an email to a parent that they need to register and create a family or need to log in and add a child to their existing family.
     *
     * @param {FamilyEmailRequest} request The request object that contains the parent email.
     * @returns {Promise<ClientResponse<void>>}
     */
    sendFamilyRequestEmail(request: FamilyEmailRequest): Promise<ClientResponse<void>>;
    /**
     * Send a passwordless authentication code in an email to complete login.
     *
     * @param {PasswordlessSendRequest} request The passwordless send request that contains all the information used to send an email containing a code.
     * @returns {Promise<ClientResponse<void>>}
     */
    sendPasswordlessCode(request: PasswordlessSendRequest): Promise<ClientResponse<void>>;
    /**
     * 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 the information used to send the code.
     * @returns {Promise<ClientResponse<void>>}
     *
     * @deprecated This method has been renamed to sendTwoFactorCodeForEnableDisable, use that method instead.
     */
    sendTwoFactorCode(request: TwoFactorSendRequest): Promise<ClientResponse<void>>;
    /**
     * 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 the information used to send the code.
     * @returns {Promise<ClientResponse<void>>}
     */
    sendTwoFactorCodeForEnableDisable(request: TwoFactorSendRequest): Promise<ClientResponse<void>>;
    /**
     * Send a Two Factor authentication code to allow the completion of Two Factor authentication.
     *
     * @param {string} twoFactorId The Id returned by the Login API necessary to complete Two Factor authentication.
     * @returns {Promise<ClientResponse<void>>}
     *
     * @deprecated This method has been renamed to sendTwoFactorCodeForLoginUsingMethod, use that method instead.
     */
    sendTwoFactorCodeForLogin(twoFactorId: string): Promise<ClientResponse<void>>;
    /**
     * Send a Two Factor authentication code to allow the completion of Two Factor authentication.
     *
     * @param {string} twoFactorId The Id returned by the Login API necessary to complete Two Factor authentication.
     * @param {TwoFactorSendRequest} request The Two Factor send request that contains all the information used to send the Two Factor code to the user.
     * @returns {Promise<ClientResponse<void>>}
     */
    sendTwoFactorCodeForLoginUsingMethod(twoFactorId: string, request: TwoFactorSendRequest): Promise<ClientResponse<void>>;
    /**
     * 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: VerifySendRequest): Promise<ClientResponse<void>>;
    /**
     * Begins an identity provider connection test.
     *
     * @param {IdentityProviderConnectionTestRequest} request The request that contains information on the connection test.
     * @returns {Promise<ClientResponse<IdentityProviderConnectionTestResponse>>}
     */
    startIdentityProviderConnectionTest(request: IdentityProviderConnectionTestRequest): Promise<ClientResponse<IdentityProviderConnectionTestResponse>>;
    /**
     * Begins a login request for a 3rd party login that requires user interaction such as HYPR.
     *
     * @param {IdentityProviderStartLoginRequest} request The third-party login request that contains information from the third-party login
     *    providers that FusionAuth uses to reconcile the user's account.
     * @returns {Promise<ClientResponse<IdentityProviderStartLoginResponse>>}
     */
    startIdentityProviderLogin(request: IdentityProviderStartLoginRequest): Promise<ClientResponse<IdentityProviderStartLoginResponse>>;
    /**
     * Start a passwordless login request by generating a passwordless code. This code can be sent to the User using the Send
     * Passwordless Code API or using a mechanism outside of FusionAuth. The passwordless login is completed by using the Passwordless Login API with this code.
     *
     * @param {PasswordlessStartRequest} request The passwordless start request that contains all the information used to begin the passwordless login request.
     * @returns {Promise<ClientResponse<PasswordlessStartResponse>>}
     */
    startPasswordlessLogin(request: PasswordlessStartRequest): Promise<ClientResponse<PasswordlessStartResponse>>;
    /**
     * Start a Two-Factor login request by generating a two-factor identifier. This code can then be sent to the Two Factor Send
     * API (/api/two-factor/send)in order to send a one-time use code to a user. You can also use one-time use code returned
     * to send the code out-of-band. The Two-Factor login is completed by making a request to the Two-Factor Login
     * API (/api/two-factor/login). with the two-factor identifier and the one-time use code.
     *
     * This API is intended to allow you to begin a Two-Factor login outside a normal login that originated from the Login API (/api/login).
     *
     * @param {TwoFactorStartRequest} request The Two-Factor start request that contains all the information used to begin the Two-Factor login request.
     * @returns {Promise<ClientResponse<TwoFactorStartResponse>>}
     */
    startTwoFactorLogin(request: TwoFactorStartRequest): Promise<ClientResponse<TwoFactorStartResponse>>;
    /**
     * 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: VerifyStartRequest): Promise<ClientResponse<VerifyStartResponse>>;
    /**
     * Start a WebAuthn authentication ceremony by generating a new challenge for the user
     *
     * @param {WebAuthnStartRequest} request An object containing data necessary for starting the authentication ceremony
     * @returns {Promise<ClientResponse<WebAuthnStartResponse>>}
     */
    startWebAuthnLogin(request: WebAuthnStartRequest): Promise<ClientResponse<WebAuthnStartResponse>>;
    /**
     * Start a WebAuthn registration ceremony by generating a new challenge for the user
     *
     * @param {WebAuthnRegisterStartRequest} request An object containing data necessary for starting the registration ceremony
     * @returns {Promise<ClientResponse<WebAuthnRegisterStartResponse>>}
     */
    startWebAuthnRegistration(request: WebAuthnRegisterStartRequest): Promise<ClientResponse<WebAuthnRegisterStartResponse>>;
    /**
     * Complete login using a 2FA challenge
     *
     * @param {TwoFactorLoginRequest} request The login request that contains the user credentials used to log them in.
     * @returns {Promise<ClientResponse<LoginResponse>>}
     */
    twoFactorLogin(request: TwoFactorLoginRequest): Promise<ClientResponse<LoginResponse>>;
    /**
     * Updates an API key with the given Id.
     *
     * @param {UUID} keyId The Id of the API key to update.
     * @param {APIKeyRequest} request The request that contains all the new API key information.
     * @returns {Promise<ClientResponse<APIKeyResponse>>}
     */
    updateAPIKey(keyId: UUID, request: APIKeyRequest): Promise<ClientResponse<APIKeyResponse>>;
    /**
     * Updates the application with the given Id.
     *
     * @param {UUID} applicationId The Id of the application to update.
     * @param {ApplicationRequest} request The request that contains all the new application information.
     * @returns {Promise<ClientResponse<ApplicationResponse>>}
     */
    updateApplication(applicationId: UUID, request: ApplicationRequest): Promise<ClientResponse<ApplicationResponse>>;
    /**
     * Updates the application role with the given Id for the application.
     *
     * @param {UUID} applicationId The Id of the application that the role belongs to.
     * @param {UUID} roleId The Id of the role to update.
     * @param {ApplicationRequest} request The request that contains all the new role information.
     * @returns {Promise<ClientResponse<ApplicationResponse>>}
     */
    updateApplicationRole(applicationId: UUID, roleId: UUID, request: ApplicationRequest): Promise<ClientResponse<ApplicationResponse>>;
    /**
     * Updates the connector with the given Id.
     *
     * @param {UUID} connectorId The Id of the connector to update.
     * @param {ConnectorRequest} request The request object that contains all the new connector information.
     * @returns {Promise<ClientResponse<ConnectorResponse>>}
     */
    updateConnector(connectorId: UUID, request: ConnectorRequest): Promise<ClientResponse<ConnectorResponse>>;
    /**
     * Updates the consent with the given Id.
     *
     * @param {UUID} consentId The Id of the consent to update.
     * @param {ConsentRequest} request The request that contains all the new consent information.
     * @returns {Promise<ClientResponse<ConsentResponse>>}
     */
    updateConsent(consentId: UUID, request: ConsentRequest): Promise<ClientResponse<ConsentResponse>>;
    /**
     * Updates the email template with the given Id.
     *
     * @param {UUID} emailTemplateId The Id of the email template to update.
     * @param {EmailTemplateRequest} request The request that contains all the new email template information.
     * @returns {Promise<ClientResponse<EmailTemplateResponse>>}
     */
    updateEmailTemplate(emailTemplateId: UUID, request: EmailTemplateRequest): Promise<ClientResponse<EmailTemplateResponse>>;
    /**
     * Updates the Entity with the given Id.
     *
     * @param {UUID} entityId The Id of the Entity to update.
     * @param {EntityRequest} request The request that contains all the new Entity information.
     * @returns {Promise<ClientResponse<EntityResponse>>}
     */
    updateEntity(entityId: UUID, request: EntityRequest): Promise<ClientResponse<EntityResponse>>;
    /**
     * Updates the Entity Type with the given Id.
     *
     * @param {UUID} entityTypeId The Id of the Entity Type to update.
     * @param {EntityTypeRequest} request The request that contains all the new Entity Type information.
     * @returns {Promise<ClientResponse<EntityTypeResponse>>}
     */
    updateEntityType(entityTypeId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
    /**
     * Updates the permission with the given Id for the entity type.
     *
     * @param {UUID} entityTypeId The Id of the entityType that the permission belongs to.
     * @param {UUID} permissionId The Id of the permission to update.
     * @param {EntityTypeRequest} request The request that contains all the new permission information.
     * @returns {Promise<ClientResponse<EntityTypeResponse>>}
     */
    updateEntityTypePermission(entityTypeId: UUID, permissionId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
    /**
     * Updates a family with a given Id.
     *
     * @param {UUID} familyId The Id of the family to update.
     * @param {FamilyRequest} request The request object that contains all the new family information.
     * @returns {Promise<ClientResponse<FamilyResponse>>}
     */
    updateFamily(familyId: UUID, request: FamilyRequest): Promise<ClientResponse<FamilyResponse>>;
    /**
     * Updates the form with the given Id.
     *
     * @param {UUID} formId The Id of the form to update.
     * @param {FormRequest} request The request object that contains all the new form information.
     * @returns {Promise<ClientResponse<FormResponse>>}
     */
    updateForm(formId: UUID, request: FormRequest): Promise<ClientResponse<FormResponse>>;
    /**
     * Updates the form field with the given Id.
     *
     * @param {UUID} fieldId The Id of the form field to update.
     * @param {FormFieldRequest} request The request object that contains all the new form field information.
     * @returns {Promise<ClientResponse<FormFieldResponse>>}
     */
    updateFormField(fieldId: UUID, request: FormFieldRequest): Promise<ClientResponse<FormFieldResponse>>;
    /**
     * Updates the group with the given Id.
     *
     * @param {UUID} groupId The Id of the group to update.
     * @param {GroupRequest} request The request that contains all the new group information.
     * @returns {Promise<ClientResponse<GroupResponse>>}
     */
    updateGroup(groupId: UUID, request: GroupRequest): Promise<ClientResponse<GroupResponse>>;
    /**
     * 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: MemberRequest): Promise<ClientResponse<MemberResponse>>;
    /**
     * 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 the new IP Access Control List information.
     * @returns {Promise<ClientResponse<IPAccessControlListResponse>>}
     */
    updateIPAccessControlList(accessControlListId: UUID, request: IPAccessControlListRequest): Promise<ClientResponse<IPAccessControlListResponse>>;
    /**
     * Updates the identity provider with the given Id.
     *
     * @param {UUID} identityProviderId The Id of the identity provider to update.
     * @param {IdentityProviderRequest} request The request object that contains the updated identity provider.
     * @returns {Promise<ClientResponse<IdentityProviderResponse>>}
     */
    updateIdentityProvider(identityProviderId: UUID, request: IdentityProviderRequest): Promise<ClientResponse<IdentityProviderResponse>>;
    /**
     * Updates the available integrations.
     *
     * @param {IntegrationRequest} request The request that contains all the new integration information.
     * @returns {Promise<ClientResponse<IntegrationResponse>>}
     */
    updateIntegrations(request: IntegrationRequest): Promise<ClientResponse<IntegrationResponse>>;
    /**
     * Updates the key with the given Id.
     *
     * @param {UUID} keyId The Id of the key to update.
     * @param {KeyRequest} request The request that contains all the new key information.
     * @returns {Promise<ClientResponse<KeyResponse>>}
     */
    updateKey(keyId: UUID, request: KeyRequest): Promise<ClientResponse<KeyResponse>>;
    /**
     * Updates the lambda with the given Id.
     *
     * @param {UUID} lambdaId The Id of the lambda to update.
     * @param {LambdaRequest} request The request that contains all the new lambda information.
     * @returns {Promise<ClientResponse<LambdaResponse>>}
     */
    updateLambda(lambdaId: UUID, request: LambdaRequest): Promise<ClientResponse<LambdaResponse>>;
    /**
     * Updates the message template with the given Id.
     *
     * @param {UUID} messageTemplateId The Id of the message template to update.
     * @param {MessageTemplateRequest} request The request that contains all the new message template information.
     * @returns {Promise<ClientResponse<MessageTemplateResponse>>}
     */
    updateMessageTemplate(messageTemplateId: UUID, request: MessageTemplateRequest): Promise<ClientResponse<MessageTemplateResponse>>;
    /**
     * Updates the messenger with the given Id.
     *
     * @param {UUID} messengerId The Id of the messenger to update.
     * @param {MessengerRequest} request The request object that contains all the new messenger information.
     * @returns {Promise<ClientResponse<MessengerResponse>>}
     */
    updateMessenger(messengerId: UUID, request: MessengerRequest): Promise<ClientResponse<MessengerResponse>>;
    /**
     * Updates the OAuth scope with the given Id for the application.
     *
     * @param {UUID} applicationId The Id of the application that the OAuth scope belongs to.
     * @param {UUID} scopeId The Id of the OAuth scope to update.
     * @param {ApplicationOAuthScopeRequest} request The request that contains all the new OAuth scope information.
     * @returns {Promise<ClientResponse<ApplicationOAuthScopeResponse>>}
     */
    updateOAuthScope(applicationId: UUID, scopeId: UUID, request: ApplicationOAuthScopeRequest): Promise<ClientResponse<ApplicationOAuthScopeResponse>>;
    /**
     * Updates the registration for the user with the given Id and the application defined in the request.
     *
     * @param {UUID} userId The Id of the user whose registration is going to be updated.
     * @param {RegistrationRequest} request The request that contains all the new registration information.
     * @returns {Promise<ClientResponse<RegistrationResponse>>}
     */
    updateRegistration(userId: UUID, request: RegistrationRequest): Promise<ClientResponse<RegistrationResponse>>;
    /**
     * Updates the system configuration.
     *
     * @param {SystemConfigurationRequest} request The request that contains all the new system configuration information.
     * @returns {Promise<ClientResponse<SystemConfigurationResponse>>}
     */
    updateSystemConfiguration(request: SystemConfigurationRequest): Promise<ClientResponse<SystemConfigurationResponse>>;
    /**
     * Updates the tenant with the given Id.
     *
     * @param {UUID} tenantId The Id of the tenant to update.
     * @param {TenantRequest} request The request that contains all the new tenant information.
     * @returns {Promise<ClientResponse<TenantResponse>>}
     */
    updateTenant(tenantId: UUID, request: TenantRequest): Promise<ClientResponse<TenantResponse>>;
    /**
     * Updates the Tenant Manager configuration.
     *
     * @param {TenantManagerConfigurationRequest} request The request that contains all the new Tenant Manager configuration information.
     * @returns {Promise<ClientResponse<TenantManagerConfigurationResponse>>}
     */
    updateTenantManagerConfiguration(request: TenantManagerConfigurationRequest): Promise<ClientResponse<TenantManagerConfigurationResponse>>;
    /**
     * Updates the tenant manager identity provider type configuration for the given identity provider type.
     *
     * @param {IdentityProviderType} type The type of the identity provider.
     * @param {TenantManagerIdentityProviderTypeConfigurationRequest} request The request object that contains the updated tenant manager identity provider type configuration.
     * @returns {Promise<ClientResponse<TenantManagerIdentityProviderTypeConfigurationResponse>>}
     */
    updateTenantManagerIdentityProviderTypeConfiguration(type: IdentityProviderType, request: TenantManagerIdentityProviderTypeConfigurationRequest): Promise<ClientResponse<TenantManagerIdentityProviderTypeConfigurationResponse>>;
    /**
     * Updates the theme with the given Id.
     *
     * @param {UUID} themeId The Id of the theme to update.
     * @param {ThemeRequest} request The request that contains all the new theme information.
     * @returns {Promise<ClientResponse<ThemeResponse>>}
     */
    updateTheme(themeId: UUID, request: ThemeRequest): Promise<ClientResponse<ThemeResponse>>;
    /**
     * Updates the user with the given Id.
     *
     * @param {UUID} userId The Id of the user to update.
     * @param {UserRequest} request The request that contains all the new user information.
     * @returns {Promise<ClientResponse<UserResponse>>}
     */
    updateUser(userId: UUID, request: UserRequest): Promise<ClientResponse<UserResponse>>;
    /**
     * Updates the user action with the given Id.
     *
     * @param {UUID} userActionId The Id of the user action to update.
     * @param {UserActionRequest} request The request that contains all the new user action information.
     * @returns {Promise<ClientResponse<UserActionResponse>>}
     */
    updateUserAction(userActionId: UUID, request: UserActionRequest): Promise<ClientResponse<UserActionResponse>>;
    /**
     * Updates the user action reason with the given Id.
     *
     * @param {UUID} userActionReasonId The Id of the user action reason to update.
     * @param {UserActionReasonRequest} request The request that contains all the new user action reason information.
     * @returns {Promise<ClientResponse<UserActionReasonResponse>>}
     */
    updateUserActionReason(userActionReasonId: UUID, request: UserActionReasonRequest): Promise<ClientResponse<UserActionReasonResponse>>;
    /**
     * Updates a single User consent by Id.
     *
     * @param {UUID} userConsentId The User Consent Id
     * @param {UserConsentRequest} request The request that contains the user consent information.
     * @returns {Promise<ClientResponse<UserConsentResponse>>}
     */
    updateUserConsent(userConsentId: UUID, request: UserConsentRequest): Promise<ClientResponse<UserConsentResponse>>;
    /**
     * Updates the webhook with the given Id.
     *
     * @param {UUID} webhookId The Id of the webhook to update.
     * @param {WebhookRequest} request The request that contains all the new webhook information.
     * @returns {Promise<ClientResponse<WebhookResponse>>}
     */
    updateWebhook(webhookId: UUID, request: WebhookRequest): Promise<ClientResponse<WebhookResponse>>;
    /**
     * 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 the information used to create the Entity Grant.
     * @returns {Promise<ClientResponse<void>>}
     */
    upsertEntityGrant(entityId: UUID, request: EntityGrantRequest): Promise<ClientResponse<void>>;
    /**
     * Validates the end-user provided user_code from the user-interaction of the Device Authorization Grant.
     * If you build your own activation form you should validate the user provided code prior to beginning the Authorization grant.
     *
     * @param {string} user_code The end-user verification code.
     * @param {string} client_id The client Id.
     * @returns {Promise<ClientResponse<void>>}
     */
    validateDevice(user_code: string, client_id: string): Promise<ClientResponse<void>>;
    /**
     * Validates the end-user provided user_code from the user-interaction of the Device Authorization Grant.
     * If you build your own activation form you should validate the user provided code prior to beginning the Authorization grant.
     *
     * @param {ValidateDeviceRequest} request The device validation request.
     * @returns {Promise<ClientResponse<void>>}
     */
    validateDeviceWithRequest(request: ValidateDeviceRequest): Promise<ClientResponse<void>>;
    /**
     * Validates the provided JWT (encoded JWT string) to ensure the token is valid. A valid access token is properly
     * signed and not expired.
     * <p>
     * This API may be used to verify the JWT as well as decode the encoded JWT into human readable identity claims.
     *
     * @param {string} encodedJWT The encoded JWT (access token).
     * @returns {Promise<ClientResponse<ValidateResponse>>}
     */
    validateJWT(encodedJWT: string): Promise<ClientResponse<ValidateResponse>>;
    /**
     * 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 the claims for this JWT.
     * @returns {Promise<ClientResponse<JWTVendResponse>>}
     */
    vendJWT(request: JWTVendRequest): Promise<ClientResponse<JWTVendResponse>>;
    /**
     * Confirms a email verification. The Id given is usually from an email sent to the user.
     *
     * @param {string} verificationId The email verification Id sent to the user.
     * @returns {Promise<ClientResponse<void>>}
     *
     * @deprecated This method has been renamed to verifyEmailAddress and changed to take a JSON request body, use that method instead.
     */
    verifyEmail(verificationId: string): Promise<ClientResponse<void>>;
    /**
     * Confirms a user's email address.
     *
     * The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When
     * the tenant is configured to gate a user until their email address is verified, this procedures requires two values instead of one.
     * The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The
     * two values together are able to confirm a user's email address and mark the user's email address as verified.
     *
     * @param {VerifyEmailRequest} request The request that contains the verificationId and optional one-time use code paired with the verificationId.
     * @returns {Promise<ClientResponse<void>>}
     */
    verifyEmailAddress(request: VerifyEmailRequest): Promise<ClientResponse<void>>;
    /**
     * 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: VerifyEmailRequest): Promise<ClientResponse<void>>;
    /**
     * 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: VerifyRequest): Promise<ClientResponse<void>>;
    /**
     * Confirms an application registration. The Id given is usually from an email sent to the user.
     *
     * @param {string} verificationId The registration verification Id sent to the user.
     * @returns {Promise<ClientResponse<void>>}
     *
     * @deprecated This method has been renamed to verifyUserRegistration and changed to take a JSON request body, use that method instead.
     */
    verifyRegistration(verificationId: string): Promise<ClientResponse<void>>;
    /**
     * Confirms a user's registration.
     *
     * The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When
     * the application is configured to gate a user until their registration is verified, this procedures requires two values instead of one.
     * The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The
     * two values together are able to confirm a user's registration and mark the user's registration as verified.
     *
     * @param {VerifyRegistrationRequest} request The request that contains the verificationId and optional one-time use code paired with the verificationId.
     * @returns {Promise<ClientResponse<void>>}
     */
    verifyUserRegistration(request: VerifyRegistrationRequest): Promise<ClientResponse<void>>;
    /**
     * creates a rest client
     *
     * @returns The RESTClient that will be used to call.
     * @private
     */
    private start;
    private startAnonymous;
}
export default FusionAuthClient;
/**
 * A 128 bit UUID in string format "8-4-4-4-12", for example "58D5E212-165B-4CA0-909B-C86B9CEE0111".
 */
export declare type UUID = string;
/**
 * domain POJO to represent AuthenticationKey
 *
 * @author sanjay
 */
export interface APIKey {
    expirationInstant?: number;
    id?: UUID;
    insertInstant?: number;
    ipAccessControlListId?: UUID;
    key?: string;
    keyManager?: boolean;
    lastUpdateInstant?: number;
    metaData?: APIKeyMetaData;
    name?: string;
    permissions?: APIKeyPermissions;
    retrievable?: boolean;
    tenantId?: UUID;
}
export interface APIKeyMetaData {
    attributes?: Record<string, string>;
}
export interface APIKeyPermissions {
    endpoints?: Record<string, Array<string>>;
}
/**
 * Authentication key request object.
 *
 * @author Sanjay
 */
export interface APIKeyRequest {
    apiKey?: APIKey;
    sourceKeyId?: UUID;
}
/**
 * Authentication key response object.
 *
 * @author Sanjay
 */
export interface APIKeyResponse {
    apiKey?: APIKey;
}
/**
 * @author Daniel DeGroff
 */
export interface AccessToken {
    access_token?: string;
    expires_in?: number;
    id_token?: string;
    refresh_token?: string;
    refresh_token_id?: UUID;
    scope?: string;
    token_type?: TokenType;
    userId?: UUID;
}
/**
 * The request object for introspecting an access token.
 *
 * @author Lyle Schemmerling
 */
export interface AccessTokenIntrospectRequest {
    client_id?: string;
    tenantId?: string;
    token?: string;
    token_type_hint?: string;
}
/**
 * The user action request object.
 *
 * @author Brian Pontarelli
 */
export interface ActionRequest extends BaseEventRequest {
    action?: ActionData;
    broadcast?: boolean;
}
export interface ActionData {
    actioneeUserId?: UUID;
    actionerUserId?: UUID;
    applicationIds?: Array<UUID>;
    comment?: string;
    emailUser?: boolean;
    expiry?: number;
    notifyUser?: boolean;
    option?: string;
    reasonId?: UUID;
    userActionId?: UUID;
}
/**
 * The user action response object.
 *
 * @author Brian Pontarelli
 */
export interface ActionResponse {
    action?: UserActionLog;
    actions?: Array<UserActionLog>;
}
/**
 * Available JSON Web Algorithms (JWA) as described in RFC 7518 available for this JWT implementation.
 *
 * @author Daniel DeGroff
 */
export declare enum Algorithm {
    ES256 = "ES256",
    ES384 = "ES384",
    ES512 = "ES512",
    HS256 = "HS256",
    HS384 = "HS384",
    HS512 = "HS512",
    PS256 = "PS256",
    PS384 = "PS384",
    PS512 = "PS512",
    RS256 = "RS256",
    RS384 = "RS384",
    RS512 = "RS512",
    none = "none"
}
/**
 * @author Daniel DeGroff
 */
export interface AppleApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
    bundleId?: string;
    buttonText?: string;
    keyId?: UUID;
    scope?: string;
    servicesId?: string;
    teamId?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface AppleIdentityProvider extends BaseIdentityProvider<AppleApplicationConfiguration> {
    bundleId?: string;
    buttonText?: string;
    keyId?: UUID;
    scope?: string;
    servicesId?: string;
    teamId?: string;
}
/**
 * @author Seth Musselman
 */
export interface Application {
    accessControlConfiguration?: ApplicationAccessControlConfiguration;
    active?: boolean;
    authenticationTokenConfiguration?: AuthenticationTokenConfiguration;
    cleanSpeakConfiguration?: CleanSpeakConfiguration;
    data?: Record<string, any>;
    emailConfiguration?: ApplicationEmailConfiguration;
    externalIdentifierConfiguration?: ApplicationExternalIdentifierConfiguration;
    formConfiguration?: ApplicationFormConfiguration;
    id?: UUID;
    insertInstant?: number;
    jwtConfiguration?: JWTConfiguration;
    lambdaConfiguration?: LambdaConfiguration;
    lastUpdateInstant?: number;
    loginConfiguration?: LoginConfiguration;
    multiFactorConfiguration?: ApplicationMultiFactorConfiguration;
    name?: string;
    oauthConfiguration?: OAuth2Configuration;
    passwordlessConfiguration?: PasswordlessConfiguration;
    phoneConfiguration?: ApplicationPhoneConfiguration;
    registrationConfiguration?: RegistrationConfiguration;
    registrationDeletePolicy?: ApplicationRegistrationDeletePolicy;
    roles?: Array<ApplicationRole>;
    samlv2Configuration?: SAMLv2Configuration;
    scopes?: Array<ApplicationOAuthScope>;
    state?: ObjectState;
    tenantId?: UUID;
    themeId?: UUID;
    universalConfiguration?: UniversalApplicationConfiguration;
    unverified?: RegistrationUnverifiedOptions;
    verificationEmailTemplateId?: UUID;
    verificationStrategy?: VerificationStrategy;
    verifyRegistration?: boolean;
    webAuthnConfiguration?: ApplicationWebAuthnConfiguration;
}
export interface ApplicationEmailConfiguration {
    emailUpdateEmailTemplateId?: UUID;
    emailVerificationEmailTemplateId?: UUID;
    emailVerifiedEmailTemplateId?: UUID;
    forgotPasswordEmailTemplateId?: UUID;
    loginIdInUseOnCreateEmailTemplateId?: UUID;
    loginIdInUseOnUpdateEmailTemplateId?: UUID;
    loginNewDeviceEmailTemplateId?: UUID;
    loginSuspiciousEmailTemplateId?: UUID;
    passwordlessEmailTemplateId?: UUID;
    passwordResetSuccessEmailTemplateId?: UUID;
    passwordUpdateEmailTemplateId?: UUID;
    setPasswordEmailTemplateId?: UUID;
    twoFactorMethodAddEmailTemplateId?: UUID;
    twoFactorMethodRemoveEmailTemplateId?: UUID;
}
export interface AuthenticationTokenConfiguration extends Enableable {
}
export interface LambdaConfiguration {
    accessTokenPopulateId?: UUID;
    idTokenPopulateId?: UUID;
    multiFactorRequirementId?: UUID;
    samlv2PopulateId?: UUID;
    selfServiceRegistrationValidationId?: UUID;
    userinfoPopulateId?: UUID;
}
export interface LoginConfiguration {
    allowTokenRefresh?: boolean;
    generateRefreshTokens?: boolean;
    requireAuthentication?: boolean;
}
export interface PasswordlessConfiguration extends Enableable {
    emailLoginStrategy?: PasswordlessStrategy;
    phoneLoginStrategy?: PasswordlessStrategy;
}
export interface RegistrationConfiguration extends Enableable {
    birthDate?: Requirable;
    completeRegistration?: boolean;
    confirmPassword?: boolean;
    firstName?: Requirable;
    formId?: UUID;
    fullName?: Requirable;
    lastName?: Requirable;
    loginIdType?: LoginIdType;
    middleName?: Requirable;
    mobilePhone?: Requirable;
    preferredLanguages?: Requirable;
    type?: RegistrationType;
}
export declare enum LoginIdType {
    email = "email",
    phoneNumber = "phoneNumber",
    username = "username"
}
export declare enum RegistrationType {
    basic = "basic",
    advanced = "advanced"
}
export interface SAMLv2Configuration extends Enableable {
    assertionEncryptionConfiguration?: SAMLv2AssertionEncryptionConfiguration;
    audience?: string;
    authorizedRedirectURLs?: Array<string>;
    callbackURL?: string;
    debug?: boolean;
    defaultVerificationKeyId?: UUID;
    initiatedLogin?: SAMLv2IdPInitiatedLoginConfiguration;
    issuer?: string;
    keyId?: UUID;
    loginHintConfiguration?: LoginHintConfiguration;
    logout?: SAMLv2Logout;
    logoutURL?: string;
    requireSignedRequests?: boolean;
    xmlSignatureC14nMethod?: CanonicalizationMethod;
    xmlSignatureLocation?: XMLSignatureLocation;
}
export declare enum SAMLLogoutBehavior {
    AllParticipants = "AllParticipants",
    OnlyOriginator = "OnlyOriginator"
}
export interface SAMLv2AssertionEncryptionConfiguration extends Enableable {
    digestAlgorithm?: string;
    encryptionAlgorithm?: string;
    keyLocation?: string;
    keyTransportAlgorithm?: string;
    keyTransportEncryptionKeyId?: UUID;
    maskGenerationFunction?: string;
}
export interface SAMLv2Logout {
    behavior?: SAMLLogoutBehavior;
    defaultVerificationKeyId?: UUID;
    keyId?: UUID;
    requireSignedRequests?: boolean;
    singleLogout?: SAMLv2SingleLogout;
    xmlSignatureC14nMethod?: CanonicalizationMethod;
}
export interface SAMLv2SingleLogout extends Enableable {
    keyId?: UUID;
    url?: string;
    xmlSignatureC14nMethod?: CanonicalizationMethod;
}
export declare enum XMLSignatureLocation {
    Assertion = "Assertion",
    Response = "Response"
}
/**
 * @author Daniel DeGroff
 */
export interface ApplicationAccessControlConfiguration {
    uiIPAccessControlListId?: UUID;
}
/**
 * Events that are bound to applications.
 *
 * @author Brian Pontarelli
 */
export interface ApplicationEvent {
}
/**
 * @author Daniel DeGroff
 */
export interface ApplicationExternalIdentifierConfiguration {
    twoFactorTrustIdTimeToLiveInSeconds?: number;
}
/**
 * @author Daniel DeGroff
 */
export interface ApplicationFormConfiguration {
    adminRegistrationFormId?: UUID;
    selfServiceFormConfiguration?: SelfServiceFormConfiguration;
    selfServiceFormId?: UUID;
}
/**
 * @author Daniel DeGroff
 */
export interface ApplicationMultiFactorConfiguration {
    email?: MultiFactorEmailTemplate;
    loginPolicy?: MultiFactorLoginPolicy;
    sms?: MultiFactorSMSTemplate;
    trustPolicy?: ApplicationMultiFactorTrustPolicy;
    voice?: MultiFactorVoiceTemplate;
}
export interface MultiFactorEmailTemplate {
    templateId?: UUID;
}
export interface MultiFactorSMSTemplate {
    templateId?: UUID;
}
export interface MultiFactorVoiceTemplate {
    templateId?: UUID;
}
/**
 * @author Daniel DeGroff
 */
export declare enum ApplicationMultiFactorTrustPolicy {
    Any = "Any",
    This = "This",
    None = "None"
}
/**
 * A custom OAuth scope for a specific application.
 *
 * @author Spencer Witt
 */
export interface ApplicationOAuthScope {
    applicationId?: UUID;
    data?: Record<string, any>;
    defaultConsentDetail?: string;
    defaultConsentMessage?: string;
    description?: string;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    name?: string;
    required?: boolean;
}
/**
 * The Application Scope API request object.
 *
 * @author Spencer Witt
 */
export interface ApplicationOAuthScopeRequest {
    scope?: ApplicationOAuthScope;
}
/**
 * The Application Scope API response.
 *
 * @author Spencer Witt
 */
export interface ApplicationOAuthScopeResponse {
    scope?: ApplicationOAuthScope;
}
/**
 * Hold application phone configuration for template overrides.
 */
export interface ApplicationPhoneConfiguration {
    forgotPasswordTemplateId?: UUID;
    identityUpdateTemplateId?: UUID;
    loginIdInUseOnCreateTemplateId?: UUID;
    loginIdInUseOnUpdateTemplateId?: UUID;
    loginNewDeviceTemplateId?: UUID;
    loginSuspiciousTemplateId?: UUID;
    passwordlessTemplateId?: UUID;
    passwordResetSuccessTemplateId?: UUID;
    passwordUpdateTemplateId?: UUID;
    setPasswordTemplateId?: UUID;
    twoFactorMethodAddTemplateId?: UUID;
    twoFactorMethodRemoveTemplateId?: UUID;
    verificationCompleteTemplateId?: UUID;
    verificationTemplateId?: UUID;
}
/**
 * A Application-level policy for deleting Users.
 *
 * @author Trevor Smith
 */
export interface ApplicationRegistrationDeletePolicy {
    unverified?: TimeBasedDeletePolicy;
}
/**
 * The Application API request object.
 *
 * @author Brian Pontarelli
 */
export interface ApplicationRequest extends BaseEventRequest {
    application?: Application;
    role?: ApplicationRole;
    sourceApplicationId?: UUID;
}
/**
 * The Application API response.
 *
 * @author Brian Pontarelli
 */
export interface ApplicationResponse {
    application?: Application;
    applications?: Array<Application>;
    role?: ApplicationRole;
}
/**
 * A role given to a user for a specific application.
 *
 * @author Seth Musselman
 */
export interface ApplicationRole {
    description?: string;
    id?: UUID;
    insertInstant?: number;
    isDefault?: boolean;
    isSuperRole?: boolean;
    lastUpdateInstant?: number;
    name?: string;
}
/**
 * Search criteria for Applications
 *
 * @author Spencer Witt
 */
export interface ApplicationSearchCriteria extends BaseSearchCriteria {
    name?: string;
    state?: ObjectState;
    tenantId?: UUID;
    universal?: boolean;
}
/**
 * Search request for Applications
 *
 * @author Spencer Witt
 */
export interface ApplicationSearchRequest extends ExpandableRequest {
    search?: ApplicationSearchCriteria;
}
/**
 * Application search response
 *
 * @author Spencer Witt
 */
export interface ApplicationSearchResponse extends ExpandableResponse {
    applications?: Array<Application>;
    total?: number;
}
/**
 * Application-level configuration for WebAuthn
 *
 * @author Daniel DeGroff
 */
export interface ApplicationWebAuthnConfiguration extends Enableable {
    bootstrapWorkflow?: ApplicationWebAuthnWorkflowConfiguration;
    reauthenticationWorkflow?: ApplicationWebAuthnWorkflowConfiguration;
}
/**
 * @author Daniel DeGroff
 */
export interface ApplicationWebAuthnWorkflowConfiguration extends Enableable {
}
/**
 * This class is a simple attachment with a byte array, name and MIME type.
 *
 * @author Brian Pontarelli
 */
export interface Attachment {
    attachment?: Array<number>;
    mime?: string;
    name?: string;
}
/**
 * Used to communicate whether and how authenticator attestation should be delivered to the Relying Party
 *
 * @author Spencer Witt
 */
export declare enum AttestationConveyancePreference {
    none = "none",
    indirect = "indirect",
    direct = "direct",
    enterprise = "enterprise"
}
/**
 * Used to indicate what type of attestation was included in the authenticator response for a given WebAuthn credential at the time it was created
 *
 * @author Spencer Witt
 */
export declare enum AttestationType {
    basic = "basic",
    self = "self",
    attestationCa = "attestationCa",
    anonymizationCa = "anonymizationCa",
    none = "none"
}
/**
 * An audit log.
 *
 * @author Brian Pontarelli
 */
export interface AuditLog {
    data?: Record<string, any>;
    id?: number;
    insertInstant?: number;
    insertUser?: string;
    message?: string;
    newValue?: any;
    oldValue?: any;
    reason?: string;
    tenantId?: UUID;
}
/**
 * Event to indicate an audit log was created.
 *
 * @author Daniel DeGroff
 */
export interface AuditLogCreateEvent extends BaseEvent {
    auditLog?: AuditLog;
}
/**
 * @author Daniel DeGroff
 */
export interface AuditLogExportRequest extends BaseExportRequest {
    criteria?: AuditLogSearchCriteria;
}
/**
 * @author Brian Pontarelli
 */
export interface AuditLogRequest extends BaseEventRequest {
    auditLog?: AuditLog;
}
/**
 * Audit log response.
 *
 * @author Brian Pontarelli
 */
export interface AuditLogResponse {
    auditLog?: AuditLog;
}
/**
 * @author Brian Pontarelli
 */
export interface AuditLogSearchCriteria extends BaseSearchCriteria {
    end?: number;
    message?: string;
    newValue?: string;
    oldValue?: string;
    reason?: string;
    start?: number;
    tenantId?: UUID;
    user?: string;
}
/**
 * @author Brian Pontarelli
 */
export interface AuditLogSearchRequest {
    search?: AuditLogSearchCriteria;
}
/**
 * Audit log response.
 *
 * @author Brian Pontarelli
 */
export interface AuditLogSearchResponse {
    auditLogs?: Array<AuditLog>;
    total?: number;
}
/**
 * @author Brett Pontarelli
 */
export declare enum AuthenticationThreats {
    ImpossibleTravel = "ImpossibleTravel"
}
/**
 * Describes the <a href="https://www.w3.org/TR/webauthn-2/#authenticator-attachment-modality">authenticator attachment modality</a>.
 *
 * @author Spencer Witt
 */
export declare enum AuthenticatorAttachment {
    platform = "platform",
    crossPlatform = "crossPlatform"
}
/**
 * Describes the authenticator attachment modality preference for a WebAuthn workflow. See {@link AuthenticatorAttachment}
 *
 * @author Spencer Witt
 */
export declare enum AuthenticatorAttachmentPreference {
    any = "any",
    platform = "platform",
    crossPlatform = "crossPlatform"
}
/**
 * @author Daniel DeGroff
 */
export interface AuthenticatorConfiguration {
    algorithm?: TOTPAlgorithm;
    codeLength?: number;
    timeStep?: number;
}
export declare enum TOTPAlgorithm {
    HmacSHA1 = "HmacSHA1",
    HmacSHA256 = "HmacSHA256",
    HmacSHA512 = "HmacSHA512"
}
/**
 * Used by the Relying Party to specify their requirements for authenticator attributes. Fields use the deprecated "resident key" terminology to refer
 * to client-side discoverable credentials to maintain backwards compatibility with WebAuthn Level 1.
 *
 * @author Spencer Witt
 */
export interface AuthenticatorSelectionCriteria {
    authenticatorAttachment?: AuthenticatorAttachment;
    requireResidentKey?: boolean;
    residentKey?: ResidentKeyRequirement;
    userVerification?: UserVerificationRequirement;
}
export interface BaseConnectorConfiguration {
    data?: Record<string, any>;
    debug?: boolean;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    name?: string;
    type?: ConnectorType;
}
/**
 * @author Brian Pontarelli
 */
export interface BaseElasticSearchCriteria extends BaseSearchCriteria {
    accurateTotal?: boolean;
    ids?: Array<UUID>;
    nextResults?: string;
    query?: string;
    queryString?: string;
    sortFields?: Array<SortField>;
}
/**
 * Base class for all FusionAuth events.
 *
 * @author Brian Pontarelli
 */
export interface BaseEvent {
    createInstant?: number;
    id?: UUID;
    info?: EventInfo;
    tenantId?: UUID;
    type?: EventType;
}
/**
 * Base class for requests that can contain event information. This event information is used when sending Webhooks or emails
 * during the transaction. The caller is responsible for ensuring that the event information is correct.
 *
 * @author Brian Pontarelli
 */
export interface BaseEventRequest {
    eventInfo?: EventInfo;
}
/**
 * @author Daniel DeGroff
 */
export interface BaseExportRequest {
    dateTimeSecondsFormat?: string;
    zoneId?: string;
}
/**
 * Base class for all {@link Group} and {@link GroupMember} events.
 *
 * @author Spencer Witt
 */
export interface BaseGroupEvent extends BaseEvent {
    group?: Group;
}
export interface BaseIdentityProvider<D extends BaseIdentityProviderApplicationConfiguration> extends Enableable {
    applicationConfiguration?: Record<UUID, D>;
    attributeMappings?: Record<string, string>;
    data?: Record<string, any>;
    debug?: boolean;
    id?: UUID;
    insertInstant?: number;
    lambdaConfiguration?: LambdaConfiguration;
    lastUpdateInstant?: number;
    linkingStrategy?: IdentityProviderLinkingStrategy;
    name?: string;
    source?: string;
    tenantConfiguration?: Record<UUID, IdentityProviderTenantConfiguration>;
    tenantId?: UUID;
    type?: IdentityProviderType;
}
export interface LambdaConfiguration {
    reconcileId?: UUID;
}
/**
 * @author Daniel DeGroff
 */
export interface BaseIdentityProviderApplicationConfiguration extends Enableable {
    createRegistration?: boolean;
    data?: Record<string, any>;
}
/**
 * @author Daniel DeGroff
 */
export interface BaseLoginRequest extends BaseEventRequest {
    applicationId?: UUID;
    ipAddress?: string;
    metaData?: MetaData;
    newDevice?: boolean;
    noJWT?: boolean;
}
export interface BaseMessengerConfiguration {
    data?: Record<string, any>;
    debug?: boolean;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    messageTypes?: Array<MessageType>;
    name?: string;
    transport?: string;
    type?: MessengerType;
}
/**
 * @author Lyle Schemmerling
 */
export interface BaseSAMLv2IdentityProvider<D extends BaseIdentityProviderApplicationConfiguration> extends BaseIdentityProvider<D> {
    assertionDecryptionConfiguration?: SAMLv2AssertionDecryptionConfiguration;
    emailClaim?: string;
    keyId?: UUID;
    uniqueIdClaim?: string;
    useNameIdForEmail?: boolean;
    usernameClaim?: string;
}
/**
 * @author Brian Pontarelli
 */
export interface BaseSearchCriteria {
    numberOfResults?: number;
    orderBy?: string;
    startRow?: number;
}
/**
 * Base class for all {@link User}-related events.
 *
 * @author Spencer Witt
 */
export interface BaseUserEvent extends BaseEvent {
    user?: User;
}
export interface IdentityInfo {
    type?: string;
    value?: string;
}
/**
 * @author Daniel DeGroff
 */
export declare enum BreachedPasswordStatus {
    None = "None",
    ExactMatch = "ExactMatch",
    SubAddressMatch = "SubAddressMatch",
    PasswordOnly = "PasswordOnly",
    CommonPassword = "CommonPassword"
}
/**
 * @author Daniel DeGroff
 */
export interface BreachedPasswordTenantMetric {
    actionRequired?: number;
    matchedCommonPasswordCount?: number;
    matchedExactCount?: number;
    matchedPasswordCount?: number;
    matchedSubAddressCount?: number;
    passwordsCheckedCount?: number;
}
/**
 * @author Trevor Smith
 */
export interface CORSConfiguration extends Enableable {
    allowCredentials?: boolean;
    allowedHeaders?: Array<string>;
    allowedMethods?: Array<HTTPMethod>;
    allowedOrigins?: Array<string>;
    debug?: boolean;
    exposedHeaders?: Array<string>;
    preflightMaxAgeInSeconds?: number;
}
/**
 * XML canonicalization method enumeration. This is used for the IdP and SP side of FusionAuth SAML.
 *
 * @author Brian Pontarelli
 */
export declare enum CanonicalizationMethod {
    exclusive = "exclusive",
    exclusive_with_comments = "exclusive_with_comments",
    inclusive = "inclusive",
    inclusive_with_comments = "inclusive_with_comments"
}
/**
 * @author Brett Pontarelli
 */
export declare enum CaptchaMethod {
    GoogleRecaptchaV2 = "GoogleRecaptchaV2",
    GoogleRecaptchaV3 = "GoogleRecaptchaV3",
    HCaptcha = "HCaptcha",
    HCaptchaEnterprise = "HCaptchaEnterprise"
}
/**
 * @author Trevor Smith
 */
export declare enum ChangePasswordReason {
    Administrative = "Administrative",
    Breached = "Breached",
    Expired = "Expired",
    Validation = "Validation"
}
/**
 * Change password request object.
 *
 * @author Brian Pontarelli
 */
export interface ChangePasswordRequest extends BaseEventRequest {
    applicationId?: UUID;
    changePasswordId?: string;
    currentPassword?: string;
    loginId?: string;
    loginIdTypes?: Array<string>;
    password?: string;
    refreshToken?: string;
    trustChallenge?: string;
    trustToken?: string;
}
/**
 * Change password response object.
 *
 * @author Daniel DeGroff
 */
export interface ChangePasswordResponse {
    oneTimePassword?: string;
    state?: Record<string, any>;
}
/**
 * CleanSpeak configuration at the system and application level.
 *
 * @author Brian Pontarelli
 */
export interface CleanSpeakConfiguration extends Enableable {
    apiKey?: string;
    applicationIds?: Array<UUID>;
    url?: string;
    usernameModeration?: UsernameModeration;
}
export interface UsernameModeration extends Enableable {
    applicationId?: UUID;
}
/**
 * @author Brett Guy
 */
export declare enum ClientAuthenticationPolicy {
    Required = "Required",
    NotRequired = "NotRequired",
    NotRequiredWhenUsingPKCE = "NotRequiredWhenUsingPKCE"
}
/**
 * Contains the parameters used to introspect an access token that was obtained via the client credentials grant.
 *
 * @author Lyle Schemmerling
 */
export interface ClientCredentialsAccessTokenIntrospectRequest {
    tenantId?: string;
    token?: string;
}
/**
 * The request object to make a Client Credentials grant request to obtain an access token.
 *
 * @author Lyle Schemmerling
 */
export interface ClientCredentialsGrantRequest {
    client_id?: string;
    client_secret?: string;
    grant_type?: string;
    scope?: string;
    tenantId?: string;
}
/**
 * @author Trevor Smith
 */
export interface ConnectorPolicy {
    connectorId?: UUID;
    data?: Record<string, any>;
    domains?: Array<string>;
    migrate?: boolean;
}
/**
 * @author Trevor Smith
 */
export interface ConnectorRequest {
    connector?: BaseConnectorConfiguration;
}
/**
 * @author Trevor Smith
 */
export interface ConnectorResponse {
    connector?: BaseConnectorConfiguration;
    connectors?: Array<BaseConnectorConfiguration>;
}
/**
 * The types of connectors. This enum is stored as an ordinal on the <code>identities</code> table, order must be maintained.
 *
 * @author Trevor Smith
 */
export declare enum ConnectorType {
    FusionAuth = "FusionAuth",
    Generic = "Generic",
    LDAP = "LDAP"
}
/**
 * Models a consent.
 *
 * @author Daniel DeGroff
 */
export interface Consent {
    consentEmailTemplateId?: UUID;
    countryMinimumAgeForSelfConsent?: LocalizedIntegers;
    data?: Record<string, any>;
    defaultMinimumAgeForSelfConsent?: number;
    emailPlus?: EmailPlus;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    multipleValuesAllowed?: boolean;
    name?: string;
    values?: Array<string>;
}
export interface EmailPlus extends Enableable {
    emailTemplateId?: UUID;
    maximumTimeToSendEmailInHours?: number;
    minimumTimeToSendEmailInHours?: number;
}
/**
 * API request for User consent types.
 *
 * @author Daniel DeGroff
 */
export interface ConsentRequest {
    consent?: Consent;
}
/**
 * API response for consent.
 *
 * @author Daniel DeGroff
 */
export interface ConsentResponse {
    consent?: Consent;
    consents?: Array<Consent>;
}
/**
 * Search criteria for Consents
 *
 * @author Spencer Witt
 */
export interface ConsentSearchCriteria extends BaseSearchCriteria {
    name?: string;
}
/**
 * Search request for Consents
 *
 * @author Spencer Witt
 */
export interface ConsentSearchRequest {
    search?: ConsentSearchCriteria;
}
/**
 * Consent search response
 *
 * @author Spencer Witt
 */
export interface ConsentSearchResponse {
    consents?: Array<Consent>;
    total?: number;
}
/**
 * Models a consent.
 *
 * @author Daniel DeGroff
 */
export declare enum ConsentStatus {
    Active = "Active",
    Revoked = "Revoked"
}
/**
 * Status for content like usernames, profile attributes, etc.
 *
 * @author Brian Pontarelli
 */
export declare enum ContentStatus {
    ACTIVE = "ACTIVE",
    PENDING = "PENDING",
    REJECTED = "REJECTED"
}
/**
 * Represents the inbound lambda parameter 'context' for MFA Required lambdas.
 */
export interface Context {
    accessToken?: string;
    action?: MultiFactorAction;
    application?: Application;
    authenticationThreats?: Array<AuthenticationThreats>;
    authenticationType?: string;
    eventInfo?: EventInfo;
    mfaTrust?: Trust;
    policies?: Policies;
}
/**
 * A number identifying a cryptographic algorithm. Values should be registered with the <a
 * href="https://www.iana.org/assignments/cose/cose.xhtml#algorithms">IANA COSE Algorithms registry</a>
 *
 * @author Spencer Witt
 */
export declare enum CoseAlgorithmIdentifier {
    ES256 = "SHA256withECDSA",
    ES384 = "SHA384withECDSA",
    ES512 = "SHA512withECDSA",
    RS256 = "SHA256withRSA",
    RS384 = "SHA384withRSA",
    RS512 = "SHA512withRSA",
    PS256 = "SHA-256",
    PS384 = "SHA-384",
    PS512 = "SHA-512"
}
/**
 * COSE Elliptic Curve identifier to determine which elliptic curve to use with a given key
 *
 * @author Spencer Witt
 */
export declare enum CoseEllipticCurve {
    Reserved = "Reserved",
    P256 = "P256",
    P384 = "P384",
    P521 = "P521",
    X25519 = "X25519",
    X448 = "X448",
    Ed25519 = "Ed25519",
    Ed448 = "Ed448",
    Secp256k1 = "Secp256k1"
}
/**
 * COSE key type
 *
 * @author Spencer Witt
 */
export declare enum CoseKeyType {
    Reserved = "0",
    OKP = "1",
    EC2 = "2",
    RSA = "3",
    Symmetric = "4"
}
/**
 * @author Brian Pontarelli
 */
export interface Count {
    count?: number;
    interval?: number;
}
/**
 * Contains the output for the {@code credProps} extension
 *
 * @author Spencer Witt
 */
export interface CredentialPropertiesOutput {
    rk?: boolean;
}
/**
 * Response for the daily active user report.
 *
 * @author Brian Pontarelli
 */
export interface DailyActiveUserReportResponse {
    dailyActiveUsers?: Array<Count>;
    total?: number;
}
/**
 * The request object to approve a device grant.
 *
 * @author Lyle Schemmerling
 */
export interface DeviceApprovalRequest {
    client_id?: string;
    client_secret?: string;
    tenantId?: UUID;
    token?: string;
    user_code?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface DeviceApprovalResponse {
    deviceGrantStatus?: string;
    deviceInfo?: DeviceInfo;
    identityProviderLink?: IdentityProviderLink;
    tenantId?: UUID;
    userId?: UUID;
}
/**
 * @author Lyle Schemmerling
 */
export interface DeviceAuthorizationRequest {
    client_id?: string;
    client_secret?: string;
    scope?: string;
    tenantId?: UUID;
}
/**
 * @author Daniel DeGroff
 */
export interface DeviceInfo {
    description?: string;
    lastAccessedAddress?: string;
    lastAccessedInstant?: number;
    name?: string;
    type?: string;
}
export declare enum DeviceType {
    BROWSER = "BROWSER",
    DESKTOP = "DESKTOP",
    LAPTOP = "LAPTOP",
    MOBILE = "MOBILE",
    OTHER = "OTHER",
    SERVER = "SERVER",
    TABLET = "TABLET",
    TV = "TV",
    UNKNOWN = "UNKNOWN"
}
/**
 * @author Trevor Smith
 */
export interface DeviceResponse {
    device_code?: string;
    expires_in?: number;
    interval?: number;
    user_code?: string;
    verification_uri?: string;
    verification_uri_complete?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface DeviceUserCodeResponse {
    client_id?: string;
    deviceInfo?: DeviceInfo;
    expires_in?: number;
    pendingIdPLink?: PendingIdPLink;
    scope?: string;
    tenantId?: UUID;
    user_code?: string;
}
/**
 * A displayable raw login that includes application name and user loginId.
 *
 * @author Brian Pontarelli
 */
export interface DisplayableRawLogin extends RawLogin {
    applicationName?: string;
    location?: Location;
    loginId?: string;
    loginIdType?: IdentityType;
}
/**
 * Interface for all identity providers that can be domain based.
 */
export interface DomainBasedIdentityProvider {
}
/**
 * This class is an abstraction of a simple email message.
 *
 * @author Brian Pontarelli
 */
export interface Email {
    attachments?: Array<Attachment>;
    bcc?: Array<EmailAddress>;
    cc?: Array<EmailAddress>;
    from?: EmailAddress;
    html?: string;
    replyTo?: EmailAddress;
    subject?: string;
    text?: string;
    to?: Array<EmailAddress>;
}
/**
 * An email address.
 *
 * @author Brian Pontarelli
 */
export interface EmailAddress {
    address?: string;
    display?: string;
}
/**
 * @author Brian Pontarelli
 */
export interface EmailConfiguration {
    additionalHeaders?: Array<EmailHeader>;
    debug?: boolean;
    defaultFromEmail?: string;
    defaultFromName?: string;
    emailUpdateEmailTemplateId?: UUID;
    emailVerifiedEmailTemplateId?: UUID;
    forgotPasswordEmailTemplateId?: UUID;
    host?: string;
    implicitEmailVerificationAllowed?: boolean;
    loginIdInUseOnCreateEmailTemplateId?: UUID;
    loginIdInUseOnUpdateEmailTemplateId?: UUID;
    loginNewDeviceEmailTemplateId?: UUID;
    loginSuspiciousEmailTemplateId?: UUID;
    password?: string;
    passwordlessEmailTemplateId?: UUID;
    passwordResetSuccessEmailTemplateId?: UUID;
    passwordUpdateEmailTemplateId?: UUID;
    port?: number;
    properties?: string;
    security?: EmailSecurityType;
    setPasswordEmailTemplateId?: UUID;
    twoFactorMethodAddEmailTemplateId?: UUID;
    twoFactorMethodRemoveEmailTemplateId?: UUID;
    unverified?: EmailUnverifiedOptions;
    username?: string;
    verificationEmailTemplateId?: UUID;
    verificationStrategy?: VerificationStrategy;
    verifyEmail?: boolean;
    verifyEmailWhenChanged?: boolean;
}
export declare enum EmailSecurityType {
    NONE = "NONE",
    SSL = "SSL",
    TLS = "TLS"
}
/**
 * @author Daniel DeGroff
 */
export interface EmailHeader {
    name?: string;
    value?: string;
}
/**
 * Stores an email template used to send emails to users.
 *
 * @author Brian Pontarelli
 */
export interface EmailTemplate {
    defaultFromName?: string;
    defaultHtmlTemplate?: string;
    defaultSubject?: string;
    defaultTextTemplate?: string;
    fromEmail?: string;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    localizedFromNames?: LocalizedStrings;
    localizedHtmlTemplates?: LocalizedStrings;
    localizedSubjects?: LocalizedStrings;
    localizedTextTemplates?: LocalizedStrings;
    name?: string;
}
/**
 * Email template request.
 *
 * @author Brian Pontarelli
 */
export interface EmailTemplateRequest {
    emailTemplate?: EmailTemplate;
}
/**
 * Email template response.
 *
 * @author Brian Pontarelli
 */
export interface EmailTemplateResponse {
    emailTemplate?: EmailTemplate;
    emailTemplates?: Array<EmailTemplate>;
}
/**
 * Search criteria for Email templates
 *
 * @author Mark Manes
 */
export interface EmailTemplateSearchCriteria extends BaseSearchCriteria {
    name?: string;
}
/**
 * Search request for email templates
 *
 * @author Mark Manes
 */
export interface EmailTemplateSearchRequest {
    search?: EmailTemplateSearchCriteria;
}
/**
 * Email template search response
 *
 * @author Mark Manes
 */
export interface EmailTemplateSearchResponse {
    emailTemplates?: Array<EmailTemplate>;
    total?: number;
}
/**
 * @author Daniel DeGroff
 */
export interface EmailUnverifiedOptions {
    allowEmailChangeWhenGated?: boolean;
    behavior?: UnverifiedBehavior;
}
/**
 * Something that can be enabled and thus also disabled.
 *
 * @author Daniel DeGroff
 */
export interface Enableable {
    enabled?: boolean;
}
/**
 * Models an entity that a user can be granted permissions to. Or an entity that can be granted permissions to another entity.
 *
 * @author Brian Pontarelli
 */
export interface Entity {
    clientId?: string;
    clientSecret?: string;
    data?: Record<string, any>;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    name?: string;
    parentId?: UUID;
    tenantId?: UUID;
    type?: EntityType;
}
/**
 * A grant for an entity to a user or another entity.
 *
 * @author Brian Pontarelli
 */
export interface EntityGrant {
    data?: Record<string, any>;
    entity?: Entity;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    permissions?: Array<string>;
    recipientEntityId?: UUID;
    userId?: UUID;
}
/**
 * Entity grant API request object.
 *
 * @author Brian Pontarelli
 */
export interface EntityGrantRequest {
    grant?: EntityGrant;
}
/**
 * Entity grant API response object.
 *
 * @author Brian Pontarelli
 */
export interface EntityGrantResponse {
    grant?: EntityGrant;
    grants?: Array<EntityGrant>;
}
/**
 * Search criteria for entity grants.
 *
 * @author Brian Pontarelli
 */
export interface EntityGrantSearchCriteria extends BaseSearchCriteria {
    entityId?: UUID;
    name?: string;
    userId?: UUID;
}
/**
 * Search request for entity grants.
 *
 * @author Brian Pontarelli
 */
export interface EntityGrantSearchRequest {
    search?: EntityGrantSearchCriteria;
}
/**
 * Search request for entity grants.
 *
 * @author Brian Pontarelli
 */
export interface EntityGrantSearchResponse {
    grants?: Array<EntityGrant>;
    total?: number;
}
/**
 * Entity API request object.
 *
 * @author Brian Pontarelli
 */
export interface EntityRequest {
    entity?: Entity;
}
/**
 * Entity API response object.
 *
 * @author Brian Pontarelli
 */
export interface EntityResponse {
    entity?: Entity;
}
/**
 * This class is the entity query. It provides a build pattern as well as public fields for use on forms and in actions.
 *
 * @author Brian Pontarelli
 */
export interface EntitySearchCriteria extends BaseElasticSearchCriteria {
}
/**
 * Search request for entities
 *
 * @author Brett Guy
 */
export interface EntitySearchRequest {
    search?: EntitySearchCriteria;
}
/**
 * Search request for entities
 *
 * @author Brett Guy
 */
export interface EntitySearchResponse {
    entities?: Array<Entity>;
    nextResults?: string;
    total?: number;
}
/**
 * Models an entity type that has a specific set of permissions. These are global objects and can be used across tenants.
 *
 * @author Brian Pontarelli
 */
export interface EntityType {
    data?: Record<string, any>;
    id?: UUID;
    insertInstant?: number;
    jwtConfiguration?: EntityJWTConfiguration;
    lastUpdateInstant?: number;
    name?: string;
    permissions?: Array<EntityTypePermission>;
}
/**
 * JWT Configuration for entities.
 */
export interface EntityJWTConfiguration extends Enableable {
    accessTokenKeyId?: UUID;
    timeToLiveInSeconds?: number;
}
/**
 * Models a specific entity type permission. This permission can be granted to users or other entities.
 *
 * @author Brian Pontarelli
 */
export interface EntityTypePermission {
    data?: Record<string, any>;
    description?: string;
    id?: UUID;
    insertInstant?: number;
    isDefault?: boolean;
    lastUpdateInstant?: number;
    name?: string;
}
/**
 * Entity Type API request object.
 *
 * @author Brian Pontarelli
 */
export interface EntityTypeRequest {
    entityType?: EntityType;
    permission?: EntityTypePermission;
}
/**
 * Entity Type API response object.
 *
 * @author Brian Pontarelli
 */
export interface EntityTypeResponse {
    entityType?: EntityType;
    entityTypes?: Array<EntityType>;
    permission?: EntityTypePermission;
}
/**
 * Search criteria for entity types.
 *
 * @author Brian Pontarelli
 */
export interface EntityTypeSearchCriteria extends BaseSearchCriteria {
    name?: string;
}
/**
 * Search request for entity types.
 *
 * @author Brian Pontarelli
 */
export interface EntityTypeSearchRequest {
    search?: EntityTypeSearchCriteria;
}
/**
 * Search response for entity types.
 *
 * @author Brian Pontarelli
 */
export interface EntityTypeSearchResponse {
    entityTypes?: Array<EntityType>;
    total?: number;
}
/**
 * @author Brett Pontarelli
 */
export interface EpicGamesApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
    buttonText?: string;
    client_id?: string;
    client_secret?: string;
    scope?: string;
}
/**
 * Epic gaming login provider.
 *
 * @author Brett Pontarelli
 */
export interface EpicGamesIdentityProvider extends BaseIdentityProvider<EpicGamesApplicationConfiguration> {
    buttonText?: string;
    client_id?: string;
    client_secret?: string;
    scope?: string;
}
/**
 * Defines an error.
 *
 * @author Brian Pontarelli
 */
export interface Error {
    code?: string;
    data?: Record<string, any>;
    message?: string;
}
/**
 * Standard error domain object that can also be used as the response from an API call.
 *
 * @author Brian Pontarelli
 */
export interface Errors {
    fieldErrors?: Record<string, Array<Error>>;
    generalErrors?: Array<Error>;
}
/**
 * @author Brian Pontarelli
 */
export interface EventConfiguration {
    events?: Record<EventType, EventConfigurationData>;
}
export interface EventConfigurationData extends Enableable {
    transactionType?: TransactionType;
}
/**
 * Information about a user event (login, register, etc) that helps identify the source of the event (location, device type, OS, etc).
 *
 * @author Brian Pontarelli
 */
export interface EventInfo {
    data?: Record<string, any>;
    deviceDescription?: string;
    deviceName?: string;
    deviceType?: string;
    ipAddress?: string;
    location?: Location;
    os?: string;
    userAgent?: string;
}
/**
 * Event log used internally by FusionAuth to help developers debug hooks, Webhooks, email templates, etc.
 *
 * @author Brian Pontarelli
 */
export interface EventLog {
    id?: number;
    insertInstant?: number;
    message?: string;
    type?: EventLogType;
}
/**
 * An Event "event" to indicate an event log was created.
 *
 * @author Daniel DeGroff
 */
export interface EventLogCreateEvent extends BaseEvent {
    eventLog?: EventLog;
}
/**
 * Event log response.
 *
 * @author Daniel DeGroff
 */
export interface EventLogResponse {
    eventLog?: EventLog;
}
/**
 * Search criteria for the event log.
 *
 * @author Brian Pontarelli
 */
export interface EventLogSearchCriteria extends BaseSearchCriteria {
    end?: number;
    message?: string;
    start?: number;
    type?: EventLogType;
}
/**
 * @author Brian Pontarelli
 */
export interface EventLogSearchRequest {
    search?: EventLogSearchCriteria;
}
/**
 * Event log response.
 *
 * @author Brian Pontarelli
 */
export interface EventLogSearchResponse {
    eventLogs?: Array<EventLog>;
    total?: number;
}
/**
 * Event Log Type
 *
 * @author Daniel DeGroff
 */
export declare enum EventLogType {
    Information = "Information",
    Debug = "Debug",
    Error = "Error"
}
/**
 * Container for the event information. This is the JSON that is sent from FusionAuth to webhooks.
 *
 * @author Brian Pontarelli
 */
export interface EventRequest {
    event?: BaseEvent;
}
/**
 * Models the event types that FusionAuth produces.
 *
 * @author Brian Pontarelli
 */
export declare enum EventType {
    JWTPublicKeyUpdate = "jwt.public-key.update",
    JWTRefreshTokenRevoke = "jwt.refresh-token.revoke",
    JWTRefresh = "jwt.refresh",
    AuditLogCreate = "audit-log.create",
    EventLogCreate = "event-log.create",
    KickstartSuccess = "kickstart.success",
    GroupCreate = "group.create",
    GroupCreateComplete = "group.create.complete",
    GroupDelete = "group.delete",
    GroupDeleteComplete = "group.delete.complete",
    GroupMemberAdd = "group.member.add",
    GroupMemberAddComplete = "group.member.add.complete",
    GroupMemberRemove = "group.member.remove",
    GroupMemberRemoveComplete = "group.member.remove.complete",
    GroupMemberUpdate = "group.member.update",
    GroupMemberUpdateComplete = "group.member.update.complete",
    GroupUpdate = "group.update",
    GroupUpdateComplete = "group.update.complete",
    UserAction = "user.action",
    UserBulkCreate = "user.bulk.create",
    UserCreate = "user.create",
    UserCreateComplete = "user.create.complete",
    UserDeactivate = "user.deactivate",
    UserDelete = "user.delete",
    UserDeleteComplete = "user.delete.complete",
    UserEmailUpdate = "user.email.update",
    UserEmailVerified = "user.email.verified",
    UserIdentityProviderLink = "user.identity-provider.link",
    UserIdentityProviderUnlink = "user.identity-provider.unlink",
    UserLoginIdDuplicateOnCreate = "user.loginId.duplicate.create",
    UserLoginIdDuplicateOnUpdate = "user.loginId.duplicate.update",
    UserLoginFailed = "user.login.failed",
    UserLoginNewDevice = "user.login.new-device",
    UserLoginSuccess = "user.login.success",
    UserLoginSuspicious = "user.login.suspicious",
    UserPasswordBreach = "user.password.breach",
    UserPasswordResetSend = "user.password.reset.send",
    UserPasswordResetStart = "user.password.reset.start",
    UserPasswordResetSuccess = "user.password.reset.success",
    UserPasswordUpdate = "user.password.update",
    UserReactivate = "user.reactivate",
    UserRegistrationCreate = "user.registration.create",
    UserRegistrationCreateComplete = "user.registration.create.complete",
    UserRegistrationDelete = "user.registration.delete",
    UserRegistrationDeleteComplete = "user.registration.delete.complete",
    UserRegistrationUpdate = "user.registration.update",
    UserRegistrationUpdateComplete = "user.registration.update.complete",
    UserRegistrationVerified = "user.registration.verified",
    UserTwoFactorMethodAdd = "user.two-factor.method.add",
    UserTwoFactorMethodRemove = "user.two-factor.method.remove",
    UserUpdate = "user.update",
    UserUpdateComplete = "user.update.complete",
    Test = "test",
    UserIdentityVerified = "user.identity.verified",
    UserIdentityUpdate = "user.identity.update"
}
/**
 * Represent the various states/expectations of a user in the context of starting verification
 */
export declare enum ExistingUserStrategy {
    mustExist = "mustExist",
    mustNotExist = "mustNotExist"
}
/**
 * An expandable API request.
 *
 * @author Daniel DeGroff
 */
export interface ExpandableRequest {
    expand?: Array<string>;
}
/**
 * An expandable API response.
 *
 * @author Daniel DeGroff
 */
export interface ExpandableResponse {
    expandable?: Array<string>;
}
/**
 * @author Brian Pontarelli
 */
export declare enum ExpiryUnit {
    MINUTES = "MINUTES",
    HOURS = "HOURS",
    DAYS = "DAYS",
    WEEKS = "WEEKS",
    MONTHS = "MONTHS",
    YEARS = "YEARS"
}
/**
 * @author Daniel DeGroff
 */
export interface ExternalIdentifierConfiguration {
    authorizationGrantIdTimeToLiveInSeconds?: number;
    changePasswordIdGenerator?: SecureGeneratorConfiguration;
    changePasswordIdTimeToLiveInSeconds?: number;
    deviceCodeTimeToLiveInSeconds?: number;
    deviceUserCodeIdGenerator?: SecureGeneratorConfiguration;
    emailVerificationIdGenerator?: SecureGeneratorConfiguration;
    emailVerificationIdTimeToLiveInSeconds?: number;
    emailVerificationOneTimeCodeGenerator?: SecureGeneratorConfiguration;
    externalAuthenticationIdTimeToLiveInSeconds?: number;
    identityProviderConnectionTestTimeToLiveInSeconds?: number;
    loginIntentTimeToLiveInSeconds?: number;
    oneTimePasswordTimeToLiveInSeconds?: number;
    passwordlessLoginGenerator?: SecureGeneratorConfiguration;
    passwordlessLoginOneTimeCodeGenerator?: SecureGeneratorConfiguration;
    passwordlessLoginTimeToLiveInSeconds?: number;
    pendingAccountLinkTimeToLiveInSeconds?: number;
    phoneVerificationIdGenerator?: SecureGeneratorConfiguration;
    phoneVerificationIdTimeToLiveInSeconds?: number;
    phoneVerificationOneTimeCodeGenerator?: SecureGeneratorConfiguration;
    registrationVerificationIdGenerator?: SecureGeneratorConfiguration;
    registrationVerificationIdTimeToLiveInSeconds?: number;
    registrationVerificationOneTimeCodeGenerator?: SecureGeneratorConfiguration;
    rememberOAuthScopeConsentChoiceTimeToLiveInSeconds?: number;
    samlv2AuthNRequestIdTimeToLiveInSeconds?: number;
    setupPasswordIdGenerator?: SecureGeneratorConfiguration;
    setupPasswordIdTimeToLiveInSeconds?: number;
    trustTokenTimeToLiveInSeconds?: number;
    twoFactorIdTimeToLiveInSeconds?: number;
    twoFactorOneTimeCodeIdGenerator?: SecureGeneratorConfiguration;
    twoFactorOneTimeCodeIdTimeToLiveInSeconds?: number;
    twoFactorTrustIdTimeToLiveInSeconds?: number;
    webAuthnAuthenticationChallengeTimeToLiveInSeconds?: number;
    webAuthnRegistrationChallengeTimeToLiveInSeconds?: number;
}
/**
 * @author Daniel DeGroff
 */
export interface ExternalJWTApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
}
/**
 * External JWT-only identity provider.
 *
 * @author Daniel DeGroff and Brian Pontarelli
 */
export interface ExternalJWTIdentityProvider extends BaseIdentityProvider<ExternalJWTApplicationConfiguration> {
    claimMap?: Record<string, string>;
    defaultKeyId?: UUID;
    domains?: Array<string>;
    headerKeyParameter?: string;
    oauth2?: IdentityProviderOauth2Configuration;
    uniqueIdentityClaim?: string;
}
/**
 * Determines if FusionAuth is in FIPS mode based on the system property <code>fusionauth.fips.enabled</code>. This can only be enabled once and
 * should be enabled when the VM starts or as close to that point as possible.
 * <p>
 * Once this has been enabled, it cannot be disabled.
 * <p>
 * This also provides some helpers for FIPS things such as password length requirements.
 *
 * @author Brian Pontarelli and Daniel DeGroff
 */
export interface FIPS {
}
/**
 * @author Daniel DeGroff
 */
export interface FacebookApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
    appId?: string;
    buttonText?: string;
    client_secret?: string;
    fields?: string;
    loginMethod?: IdentityProviderLoginMethod;
    permissions?: string;
}
/**
 * Facebook social login provider.
 *
 * @author Brian Pontarelli
 */
export interface FacebookIdentityProvider extends BaseIdentityProvider<FacebookApplicationConfiguration> {
    appId?: string;
    buttonText?: string;
    client_secret?: string;
    fields?: string;
    loginMethod?: IdentityProviderLoginMethod;
    permissions?: string;
}
/**
 * A policy to configure if and when the user-action is canceled prior to the expiration of the action.
 *
 * @author Daniel DeGroff
 */
export interface FailedAuthenticationActionCancelPolicy {
    onPasswordReset?: boolean;
}
/**
 * Configuration for the behavior of failed login attempts. This helps us protect against brute force password attacks.
 *
 * @author Daniel DeGroff
 */
export interface FailedAuthenticationConfiguration {
    actionCancelPolicy?: FailedAuthenticationActionCancelPolicy;
    actionDuration?: number;
    actionDurationUnit?: ExpiryUnit;
    emailUser?: boolean;
    resetCountInSeconds?: number;
    tooManyAttempts?: number;
    userActionId?: UUID;
}
/**
 * Models a family grouping of users.
 *
 * @author Brian Pontarelli
 */
export interface Family {
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    members?: Array<FamilyMember>;
}
/**
 * @author Brian Pontarelli
 */
export interface FamilyConfiguration extends Enableable {
    allowChildRegistrations?: boolean;
    confirmChildEmailTemplateId?: UUID;
    deleteOrphanedAccounts?: boolean;
    deleteOrphanedAccountsDays?: number;
    familyRequestEmailTemplateId?: UUID;
    maximumChildAge?: number;
    minimumOwnerAge?: number;
    parentEmailRequired?: boolean;
    parentRegistrationEmailTemplateId?: UUID;
}
/**
 * API request for sending out family requests to parent's.
 *
 * @author Brian Pontarelli
 */
export interface FamilyEmailRequest {
    parentEmail?: string;
}
/**
 * Models a single family member.
 *
 * @author Brian Pontarelli
 */
export interface FamilyMember {
    data?: Record<string, any>;
    insertInstant?: number;
    lastUpdateInstant?: number;
    owner?: boolean;
    role?: FamilyRole;
    userId?: UUID;
}
export declare enum FamilyRole {
    Child = "Child",
    Teen = "Teen",
    Adult = "Adult"
}
/**
 * API request for managing families and members.
 *
 * @author Brian Pontarelli
 */
export interface FamilyRequest {
    familyMember?: FamilyMember;
}
/**
 * API response for managing families and members.
 *
 * @author Brian Pontarelli
 */
export interface FamilyResponse {
    families?: Array<Family>;
    family?: Family;
}
/**
 * Components of a Favicon in an HTML {@code <head>} element.
 */
export interface Favicon {
    href?: string;
    rel?: string;
    sizes?: string;
    type?: string;
}
/**
 * Forgot password request object.
 *
 * @author Brian Pontarelli
 */
export interface ForgotPasswordRequest extends BaseEventRequest {
    applicationId?: UUID;
    changePasswordId?: string;
    email?: string;
    loginId?: string;
    loginIdTypes?: Array<string>;
    sendForgotPasswordEmail?: boolean;
    sendForgotPasswordMessage?: boolean;
    state?: Record<string, any>;
    username?: string;
}
/**
 * Forgot password response object.
 *
 * @author Daniel DeGroff
 */
export interface ForgotPasswordResponse {
    changePasswordId?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface Form {
    data?: Record<string, any>;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    name?: string;
    steps?: Array<FormStep>;
    type?: FormType;
}
/**
 * @author Daniel DeGroff
 */
export declare enum FormControl {
    checkbox = "checkbox",
    number = "number",
    password = "password",
    radio = "radio",
    select = "select",
    textarea = "textarea",
    text = "text"
}
/**
 * @author Daniel DeGroff
 */
export declare enum FormDataType {
    bool = "bool",
    consent = "consent",
    date = "date",
    email = "email",
    number = "number",
    phoneNumber = "phoneNumber",
    string = "string"
}
/**
 * @author Daniel DeGroff
 */
export interface FormField {
    confirm?: boolean;
    consentId?: UUID;
    control?: FormControl;
    data?: Record<string, any>;
    description?: string;
    id?: UUID;
    insertInstant?: number;
    key?: string;
    lastUpdateInstant?: number;
    name?: string;
    options?: Array<string>;
    required?: boolean;
    type?: FormDataType;
    validator?: FormFieldValidator;
}
/**
 * @author Daniel DeGroff
 */
export declare enum FormFieldAdminPolicy {
    Edit = "Edit",
    View = "View"
}
/**
 * The FormField API request object.
 *
 * @author Brett Guy
 */
export interface FormFieldRequest {
    field?: FormField;
    fields?: Array<FormField>;
}
/**
 * Form field response.
 *
 * @author Brett Guy
 */
export interface FormFieldResponse {
    field?: FormField;
    fields?: Array<FormField>;
}
/**
 * @author Daniel DeGroff
 */
export interface FormFieldValidator extends Enableable {
    expression?: string;
}
/**
 * Form response.
 *
 * @author Daniel DeGroff
 */
export interface FormRequest {
    form?: Form;
}
/**
 * Form response.
 *
 * @author Daniel DeGroff
 */
export interface FormResponse {
    form?: Form;
    forms?: Array<Form>;
}
/**
 * @author Daniel DeGroff
 */
export interface FormStep {
    fields?: Array<UUID>;
    type?: FormStepType;
}
/**
 * Denotes the type of form step. This is used to configure different behavior on form steps in the registration flow.
 */
export declare enum FormStepType {
    collectData = "collectData",
    verifyEmail = "verifyEmail",
    verifyPhoneNumber = "verifyPhoneNumber"
}
/**
 * @author Daniel DeGroff
 */
export declare enum FormType {
    registration = "registration",
    adminRegistration = "adminRegistration",
    adminUser = "adminUser",
    selfServiceUser = "selfServiceUser"
}
/**
 * Models the FusionAuth connector.
 *
 * @author Trevor Smith
 */
export interface FusionAuthConnectorConfiguration extends BaseConnectorConfiguration {
}
/**
 * Models a generic connector.
 *
 * @author Trevor Smith
 */
export interface GenericConnectorConfiguration extends BaseConnectorConfiguration {
    authenticationURL?: string;
    connectTimeout?: number;
    headers?: HTTPHeaders;
    httpAuthenticationPassword?: string;
    httpAuthenticationUsername?: string;
    readTimeout?: number;
    sslCertificateKeyId?: UUID;
}
/**
 * @author Brett Guy
 */
export interface GenericMessengerConfiguration extends BaseMessengerConfiguration {
    connectTimeout?: number;
    headers?: HTTPHeaders;
    httpAuthenticationPassword?: string;
    httpAuthenticationUsername?: string;
    readTimeout?: number;
    sslCertificate?: string;
    url?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface GoogleApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
    buttonText?: string;
    client_id?: string;
    client_secret?: string;
    loginMethod?: IdentityProviderLoginMethod;
    properties?: GoogleIdentityProviderProperties;
    scope?: string;
}
/**
 * Google social login provider.
 *
 * @author Daniel DeGroff
 */
export interface GoogleIdentityProvider extends BaseIdentityProvider<GoogleApplicationConfiguration> {
    buttonText?: string;
    client_id?: string;
    client_secret?: string;
    loginMethod?: IdentityProviderLoginMethod;
    properties?: GoogleIdentityProviderProperties;
    scope?: string;
}
/**
 * Google social login provider parameters.
 *
 * @author Daniel DeGroff
 */
export interface GoogleIdentityProviderProperties {
    api?: string;
    button?: string;
}
/**
 * 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">
 * OAuth 2.0 Dynamic Client Registration Protocol - RFC 7591 Section 4.1</a>
 *
 * @author Daniel DeGroff
 */
export declare enum GrantType {
    authorization_code = "authorization_code",
    implicit = "implicit",
    password = "password",
    client_credentials = "client_credentials",
    refresh_token = "refresh_token",
    unknown = "unknown",
    device_code = "urn:ietf:params:oauth:grant-type:device_code"
}
/**
 * @author Tyler Scott
 */
export interface Group {
    data?: Record<string, any>;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    name?: string;
    roles?: Record<UUID, Array<ApplicationRole>>;
    tenantId?: UUID;
}
/**
 * Models the Group Created Event.
 *
 * @author Daniel DeGroff
 */
export interface GroupCreateCompleteEvent extends BaseGroupEvent {
}
/**
 * Models the Group Create Event.
 *
 * @author Daniel DeGroff
 */
export interface GroupCreateEvent extends BaseGroupEvent {
}
/**
 * Models the Group Create Complete Event.
 *
 * @author Daniel DeGroff
 */
export interface GroupDeleteCompleteEvent extends BaseGroupEvent {
}
/**
 * Models the Group Delete Event.
 *
 * @author Daniel DeGroff
 */
export interface GroupDeleteEvent extends BaseGroupEvent {
}
/**
 * A User's membership into a Group
 *
 * @author Daniel DeGroff
 */
export interface GroupMember {
    data?: Record<string, any>;
    groupId?: UUID;
    id?: UUID;
    insertInstant?: number;
    userId?: UUID;
}
/**
 * Models the Group Member Add Complete Event.
 *
 * @author Daniel DeGroff
 */
export interface GroupMemberAddCompleteEvent extends BaseGroupEvent {
    members?: Array<GroupMember>;
}
/**
 * Models the Group Member Add Event.
 *
 * @author Daniel DeGroff
 */
export interface GroupMemberAddEvent extends BaseGroupEvent {
    members?: Array<GroupMember>;
}
/**
 * Models the Group Member Remove Complete Event.
 *
 * @author Daniel DeGroff
 */
export interface GroupMemberRemoveCompleteEvent extends BaseGroupEvent {
    members?: Array<GroupMember>;
}
/**
 * Models the Group Member Remove Event.
 *
 * @author Daniel DeGroff
 */
export interface GroupMemberRemoveEvent extends BaseGroupEvent {
    members?: Array<GroupMember>;
}
/**
 * Search criteria for Group Members
 *
 * @author Daniel DeGroff
 */
export interface GroupMemberSearchCriteria extends BaseSearchCriteria {
    groupId?: UUID;
    tenantId?: UUID;
    userId?: UUID;
}
/**
 * Search request for Group Members.
 *
 * @author Daniel DeGroff
 */
export interface GroupMemberSearchRequest {
    search?: GroupMemberSearchCriteria;
}
/**
 * Search response for Group Members
 *
 * @author Daniel DeGroff
 */
export interface GroupMemberSearchResponse {
    members?: Array<GroupMember>;
    total?: number;
}
/**
 * Models the Group Member Update Complete Event.
 *
 * @author Daniel DeGroff
 */
export interface GroupMemberUpdateCompleteEvent extends BaseGroupEvent {
    members?: Array<GroupMember>;
}
/**
 * Models the Group Member Update Event.
 *
 * @author Daniel DeGroff
 */
export interface GroupMemberUpdateEvent extends BaseGroupEvent {
    members?: Array<GroupMember>;
}
/**
 * Group API request object.
 *
 * @author Daniel DeGroff
 */
export interface GroupRequest {
    group?: Group;
    roleIds?: Array<UUID>;
}
/**
 * Group API response object.
 *
 * @author Daniel DeGroff
 */
export interface GroupResponse {
    group?: Group;
    groups?: Array<Group>;
}
/**
 * Search criteria for Groups
 *
 * @author Daniel DeGroff
 */
export interface GroupSearchCriteria extends BaseSearchCriteria {
    name?: string;
    tenantId?: UUID;
}
/**
 * Search request for Groups.
 *
 * @author Daniel DeGroff
 */
export interface GroupSearchRequest {
    search?: GroupSearchCriteria;
}
/**
 * Search response for Groups
 *
 * @author Daniel DeGroff
 */
export interface GroupSearchResponse {
    groups?: Array<Group>;
    total?: number;
}
/**
 * Models the Group Update Complete Event.
 *
 * @author Daniel DeGroff
 */
export interface GroupUpdateCompleteEvent extends BaseGroupEvent {
    original?: Group;
}
/**
 * Models the Group Update Event.
 *
 * @author Daniel DeGroff
 */
export interface GroupUpdateEvent extends BaseGroupEvent {
    original?: Group;
}
/**
 * Type for webhook headers.
 *
 * @author Brian Pontarelli
 */
export interface HTTPHeaders extends Record<string, string> {
}
/**
 * @author Daniel DeGroff
 */
export declare enum HTTPMethod {
    GET = "GET",
    POST = "POST",
    PUT = "PUT",
    DELETE = "DELETE",
    HEAD = "HEAD",
    OPTIONS = "OPTIONS",
    PATCH = "PATCH"
}
/**
 * @author Daniel DeGroff
 */
export interface HYPRApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
    relyingPartyApplicationId?: string;
    relyingPartyURL?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface HYPRIdentityProvider extends BaseIdentityProvider<HYPRApplicationConfiguration> {
    relyingPartyApplicationId?: string;
    relyingPartyURL?: string;
}
/**
 * @author Brett Guy
 */
export interface IPAccessControlEntry {
    action?: IPAccessControlEntryAction;
    endIPAddress?: string;
    startIPAddress?: string;
}
/**
 * @author Brett Guy
 */
export declare enum IPAccessControlEntryAction {
    Allow = "Allow",
    Block = "Block"
}
/**
 * @author Brett Guy
 */
export interface IPAccessControlList {
    data?: Record<string, any>;
    entries?: Array<IPAccessControlEntry>;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    name?: string;
}
/**
 * @author Brett Guy
 */
export interface IPAccessControlListRequest {
    ipAccessControlList?: IPAccessControlList;
}
/**
 * @author Brett Guy
 */
export interface IPAccessControlListResponse {
    ipAccessControlList?: IPAccessControlList;
    ipAccessControlLists?: Array<IPAccessControlList>;
}
/**
 * @author Brett Guy
 */
export interface IPAccessControlListSearchCriteria extends BaseSearchCriteria {
    name?: string;
}
/**
 * Search request for IP ACLs .
 *
 * @author Brett Guy
 */
export interface IPAccessControlListSearchRequest {
    search?: IPAccessControlListSearchCriteria;
}
/**
 * @author Brett Guy
 */
export interface IPAccessControlListSearchResponse {
    ipAccessControlLists?: Array<IPAccessControlList>;
    total?: number;
}
/**
 * A request for interacting with the identity provider connection test API
 */
export interface IdentityProviderConnectionTestRequest {
    identityProviderId?: UUID;
    tenantId?: UUID;
}
/**
 * A response for the identity provider connection test API
 */
export interface IdentityProviderConnectionTestResponse {
    connectionTestId?: string;
    result?: IdentityProviderConnectionTestResult;
}
/**
 * The results of an identity provider connection test.
 */
export interface IdentityProviderConnectionTestResult {
    email?: string;
    identityProviderId?: UUID;
    identityProviderUserId?: string;
    startInstant?: number;
    steps?: Array<IdentityProviderLoginStep>;
    success?: boolean;
    username?: string;
}
export interface IdentityProviderLoginStep {
    detail?: string;
    success?: boolean;
    title?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface IdentityProviderLimitUserLinkingPolicy extends Enableable {
    maximumLinks?: number;
}
/**
 * @author Daniel DeGroff
 */
export interface IdentityProviderLink {
    data?: Record<string, any>;
    displayName?: string;
    identityProviderId?: UUID;
    identityProviderName?: string;
    identityProviderType?: IdentityProviderType;
    identityProviderUserId?: string;
    insertInstant?: number;
    lastLoginInstant?: number;
    tenantId?: UUID;
    token?: string;
    userId?: UUID;
}
/**
 * @author Daniel DeGroff
 */
export interface IdentityProviderLinkRequest extends BaseEventRequest {
    identityProviderLink?: IdentityProviderLink;
    pendingIdPLinkId?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface IdentityProviderLinkResponse {
    identityProviderLink?: IdentityProviderLink;
    identityProviderLinks?: Array<IdentityProviderLink>;
}
/**
 * The IdP behavior when no user link has been made yet.
 *
 * @author Daniel DeGroff
 */
export declare enum IdentityProviderLinkingStrategy {
    CreatePendingLink = "CreatePendingLink",
    Disabled = "Disabled",
    LinkAnonymously = "LinkAnonymously",
    LinkByEmail = "LinkByEmail",
    LinkByEmailForExistingUser = "LinkByEmailForExistingUser",
    LinkByUsername = "LinkByUsername",
    LinkByUsernameForExistingUser = "LinkByUsernameForExistingUser",
    Unsupported = "Unsupported"
}
/**
 * @author Brett Pontarelli
 */
export declare enum IdentityProviderLoginMethod {
    UsePopup = "UsePopup",
    UseRedirect = "UseRedirect",
    UseVendorJavaScript = "UseVendorJavaScript"
}
/**
 * Login API request object used for login to third-party systems (i.e. Login with Facebook).
 *
 * @author Brian Pontarelli
 */
export interface IdentityProviderLoginRequest extends BaseLoginRequest {
    connectionTestId?: string;
    data?: Record<string, string>;
    encodedJWT?: string;
    identityProviderId?: UUID;
    noLink?: boolean;
}
/**
 * @author Daniel DeGroff
 */
export interface IdentityProviderOauth2Configuration {
    authorization_endpoint?: string;
    client_id?: string;
    client_secret?: string;
    clientAuthenticationMethod?: ClientAuthenticationMethod;
    emailClaim?: string;
    emailVerifiedClaim?: string;
    issuer?: string;
    scope?: string;
    token_endpoint?: string;
    uniqueIdClaim?: string;
    userinfo_endpoint?: string;
    usernameClaim?: string;
}
export declare enum ClientAuthenticationMethod {
    none = "none",
    client_secret_basic = "client_secret_basic",
    client_secret_post = "client_secret_post"
}
/**
 * @author Daniel DeGroff
 */
export interface IdentityProviderPendingLinkResponse {
    identityProviderTenantConfiguration?: IdentityProviderTenantConfiguration;
    linkCount?: number;
    pendingIdPLink?: PendingIdPLink;
}
/**
 * @author Daniel DeGroff
 */
export interface IdentityProviderRequest {
    identityProvider?: BaseIdentityProvider<any>;
}
/**
 * @author Daniel DeGroff
 */
export interface IdentityProviderResponse {
    identityProvider?: BaseIdentityProvider<any>;
    identityProviders?: Array<BaseIdentityProvider<any>>;
}
/**
 * Search criteria for Identity Providers.
 *
 * @author Spencer Witt
 */
export interface IdentityProviderSearchCriteria extends BaseSearchCriteria {
    applicationId?: UUID;
    name?: string;
    source?: string;
    tenantId?: UUID;
    type?: IdentityProviderType;
}
/**
 * Search request for Identity Providers
 *
 * @author Spencer Witt
 */
export interface IdentityProviderSearchRequest {
    search?: IdentityProviderSearchCriteria;
}
/**
 * Identity Provider response.
 *
 * @author Spencer Witt
 */
export interface IdentityProviderSearchResponse {
    identityProviders?: Array<BaseIdentityProvider<any>>;
    total?: number;
}
/**
 * @author Daniel DeGroff
 */
export interface IdentityProviderStartLoginRequest extends BaseLoginRequest {
    connectionTestId?: string;
    data?: Record<string, string>;
    identityProviderId?: UUID;
    loginId?: string;
    loginIdTypes?: Array<string>;
    state?: Record<string, any>;
}
/**
 * @author Daniel DeGroff
 */
export interface IdentityProviderStartLoginResponse {
    code?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface IdentityProviderTenantConfiguration {
    data?: Record<string, any>;
    limitUserLinkCount?: IdentityProviderLimitUserLinkingPolicy;
}
/**
 * @author Daniel DeGroff
 */
export declare enum IdentityProviderType {
    Apple = "Apple",
    EpicGames = "EpicGames",
    ExternalJWT = "ExternalJWT",
    Facebook = "Facebook",
    Google = "Google",
    HYPR = "HYPR",
    LinkedIn = "LinkedIn",
    Nintendo = "Nintendo",
    OpenIDConnect = "OpenIDConnect",
    SAMLv2 = "SAMLv2",
    SAMLv2IdPInitiated = "SAMLv2IdPInitiated",
    SonyPSN = "SonyPSN",
    Steam = "Steam",
    Twitch = "Twitch",
    Twitter = "Twitter",
    Xbox = "Xbox"
}
/**
 * Model identity types provided by FusionAuth.
 */
export interface IdentityType {
    name?: string;
}
/**
 * Models the reason that {@link UserIdentity#verified} was set to true or false.
 *
 * @author Brady Wied
 */
export declare enum IdentityVerifiedReason {
    Skipped = "Skipped",
    Trusted = "Trusted",
    Unverifiable = "Unverifiable",
    Implicit = "Implicit",
    Pending = "Pending",
    Completed = "Completed",
    Disabled = "Disabled",
    Administrative = "Administrative",
    Import = "Import"
}
/**
 * Import request.
 *
 * @author Brian Pontarelli
 */
export interface ImportRequest extends BaseEventRequest {
    encryptionScheme?: string;
    factor?: number;
    users?: Array<User>;
    validateDbConstraints?: boolean;
}
/**
 * A marker interface indicating this event is not scoped to a tenant and will be sent to all webhooks.
 *
 * @author Daniel DeGroff
 */
export interface InstanceEvent extends NonTransactionalEvent {
}
/**
 * The Integration Request
 *
 * @author Daniel DeGroff
 */
export interface IntegrationRequest {
    integrations?: Integrations;
}
/**
 * The Integration Response
 *
 * @author Daniel DeGroff
 */
export interface IntegrationResponse {
    integrations?: Integrations;
}
/**
 * Available Integrations
 *
 * @author Daniel DeGroff
 */
export interface Integrations {
    cleanspeak?: CleanSpeakConfiguration;
    kafka?: KafkaConfiguration;
}
/**
 * @author Daniel DeGroff
 */
export interface IntrospectResponse extends Record<string, any> {
}
/**
 * @author Daniel DeGroff
 */
export interface IssueResponse {
    refreshToken?: string;
    token?: string;
}
/**
 * A JSON Web Key as defined by <a href="https://tools.ietf.org/html/rfc7517#section-4">RFC 7517 JSON Web Key (JWK)
 * Section 4</a> and <a href="https://tools.ietf.org/html/rfc7518">RFC 7518 JSON Web Algorithms (JWA)</a>.
 *
 * @author Daniel DeGroff
 */
export interface JSONWebKey {
    alg?: Algorithm;
    crv?: string;
    d?: string;
    dp?: string;
    dq?: string;
    e?: string;
    kid?: string;
    kty?: KeyType;
    n?: string;
    [other: string]: any;
    p?: string;
    q?: string;
    qi?: string;
    use?: string;
    x?: string;
    x5c?: Array<string>;
    x5t?: string;
    x5t_S256?: string;
    y?: string;
}
/**
 * Interface for any object that can provide JSON Web key Information.
 */
export interface JSONWebKeyInfoProvider {
}
/**
 * @author Daniel DeGroff
 */
export interface JWKSResponse {
    keys?: Array<JSONWebKey>;
}
/**
 * JSON Web Token (JWT) as defined by RFC 7519.
 * <pre>
 * From RFC 7519 Section 1. Introduction:
 *    The suggested pronunciation of JWT is the same as the English word "jot".
 * </pre>
 * The JWT is not Thread-Safe and should not be re-used.
 *
 * @author Daniel DeGroff
 */
export interface JWT {
    aud?: any;
    exp?: number;
    iat?: number;
    iss?: string;
    jti?: string;
    nbf?: number;
    [otherClaims: string]: any;
    sub?: string;
}
/**
 * JWT Configuration. A JWT Configuration for an Application may not be active if it is using the global configuration, the configuration
 * may be <code>enabled = false</code>.
 *
 * @author Daniel DeGroff
 */
export interface JWTConfiguration extends Enableable {
    accessTokenKeyId?: UUID;
    idTokenKeyId?: UUID;
    refreshTokenExpirationPolicy?: RefreshTokenExpirationPolicy;
    refreshTokenOneTimeUseConfiguration?: RefreshTokenOneTimeUseConfiguration;
    refreshTokenRevocationPolicy?: RefreshTokenRevocationPolicy;
    refreshTokenSlidingWindowConfiguration?: RefreshTokenSlidingWindowConfiguration;
    refreshTokenTimeToLiveInMinutes?: number;
    refreshTokenUsagePolicy?: RefreshTokenUsagePolicy;
    timeToLiveInSeconds?: number;
}
/**
 * Models the JWT public key Refresh Token Revoke Event. This event might be for a single
 * token, a user or an entire application.
 *
 * @author Brian Pontarelli
 */
export interface JWTPublicKeyUpdateEvent extends BaseEvent {
    applicationIds?: Array<UUID>;
}
/**
 * Models the JWT Refresh Event. This event will be fired when a JWT is "refreshed" (generated) using a Refresh Token.
 *
 * @author Daniel DeGroff
 */
export interface JWTRefreshEvent extends BaseEvent {
    applicationId?: UUID;
    original?: string;
    refreshToken?: string;
    token?: string;
    userId?: UUID;
}
/**
 * API response for refreshing a JWT with a Refresh Token.
 * <p>
 * Using a different response object from RefreshTokenResponse because the retrieve response will return an object for refreshToken, and this is a
 * string.
 *
 * @author Daniel DeGroff
 */
export interface JWTRefreshResponse {
    refreshToken?: string;
    refreshTokenId?: UUID;
    token?: string;
}
/**
 * Models the Refresh Token Revoke Event. This event might be for a single token, a user
 * or an entire application.
 *
 * @author Brian Pontarelli
 */
export interface JWTRefreshTokenRevokeEvent extends BaseEvent {
    applicationId?: UUID;
    applicationTimeToLiveInSeconds?: Record<UUID, number>;
    refreshToken?: RefreshToken;
    user?: User;
    userId?: UUID;
}
/**
 * @author Daniel DeGroff
 */
export interface JWTVendRequest {
    claims?: Record<string, any>;
    keyId?: UUID;
    timeToLiveInSeconds?: number;
}
/**
 * @author Daniel DeGroff
 */
export interface JWTVendResponse {
    token?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface KafkaConfiguration extends Enableable {
    defaultTopic?: string;
    producer?: Record<string, string>;
}
/**
 * @author Brett Guy
 */
export interface KafkaMessengerConfiguration extends BaseMessengerConfiguration {
    defaultTopic?: string;
    producer?: Record<string, string>;
}
/**
 * Domain for a public key, key pair or an HMAC secret. This is used by KeyMaster to manage keys for JWTs, SAML, etc.
 *
 * @author Brian Pontarelli
 */
export interface Key {
    algorithm?: KeyAlgorithm;
    certificate?: string;
    certificateInformation?: CertificateInformation;
    expirationInstant?: number;
    hasPrivateKey?: boolean;
    id?: UUID;
    insertInstant?: number;
    issuer?: string;
    kid?: string;
    lastUpdateInstant?: number;
    length?: number;
    name?: string;
    privateKey?: string;
    publicKey?: string;
    secret?: string;
    type?: KeyType;
}
export interface CertificateInformation {
    issuer?: string;
    md5Fingerprint?: string;
    serialNumber?: string;
    sha1Fingerprint?: string;
    sha1Thumbprint?: string;
    sha256Fingerprint?: string;
    sha256Thumbprint?: string;
    subject?: string;
    validFrom?: number;
    validTo?: number;
}
export declare enum KeyAlgorithm {
    ES256 = "ES256",
    ES384 = "ES384",
    ES512 = "ES512",
    HS256 = "HS256",
    HS384 = "HS384",
    HS512 = "HS512",
    RS256 = "RS256",
    RS384 = "RS384",
    RS512 = "RS512",
    Ed25519 = "Ed25519",
    None = "None"
}
export declare enum KeyType {
    EC = "EC",
    RSA = "RSA",
    HMAC = "HMAC",
    OKP = "OKP",
    Secret = "Secret"
}
/**
 * Key API request object.
 *
 * @author Daniel DeGroff
 */
export interface KeyRequest {
    key?: Key;
}
/**
 * Key API response object.
 *
 * @author Daniel DeGroff
 */
export interface KeyResponse {
    key?: Key;
    keys?: Array<Key>;
}
/**
 * Search criteria for Keys
 *
 * @author Spencer Witt
 */
export interface KeySearchCriteria extends BaseSearchCriteria {
    algorithm?: KeyAlgorithm;
    name?: string;
    type?: KeyType;
}
/**
 * Search request for Keys
 *
 * @author Spencer Witt
 */
export interface KeySearchRequest {
    search?: KeySearchCriteria;
}
/**
 * Key search response
 *
 * @author Spencer Witt
 */
export interface KeySearchResponse {
    keys?: Array<Key>;
    total?: number;
}
/**
 * The use type of a key.
 *
 * @author Daniel DeGroff
 */
export declare enum KeyUse {
    SignOnly = "SignOnly",
    SignAndVerify = "SignAndVerify",
    VerifyOnly = "VerifyOnly"
}
/**
 * Event to indicate kickstart has been successfully completed.
 *
 * @author Daniel DeGroff
 */
export interface KickstartSuccessEvent extends BaseEvent {
    instanceId?: UUID;
}
/**
 * Models an LDAP connector.
 *
 * @author Trevor Smith
 */
export interface LDAPConnectorConfiguration extends BaseConnectorConfiguration {
    authenticationURL?: string;
    baseStructure?: string;
    connectTimeout?: number;
    identifyingAttribute?: string;
    lambdaConfiguration?: LambdaConfiguration;
    loginIdAttribute?: string;
    readTimeout?: number;
    requestedAttributes?: Array<string>;
    securityMethod?: LDAPSecurityMethod;
    systemAccountDN?: string;
    systemAccountPassword?: string;
}
export declare enum LDAPSecurityMethod {
    None = "None",
    LDAPS = "LDAPS",
    StartTLS = "StartTLS"
}
export interface LambdaConfiguration {
    reconcileId?: UUID;
}
/**
 * A JavaScript lambda function that is executed during certain events inside FusionAuth.
 *
 * @author Brian Pontarelli
 */
export interface Lambda {
    body?: string;
    debug?: boolean;
    engineType?: LambdaEngineType;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    name?: string;
    type?: LambdaType;
}
/**
 * @author Daniel DeGroff
 */
export declare enum LambdaEngineType {
    GraalJS = "GraalJS",
    Nashorn = "Nashorn"
}
/**
 * Lambda API request object.
 *
 * @author Brian Pontarelli
 */
export interface LambdaRequest {
    lambda?: Lambda;
}
/**
 * Lambda API response object.
 *
 * @author Brian Pontarelli
 */
export interface LambdaResponse {
    lambda?: Lambda;
    lambdas?: Array<Lambda>;
}
/**
 * Search criteria for Lambdas
 *
 * @author Mark Manes
 */
export interface LambdaSearchCriteria extends BaseSearchCriteria {
    body?: string;
    name?: string;
    type?: LambdaType;
}
/**
 * Search request for Lambdas
 *
 * @author Mark Manes
 */
export interface LambdaSearchRequest {
    search?: LambdaSearchCriteria;
}
/**
 * Lambda search response
 *
 * @author Mark Manes
 */
export interface LambdaSearchResponse {
    lambdas?: Array<Lambda>;
    total?: number;
}
/**
 * The types of lambdas that indicate how they are invoked by FusionAuth.
 *
 * @author Brian Pontarelli
 */
export declare enum LambdaType {
    JWTPopulate = "JWTPopulate",
    OpenIDReconcile = "OpenIDReconcile",
    SAMLv2Reconcile = "SAMLv2Reconcile",
    SAMLv2Populate = "SAMLv2Populate",
    AppleReconcile = "AppleReconcile",
    ExternalJWTReconcile = "ExternalJWTReconcile",
    FacebookReconcile = "FacebookReconcile",
    GoogleReconcile = "GoogleReconcile",
    HYPRReconcile = "HYPRReconcile",
    TwitterReconcile = "TwitterReconcile",
    LDAPConnectorReconcile = "LDAPConnectorReconcile",
    LinkedInReconcile = "LinkedInReconcile",
    EpicGamesReconcile = "EpicGamesReconcile",
    NintendoReconcile = "NintendoReconcile",
    SonyPSNReconcile = "SonyPSNReconcile",
    SteamReconcile = "SteamReconcile",
    TwitchReconcile = "TwitchReconcile",
    XboxReconcile = "XboxReconcile",
    ClientCredentialsJWTPopulate = "ClientCredentialsJWTPopulate",
    SCIMServerGroupRequestConverter = "SCIMServerGroupRequestConverter",
    SCIMServerGroupResponseConverter = "SCIMServerGroupResponseConverter",
    SCIMServerUserRequestConverter = "SCIMServerUserRequestConverter",
    SCIMServerUserResponseConverter = "SCIMServerUserResponseConverter",
    SelfServiceRegistrationValidation = "SelfServiceRegistrationValidation",
    UserInfoPopulate = "UserInfoPopulate",
    LoginValidation = "LoginValidation",
    MFARequirement = "MFARequirement"
}
/**
 * @author Daniel DeGroff
 */
export interface LinkedInApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
    buttonText?: string;
    client_id?: string;
    client_secret?: string;
    scope?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface LinkedInIdentityProvider extends BaseIdentityProvider<LinkedInApplicationConfiguration> {
    buttonText?: string;
    client_id?: string;
    client_secret?: string;
    scope?: string;
}
/**
 * Models a set of localized Integers that can be stored as JSON.
 *
 * @author Daniel DeGroff
 */
export interface LocalizedIntegers extends Record<string, number> {
}
/**
 * Models a set of localized Strings that can be stored as JSON.
 *
 * @author Brian Pontarelli
 */
export interface LocalizedStrings extends Record<string, string> {
}
/**
 * Location information. Useful for IP addresses and other displayable data objects.
 *
 * @author Brian Pontarelli
 */
export interface Location {
    city?: string;
    country?: string;
    displayString?: string;
    latitude?: number;
    longitude?: number;
    region?: string;
    zipcode?: string;
}
/**
 * A historical state of a user log event. Since events can be modified, this stores the historical state.
 *
 * @author Brian Pontarelli
 */
export interface LogHistory {
    historyItems?: Array<HistoryItem>;
}
export interface HistoryItem {
    actionerUserId?: UUID;
    comment?: string;
    createInstant?: number;
    expiry?: number;
}
/**
 * @author Daniel DeGroff
 */
export interface LoginHintConfiguration extends Enableable {
    parameterName?: string;
}
/**
 * Login Ping API request object.
 *
 * @author Daniel DeGroff
 */
export interface LoginPingRequest extends BaseLoginRequest {
    userId?: UUID;
}
/**
 * The summary of the action that is preventing login to be returned on the login response.
 *
 * @author Daniel DeGroff
 */
export interface LoginPreventedResponse {
    actionerUserId?: UUID;
    actionId?: UUID;
    expiry?: number;
    localizedName?: string;
    localizedOption?: string;
    localizedReason?: string;
    name?: string;
    option?: string;
    reason?: string;
    reasonCode?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface LoginRecordExportRequest extends BaseExportRequest {
    criteria?: LoginRecordSearchCriteria;
}
/**
 * @author Daniel DeGroff
 */
export interface LoginRecordSearchCriteria extends BaseSearchCriteria {
    applicationId?: UUID;
    end?: number;
    start?: number;
    userId?: UUID;
}
/**
 * @author Daniel DeGroff
 */
export interface LoginRecordSearchRequest {
    retrieveTotal?: boolean;
    search?: LoginRecordSearchCriteria;
}
/**
 * A raw login record response
 *
 * @author Daniel DeGroff
 */
export interface LoginRecordSearchResponse {
    logins?: Array<DisplayableRawLogin>;
    total?: number;
}
/**
 * Response for the login report.
 *
 * @author Brian Pontarelli
 */
export interface LoginReportResponse {
    hourlyCounts?: Array<Count>;
    total?: number;
}
/**
 * Login API request object.
 *
 * @author Seth Musselman
 */
export interface LoginRequest extends BaseLoginRequest {
    loginId?: string;
    loginIdTypes?: Array<string>;
    oneTimePassword?: string;
    password?: string;
    twoFactorTrustId?: string;
}
/**
 * @author Brian Pontarelli
 */
export interface LoginResponse {
    actions?: Array<LoginPreventedResponse>;
    changePasswordId?: string;
    changePasswordReason?: ChangePasswordReason;
    configurableMethods?: Array<string>;
    emailVerificationId?: string;
    identityVerificationId?: string;
    methods?: Array<TwoFactorMethod>;
    pendingIdPLinkId?: string;
    refreshToken?: string;
    refreshTokenId?: UUID;
    registrationVerificationId?: string;
    state?: Record<string, any>;
    threatsDetected?: Array<AuthenticationThreats>;
    token?: string;
    tokenExpirationInstant?: number;
    trustToken?: string;
    twoFactorId?: string;
    twoFactorTrustId?: string;
    user?: User;
}
/**
 * @author Matthew Altman
 */
export declare enum LogoutBehavior {
    RedirectOnly = "RedirectOnly",
    AllApplications = "AllApplications"
}
/**
 * Request for the Logout API that can be used as an alternative to URL parameters.
 *
 * @author Brian Pontarelli
 */
export interface LogoutRequest extends BaseEventRequest {
    global?: boolean;
    refreshToken?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface LookupResponse {
    identityProvider?: IdentityProviderDetails;
}
export interface IdentityProviderDetails {
    applicationIds?: Array<UUID>;
    id?: UUID;
    idpEndpoint?: string;
    name?: string;
    oauth2?: IdentityProviderOauth2Configuration;
    tenantId?: UUID;
    type?: IdentityProviderType;
}
/**
 * This class contains the managed fields that are also put into the database during FusionAuth setup.
 * <p>
 * Internal Note: These fields are also declared in SQL in order to bootstrap the system. These need to stay in sync.
 * Any changes to these fields needs to also be reflected in mysql.sql and postgresql.sql
 *
 * @author Brian Pontarelli
 */
export interface ManagedFields {
}
/**
 * @author Daniel DeGroff
 */
export interface MaximumPasswordAge extends Enableable {
    days?: number;
}
/**
 * Group Member Delete Request
 *
 * @author Daniel DeGroff
 */
export interface MemberDeleteRequest {
    memberIds?: Array<UUID>;
    members?: Record<UUID, Array<UUID>>;
}
/**
 * Group Member Request
 *
 * @author Daniel DeGroff
 */
export interface MemberRequest {
    members?: Record<UUID, Array<GroupMember>>;
}
/**
 * Group Member Response
 *
 * @author Daniel DeGroff
 */
export interface MemberResponse {
    members?: Record<UUID, Array<GroupMember>>;
}
/**
 * @author Mikey Sleevi
 */
export interface Message {
}
/**
 * Stores an message template used to distribute messages;
 *
 * @author Michael Sleevi
 */
export interface MessageTemplate {
    data?: Record<string, any>;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    name?: string;
    type?: MessageType;
}
/**
 * A Message Template Request to the API
 *
 * @author Michael Sleevi
 */
export interface MessageTemplateRequest {
    messageTemplate?: MessageTemplate;
}
/**
 * @author Michael Sleevi
 */
export interface MessageTemplateResponse {
    messageTemplate?: MessageTemplate;
    messageTemplates?: Array<MessageTemplate>;
}
/**
 * @author Mikey Sleevi
 */
export declare enum MessageType {
    SMS = "SMS",
    Voice = "Voice"
}
/**
 * @author Brett Guy
 */
export interface MessengerRequest {
    messenger?: BaseMessengerConfiguration;
}
/**
 * @author Brett Guy
 */
export interface MessengerResponse {
    messenger?: BaseMessengerConfiguration;
    messengers?: Array<BaseMessengerConfiguration>;
}
/**
 * @author Daniel DeGroff
 * @deprecated since 1.65.0,  use {@code MessageType} instead
 */
export interface MessengerTransport {
}
/**
 * @author Brett Guy
 */
export declare enum MessengerType {
    Generic = "Generic",
    Kafka = "Kafka",
    Twilio = "Twilio"
}
/**
 * @author Daniel DeGroff
 */
export interface MinimumPasswordAge extends Enableable {
    seconds?: number;
}
/**
 * Response for the daily active user report.
 *
 * @author Brian Pontarelli
 */
export interface MonthlyActiveUserReportResponse {
    monthlyActiveUsers?: Array<Count>;
    total?: number;
}
/**
 * Communicate various actions/contexts in which multi-factor authentication can be used.
 */
export declare enum MultiFactorAction {
    changePassword = "changePassword",
    login = "login",
    stepUp = "stepUp"
}
/**
 * @author Daniel DeGroff
 */
export declare enum MultiFactorLoginPolicy {
    Disabled = "Disabled",
    Enabled = "Enabled",
    Required = "Required"
}
/**
 * @author Brett Pontarelli
 */
export interface NintendoApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
    buttonText?: string;
    client_id?: string;
    client_secret?: string;
    emailClaim?: string;
    scope?: string;
    uniqueIdClaim?: string;
    usernameClaim?: string;
}
/**
 * Nintendo gaming login provider.
 *
 * @author Brett Pontarelli
 */
export interface NintendoIdentityProvider extends BaseIdentityProvider<NintendoApplicationConfiguration> {
    buttonText?: string;
    client_id?: string;
    client_secret?: string;
    emailClaim?: string;
    scope?: string;
    uniqueIdClaim?: string;
    usernameClaim?: string;
}
/**
 * A marker interface indicating this event cannot be made transactional.
 *
 * @author Daniel DeGroff
 */
export interface NonTransactionalEvent {
}
/**
 * @author Daniel DeGroff
 */
export interface OAuth2Configuration {
    authorizedOriginURLs?: Array<string>;
    authorizedRedirectURLs?: Array<string>;
    authorizedURLValidationPolicy?: Oauth2AuthorizedURLValidationPolicy;
    clientAuthenticationPolicy?: ClientAuthenticationPolicy;
    clientId?: string;
    clientSecret?: string;
    consentMode?: OAuthScopeConsentMode;
    debug?: boolean;
    deviceVerificationURL?: string;
    enabledGrants?: Array<GrantType>;
    generateRefreshTokens?: boolean;
    logoutBehavior?: LogoutBehavior;
    logoutURL?: string;
    proofKeyForCodeExchangePolicy?: ProofKeyForCodeExchangePolicy;
    providedScopePolicy?: ProvidedScopePolicy;
    relationship?: OAuthApplicationRelationship;
    requireClientAuthentication?: boolean;
    requireRegistration?: boolean;
    scopeHandlingPolicy?: OAuthScopeHandlingPolicy;
    unknownScopePolicy?: UnknownScopePolicy;
}
/**
 * The application's relationship to the authorization server. First-party applications will be granted implicit permission for requested scopes.
 * Third-party applications will use the {@link OAuthScopeConsentMode} policy.
 *
 * @author Spencer Witt
 */
export declare enum OAuthApplicationRelationship {
    FirstParty = "FirstParty",
    ThirdParty = "ThirdParty"
}
/**
 * The request object for exchanging an OAuth authorization code for an access token.
 *
 * @author Lyle Schemmerling
 */
export interface OAuthCodeAccessTokenRequest {
    client_id?: string;
    client_secret?: string;
    code?: string;
    grant_type?: string;
    redirect_uri?: string;
    tenantId?: string;
}
/**
 * The request object to make a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint and a
 * code_verifier for an access token.
 *
 * @author Lyle Schemmerling
 */
export interface OAuthCodePKCEAccessTokenRequest {
    client_id?: string;
    client_secret?: string;
    code?: string;
    code_verifier?: string;
    grant_type?: string;
    redirect_uri?: string;
    tenantId?: UUID;
}
/**
 * @author Daniel DeGroff
 */
export interface OAuthConfigurationResponse {
    httpSessionMaxInactiveInterval?: number;
    logoutURL?: string;
    oauthConfiguration?: OAuth2Configuration;
}
/**
 * @author Daniel DeGroff
 */
export interface OAuthError {
    change_password_id?: string;
    error?: OAuthErrorType;
    error_description?: string;
    error_reason?: OAuthErrorReason;
    error_uri?: string;
    two_factor_id?: string;
    two_factor_methods?: Array<TwoFactorMethod>;
}
export declare enum OAuthErrorReason {
    auth_code_not_found = "auth_code_not_found",
    access_token_malformed = "access_token_malformed",
    access_token_expired = "access_token_expired",
    access_token_unavailable_for_processing = "access_token_unavailable_for_processing",
    access_token_failed_processing = "access_token_failed_processing",
    access_token_invalid = "access_token_invalid",
    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",
    invalid_grant_type = "invalid_grant_type",
    invalid_origin = "invalid_origin",
    invalid_origin_opaque = "invalid_origin_opaque",
    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",
    invalid_id_token_hint = "invalid_id_token_hint",
    invalid_post_logout_redirect_uri = "invalid_post_logout_redirect_uri",
    invalid_device_code = "invalid_device_code",
    invalid_user_code = "invalid_user_code",
    invalid_additional_client_id = "invalid_additional_client_id",
    invalid_target_entity_scope = "invalid_target_entity_scope",
    invalid_entity_permission_scope = "invalid_entity_permission_scope",
    invalid_user_id = "invalid_user_id",
    invalid_tenant_id = "invalid_tenant_id",
    grant_type_disabled = "grant_type_disabled",
    missing_client_id = "missing_client_id",
    missing_client_secret = "missing_client_secret",
    missing_code = "missing_code",
    missing_code_challenge = "missing_code_challenge",
    missing_code_verifier = "missing_code_verifier",
    missing_device_code = "missing_device_code",
    missing_grant_type = "missing_grant_type",
    missing_redirect_uri = "missing_redirect_uri",
    missing_refresh_token = "missing_refresh_token",
    missing_response_type = "missing_response_type",
    missing_token = "missing_token",
    missing_user_code = "missing_user_code",
    missing_user_id = "missing_user_id",
    missing_verification_uri = "missing_verification_uri",
    missing_tenant_id = "missing_tenant_id",
    login_prevented = "login_prevented",
    not_licensed = "not_licensed",
    user_code_expired = "user_code_expired",
    user_expired = "user_expired",
    user_locked = "user_locked",
    user_not_found = "user_not_found",
    client_authentication_missing = "client_authentication_missing",
    invalid_client_authentication_scheme = "invalid_client_authentication_scheme",
    invalid_client_authentication = "invalid_client_authentication",
    client_id_mismatch = "client_id_mismatch",
    change_password_administrative = "change_password_administrative",
    change_password_breached = "change_password_breached",
    change_password_expired = "change_password_expired",
    change_password_validation = "change_password_validation",
    unknown = "unknown",
    missing_required_scope = "missing_required_scope",
    unknown_scope = "unknown_scope",
    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",
    unsupported_grant_type = "unsupported_grant_type",
    unsupported_response_type = "unsupported_response_type",
    access_denied = "access_denied",
    change_password_required = "change_password_required",
    not_licensed = "not_licensed",
    two_factor_required = "two_factor_required",
    authorization_pending = "authorization_pending",
    expired_token = "expired_token",
    unsupported_token_type = "unsupported_token_type",
    invalid_dpop_proof = "invalid_dpop_proof"
}
/**
 * @author Daniel DeGroff
 */
export interface OAuthResponse {
}
/**
 * Controls the policy for requesting user permission to grant access to requested scopes during an OAuth workflow
 * for a third-party application.
 *
 * @author Spencer Witt
 */
export declare enum OAuthScopeConsentMode {
    AlwaysPrompt = "AlwaysPrompt",
    RememberDecision = "RememberDecision",
    NeverPrompt = "NeverPrompt"
}
/**
 * Controls the policy for whether OAuth workflows will more strictly adhere to the OAuth and OIDC specification
 * or run in backwards compatibility mode.
 *
 * @author David Charles
 */
export declare enum OAuthScopeHandlingPolicy {
    Compatibility = "Compatibility",
    Strict = "Strict"
}
/**
 * @author Johnathon Wood
 */
export declare enum Oauth2AuthorizedURLValidationPolicy {
    AllowWildcards = "AllowWildcards",
    ExactMatch = "ExactMatch"
}
/**
 * A marker interface indicating this event is an event that can supply a linked object Id.
 *
 * @author Spencer Witt
 */
export interface ObjectIdentifiable {
}
/**
 * @author Daniel DeGroff
 */
export declare enum ObjectState {
    Active = "Active",
    Inactive = "Inactive",
    PendingDelete = "PendingDelete"
}
/**
 * OpenID Connect Configuration as described by the <a href="https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata">OpenID
 * Provider Metadata</a>.
 *
 * @author Daniel DeGroff
 */
export interface OpenIdConfiguration {
    authorization_endpoint?: string;
    backchannel_logout_supported?: boolean;
    claims_supported?: Array<string>;
    code_challenge_methods_supported?: Array<string>;
    device_authorization_endpoint?: string;
    dpop_signing_alg_values_supported?: Array<string>;
    end_session_endpoint?: string;
    frontchannel_logout_supported?: boolean;
    grant_types_supported?: Array<string>;
    id_token_signing_alg_values_supported?: Array<string>;
    issuer?: string;
    jwks_uri?: string;
    response_modes_supported?: Array<string>;
    response_types_supported?: Array<string>;
    scopes_supported?: Array<string>;
    subject_types_supported?: Array<string>;
    token_endpoint?: string;
    token_endpoint_auth_methods_supported?: Array<string>;
    userinfo_endpoint?: string;
    userinfo_signing_alg_values_supported?: Array<string>;
}
/**
 * @author Daniel DeGroff
 */
export interface OpenIdConnectApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
    buttonImageURL?: string;
    buttonText?: string;
    oauth2?: IdentityProviderOauth2Configuration;
}
/**
 * @author Daniel DeGroff
 */
export interface OpenIdConnectIdentityProvider extends BaseIdentityProvider<OpenIdConnectApplicationConfiguration> {
    buttonImageURL?: string;
    buttonText?: string;
    domains?: Array<string>;
    oauth2?: IdentityProviderOauth2Configuration;
    postRequest?: boolean;
}
/**
 * @author Daniel DeGroff
 */
export interface PasswordBreachDetection extends Enableable {
    matchMode?: BreachMatchMode;
    notifyUserEmailTemplateId?: UUID;
    onLogin?: BreachAction;
}
export declare enum BreachAction {
    Off = "Off",
    RecordOnly = "RecordOnly",
    NotifyUser = "NotifyUser",
    RequireChange = "RequireChange"
}
export declare enum BreachMatchMode {
    Low = "Low",
    Medium = "Medium",
    High = "High"
}
/**
 * Password Encryption Scheme Configuration
 *
 * @author Daniel DeGroff
 */
export interface PasswordEncryptionConfiguration {
    encryptionScheme?: string;
    encryptionSchemeFactor?: number;
    modifyEncryptionSchemeOnLogin?: boolean;
}
/**
 * @author Derek Klatt
 */
export interface PasswordValidationRules {
    breachDetection?: PasswordBreachDetection;
    disallowUserLoginId?: boolean;
    maxLength?: number;
    minLength?: number;
    rememberPreviousPasswords?: RememberPreviousPasswords;
    requireMixedCase?: boolean;
    requireNonAlpha?: boolean;
    requireNumber?: boolean;
    validateOnLogin?: boolean;
}
/**
 * @author Daniel DeGroff
 */
export interface PasswordValidationRulesResponse {
    passwordValidationRules?: PasswordValidationRules;
}
/**
 * Interface for all identity providers that are passwordless and do not accept a password.
 */
export interface PasswordlessIdentityProvider {
}
/**
 * @author Daniel DeGroff
 */
export interface PasswordlessLoginRequest extends BaseLoginRequest {
    code?: string;
    oneTimeCode?: string;
    twoFactorTrustId?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface PasswordlessSendRequest {
    applicationId?: UUID;
    code?: string;
    loginId?: string;
    state?: Record<string, any>;
}
/**
 * @author Daniel DeGroff
 */
export interface PasswordlessStartRequest {
    applicationId?: UUID;
    loginId?: string;
    loginIdTypes?: Array<string>;
    loginStrategy?: PasswordlessStrategy;
    state?: Record<string, any>;
}
/**
 * @author Daniel DeGroff
 */
export interface PasswordlessStartResponse {
    code?: string;
    oneTimeCode?: string;
}
/**
 * @author Daniel DeGroff
 */
export declare enum PasswordlessStrategy {
    ClickableLink = "ClickableLink",
    FormField = "FormField"
}
/**
 * @author Daniel DeGroff
 */
export interface PendingIdPLink {
    displayName?: string;
    email?: string;
    identityProviderId?: UUID;
    identityProviderLinks?: Array<IdentityProviderLink>;
    identityProviderName?: string;
    identityProviderTenantConfiguration?: IdentityProviderTenantConfiguration;
    identityProviderType?: IdentityProviderType;
    identityProviderUserId?: string;
    user?: User;
    username?: string;
}
/**
 * @author Brian Pontarelli
 */
export interface PendingResponse {
    users?: Array<User>;
}
/**
 * Configuration for unverified phone number identities.
 *
 * @author Spencer Witt
 */
export interface PhoneUnverifiedOptions {
    allowPhoneNumberChangeWhenGated?: boolean;
    behavior?: UnverifiedBehavior;
}
/**
 * Represents the inbound lambda parameter 'policies' for MFA Required lambdas.
 */
export interface Policies {
    applicationLoginPolicy?: MultiFactorLoginPolicy;
    applicationMultiFactorTrustPolicy?: ApplicationMultiFactorTrustPolicy;
    tenantLoginPolicy?: MultiFactorLoginPolicy;
}
/**
 * @author Michael Sleevi
 */
export interface PreviewMessageTemplateRequest {
    locale?: string;
    messageTemplate?: MessageTemplate;
}
/**
 * @author Michael Sleevi
 */
export interface PreviewMessageTemplateResponse {
    errors?: Errors;
    message?: SMSMessage;
    previewMessage?: string;
}
/**
 * @author Brian Pontarelli
 */
export interface PreviewRequest {
    emailTemplate?: EmailTemplate;
    locale?: string;
}
/**
 * @author Seth Musselman
 */
export interface PreviewResponse {
    email?: Email;
    errors?: Errors;
}
/**
 * @author Brett Guy
 */
export declare enum ProofKeyForCodeExchangePolicy {
    Required = "Required",
    NotRequired = "NotRequired",
    NotRequiredWhenUsingClientAuthentication = "NotRequiredWhenUsingClientAuthentication"
}
/**
 * The handling policy for scopes provided by FusionAuth
 *
 * @author Spencer Witt
 */
export interface ProvidedScopePolicy {
    address?: Requirable;
    email?: Requirable;
    phone?: Requirable;
    profile?: Requirable;
}
/**
 * Allows the Relying Party to specify desired attributes of a new credential.
 *
 * @author Spencer Witt
 */
export interface PublicKeyCredentialCreationOptions {
    attestation?: AttestationConveyancePreference;
    authenticatorSelection?: AuthenticatorSelectionCriteria;
    challenge?: string;
    excludeCredentials?: Array<PublicKeyCredentialDescriptor>;
    extensions?: WebAuthnRegistrationExtensionOptions;
    pubKeyCredParams?: Array<PublicKeyCredentialParameters>;
    rp?: PublicKeyCredentialRelyingPartyEntity;
    timeout?: number;
    user?: PublicKeyCredentialUserEntity;
}
/**
 * Contains attributes for the Relying Party to refer to an existing public key credential as an input parameter.
 *
 * @author Spencer Witt
 */
export interface PublicKeyCredentialDescriptor {
    id?: string;
    transports?: Array<string>;
    type?: PublicKeyCredentialType;
}
/**
 * Describes a user account or WebAuthn Relying Party associated with a public key credential
 */
export interface PublicKeyCredentialEntity {
    name?: string;
}
/**
 * Supply information on credential type and algorithm to the <i>authenticator</i>.
 *
 * @author Spencer Witt
 */
export interface PublicKeyCredentialParameters {
    alg?: CoseAlgorithmIdentifier;
    type?: PublicKeyCredentialType;
}
/**
 * Supply additional information about the Relying Party when creating a new credential
 *
 * @author Spencer Witt
 */
export interface PublicKeyCredentialRelyingPartyEntity extends PublicKeyCredentialEntity {
    id?: string;
}
/**
 * Provides the <i>authenticator</i> with the data it needs to generate an assertion.
 *
 * @author Spencer Witt
 */
export interface PublicKeyCredentialRequestOptions {
    allowCredentials?: Array<PublicKeyCredentialDescriptor>;
    challenge?: string;
    rpId?: string;
    timeout?: number;
    userVerification?: UserVerificationRequirement;
}
/**
 * Defines valid credential types. This is an extension point in the WebAuthn spec. The only defined value at this time is "public-key"
 *
 * @author Spencer Witt
 */
export declare enum PublicKeyCredentialType {
    publicKey = "public-key"
}
/**
 * Supply additional information about the user account when creating a new credential
 *
 * @author Spencer Witt
 */
export interface PublicKeyCredentialUserEntity extends PublicKeyCredentialEntity {
    displayName?: string;
    id?: string;
}
/**
 * JWT Public Key Response Object
 *
 * @author Daniel DeGroff
 */
export interface PublicKeyResponse {
    publicKey?: string;
    publicKeys?: Record<string, string>;
}
/**
 * @author Daniel DeGroff
 */
export interface RateLimitedRequestConfiguration extends Enableable {
    limit?: number;
    timePeriodInSeconds?: number;
}
/**
 * Raw login information for each time a user logs into an application.
 *
 * @author Brian Pontarelli
 */
export interface RawLogin {
    applicationId?: UUID;
    instant?: number;
    ipAddress?: string;
    userId?: UUID;
}
/**
 * @author Brian Pontarelli
 */
export declare enum ReactorFeatureStatus {
    ACTIVE = "ACTIVE",
    DISCONNECTED = "DISCONNECTED",
    PENDING = "PENDING",
    DISABLED = "DISABLED",
    UNKNOWN = "UNKNOWN"
}
/**
 * @author Daniel DeGroff
 */
export interface ReactorMetrics {
    breachedPasswordMetrics?: Record<UUID, BreachedPasswordTenantMetric>;
}
/**
 * @author Daniel DeGroff
 */
export interface ReactorMetricsResponse {
    metrics?: ReactorMetrics;
}
/**
 * Request for managing FusionAuth Reactor and licenses.
 *
 * @author Brian Pontarelli
 */
export interface ReactorRequest {
    license?: string;
    licenseId?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface ReactorResponse {
    status?: ReactorStatus;
}
/**
 * @author Daniel DeGroff
 */
export interface ReactorStatus {
    advancedIdentityProviders?: ReactorFeatureStatus;
    advancedLambdas?: ReactorFeatureStatus;
    advancedMultiFactorAuthentication?: ReactorFeatureStatus;
    advancedOAuthScopes?: ReactorFeatureStatus;
    advancedOAuthScopesCustomScopes?: ReactorFeatureStatus;
    advancedOAuthScopesThirdPartyApplications?: ReactorFeatureStatus;
    advancedRegistration?: ReactorFeatureStatus;
    applicationMultiFactorAuthentication?: ReactorFeatureStatus;
    applicationThemes?: ReactorFeatureStatus;
    breachedPasswordDetection?: ReactorFeatureStatus;
    connectors?: ReactorFeatureStatus;
    dPoP?: ReactorFeatureStatus;
    entityManagement?: ReactorFeatureStatus;
    expiration?: string;
    ipGeoLocation?: ReactorFeatureStatus;
    licenseAttributes?: Record<string, string>;
    licensed?: boolean;
    multiFactorLambdas?: ReactorFeatureStatus;
    scimServer?: ReactorFeatureStatus;
    tenantManagerApplication?: ReactorFeatureStatus;
    threatDetection?: ReactorFeatureStatus;
    universalApplication?: ReactorFeatureStatus;
    webAuthn?: ReactorFeatureStatus;
    webAuthnPlatformAuthenticators?: ReactorFeatureStatus;
    webAuthnRoamingAuthenticators?: ReactorFeatureStatus;
}
/**
 * Response for the user login report.
 *
 * @author Seth Musselman
 */
export interface RecentLoginResponse {
    logins?: Array<DisplayableRawLogin>;
}
/**
 * @author Daniel DeGroff
 */
export interface RefreshRequest extends BaseEventRequest {
    refreshToken?: string;
    timeToLiveInSeconds?: number;
    token?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface RefreshResponse {
}
/**
 * Models a JWT Refresh Token.
 *
 * @author Daniel DeGroff
 */
export interface RefreshToken {
    applicationId?: UUID;
    data?: Record<string, any>;
    id?: UUID;
    insertInstant?: number;
    metaData?: MetaData;
    startInstant?: number;
    tenantId?: UUID;
    token?: string;
    userId?: UUID;
}
export interface MetaData {
    data?: Record<string, any>;
    device?: DeviceInfo;
    scopes?: Array<string>;
}
/**
 * The request object to exchange a Refresh Token for an Access Token.
 *
 * @author Lyle Schemmerling
 */
export interface RefreshTokenAccessTokenRequest {
    client_id?: string;
    client_secret?: string;
    grant_type?: string;
    refresh_token?: string;
    scope?: string;
    tenantId?: UUID;
    user_code?: string;
}
/**
 * @author Daniel DeGroff
 */
export declare enum RefreshTokenExpirationPolicy {
    Fixed = "Fixed",
    SlidingWindow = "SlidingWindow",
    SlidingWindowWithMaximumLifetime = "SlidingWindowWithMaximumLifetime"
}
/**
 * Refresh Token Import request.
 *
 * @author Brett Guy
 */
export interface RefreshTokenImportRequest {
    refreshTokens?: Array<RefreshToken>;
    validateDbConstraints?: boolean;
}
/**
 * Refresh token one-time use configuration. This configuration is utilized when the usage policy is
 * configured for one-time use.
 *
 * @author Daniel DeGroff
 */
export interface RefreshTokenOneTimeUseConfiguration {
    gracePeriodInSeconds?: number;
}
/**
 * API response for retrieving Refresh Tokens
 *
 * @author Daniel DeGroff
 */
export interface RefreshTokenResponse {
    refreshToken?: RefreshToken;
    refreshTokens?: Array<RefreshToken>;
}
/**
 * @author Daniel DeGroff
 */
export interface RefreshTokenRevocationPolicy {
    onLoginPrevented?: boolean;
    onMultiFactorEnable?: boolean;
    onOneTimeTokenReuse?: boolean;
    onPasswordChanged?: boolean;
}
/**
 * Request for the Refresh Token API to revoke a refresh token rather than using the URL parameters.
 *
 * @author Brian Pontarelli
 */
export interface RefreshTokenRevokeRequest extends BaseEventRequest {
    applicationId?: UUID;
    token?: string;
    userId?: UUID;
}
/**
 * @author Daniel DeGroff
 */
export interface RefreshTokenSlidingWindowConfiguration {
    maximumTimeToLiveInMinutes?: number;
}
/**
 * @author Daniel DeGroff
 */
export declare enum RefreshTokenUsagePolicy {
    Reusable = "Reusable",
    OneTimeUse = "OneTimeUse"
}
/**
 * Registration delete API request object.
 *
 * @author Brian Pontarelli
 */
export interface RegistrationDeleteRequest extends BaseEventRequest {
}
/**
 * Response for the registration report.
 *
 * @author Brian Pontarelli
 */
export interface RegistrationReportResponse {
    hourlyCounts?: Array<Count>;
    total?: number;
}
/**
 * Registration API request object.
 *
 * @author Brian Pontarelli
 */
export interface RegistrationRequest extends BaseEventRequest {
    disableDomainBlock?: boolean;
    generateAuthenticationToken?: boolean;
    registration?: UserRegistration;
    sendSetPasswordEmail?: boolean;
    sendSetPasswordIdentityType?: SendSetPasswordIdentityType;
    skipRegistrationVerification?: boolean;
    skipVerification?: boolean;
    user?: User;
    verificationIds?: Array<string>;
}
/**
 * Registration API request object.
 *
 * @author Brian Pontarelli
 */
export interface RegistrationResponse {
    refreshToken?: string;
    refreshTokenId?: UUID;
    registration?: UserRegistration;
    registrationVerificationId?: string;
    registrationVerificationOneTimeCode?: string;
    token?: string;
    tokenExpirationInstant?: number;
    user?: User;
    verificationIds?: Array<VerificationId>;
}
/**
 * @author Daniel DeGroff
 */
export interface RegistrationUnverifiedOptions {
    behavior?: UnverifiedBehavior;
}
/**
 * Reindex API request
 *
 * @author Daniel DeGroff
 */
export interface ReindexRequest {
    index?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface ReloadRequest {
    names?: Array<string>;
}
/**
 * @author Daniel DeGroff
 */
export interface RememberPreviousPasswords extends Enableable {
    count?: number;
}
/**
 * Something that can be required and thus also optional. This currently extends Enableable because anything that is
 * required/optional is almost always enableable as well.
 *
 * @author Brian Pontarelli
 */
export interface Requirable extends Enableable {
    required?: boolean;
}
/**
 * Represents the inbound lambda parameter 'result' for MFA Required lambdas.
 */
export interface RequiredLambdaResult {
    required?: boolean;
    sendSuspiciousLoginEvent?: boolean;
}
/**
 * Interface describing the need for CORS configuration.
 *
 * @author Daniel DeGroff
 */
export interface RequiresCORSConfiguration {
}
/**
 * Describes the Relying Party's requirements for <a href="https://www.w3.org/TR/webauthn-2/#client-side-discoverable-credential">client-side
 * discoverable credentials</a> (formerly known as "resident keys")
 *
 * @author Spencer Witt
 */
export declare enum ResidentKeyRequirement {
    discouraged = "discouraged",
    preferred = "preferred",
    required = "required"
}
/**
 * The request object for retrieving a user code that is part of an in-progress Device Authorization Grant.
 *
 * @author Lyle Schemmerling
 */
export interface RetrieveUserCodeRequest {
    client_id?: string;
    client_secret?: string;
    tenantId?: UUID;
    user_code?: string;
}
/**
 * The request object for retrieving a user code that is part of an in-progress Device Authorization Grant using an API key
 *
 * @author Lyle Schemmerling
 */
export interface RetrieveUserCodeUsingAPIKeyRequest {
    tenantId?: UUID;
    user_code?: string;
}
/**
 * @author Brian Pontarelli
 */
export interface SAMLv2ApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
    buttonImageURL?: string;
    buttonText?: string;
}
/**
 * @author Lyle Schemmerling
 */
export interface SAMLv2AssertionConfiguration {
    destination?: SAMLv2DestinationAssertionConfiguration;
}
/**
 * Configuration for encrypted assertions when acting as SAML Service Provider
 *
 * @author Jaret Hendrickson
 */
export interface SAMLv2AssertionDecryptionConfiguration extends Enableable {
    keyTransportDecryptionKeyId?: UUID;
}
/**
 * @author Lyle Schemmerling
 */
export interface SAMLv2DestinationAssertionConfiguration {
    alternates?: Array<string>;
    policy?: SAMLv2DestinationAssertionPolicy;
}
/**
 * @author Lyle Schemmerling
 */
export declare enum SAMLv2DestinationAssertionPolicy {
    Enabled = "Enabled",
    Disabled = "Disabled",
    AllowAlternates = "AllowAlternates"
}
/**
 * @author Daniel DeGroff
 */
export interface SAMLv2IdPInitiatedApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
}
/**
 * SAML v2 IdP Initiated identity provider configuration.
 *
 * @author Daniel DeGroff
 */
export interface SAMLv2IdPInitiatedIdentityProvider extends BaseSAMLv2IdentityProvider<SAMLv2IdPInitiatedApplicationConfiguration> {
    issuer?: string;
}
/**
 * IdP Initiated login configuration
 *
 * @author Daniel DeGroff
 */
export interface SAMLv2IdPInitiatedLoginConfiguration extends Enableable {
    nameIdFormat?: string;
}
/**
 * SAML v2 identity provider configuration.
 *
 * @author Brian Pontarelli
 */
export interface SAMLv2IdentityProvider extends BaseSAMLv2IdentityProvider<SAMLv2ApplicationConfiguration> {
    assertionConfiguration?: SAMLv2AssertionConfiguration;
    buttonImageURL?: string;
    buttonText?: string;
    domains?: Array<string>;
    idpEndpoint?: string;
    idpInitiatedConfiguration?: SAMLv2IdpInitiatedConfiguration;
    issuer?: string;
    loginHintConfiguration?: LoginHintConfiguration;
    nameIdFormat?: string;
    postRequest?: boolean;
    requestSigningKeyId?: UUID;
    signRequest?: boolean;
    xmlSignatureC14nMethod?: CanonicalizationMethod;
}
/**
 * Config for regular SAML IDP configurations that support IdP initiated requests
 *
 * @author Lyle Schemmerling
 */
export interface SAMLv2IdpInitiatedConfiguration extends Enableable {
    issuer?: string;
}
/**
 * @author Michael Sleevi
 */
export interface SMSMessage {
    phoneNumber?: string;
    textMessage?: string;
}
/**
 * @author Michael Sleevi
 */
export interface SMSMessageTemplate extends MessageTemplate {
    defaultTemplate?: string;
    localizedTemplates?: LocalizedStrings;
}
/**
 * Search API request.
 *
 * @author Brian Pontarelli
 */
export interface SearchRequest extends ExpandableRequest {
    search?: UserSearchCriteria;
}
/**
 * Search API response.
 *
 * @author Brian Pontarelli
 */
export interface SearchResponse extends ExpandableResponse {
    nextResults?: string;
    total?: number;
    users?: Array<User>;
}
/**
 * Search results.
 *
 * @author Brian Pontarelli
 */
export interface SearchResults<T> {
    nextResults?: string;
    results?: Array<T>;
    total?: number;
    totalEqualToActual?: boolean;
}
/**
 * @author Daniel DeGroff
 */
export interface SecretResponse {
    secret?: string;
    secretBase32Encoded?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface SecureGeneratorConfiguration {
    length?: number;
    type?: SecureGeneratorType;
}
/**
 * @author Daniel DeGroff
 */
export declare enum SecureGeneratorType {
    randomDigits = "randomDigits",
    randomBytes = "randomBytes",
    randomAlpha = "randomAlpha",
    randomAlphaNumeric = "randomAlphaNumeric"
}
/**
 * @author Daniel DeGroff
 */
export interface SecureIdentity {
    breachedPasswordLastCheckedInstant?: number;
    breachedPasswordStatus?: BreachedPasswordStatus;
    connectorId?: UUID;
    encryptionScheme?: string;
    factor?: number;
    id?: UUID;
    identities?: Array<UserIdentity>;
    lastLoginInstant?: number;
    password?: string;
    passwordChangeReason?: ChangePasswordReason;
    passwordChangeRequired?: boolean;
    passwordLastUpdateInstant?: number;
    salt?: string;
    uniqueUsername?: string;
    username?: string;
    usernameStatus?: ContentStatus;
    verified?: boolean;
    verifiedInstant?: number;
}
/**
 * @author andrewpai
 */
export interface SelfServiceFormConfiguration {
    requireCurrentPasswordOnPasswordChange?: boolean;
}
/**
 * @author Daniel DeGroff
 */
export interface SendRequest {
    applicationId?: UUID;
    bccAddresses?: Array<string>;
    ccAddresses?: Array<string>;
    preferredLanguages?: Array<string>;
    requestData?: Record<string, any>;
    toAddresses?: Array<EmailAddress>;
    userIds?: Array<UUID>;
}
/**
 * @author Daniel DeGroff
 */
export interface SendResponse {
    anonymousResults?: Record<string, EmailTemplateErrors>;
    results?: Record<UUID, EmailTemplateErrors>;
}
export interface EmailTemplateErrors {
    parseErrors?: Record<string, string>;
    renderErrors?: Record<string, string>;
}
/**
 * Used to indicate which identity type a password "request" might go to. It could be
 * used for send set passwords or send password resets.
 */
export declare enum SendSetPasswordIdentityType {
    email = "email",
    phone = "phone",
    doNotSend = "doNotSend"
}
/**
 * Theme object for values used in the css variables for simple themes.
 *
 * @author Lyle Schemmerling
 */
export interface SimpleThemeVariables {
    alertBackgroundColor?: string;
    alertFontColor?: string;
    backgroundImageURL?: string;
    backgroundSize?: string;
    borderRadius?: string;
    deleteButtonColor?: string;
    deleteButtonFocusColor?: string;
    deleteButtonTextColor?: string;
    deleteButtonTextFocusColor?: string;
    errorFontColor?: string;
    errorIconColor?: string;
    favicons?: Array<Favicon>;
    fontColor?: string;
    fontFamily?: string;
    footerDisplay?: boolean;
    iconBackgroundColor?: string;
    iconColor?: string;
    infoIconColor?: string;
    inputBackgroundColor?: string;
    inputIconColor?: string;
    inputTextColor?: string;
    linkTextColor?: string;
    linkTextFocusColor?: string;
    logoImageSize?: string;
    logoImageURL?: string;
    monoFontColor?: string;
    monoFontFamily?: string;
    pageBackgroundColor?: string;
    panelBackgroundColor?: string;
    primaryButtonColor?: string;
    primaryButtonFocusColor?: string;
    primaryButtonTextColor?: string;
    primaryButtonTextFocusColor?: string;
}
/**
 * @author Brett Pontarelli
 */
export interface SonyPSNApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
    buttonText?: string;
    client_id?: string;
    client_secret?: string;
    scope?: string;
}
/**
 * SonyPSN gaming login provider.
 *
 * @author Brett Pontarelli
 */
export interface SonyPSNIdentityProvider extends BaseIdentityProvider<SonyPSNApplicationConfiguration> {
    buttonText?: string;
    client_id?: string;
    client_secret?: string;
    scope?: string;
}
/**
 * @author Daniel DeGroff
 */
export declare enum Sort {
    asc = "asc",
    desc = "desc"
}
/**
 * @author Daniel DeGroff
 */
export interface SortField {
    missing?: string;
    name?: string;
    order?: Sort;
}
/**
 * The public Status API response
 *
 * @author Daniel DeGroff
 */
export interface StatusResponse extends Record<string, any> {
}
/**
 * Steam API modes.
 *
 * @author Daniel DeGroff
 */
export declare enum SteamAPIMode {
    Public = "Public",
    Partner = "Partner"
}
/**
 * @author Brett Pontarelli
 */
export interface SteamApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
    apiMode?: SteamAPIMode;
    buttonText?: string;
    client_id?: string;
    scope?: string;
    webAPIKey?: string;
}
/**
 * Steam gaming login provider.
 *
 * @author Brett Pontarelli
 */
export interface SteamIdentityProvider extends BaseIdentityProvider<SteamApplicationConfiguration> {
    apiMode?: SteamAPIMode;
    buttonText?: string;
    client_id?: string;
    scope?: string;
    webAPIKey?: string;
}
/**
 * Helper interface that indicates an identity provider can be federated to using the HTTP POST method.
 *
 * @author Brian Pontarelli
 */
export interface SupportsPostBindings {
}
/**
 * @author Brian Pontarelli
 */
export interface SystemConfiguration {
    auditLogConfiguration?: AuditLogConfiguration;
    corsConfiguration?: CORSConfiguration;
    data?: Record<string, any>;
    eventLogConfiguration?: EventLogConfiguration;
    insertInstant?: number;
    lastUpdateInstant?: number;
    loginRecordConfiguration?: LoginRecordConfiguration;
    reportTimezone?: string;
    trustedProxyConfiguration?: SystemTrustedProxyConfiguration;
    uiConfiguration?: UIConfiguration;
    usageDataConfiguration?: UsageDataConfiguration;
    webhookEventLogConfiguration?: WebhookEventLogConfiguration;
}
export interface AuditLogConfiguration {
    delete?: DeleteConfiguration;
}
export interface DeleteConfiguration extends Enableable {
    numberOfDaysToRetain?: number;
}
export interface EventLogConfiguration {
    numberToRetain?: number;
}
export interface LoginRecordConfiguration {
    delete?: DeleteConfiguration;
}
export interface UIConfiguration {
    headerColor?: string;
    logoURL?: string;
    menuFontColor?: string;
}
/**
 * Request for the system configuration API.
 *
 * @author Brian Pontarelli
 */
export interface SystemConfigurationRequest {
    systemConfiguration?: SystemConfiguration;
}
/**
 * Response for the system configuration API.
 *
 * @author Brian Pontarelli
 */
export interface SystemConfigurationResponse {
    systemConfiguration?: SystemConfiguration;
}
/**
 * @author Daniel DeGroff
 */
export interface SystemLogsExportRequest extends BaseExportRequest {
    includeArchived?: boolean;
    lastNBytes?: number;
}
/**
 * @author Daniel DeGroff
 */
export interface SystemTrustedProxyConfiguration {
    trusted?: Array<string>;
    trustPolicy?: SystemTrustedProxyConfigurationPolicy;
}
/**
 * @author Daniel DeGroff
 */
export declare enum SystemTrustedProxyConfigurationPolicy {
    All = "All",
    OnlyConfigured = "OnlyConfigured"
}
/**
 * @author Daniel DeGroff
 */
export interface Tenant {
    accessControlConfiguration?: TenantAccessControlConfiguration;
    captchaConfiguration?: TenantCaptchaConfiguration;
    configured?: boolean;
    connectorPolicies?: Array<ConnectorPolicy>;
    data?: Record<string, any>;
    emailConfiguration?: EmailConfiguration;
    eventConfiguration?: EventConfiguration;
    externalIdentifierConfiguration?: ExternalIdentifierConfiguration;
    failedAuthenticationConfiguration?: FailedAuthenticationConfiguration;
    familyConfiguration?: FamilyConfiguration;
    formConfiguration?: TenantFormConfiguration;
    httpSessionMaxInactiveInterval?: number;
    id?: UUID;
    insertInstant?: number;
    issuer?: string;
    jwtConfiguration?: JWTConfiguration;
    lambdaConfiguration?: TenantLambdaConfiguration;
    lastUpdateInstant?: number;
    loginConfiguration?: TenantLoginConfiguration;
    logoutURL?: string;
    maximumPasswordAge?: MaximumPasswordAge;
    minimumPasswordAge?: MinimumPasswordAge;
    multiFactorConfiguration?: TenantMultiFactorConfiguration;
    name?: string;
    oauthConfiguration?: TenantOAuth2Configuration;
    passwordEncryptionConfiguration?: PasswordEncryptionConfiguration;
    passwordValidationRules?: PasswordValidationRules;
    phoneConfiguration?: TenantPhoneConfiguration;
    rateLimitConfiguration?: TenantRateLimitConfiguration;
    registrationConfiguration?: TenantRegistrationConfiguration;
    scimServerConfiguration?: TenantSCIMServerConfiguration;
    ssoConfiguration?: TenantSSOConfiguration;
    state?: ObjectState;
    themeId?: UUID;
    userDeletePolicy?: TenantUserDeletePolicy;
    usernameConfiguration?: TenantUsernameConfiguration;
    webAuthnConfiguration?: TenantWebAuthnConfiguration;
}
export interface TenantOAuth2Configuration {
    clientCredentialsAccessTokenPopulateLambdaId?: UUID;
}
/**
 * @author Brett Guy
 */
export interface TenantAccessControlConfiguration {
    uiIPAccessControlListId?: UUID;
}
/**
 * @author Brett Pontarelli
 */
export interface TenantCaptchaConfiguration extends Enableable {
    captchaMethod?: CaptchaMethod;
    secretKey?: string;
    siteKey?: string;
    threshold?: number;
}
/**
 * Request for the Tenant API to delete a tenant rather than using the URL parameters.
 *
 * @author Brian Pontarelli
 */
export interface TenantDeleteRequest extends BaseEventRequest {
    async?: boolean;
}
/**
 * @author Daniel DeGroff
 */
export interface TenantFormConfiguration {
    adminUserFormId?: UUID;
}
/**
 * @author Rob Davis
 */
export interface TenantLambdaConfiguration {
    loginValidationId?: UUID;
    multiFactorRequirementId?: UUID;
    scimEnterpriseUserRequestConverterId?: UUID;
    scimEnterpriseUserResponseConverterId?: UUID;
    scimGroupRequestConverterId?: UUID;
    scimGroupResponseConverterId?: UUID;
    scimUserRequestConverterId?: UUID;
    scimUserResponseConverterId?: UUID;
}
/**
 * @author Daniel DeGroff
 */
export interface TenantLoginConfiguration {
    requireAuthentication?: boolean;
}
/**
 * Tenant Manager application configuration.
 */
export interface TenantManagerApplicationConfiguration {
    applicationId?: UUID;
}
/**
 * Configuration object for the Tenant Manager.
 */
export interface TenantManagerConfiguration {
    applicationConfigurations?: Array<TenantManagerApplicationConfiguration>;
    attributeFormId?: UUID;
    brandName?: string;
    identityProviderTypeConfigurations?: Record<string, TenantManagerIdentityProviderTypeConfiguration>;
    insertInstant?: number;
    lastUpdateInstant?: number;
}
/**
 * The Tenant Manager configuration request object
 */
export interface TenantManagerConfigurationRequest {
    tenantManagerConfiguration?: TenantManagerConfiguration;
}
/**
 * The Tenant Manager configuration response object
 */
export interface TenantManagerConfigurationResponse {
    tenantManagerConfiguration?: TenantManagerConfiguration;
}
/**
 * Configuration object for identity provider types allowed in Tenant Manager
 */
export interface TenantManagerIdentityProviderTypeConfiguration extends Enableable {
    defaultAttributeMappings?: Record<string, string>;
    insertInstant?: number;
    lastUpdateInstant?: number;
    linkingStrategy?: IdentityProviderLinkingStrategy;
    type?: IdentityProviderType;
}
/**
 * The Tenant Manager IdP type configuration request object
 */
export interface TenantManagerIdentityProviderTypeConfigurationRequest {
    typeConfiguration?: TenantManagerIdentityProviderTypeConfiguration;
}
/**
 * The Tenant Manager IdP type configuration response object
 */
export interface TenantManagerIdentityProviderTypeConfigurationResponse {
    typeConfiguration?: TenantManagerIdentityProviderTypeConfiguration;
}
/**
 * @author Mikey Sleevi
 */
export interface TenantMultiFactorConfiguration {
    authenticator?: MultiFactorAuthenticatorMethod;
    email?: MultiFactorEmailMethod;
    loginPolicy?: MultiFactorLoginPolicy;
    sms?: MultiFactorSMSMethod;
    voice?: MultiFactorVoiceMethod;
}
export interface MultiFactorAuthenticatorMethod extends Enableable {
    algorithm?: TOTPAlgorithm;
    codeLength?: number;
    timeStep?: number;
}
export interface MultiFactorEmailMethod extends Enableable {
    templateId?: UUID;
}
export interface MultiFactorSMSMethod extends Enableable {
    messengerId?: UUID;
    templateId?: UUID;
}
export interface MultiFactorVoiceMethod extends Enableable {
    messengerId?: UUID;
    templateId?: UUID;
}
/**
 * Hold tenant phone configuration for passwordless and verification cases.
 *
 * @author Brady Wied
 */
export interface TenantPhoneConfiguration {
    forgotPasswordTemplateId?: UUID;
    identityUpdateTemplateId?: UUID;
    implicitPhoneVerificationAllowed?: boolean;
    loginIdInUseOnCreateTemplateId?: UUID;
    loginIdInUseOnUpdateTemplateId?: UUID;
    loginNewDeviceTemplateId?: UUID;
    loginSuspiciousTemplateId?: UUID;
    messengerId?: UUID;
    passwordlessTemplateId?: UUID;
    passwordResetSuccessTemplateId?: UUID;
    passwordUpdateTemplateId?: UUID;
    setPasswordTemplateId?: UUID;
    twoFactorMethodAddTemplateId?: UUID;
    twoFactorMethodRemoveTemplateId?: UUID;
    unverified?: PhoneUnverifiedOptions;
    verificationCompleteTemplateId?: UUID;
    verificationStrategy?: VerificationStrategy;
    verificationTemplateId?: UUID;
    verifyPhoneNumber?: boolean;
}
/**
 * @author Daniel DeGroff
 */
export interface TenantRateLimitConfiguration {
    failedLogin?: RateLimitedRequestConfiguration;
    forgotPassword?: RateLimitedRequestConfiguration;
    sendEmailVerification?: RateLimitedRequestConfiguration;
    sendPasswordless?: RateLimitedRequestConfiguration;
    sendPasswordlessPhone?: RateLimitedRequestConfiguration;
    sendPhoneVerification?: RateLimitedRequestConfiguration;
    sendRegistrationVerification?: RateLimitedRequestConfiguration;
    sendTwoFactor?: RateLimitedRequestConfiguration;
}
/**
 * @author Daniel DeGroff
 */
export interface TenantRegistrationConfiguration {
    blockedDomains?: Array<string>;
}
/**
 * @author Daniel DeGroff
 */
export interface TenantRequest extends BaseEventRequest {
    sourceTenantId?: UUID;
    tenant?: Tenant;
    webhookIds?: Array<UUID>;
}
/**
 * @author Daniel DeGroff
 */
export interface TenantResponse {
    tenant?: Tenant;
    tenants?: Array<Tenant>;
}
/**
 * @author Rob Davis
 */
export interface TenantSCIMServerConfiguration extends Enableable {
    clientEntityTypeId?: UUID;
    schemas?: Record<string, any>;
    serverEntityTypeId?: UUID;
}
/**
 * @author Brett Pontarelli
 */
export interface TenantSSOConfiguration {
    allowAccessTokenBootstrap?: boolean;
    deviceTrustTimeToLiveInSeconds?: number;
}
/**
 * Search criteria for Tenants
 *
 * @author Mark Manes
 */
export interface TenantSearchCriteria extends BaseSearchCriteria {
    name?: string;
}
/**
 * Search request for Tenants
 *
 * @author Mark Manes
 */
export interface TenantSearchRequest {
    search?: TenantSearchCriteria;
}
/**
 * Tenant search response
 *
 * @author Mark Manes
 */
export interface TenantSearchResponse {
    tenants?: Array<Tenant>;
    total?: number;
}
/**
 * @author Daniel DeGroff
 */
export interface TenantUnverifiedConfiguration {
    email?: UnverifiedBehavior;
    whenGated?: RegistrationUnverifiedOptions;
}
/**
 * A Tenant-level policy for deleting Users.
 *
 * @author Trevor Smith
 */
export interface TenantUserDeletePolicy {
    unverified?: TimeBasedDeletePolicy;
}
/**
 * @author Daniel DeGroff
 */
export interface TenantUsernameConfiguration {
    unique?: UniqueUsernameConfiguration;
}
export interface UniqueUsernameConfiguration extends Enableable {
    numberOfDigits?: number;
    separator?: string;
    strategy?: UniqueUsernameStrategy;
}
export declare enum UniqueUsernameStrategy {
    Always = "Always",
    OnCollision = "OnCollision"
}
/**
 * Tenant-level configuration for WebAuthn
 *
 * @author Spencer Witt
 */
export interface TenantWebAuthnConfiguration extends Enableable {
    bootstrapWorkflow?: TenantWebAuthnWorkflowConfiguration;
    debug?: boolean;
    reauthenticationWorkflow?: TenantWebAuthnWorkflowConfiguration;
    relyingPartyId?: string;
    relyingPartyName?: string;
}
/**
 * @author Spencer Witt
 */
export interface TenantWebAuthnWorkflowConfiguration extends Enableable {
    authenticatorAttachmentPreference?: AuthenticatorAttachmentPreference;
    userVerificationRequirement?: UserVerificationRequirement;
}
/**
 * @author Brian Pontarelli
 */
export interface Tenantable {
}
/**
 * @author Daniel DeGroff
 */
export interface TestEvent extends BaseEvent {
    message?: string;
}
/**
 * @author Trevor Smith
 */
export interface Theme {
    data?: Record<string, any>;
    defaultMessages?: string;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    localizedMessages?: LocalizedStrings;
    name?: string;
    stylesheet?: string;
    templates?: Templates;
    type?: ThemeType;
    variables?: SimpleThemeVariables;
}
export interface Templates {
    accountEdit?: string;
    accountIndex?: string;
    accountTwoFactorDisable?: string;
    accountTwoFactorEnable?: string;
    accountTwoFactorIndex?: string;
    accountWebAuthnAdd?: string;
    accountWebAuthnDelete?: string;
    accountWebAuthnIndex?: string;
    confirmationRequired?: string;
    emailComplete?: string;
    emailSend?: string;
    emailSent?: string;
    emailVerificationRequired?: string;
    emailVerify?: string;
    helpers?: string;
    index?: string;
    oauth2Authorize?: string;
    oauth2AuthorizedNotRegistered?: string;
    oauth2ChildRegistrationNotAllowed?: string;
    oauth2ChildRegistrationNotAllowedComplete?: string;
    oauth2CompleteRegistration?: string;
    oauth2Consent?: string;
    oauth2Device?: string;
    oauth2DeviceComplete?: string;
    oauth2Error?: string;
    oauth2Logout?: string;
    oauth2Passwordless?: string;
    oauth2Register?: string;
    oauth2StartIdPLink?: string;
    oauth2TwoFactor?: string;
    oauth2TwoFactorEnable?: string;
    oauth2TwoFactorEnableComplete?: string;
    oauth2TwoFactorMethods?: string;
    oauth2Wait?: string;
    oauth2WebAuthn?: string;
    oauth2WebAuthnReauth?: string;
    oauth2WebAuthnReauthEnable?: string;
    passwordChange?: string;
    passwordComplete?: string;
    passwordForgot?: string;
    passwordSent?: string;
    phoneComplete?: string;
    phoneSent?: string;
    phoneVerificationRequired?: string;
    phoneVerify?: string;
    registrationComplete?: string;
    registrationSend?: string;
    registrationSent?: string;
    registrationVerificationRequired?: string;
    registrationVerify?: string;
    samlv2Logout?: string;
    unauthorized?: string;
}
/**
 * Theme API request object.
 *
 * @author Trevor Smith
 */
export interface ThemeRequest {
    sourceThemeId?: UUID;
    theme?: Theme;
}
/**
 * Theme API response object.
 *
 * @author Trevor Smith
 */
export interface ThemeResponse {
    theme?: Theme;
    themes?: Array<Theme>;
}
/**
 * Search criteria for themes
 *
 * @author Mark Manes
 */
export interface ThemeSearchCriteria extends BaseSearchCriteria {
    name?: string;
    type?: ThemeType;
}
/**
 * Search request for Themes.
 *
 * @author Mark Manes
 */
export interface ThemeSearchRequest {
    search?: ThemeSearchCriteria;
}
/**
 * Search response for Themes
 *
 * @author Mark Manes
 */
export interface ThemeSearchResponse {
    themes?: Array<Theme>;
    total?: number;
}
export declare enum ThemeType {
    advanced = "advanced",
    simple = "simple"
}
/**
 * A policy for deleting Users based upon some external criteria.
 *
 * @author Trevor Smith
 */
export interface TimeBasedDeletePolicy extends Enableable {
    enabledInstant?: number;
    numberOfDaysToRetain?: number;
}
/**
 * <ul>
 * <li>Bearer Token type as defined by <a href="https://tools.ietf.org/html/rfc6750">RFC 6750</a>.</li>
 * <li>MAC Token type as referenced by <a href="https://tools.ietf.org/html/rfc6749">RFC 6749</a> and
 * <a href="https://tools.ietf.org/html/draft-ietf-oauth-v2-http-mac-05">
 * Draft RFC on OAuth 2.0 Message Authentication Code (MAC) Tokens</a>
 * </li>
 * <li>DPoP Token type as defined by <a href="https://datatracker.ietf.org/doc/html/rfc9449">RFC 9449</a></li>
 * </ul>
 *
 * @author Daniel DeGroff
 */
export declare enum TokenType {
    Bearer = "Bearer",
    MAC = "MAC",
    DPoP = "DPoP"
}
/**
 * The response from the total report. This report stores the total numbers for each application.
 *
 * @author Brian Pontarelli
 */
export interface TotalsReportResponse {
    applicationTotals?: Record<UUID, Totals>;
    globalRegistrations?: number;
    totalGlobalRegistrations?: number;
}
export interface Totals {
    logins?: number;
    registrations?: number;
    totalRegistrations?: number;
}
/**
 * The transaction types for Webhooks and other event systems within FusionAuth.
 *
 * @author Brian Pontarelli
 */
export declare enum TransactionType {
    None = "None",
    Any = "Any",
    SimpleMajority = "SimpleMajority",
    SuperMajority = "SuperMajority",
    AbsoluteMajority = "AbsoluteMajority"
}
/**
 * Represents the inbound lambda parameter 'mfaTrust' inside the 'context' parameter for MFA Required lambdas.
 */
export interface Trust {
    applicationId?: UUID;
    attributes?: Record<string, string>;
    expirationInstant?: number;
    id?: string;
    insertInstant?: number;
    startInstants?: StartInstant;
    state?: Record<string, any>;
    tenantId?: UUID;
    userId?: UUID;
}
export interface StartInstant {
    applications?: Record<UUID, number>;
    tenant?: number;
}
/**
 * @author Brett Guy
 */
export interface TwilioMessengerConfiguration extends BaseMessengerConfiguration {
    accountSID?: string;
    authToken?: string;
    fromPhoneNumber?: string;
    messagingServiceSid?: string;
    url?: string;
}
/**
 * @author Brett Pontarelli
 */
export interface TwitchApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
    buttonText?: string;
    client_id?: string;
    client_secret?: string;
    scope?: string;
}
/**
 * Twitch gaming login provider.
 *
 * @author Brett Pontarelli
 */
export interface TwitchIdentityProvider extends BaseIdentityProvider<TwitchApplicationConfiguration> {
    buttonText?: string;
    client_id?: string;
    client_secret?: string;
    scope?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface TwitterApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
    buttonText?: string;
    consumerKey?: string;
    consumerSecret?: string;
}
/**
 * Twitter social login provider.
 *
 * @author Daniel DeGroff
 */
export interface TwitterIdentityProvider extends BaseIdentityProvider<TwitterApplicationConfiguration> {
    buttonText?: string;
    consumerKey?: string;
    consumerSecret?: string;
}
/**
 * @author Brian Pontarelli
 */
export interface TwoFactorDisableRequest extends BaseEventRequest {
    applicationId?: UUID;
    code?: string;
    methodId?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface TwoFactorEnableDisableSendRequest {
    email?: string;
    method?: string;
    methodId?: string;
    mobilePhone?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface TwoFactorLoginRequest extends BaseLoginRequest {
    code?: string;
    trustComputer?: boolean;
    twoFactorId?: string;
    userId?: UUID;
}
/**
 * @author Daniel DeGroff
 */
export interface TwoFactorMethod {
    authenticator?: AuthenticatorConfiguration;
    email?: string;
    id?: string;
    lastUsed?: boolean;
    method?: string;
    mobilePhone?: string;
    secret?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface TwoFactorRecoveryCodeResponse {
    recoveryCodes?: Array<string>;
}
/**
 * @author Brian Pontarelli
 */
export interface TwoFactorRequest extends BaseEventRequest {
    applicationId?: UUID;
    authenticatorId?: string;
    code?: string;
    email?: string;
    method?: string;
    mobilePhone?: string;
    secret?: string;
    secretBase32Encoded?: string;
    twoFactorId?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface TwoFactorResponse {
    code?: string;
    recoveryCodes?: Array<string>;
}
/**
 * @author Daniel DeGroff
 */
export interface TwoFactorSendRequest {
    applicationId?: UUID;
    email?: string;
    messageType?: MessageType;
    method?: string;
    methodId?: string;
    mobilePhone?: string;
    userId?: UUID;
}
/**
 * @author Brett Guy
 */
export interface TwoFactorStartRequest {
    applicationId?: UUID;
    code?: string;
    loginId?: string;
    loginIdTypes?: Array<string>;
    state?: Record<string, any>;
    trustChallenge?: string;
    userId?: UUID;
}
/**
 * @author Daniel DeGroff
 */
export interface TwoFactorStartResponse {
    code?: string;
    methods?: Array<TwoFactorMethod>;
    twoFactorId?: string;
}
/**
 * Check the status of two-factor authentication for a user, with more options than on a GET request.
 */
export interface TwoFactorStatusRequest extends BaseEventRequest {
    accessToken?: string;
    action?: MultiFactorAction;
    applicationId?: UUID;
    twoFactorTrustId?: string;
    userId?: UUID;
}
/**
 * @author Daniel DeGroff
 */
export interface TwoFactorStatusResponse {
    trusts?: Array<TwoFactorTrust>;
    twoFactorTrustId?: string;
}
export interface TwoFactorTrust {
    applicationId?: UUID;
    expiration?: number;
    startInstant?: number;
}
/**
 * @author Lyle Schemmerling
 */
export interface UniversalApplicationConfiguration {
    universal?: boolean;
}
/**
 * Policy for handling unknown OAuth scopes in the request
 *
 * @author Spencer Witt
 */
export declare enum UnknownScopePolicy {
    Allow = "Allow",
    Remove = "Remove",
    Reject = "Reject"
}
/**
 * @author Daniel DeGroff
 */
export declare enum UnverifiedBehavior {
    Allow = "Allow",
    Gated = "Gated"
}
/**
 * Config for Usage Data / Stats
 *
 * @author Lyle Schemmerling
 */
export interface UsageDataConfiguration extends Enableable {
    numberOfDaysToRetain?: number;
}
/**
 * The public, global view of a User. This object contains all global information about the user including birthdate, registration information
 * preferred languages, global attributes, etc.
 *
 * @author Seth Musselman
 */
export interface User extends SecureIdentity {
    active?: boolean;
    birthDate?: string;
    cleanSpeakId?: UUID;
    data?: Record<string, any>;
    email?: string;
    expiry?: number;
    firstName?: string;
    fullName?: string;
    imageUrl?: string;
    insertInstant?: number;
    lastName?: string;
    lastUpdateInstant?: number;
    memberships?: Array<GroupMember>;
    middleName?: string;
    mobilePhone?: string;
    parentEmail?: string;
    phoneNumber?: string;
    preferredLanguages?: Array<string>;
    registrations?: Array<UserRegistration>;
    tenantId?: UUID;
    timezone?: string;
    twoFactor?: UserTwoFactorConfiguration;
}
/**
 * An action that can be executed on a user (discipline or reward potentially).
 *
 * @author Brian Pontarelli
 */
export interface UserAction {
    active?: boolean;
    cancelEmailTemplateId?: UUID;
    endEmailTemplateId?: UUID;
    id?: UUID;
    includeEmailInEventJSON?: boolean;
    insertInstant?: number;
    lastUpdateInstant?: number;
    localizedNames?: LocalizedStrings;
    modifyEmailTemplateId?: UUID;
    name?: string;
    options?: Array<UserActionOption>;
    preventLogin?: boolean;
    sendEndEvent?: boolean;
    startEmailTemplateId?: UUID;
    temporal?: boolean;
    transactionType?: TransactionType;
    userEmailingEnabled?: boolean;
    userNotificationsEnabled?: boolean;
}
/**
 * Models the user action Event.
 *
 * @author Brian Pontarelli
 */
export interface UserActionEvent extends BaseEvent {
    action?: string;
    actioneeUserId?: UUID;
    actionerUserId?: UUID;
    actionId?: UUID;
    applicationIds?: Array<UUID>;
    comment?: string;
    email?: Email;
    emailedUser?: boolean;
    expiry?: number;
    localizedAction?: string;
    localizedDuration?: string;
    localizedOption?: string;
    localizedReason?: string;
    notifyUser?: boolean;
    option?: string;
    phase?: UserActionPhase;
    reason?: string;
    reasonCode?: string;
}
/**
 * A log for an action that was taken on a User.
 *
 * @author Brian Pontarelli
 */
export interface UserActionLog {
    actioneeUserId?: UUID;
    actionerUserId?: UUID;
    applicationIds?: Array<UUID>;
    comment?: string;
    emailUserOnEnd?: boolean;
    endEventSent?: boolean;
    expiry?: number;
    history?: LogHistory;
    id?: UUID;
    insertInstant?: number;
    localizedName?: string;
    localizedOption?: string;
    localizedReason?: string;
    name?: string;
    notifyUserOnEnd?: boolean;
    option?: string;
    reason?: string;
    reasonCode?: string;
    userActionId?: UUID;
}
/**
 * Models content user action options.
 *
 * @author Brian Pontarelli
 */
export interface UserActionOption {
    localizedNames?: LocalizedStrings;
    name?: string;
}
/**
 * The phases of a time-based user action.
 *
 * @author Brian Pontarelli
 */
export declare enum UserActionPhase {
    start = "start",
    modify = "modify",
    cancel = "cancel",
    end = "end"
}
/**
 * Models action reasons.
 *
 * @author Brian Pontarelli
 */
export interface UserActionReason {
    code?: string;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    localizedTexts?: LocalizedStrings;
    text?: string;
}
/**
 * User Action Reason API request object.
 *
 * @author Brian Pontarelli
 */
export interface UserActionReasonRequest {
    userActionReason?: UserActionReason;
}
/**
 * User Action Reason API response object.
 *
 * @author Brian Pontarelli
 */
export interface UserActionReasonResponse {
    userActionReason?: UserActionReason;
    userActionReasons?: Array<UserActionReason>;
}
/**
 * User Action API request object.
 *
 * @author Brian Pontarelli
 */
export interface UserActionRequest {
    userAction?: UserAction;
}
/**
 * User Action API response object.
 *
 * @author Brian Pontarelli
 */
export interface UserActionResponse {
    userAction?: UserAction;
    userActions?: Array<UserAction>;
}
/**
 * Models the User Bulk Create Event.
 *
 * @author Brian Pontarelli
 */
export interface UserBulkCreateEvent extends BaseEvent {
    users?: Array<User>;
}
/**
 * A log for an event that happened to a User.
 *
 * @author Brian Pontarelli
 */
export interface UserComment {
    comment?: string;
    commenterId?: UUID;
    id?: UUID;
    insertInstant?: number;
    userId?: UUID;
}
/**
 * @author Seth Musselman
 */
export interface UserCommentRequest {
    userComment?: UserComment;
}
/**
 * User Comment Response
 *
 * @author Seth Musselman
 */
export interface UserCommentResponse {
    userComment?: UserComment;
    userComments?: Array<UserComment>;
}
/**
 * Search criteria for user comments.
 *
 * @author Spencer Witt
 */
export interface UserCommentSearchCriteria extends BaseSearchCriteria {
    comment?: string;
    commenterId?: UUID;
    tenantId?: UUID;
    userId?: UUID;
}
/**
 * Search request for user comments
 *
 * @author Spencer Witt
 */
export interface UserCommentSearchRequest {
    search?: UserCommentSearchCriteria;
}
/**
 * User comment search response
 *
 * @author Spencer Witt
 */
export interface UserCommentSearchResponse {
    total?: number;
    userComments?: Array<UserComment>;
}
/**
 * Models a User consent.
 *
 * @author Daniel DeGroff
 */
export interface UserConsent {
    consent?: Consent;
    consentId?: UUID;
    data?: Record<string, any>;
    giverUserId?: UUID;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    status?: ConsentStatus;
    userId?: UUID;
    values?: Array<string>;
}
/**
 * API response for User consent.
 *
 * @author Daniel DeGroff
 */
export interface UserConsentRequest {
    userConsent?: UserConsent;
}
/**
 * API response for User consent.
 *
 * @author Daniel DeGroff
 */
export interface UserConsentResponse {
    userConsent?: UserConsent;
    userConsents?: Array<UserConsent>;
}
/**
 * Models the User Created Event.
 * <p>
 * This is different than the user.create event in that it will be sent after the user has been created. This event cannot be made transactional.
 *
 * @author Daniel DeGroff
 */
export interface UserCreateCompleteEvent extends BaseUserEvent {
}
/**
 * Models the User Create Event.
 *
 * @author Brian Pontarelli
 */
export interface UserCreateEvent extends BaseUserEvent {
}
/**
 * The request object for exchanging user credentials (username and password) for an access token.
 *
 * @author Lyle Schemmerling
 */
export interface UserCredentialsAccessTokenRequest {
    client_id?: string;
    client_secret?: string;
    grant_type?: string;
    password?: string;
    scope?: string;
    tenantId?: string;
    user_code?: string;
    username?: string;
}
/**
 * Models the User Deactivate Event.
 *
 * @author Brian Pontarelli
 */
export interface UserDeactivateEvent extends BaseUserEvent {
}
/**
 * Models the User Event (and can be converted to JSON) that is used for all user modifications (create, update,
 * delete).
 * <p>
 * This is different than user.delete because it is sent after the tx is committed, this cannot be transactional.
 *
 * @author Daniel DeGroff
 */
export interface UserDeleteCompleteEvent extends BaseUserEvent {
}
/**
 * Models the User Event (and can be converted to JSON) that is used for all user modifications (create, update,
 * delete).
 *
 * @author Brian Pontarelli
 */
export interface UserDeleteEvent extends BaseUserEvent {
}
/**
 * User API delete request object.
 *
 * @author Daniel DeGroff
 */
export interface UserDeleteRequest extends BaseEventRequest {
    dryRun?: boolean;
    hardDelete?: boolean;
    limit?: number;
    query?: string;
    queryString?: string;
    userIds?: Array<UUID>;
}
/**
 * User API bulk response object.
 *
 * @author Trevor Smith
 */
export interface UserDeleteResponse {
    dryRun?: boolean;
    hardDelete?: boolean;
    total?: number;
    userIds?: Array<UUID>;
}
/**
 * User API delete request object for a single user.
 *
 * @author Brian Pontarelli
 */
export interface UserDeleteSingleRequest extends BaseEventRequest {
    hardDelete?: boolean;
}
/**
 * Models an event where a user's email is updated outside of a forgot / change password workflow.
 *
 * @author Daniel DeGroff
 */
export interface UserEmailUpdateEvent extends BaseUserEvent {
    previousEmail?: string;
}
/**
 * Models the User Email Verify Event.
 *
 * @author Trevor Smith
 */
export interface UserEmailVerifiedEvent extends BaseUserEvent {
}
/**
 * @author Daniel DeGroff
 */
export interface UserIdentity {
    displayValue?: string;
    insertInstant?: number;
    lastLoginInstant?: number;
    lastUpdateInstant?: number;
    moderationStatus?: ContentStatus;
    primary?: boolean;
    type?: IdentityType;
    value?: string;
    verified?: boolean;
    verifiedInstant?: number;
    verifiedReason?: IdentityVerifiedReason;
}
/**
 * Models the User Identity Provider Link Event.
 *
 * @author Rob Davis
 */
export interface UserIdentityProviderLinkEvent extends BaseUserEvent {
    identityProviderLink?: IdentityProviderLink;
}
/**
 * Models the User Identity Provider Unlink Event.
 *
 * @author Rob Davis
 */
export interface UserIdentityProviderUnlinkEvent extends BaseUserEvent {
    identityProviderLink?: IdentityProviderLink;
}
/**
 * Models the user identity update event
 *
 * @author Brent Halsey
 */
export interface UserIdentityUpdateEvent extends BaseUserEvent {
    loginIdType?: string;
    newLoginId?: string;
    previousLoginId?: string;
}
/**
 * Models the user identity verified event
 *
 * @author Brady Wied
 */
export interface UserIdentityVerifiedEvent extends BaseUserEvent {
    loginId?: string;
    loginIdType?: string;
}
/**
 * Models the User Login Failed Event.
 *
 * @author Daniel DeGroff
 */
export interface UserLoginFailedEvent extends BaseUserEvent {
    applicationId?: UUID;
    authenticationType?: string;
    ipAddress?: string;
    reason?: UserLoginFailedReason;
}
/**
 * The reason for the login failure.
 *
 * @author Daniel DeGroff
 */
export interface UserLoginFailedReason {
    code?: string;
    lambdaId?: UUID;
    lambdaResult?: Errors;
}
/**
 * User login failed reason codes.
 */
export interface UserLoginFailedReasonCode {
}
/**
 * Models an event where a user is being created with an "in-use" login Id (email, username, or other identities).
 *
 * @author Daniel DeGroff
 */
export interface UserLoginIdDuplicateOnCreateEvent extends BaseUserEvent {
    duplicateEmail?: string;
    duplicateIdentities?: Array<IdentityInfo>;
    duplicatePhoneNumber?: string;
    duplicateUsername?: string;
    existing?: User;
}
/**
 * Models an event where a user is being updated and tries to use an "in-use" login Id (email or username).
 *
 * @author Daniel DeGroff
 */
export interface UserLoginIdDuplicateOnUpdateEvent extends UserLoginIdDuplicateOnCreateEvent {
}
/**
 * Models the User Login event for a new device (un-recognized)
 *
 * @author Daniel DeGroff
 */
export interface UserLoginNewDeviceEvent extends UserLoginSuccessEvent {
}
/**
 * Models the User Login Success Event.
 *
 * @author Daniel DeGroff
 */
export interface UserLoginSuccessEvent extends BaseUserEvent {
    applicationId?: UUID;
    authenticationType?: string;
    connectorId?: UUID;
    identityProviderId?: UUID;
    identityProviderName?: string;
    ipAddress?: string;
}
/**
 * Models the User Login event that is suspicious.
 *
 * @author Daniel DeGroff
 */
export interface UserLoginSuspiciousEvent extends UserLoginSuccessEvent {
    threatsDetected?: Array<AuthenticationThreats>;
}
/**
 * Models the User Password Breach Event.
 *
 * @author Matthew Altman
 */
export interface UserPasswordBreachEvent extends BaseUserEvent {
}
/**
 * Models the User Password Reset Send Event.
 *
 * @author Daniel DeGroff
 */
export interface UserPasswordResetSendEvent extends BaseUserEvent {
}
/**
 * Models the User Password Reset Start Event.
 *
 * @author Daniel DeGroff
 */
export interface UserPasswordResetStartEvent extends BaseUserEvent {
}
/**
 * Models the User Password Reset Success Event.
 *
 * @author Daniel DeGroff
 */
export interface UserPasswordResetSuccessEvent extends BaseUserEvent {
}
/**
 * Models the User Password Update Event.
 *
 * @author Daniel DeGroff
 */
export interface UserPasswordUpdateEvent extends BaseUserEvent {
}
/**
 * Models the User Reactivate Event.
 *
 * @author Brian Pontarelli
 */
export interface UserReactivateEvent extends BaseUserEvent {
}
/**
 * User registration information for a single application.
 *
 * @author Brian Pontarelli
 */
export interface UserRegistration {
    applicationId?: UUID;
    authenticationToken?: string;
    cleanSpeakId?: UUID;
    data?: Record<string, any>;
    id?: UUID;
    insertInstant?: number;
    lastLoginInstant?: number;
    lastUpdateInstant?: number;
    preferredLanguages?: Array<string>;
    roles?: Array<string>;
    timezone?: string;
    tokens?: Record<string, string>;
    username?: string;
    usernameStatus?: ContentStatus;
    verified?: boolean;
    verifiedInstant?: number;
}
/**
 * Models the User Created Registration Event.
 * <p>
 * This is different than the user.registration.create event in that it will be sent after the user has been created. This event cannot be made
 * transactional.
 *
 * @author Daniel DeGroff
 */
export interface UserRegistrationCreateCompleteEvent extends BaseUserEvent {
    applicationId?: UUID;
    registration?: UserRegistration;
}
/**
 * Models the User Create Registration Event.
 *
 * @author Daniel DeGroff
 */
export interface UserRegistrationCreateEvent extends BaseUserEvent {
    applicationId?: UUID;
    registration?: UserRegistration;
}
/**
 * Models the User Deleted Registration Event.
 * <p>
 * This is different than user.registration.delete in that it is sent after the TX has been committed. This event cannot be transactional.
 *
 * @author Daniel DeGroff
 */
export interface UserRegistrationDeleteCompleteEvent extends BaseUserEvent {
    applicationId?: UUID;
    registration?: UserRegistration;
}
/**
 * Models the User Delete Registration Event.
 *
 * @author Daniel DeGroff
 */
export interface UserRegistrationDeleteEvent extends BaseUserEvent {
    applicationId?: UUID;
    registration?: UserRegistration;
}
/**
 * Models the User Update Registration Event.
 * <p>
 * This is different than user.registration.update in that it is sent after this event completes, this cannot be transactional.
 *
 * @author Daniel DeGroff
 */
export interface UserRegistrationUpdateCompleteEvent extends BaseUserEvent {
    applicationId?: UUID;
    original?: UserRegistration;
    registration?: UserRegistration;
}
/**
 * Models the User Update Registration Event.
 *
 * @author Daniel DeGroff
 */
export interface UserRegistrationUpdateEvent extends BaseUserEvent {
    applicationId?: UUID;
    original?: UserRegistration;
    registration?: UserRegistration;
}
/**
 * Models the User Registration Verified Event.
 *
 * @author Trevor Smith
 */
export interface UserRegistrationVerifiedEvent extends BaseUserEvent {
    applicationId?: UUID;
    registration?: UserRegistration;
}
/**
 * User API request object.
 *
 * @author Brian Pontarelli
 */
export interface UserRequest extends BaseEventRequest {
    applicationId?: UUID;
    currentPassword?: string;
    disableDomainBlock?: boolean;
    sendSetPasswordEmail?: boolean;
    sendSetPasswordIdentityType?: SendSetPasswordIdentityType;
    skipVerification?: boolean;
    user?: User;
    verificationIds?: Array<string>;
}
/**
 * User API response object.
 *
 * @author Brian Pontarelli
 */
export interface UserResponse {
    emailVerificationId?: string;
    emailVerificationOneTimeCode?: string;
    registrationVerificationIds?: Record<UUID, string>;
    registrationVerificationOneTimeCodes?: Record<UUID, string>;
    token?: string;
    tokenExpirationInstant?: number;
    user?: User;
    verificationIds?: Array<VerificationId>;
}
export interface VerificationId {
    id?: string;
    oneTimeCode?: string;
    type?: IdentityType;
    value?: string;
}
/**
 * This class is the user query. It provides a build pattern as well as public fields for use on forms and in actions.
 *
 * @author Brian Pontarelli
 */
export interface UserSearchCriteria extends BaseElasticSearchCriteria {
}
/**
 * @author Daniel DeGroff
 */
export declare enum UserState {
    Authenticated = "Authenticated",
    AuthenticatedNotRegistered = "AuthenticatedNotRegistered",
    AuthenticatedNotVerified = "AuthenticatedNotVerified",
    AuthenticatedRegistrationNotVerified = "AuthenticatedRegistrationNotVerified"
}
/**
 * @author Daniel DeGroff
 */
export interface UserTwoFactorConfiguration {
    methods?: Array<TwoFactorMethod>;
    recoveryCodes?: Array<string>;
}
/**
 * Model a user event when a two-factor method has been removed.
 *
 * @author Daniel DeGroff
 */
export interface UserTwoFactorMethodAddEvent extends BaseUserEvent {
    method?: TwoFactorMethod;
}
/**
 * Model a user event when a two-factor method has been added.
 *
 * @author Daniel DeGroff
 */
export interface UserTwoFactorMethodRemoveEvent extends BaseUserEvent {
    method?: TwoFactorMethod;
}
/**
 * Models the User Update Event once it is completed. This cannot be transactional.
 *
 * @author Daniel DeGroff
 */
export interface UserUpdateCompleteEvent extends BaseUserEvent {
    original?: User;
}
/**
 * Models the User Update Event.
 *
 * @author Brian Pontarelli
 */
export interface UserUpdateEvent extends BaseUserEvent {
    original?: User;
}
/**
 * Used to express whether the Relying Party requires <a href="https://www.w3.org/TR/webauthn-2/#user-verification">user verification</a> for the
 * current operation.
 *
 * @author Spencer Witt
 */
export declare enum UserVerificationRequirement {
    required = "required",
    preferred = "preferred",
    discouraged = "discouraged"
}
/**
 * @author Daniel DeGroff
 */
export interface UserinfoResponse extends Record<string, any> {
}
/**
 * The request object for validating an end-user provided user_code from the user-interaction of the Device Authorization Grant
 *
 * @author Lyle Schemmerling
 */
export interface ValidateDeviceRequest {
    client_id?: string;
    tenantId?: UUID;
    user_code?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface ValidateResponse {
    jwt?: JWT;
}
/**
 * @author Daniel DeGroff
 */
export declare enum VerificationStrategy {
    ClickableLink = "ClickableLink",
    FormField = "FormField"
}
/**
 * Verify Complete API request object.
 */
export interface VerifyCompleteRequest extends BaseEventRequest {
    oneTimeCode?: string;
    verificationId?: string;
}
/**
 * Verify Complete API response object.
 */
export interface VerifyCompleteResponse {
    state?: Record<string, any>;
}
/**
 * @author Daniel DeGroff
 */
export interface VerifyEmailRequest extends BaseEventRequest {
    oneTimeCode?: string;
    userId?: UUID;
    verificationId?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface VerifyEmailResponse {
    oneTimeCode?: string;
    verificationId?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface VerifyRegistrationRequest extends BaseEventRequest {
    oneTimeCode?: string;
    verificationId?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface VerifyRegistrationResponse {
    oneTimeCode?: string;
    verificationId?: string;
}
/**
 * Identity verify request. Used to administratively verify an identity.
 */
export interface VerifyRequest extends BaseEventRequest {
    loginId?: string;
    loginIdType?: string;
}
/**
 * Verify Send API request object.
 */
export interface VerifySendRequest {
    verificationId?: string;
}
/**
 * @author Brady Wied
 */
export interface VerifyStartRequest {
    applicationId?: UUID;
    existingUserStrategy?: ExistingUserStrategy;
    loginId?: string;
    loginIdType?: string;
    state?: Record<string, any>;
    verificationStrategy?: VerificationStrategy;
}
/**
 * @author Brady Wied
 */
export interface VerifyStartResponse {
    oneTimeCode?: string;
    verificationId?: string;
}
/**
 * @author Daniel DeGroff
 */
export interface VersionResponse {
    version?: string;
}
/**
 * @author Daniel King
 */
export interface VoiceMessage {
    locale?: string;
    message?: string;
    phoneNumber?: string;
}
/**
 * @author Daniel King
 */
export interface VoiceMessageTemplate extends MessageTemplate {
    defaultTemplate?: string;
    localizedTemplates?: LocalizedStrings;
}
/**
 * API response for completing WebAuthn assertion
 *
 * @author Spencer Witt
 */
export interface WebAuthnAssertResponse {
    credential?: WebAuthnCredential;
}
/**
 * The <i>authenticator's</i> response for the authentication ceremony in its encoded format
 *
 * @author Spencer Witt
 */
export interface WebAuthnAuthenticatorAuthenticationResponse {
    authenticatorData?: string;
    clientDataJSON?: string;
    signature?: string;
    userHandle?: string;
}
/**
 * The <i>authenticator's</i> response for the registration ceremony in its encoded format
 *
 * @author Spencer Witt
 */
export interface WebAuthnAuthenticatorRegistrationResponse {
    attestationObject?: string;
    clientDataJSON?: string;
}
/**
 * A User's WebAuthnCredential. Contains all data required to complete WebAuthn authentication ceremonies.
 *
 * @author Spencer Witt
 */
export interface WebAuthnCredential {
    algorithm?: CoseAlgorithmIdentifier;
    attestationType?: AttestationType;
    authenticatorSupportsUserVerification?: boolean;
    credentialId?: string;
    data?: Record<string, any>;
    discoverable?: boolean;
    displayName?: string;
    id?: UUID;
    insertInstant?: number;
    lastUseInstant?: number;
    name?: string;
    publicKey?: string;
    relyingPartyId?: string;
    signCount?: number;
    tenantId?: UUID;
    transports?: Array<string>;
    userAgent?: string;
    userId?: UUID;
}
/**
 * API request to import an existing WebAuthn credential(s)
 *
 * @author Spencer Witt
 */
export interface WebAuthnCredentialImportRequest {
    credentials?: Array<WebAuthnCredential>;
    validateDbConstraints?: boolean;
}
/**
 * WebAuthn Credential API response
 *
 * @author Spencer Witt
 */
export interface WebAuthnCredentialResponse {
    credential?: WebAuthnCredential;
    credentials?: Array<WebAuthnCredential>;
}
/**
 * Contains extension output for requested extensions during a WebAuthn ceremony
 *
 * @author Spencer Witt
 */
export interface WebAuthnExtensionsClientOutputs {
    credProps?: CredentialPropertiesOutput;
}
/**
 * Request to complete the WebAuthn registration ceremony
 *
 * @author Spencer Witt
 */
export interface WebAuthnLoginRequest extends BaseLoginRequest {
    credential?: WebAuthnPublicKeyAuthenticationRequest;
    origin?: string;
    rpId?: string;
    twoFactorTrustId?: string;
}
/**
 * Request to authenticate with WebAuthn
 *
 * @author Spencer Witt
 */
export interface WebAuthnPublicKeyAuthenticationRequest {
    clientExtensionResults?: WebAuthnExtensionsClientOutputs;
    id?: string;
    response?: WebAuthnAuthenticatorAuthenticationResponse;
    rpId?: string;
    type?: string;
}
/**
 * Request to register a new public key with WebAuthn
 *
 * @author Spencer Witt
 */
export interface WebAuthnPublicKeyRegistrationRequest {
    clientExtensionResults?: WebAuthnExtensionsClientOutputs;
    id?: string;
    response?: WebAuthnAuthenticatorRegistrationResponse;
    rpId?: string;
    transports?: Array<string>;
    type?: string;
}
/**
 * Request to complete the WebAuthn registration ceremony for a new credential,.
 *
 * @author Spencer Witt
 */
export interface WebAuthnRegisterCompleteRequest {
    credential?: WebAuthnPublicKeyRegistrationRequest;
    origin?: string;
    rpId?: string;
    userId?: UUID;
}
/**
 * API response for completing WebAuthn credential registration or assertion
 *
 * @author Spencer Witt
 */
export interface WebAuthnRegisterCompleteResponse {
    credential?: WebAuthnCredential;
}
/**
 * API request to start a WebAuthn registration ceremony
 *
 * @author Spencer Witt
 */
export interface WebAuthnRegisterStartRequest {
    displayName?: string;
    name?: string;
    userAgent?: string;
    userId?: UUID;
    workflow?: WebAuthnWorkflow;
}
/**
 * API response for starting a WebAuthn registration ceremony
 *
 * @author Spencer Witt
 */
export interface WebAuthnRegisterStartResponse {
    options?: PublicKeyCredentialCreationOptions;
}
/**
 * Options to request extensions during credential registration
 *
 * @author Spencer Witt
 */
export interface WebAuthnRegistrationExtensionOptions {
    credProps?: boolean;
}
/**
 * API request to start a WebAuthn authentication ceremony
 *
 * @author Spencer Witt
 */
export interface WebAuthnStartRequest {
    applicationId?: UUID;
    credentialId?: UUID;
    loginId?: string;
    loginIdTypes?: Array<string>;
    state?: Record<string, any>;
    userId?: UUID;
    workflow?: WebAuthnWorkflow;
}
/**
 * API response for starting a WebAuthn authentication ceremony
 *
 * @author Spencer Witt
 */
export interface WebAuthnStartResponse {
    options?: PublicKeyCredentialRequestOptions;
}
/**
 * Identifies the WebAuthn workflow. This will affect the parameters used for credential creation
 * and request based on the Tenant configuration.
 *
 * @author Spencer Witt
 */
export declare enum WebAuthnWorkflow {
    bootstrap = "bootstrap",
    general = "general",
    reauthentication = "reauthentication"
}
/**
 * A server where events are sent. This includes user action events and any other events sent by FusionAuth.
 *
 * @author Brian Pontarelli
 */
export interface Webhook {
    connectTimeout?: number;
    data?: Record<string, any>;
    description?: string;
    eventsEnabled?: Record<EventType, boolean>;
    global?: boolean;
    headers?: HTTPHeaders;
    httpAuthenticationPassword?: string;
    httpAuthenticationUsername?: string;
    id?: UUID;
    insertInstant?: number;
    lastUpdateInstant?: number;
    readTimeout?: number;
    signatureConfiguration?: WebhookSignatureConfiguration;
    sslCertificate?: string;
    sslCertificateKeyId?: UUID;
    tenantIds?: Array<UUID>;
    url?: string;
}
/**
 * A webhook call attempt log.
 *
 * @author Spencer Witt
 */
export interface WebhookAttemptLog {
    attemptResult?: WebhookAttemptResult;
    data?: Record<string, any>;
    endInstant?: number;
    id?: UUID;
    startInstant?: number;
    webhookCallResponse?: WebhookCallResponse;
    webhookEventLogId?: UUID;
    webhookId?: UUID;
}
/**
 * Webhook attempt log response.
 *
 * @author Spencer Witt
 */
export interface WebhookAttemptLogResponse {
    webhookAttemptLog?: WebhookAttemptLog;
}
/**
 * The possible states of an individual webhook attempt to a single endpoint.
 *
 * @author Spencer Witt
 */
export declare enum WebhookAttemptResult {
    Success = "Success",
    Failure = "Failure",
    Unknown = "Unknown"
}
/**
 * A webhook call response.
 *
 * @author Spencer Witt
 */
export interface WebhookCallResponse {
    exception?: string;
    statusCode?: number;
    url?: string;
}
export interface WebhookEventLog {
    attempts?: Array<WebhookAttemptLog>;
    data?: Record<string, any>;
    event?: EventRequest;
    eventResult?: WebhookEventResult;
    eventType?: EventType;
    failedAttempts?: number;
    id?: UUID;
    insertInstant?: number;
    lastAttemptInstant?: number;
    lastUpdateInstant?: number;
    linkedObjectId?: UUID;
    sequence?: number;
    successfulAttempts?: number;
}
/**
 * The system configuration for Webhook Event Log data.
 *
 * @author Spencer Witt
 */
export interface WebhookEventLogConfiguration extends Enableable {
    delete?: DeleteConfiguration;
}
/**
 * Webhook event log response.
 *
 * @author Spencer Witt
 */
export interface WebhookEventLogResponse {
    webhookEventLog?: WebhookEventLog;
}
/**
 * Search criteria for the webhook event log.
 *
 * @author Spencer Witt
 */
export interface WebhookEventLogSearchCriteria extends BaseSearchCriteria {
    end?: number;
    event?: string;
    eventResult?: WebhookEventResult;
    eventType?: EventType;
    start?: number;
}
/**
 * Webhook event log search request.
 *
 * @author Spencer Witt
 */
export interface WebhookEventLogSearchRequest {
    search?: WebhookEventLogSearchCriteria;
}
/**
 * Webhook event log search response.
 *
 * @author Spencer Witt
 */
export interface WebhookEventLogSearchResponse {
    total?: number;
    webhookEventLogs?: Array<WebhookEventLog>;
}
/**
 * The possible result states of a webhook event. This tracks the success of the overall webhook transaction according to the {@link TransactionType}
 * and configured webhooks.
 *
 * @author Spencer Witt
 */
export declare enum WebhookEventResult {
    Failed = "Failed",
    Running = "Running",
    Succeeded = "Succeeded"
}
/**
 * Webhook API request object.
 *
 * @author Brian Pontarelli
 */
export interface WebhookRequest {
    webhook?: Webhook;
}
/**
 * Webhook API response object.
 *
 * @author Brian Pontarelli
 */
export interface WebhookResponse {
    webhook?: Webhook;
    webhooks?: Array<Webhook>;
}
/**
 * Search criteria for webhooks.
 *
 * @author Spencer Witt
 */
export interface WebhookSearchCriteria extends BaseSearchCriteria {
    description?: string;
    tenantId?: UUID;
    url?: string;
}
/**
 * Search request for webhooks
 *
 * @author Spencer Witt
 */
export interface WebhookSearchRequest {
    search?: WebhookSearchCriteria;
}
/**
 * Webhook search response
 *
 * @author Spencer Witt
 */
export interface WebhookSearchResponse {
    total?: number;
    webhooks?: Array<Webhook>;
}
/**
 * Configuration for signing webhooks.
 *
 * @author Brent Halsey
 */
export interface WebhookSignatureConfiguration extends Enableable {
    signingKeyId?: UUID;
}
/**
 * @author Brett Pontarelli
 */
export interface XboxApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
    buttonText?: string;
    client_id?: string;
    client_secret?: string;
    scope?: string;
}
/**
 * Xbox gaming login provider.
 *
 * @author Brett Pontarelli
 */
export interface XboxIdentityProvider extends BaseIdentityProvider<XboxApplicationConfiguration> {
    buttonText?: string;
    client_id?: string;
    client_secret?: string;
    scope?: string;
}