squash bpontarelli/themes-and-registrations into master

Author: robotdan

build.savant

@@ -15,7 +15,7 @@
  */
 savantVersion = "1.0.0"
 
-project(group: "io.fusionauth", name: "fusionauth-typescript-client", version: "1.26.1", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-typescript-client", version: "1.27.0", licenses: ["ApacheV2_0"]) {
   workflow {
     standard()
   }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@fusionauth/typescript-client",
-  "version": "1.26.1",
+  "version": "1.27.0",
   "description": "A typescript implementation of the FusionAuth client.",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package.json

@@ -1530,10 +1530,10 @@ export class FusionAuthClient {
    * @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<void>>}
+   * @returns {Promise<ClientResponse<LoginResponse>>}
    */
-  loginPing(userId: UUID, applicationId: UUID, callerIPAddress: string): Promise<ClientResponse<void>> {
-    return this.start<void, Errors>()
+  loginPing(userId: UUID, applicationId: UUID, callerIPAddress: string): Promise<ClientResponse<LoginResponse>> {
+    return this.start<LoginResponse, Errors>()
         .withUri('/api/login')
         .withUriSegment(userId)
         .withUriSegment(applicationId)
@@ -3376,6 +3376,18 @@ export class FusionAuthClient {
         .go();
   }
 
+  /**
+   * Retrieves the FusionAuth version string.
+   *
+   * @returns {Promise<ClientResponse<VersionResponse>>}
+   */
+  retrieveVersion(): Promise<ClientResponse<VersionResponse>> {
+    return this.start<VersionResponse, Errors>()
+        .withUri('/api/system/version')
+        .withMethod("GET")
+        .go();
+  }
+
   /**
    * Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks.
    *
@@ -4350,6 +4362,8 @@ export class FusionAuthClient {
    *
    * @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>> {
     return this.startAnonymous<void, Errors>()
@@ -4360,11 +4374,32 @@ export class FusionAuthClient {
         .go();
   }
 
+  /**
+   * 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>> {
+    return this.startAnonymous<void, Errors>()
+        .withUri('/api/user/verify-email')
+        .withJSONBody(request)
+        .withMethod("POST")
+        .go();
+  }
+
   /**
    * 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>> {
     return this.startAnonymous<void, Errors>()
@@ -4375,6 +4410,25 @@ export class FusionAuthClient {
         .go();
   }
 
+  /**
+   * 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>> {
+    return this.startAnonymous<void, Errors>()
+        .withUri('/api/user/verify-registration')
+        .withJSONBody(request)
+        .withMethod("POST")
+        .go();
+  }
+
 
   /* ===================================================================================================================
    * Private methods
@@ -4569,7 +4623,10 @@ export interface Application {
   samlv2Configuration?: SAMLv2Configuration;
   state?: ObjectState;
   tenantId?: UUID;
+  themeId?: UUID;
+  unverified?: RegistrationUnverifiedOptions;
   verificationEmailTemplateId?: UUID;
+  verificationStrategy?: VerificationStrategy;
   verifyRegistration?: boolean;
 }
 
@@ -4650,6 +4707,15 @@ export interface ApplicationRole {
   name?: string;
 }
 
+/**
+ * @author Daniel DeGroff
+ */
+export interface ApplicationUnverifiedConfiguration {
+  registration?: UnverifiedBehavior;
+  verificationStrategy?: VerificationStrategy;
+  whenGated?: RegistrationUnverifiedOptions;
+}
+
 /**
  * This class is a simple attachment with a byte array, name and MIME type.
  *
@@ -5169,8 +5235,10 @@ export interface EmailConfiguration {
   properties?: string;
   security?: EmailSecurityType;
   setPasswordEmailTemplateId?: UUID;
+  unverified?: EmailUnverifiedOptions;
   username?: string;
   verificationEmailTemplateId?: UUID;
+  verificationStrategy?: VerificationStrategy;
   verifyEmail?: boolean;
   verifyEmailWhenChanged?: boolean;
 }
@@ -5232,6 +5300,14 @@ export interface EmailTemplateResponse {
   emailTemplates?: Array<EmailTemplate>;
 }
 
+/**
+ * @author Daniel DeGroff
+ */
+export interface EmailUnverifiedOptions {
+  allowEmailChangeWhenGated?: boolean;
+  behavior?: UnverifiedBehavior;
+}
+
 /**
  * Something that can be enabled and thus also disabled.
  *
@@ -5611,12 +5687,14 @@ export interface ExternalIdentifierConfiguration {
   deviceUserCodeIdGenerator?: SecureGeneratorConfiguration;
   emailVerificationIdGenerator?: SecureGeneratorConfiguration;
   emailVerificationIdTimeToLiveInSeconds?: number;
+  emailVerificationOneTimeCodeGenerator?: SecureGeneratorConfiguration;
   externalAuthenticationIdTimeToLiveInSeconds?: number;
   oneTimePasswordTimeToLiveInSeconds?: number;
   passwordlessLoginGenerator?: SecureGeneratorConfiguration;
   passwordlessLoginTimeToLiveInSeconds?: number;
   registrationVerificationIdGenerator?: SecureGeneratorConfiguration;
   registrationVerificationIdTimeToLiveInSeconds?: number;
+  registrationVerificationOneTimeCodeGenerator?: SecureGeneratorConfiguration;
   samlv2AuthNRequestIdTimeToLiveInSeconds?: number;
   setupPasswordIdGenerator?: SecureGeneratorConfiguration;
   setupPasswordIdTimeToLiveInSeconds?: number;
@@ -6687,8 +6765,10 @@ export interface LoginResponse {
   actions?: Array<LoginPreventedResponse>;
   changePasswordId?: string;
   changePasswordReason?: ChangePasswordReason;
+  emailVerificationId?: string;
   methods?: Array<TwoFactorMethod>;
   refreshToken?: string;
+  registrationVerificationId?: string;
   state?: Record<string, any>;
   token?: string;
   twoFactorId?: string;
@@ -7225,7 +7305,8 @@ export interface ReactorResponse {
 export interface ReactorStatus {
   advancedIdentityProviders?: ReactorFeatureStatus;
   advancedMultiFactorAuthentication?: ReactorFeatureStatus;
-  advancedRegistrationForms?: ReactorFeatureStatus;
+  advancedRegistration?: ReactorFeatureStatus;
+  applicationThemes?: ReactorFeatureStatus;
   breachedPasswordDetection?: ReactorFeatureStatus;
   connectors?: ReactorFeatureStatus;
   entityManagement?: ReactorFeatureStatus;
@@ -7360,6 +7441,7 @@ export interface RegistrationRequest {
 export interface RegistrationResponse {
   refreshToken?: string;
   registration?: UserRegistration;
+  registrationVerificationId?: string;
   token?: string;
   user?: User;
 }
@@ -7369,6 +7451,13 @@ export enum RegistrationType {
   advanced = "advanced"
 }
 
+/**
+ * @author Daniel DeGroff
+ */
+export interface RegistrationUnverifiedOptions {
+  behavior?: UnverifiedBehavior;
+}
+
 /**
  * @author Daniel DeGroff
  */
@@ -7554,6 +7643,7 @@ export interface SecureIdentity {
   passwordChangeRequired?: boolean;
   passwordLastUpdateInstant?: number;
   salt?: string;
+  uniqueUsername?: string;
   username?: string;
   usernameStatus?: ContentStatus;
   verified?: boolean;
@@ -7665,6 +7755,8 @@ export interface Templates {
   accountTwoFactorIndex?: string;
   emailComplete?: string;
   emailSend?: string;
+  emailSent?: string;
+  emailVerificationRequired?: string;
   emailVerify?: string;
   helpers?: string;
   index?: string;
@@ -7687,6 +7779,8 @@ export interface Templates {
   passwordSent?: string;
   registrationComplete?: string;
   registrationSend?: string;
+  registrationSent?: string;
+  registrationVerificationRequired?: string;
   registrationVerify?: string;
   samlv2Logout?: string;
 }
@@ -7721,6 +7815,7 @@ export interface Tenant {
   state?: ObjectState;
   themeId?: UUID;
   userDeletePolicy?: TenantUserDeletePolicy;
+  usernameConfiguration?: TenantUsernameConfiguration;
 }
 
 /**
@@ -7768,6 +7863,14 @@ export interface TenantResponse {
   tenants?: Array<Tenant>;
 }
 
+/**
+ * @author Daniel DeGroff
+ */
+export interface TenantUnverifiedConfiguration {
+  email?: UnverifiedBehavior;
+  whenGated?: RegistrationUnverifiedOptions;
+}
+
 /**
  * A Tenant-level policy for deleting Users.
  *
@@ -7777,6 +7880,13 @@ export interface TenantUserDeletePolicy {
   unverified?: TimeBasedDeletePolicy;
 }
 
+/**
+ * @author Daniel DeGroff
+ */
+export interface TenantUsernameConfiguration {
+  unique?: UniqueUsernameConfiguration;
+}
+
 /**
  * @author Daniel DeGroff
  */
@@ -8016,6 +8126,19 @@ export interface UIConfiguration {
   menuFontColor?: string;
 }
 
+export interface UniqueUsernameConfiguration extends Enableable {
+  numberOfDigits?: number;
+  separator?: string;
+}
+
+/**
+ * @author Daniel DeGroff
+ */
+export enum UnverifiedBehavior {
+  Allow = "Allow",
+  Gated = "Gated"
+}
+
 /**
  * The global view of a User. This object contains all global information about the user including birth date, registration information
  * preferred languages, global attributes, etc.
@@ -8477,6 +8600,8 @@ export interface UserRequest {
  * @author Brian Pontarelli
  */
 export interface UserResponse {
+  emailVerificationId?: string;
+  registrationVerificationIds?: Record<UUID, string>;
   token?: string;
   user?: User;
 }
@@ -8494,7 +8619,9 @@ export interface UserSearchCriteria extends BaseElasticSearchCriteria {
  */
 export enum UserState {
   Authenticated = "Authenticated",
-  AuthenticatedNotRegistered = "AuthenticatedNotRegistered"
+  AuthenticatedNotRegistered = "AuthenticatedNotRegistered",
+  AuthenticatedNotVerified = "AuthenticatedNotVerified",
+  AuthenticatedRegistrationNotVerified = "AuthenticatedRegistrationNotVerified"
 }
 
 /**
@@ -8522,20 +8649,53 @@ export interface ValidateResponse {
   jwt?: JWT;
 }
 
+/**
+ * @author Daniel DeGroff
+ */
+export enum VerificationStrategy {
+  ClickableLink = "ClickableLink",
+  FormField = "FormField"
+}
+
+/**
+ * @author Daniel DeGroff
+ */
+export interface VerifyEmailRequest {
+  oneTimeCode?: string;
+  verificationId?: string;
+}
+
 /**
  * @author Daniel DeGroff
  */
 export interface VerifyEmailResponse {
+  oneTimeCode?: string;
+  verificationId?: string;
+}
+
+/**
+ * @author Daniel DeGroff
+ */
+export interface VerifyRegistrationRequest {
+  oneTimeCode?: string;
   verificationId?: string;
 }
 
 /**
  * @author Daniel DeGroff
  */
 export interface VerifyRegistrationResponse {
+  oneTimeCode?: string;
   verificationId?: string;
 }
 
+/**
+ * @author Daniel DeGroff
+ */
+export interface VersionResponse {
+  version?: string;
+}
+
 /**
  * A server where events are sent. This includes user action events and any other events sent by FusionAuth.
  *