@fusionauth/typescript-client 1.34.0 → 1.36.0

package/README.md

@@ -28,7 +28,7 @@ Refer to the FusionAuth API documentation to for request and response formats.
 
 If you have a question or support issue regarding this client library, we'd love to hear from you.
 
-If you have a paid edition with support included, please [open a ticket in your account portal](https://account.fusionauth.io/account/support/). Learn more about [paid editions here](https://fusionauth.io/pricing/).
+If you have a paid edition with support included, please [open a ticket in your account portal](https://account.fusionauth.io/account/support/). Learn more about [paid editions here](https://fusionauth.io/pricing).
 
 Otherwise, please [post your question in the community forum](https://fusionauth.io/community/forum/).
 

package/build/src/FusionAuthClient.d.ts

@@ -1221,7 +1221,7 @@ export declare class FusionAuthClient {
      */
     retrieveAction(actionId: UUID): Promise<ClientResponse<ActionResponse>>;
     /**
-     * Retrieves all of the actions for the user with the given Id. This will return all time based actions that are active,
+     * 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.
@@ -1229,14 +1229,14 @@ export declare class FusionAuthClient {
      */
     retrieveActions(userId: UUID): Promise<ClientResponse<ActionResponse>>;
     /**
-     * Retrieves all of the actions for the user with the given Id that are currently preventing the User from logging in.
+     * 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 of the actions for the user with the given Id that are currently active.
+     * 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.
@@ -1251,7 +1251,7 @@ export declare class FusionAuthClient {
      */
     retrieveApplication(applicationId: UUID): Promise<ClientResponse<ApplicationResponse>>;
     /**
-     * Retrieves all of the applications.
+     * Retrieves all the applications.
      *
      * @returns {Promise<ClientResponse<ApplicationResponse>>}
      */
@@ -1271,7 +1271,7 @@ export declare class FusionAuthClient {
      */
     retrieveConnector(connectorId: UUID): Promise<ClientResponse<ConnectorResponse>>;
     /**
-     * Retrieves all of the connectors.
+     * Retrieves all the connectors.
      *
      * @returns {Promise<ClientResponse<ConnectorResponse>>}
      */
@@ -1284,7 +1284,7 @@ export declare class FusionAuthClient {
      */
     retrieveConsent(consentId: UUID): Promise<ClientResponse<ConsentResponse>>;
     /**
-     * Retrieves all of the consent.
+     * Retrieves all the consent.
      *
      * @returns {Promise<ClientResponse<ConsentResponse>>}
      */
@@ -1316,7 +1316,7 @@ export declare class FusionAuthClient {
      */
     retrieveEmailTemplatePreview(request: PreviewRequest): Promise<ClientResponse<PreviewResponse>>;
     /**
-     * Retrieves all of the email templates.
+     * Retrieves all the email templates.
      *
      * @returns {Promise<ClientResponse<EmailTemplateResponse>>}
      */
@@ -1345,7 +1345,7 @@ export declare class FusionAuthClient {
      */
     retrieveEntityType(entityTypeId: UUID): Promise<ClientResponse<EntityTypeResponse>>;
     /**
-     * Retrieves all of the Entity Types.
+     * Retrieves all the Entity Types.
      *
      * @returns {Promise<ClientResponse<EntityTypeResponse>>}
      */
@@ -1358,14 +1358,14 @@ export declare class FusionAuthClient {
      */
     retrieveEventLog(eventLogId: number): Promise<ClientResponse<EventLogResponse>>;
     /**
-     * Retrieves all of the families that a user belongs to.
+     * 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 of the members of a family by the unique Family Id.
+     * 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>>}
@@ -1386,13 +1386,13 @@ export declare class FusionAuthClient {
      */
     retrieveFormField(fieldId: UUID): Promise<ClientResponse<FormFieldResponse>>;
     /**
-     * Retrieves all of the forms fields
+     * Retrieves all the forms fields
      *
      * @returns {Promise<ClientResponse<FormFieldResponse>>}
      */
     retrieveFormFields(): Promise<ClientResponse<FormFieldResponse>>;
     /**
-     * Retrieves all of the forms.
+     * Retrieves all the forms.
      *
      * @returns {Promise<ClientResponse<FormResponse>>}
      */
@@ -1405,7 +1405,7 @@ export declare class FusionAuthClient {
      */
     retrieveGroup(groupId: UUID): Promise<ClientResponse<GroupResponse>>;
     /**
-     * Retrieves all of the groups.
+     * Retrieves all the groups.
      *
      * @returns {Promise<ClientResponse<GroupResponse>>}
      */
@@ -1434,13 +1434,13 @@ export declare class FusionAuthClient {
      */
     retrieveIdentityProviderByType(type: IdentityProviderType): Promise<ClientResponse<IdentityProviderResponse>>;
     /**
-     * Retrieves all of the identity providers.
+     * Retrieves all the identity providers.
      *
      * @returns {Promise<ClientResponse<IdentityProviderResponse>>}
      */
     retrieveIdentityProviders(): Promise<ClientResponse<IdentityProviderResponse>>;
     /**
-     * Retrieves all of the actions for the user with the given Id that are currently inactive.
+     * 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.
@@ -1448,13 +1448,13 @@ export declare class FusionAuthClient {
      */
     retrieveInactiveActions(userId: UUID): Promise<ClientResponse<ActionResponse>>;
     /**
-     * Retrieves all of the applications that are currently inactive.
+     * Retrieves all the applications that are currently inactive.
      *
      * @returns {Promise<ClientResponse<ApplicationResponse>>}
      */
     retrieveInactiveApplications(): Promise<ClientResponse<ApplicationResponse>>;
     /**
-     * Retrieves all of the user actions that are currently inactive.
+     * Retrieves all the user actions that are currently inactive.
      *
      * @returns {Promise<ClientResponse<UserActionResponse>>}
      */
@@ -1499,7 +1499,7 @@ export declare class FusionAuthClient {
      */
     retrieveKey(keyId: UUID): Promise<ClientResponse<KeyResponse>>;
     /**
-     * Retrieves all of the keys.
+     * Retrieves all the keys.
      *
      * @returns {Promise<ClientResponse<KeyResponse>>}
      */
@@ -1512,13 +1512,13 @@ export declare class FusionAuthClient {
      */
     retrieveLambda(lambdaId: UUID): Promise<ClientResponse<LambdaResponse>>;
     /**
-     * Retrieves all of the lambdas.
+     * Retrieves all the lambdas.
      *
      * @returns {Promise<ClientResponse<LambdaResponse>>}
      */
     retrieveLambdas(): Promise<ClientResponse<LambdaResponse>>;
     /**
-     * Retrieves all of the lambdas for the provided type.
+     * Retrieves all the lambdas for the provided type.
      *
      * @param {LambdaType} type The type of the lambda to return.
      * @returns {Promise<ClientResponse<LambdaResponse>>}
@@ -1549,7 +1549,7 @@ export declare class FusionAuthClient {
      */
     retrieveMessageTemplatePreview(request: PreviewMessageTemplateRequest): Promise<ClientResponse<PreviewMessageTemplateResponse>>;
     /**
-     * Retrieves all of the message templates.
+     * Retrieves all the message templates.
      *
      * @returns {Promise<ClientResponse<MessageTemplateResponse>>}
      */
@@ -1562,7 +1562,7 @@ export declare class FusionAuthClient {
      */
     retrieveMessenger(messengerId: UUID): Promise<ClientResponse<MessengerResponse>>;
     /**
-     * Retrieves all of the messengers.
+     * Retrieves all the messengers.
      *
      * @returns {Promise<ClientResponse<MessengerResponse>>}
      */
@@ -1609,7 +1609,7 @@ export declare class FusionAuthClient {
      */
     retrievePasswordValidationRulesWithTenantId(tenantId: UUID): Promise<ClientResponse<PasswordValidationRulesResponse>>;
     /**
-     * Retrieves all of the children for the given parent email address.
+     * Retrieves all the children for the given parent email address.
      *
      * @param {string} parentEmail The email of the parent.
      * @returns {Promise<ClientResponse<PendingResponse>>}
@@ -1688,7 +1688,7 @@ export declare class FusionAuthClient {
      */
     retrieveTenant(tenantId: UUID): Promise<ClientResponse<TenantResponse>>;
     /**
-     * Retrieves all of the tenants.
+     * Retrieves all the tenants.
      *
      * @returns {Promise<ClientResponse<TenantResponse>>}
      */
@@ -1701,7 +1701,7 @@ export declare class FusionAuthClient {
      */
     retrieveTheme(themeId: UUID): Promise<ClientResponse<ThemeResponse>>;
     /**
-     * Retrieves all of the themes.
+     * Retrieves all the themes.
      *
      * @returns {Promise<ClientResponse<ThemeResponse>>}
      */
@@ -1750,7 +1750,7 @@ export declare class FusionAuthClient {
      */
     retrieveUserActionReasons(): Promise<ClientResponse<UserActionReasonResponse>>;
     /**
-     * Retrieves all of the user actions.
+     * Retrieves all the user actions.
      *
      * @returns {Promise<ClientResponse<UserActionResponse>>}
      */
@@ -1793,7 +1793,7 @@ export declare class FusionAuthClient {
      */
     retrieveUserByVerificationId(verificationId: string): Promise<ClientResponse<UserResponse>>;
     /**
-     * Retrieves all of the comments for the user with the given Id.
+     * Retrieves all the comments for the user with the given Id.
      *
      * @param {UUID} userId The Id of the user.
      * @returns {Promise<ClientResponse<UserCommentResponse>>}
@@ -1807,7 +1807,7 @@ export declare class FusionAuthClient {
      */
     retrieveUserConsent(userConsentId: UUID): Promise<ClientResponse<UserConsentResponse>>;
     /**
-     * Retrieves all of the consents for a User.
+     * Retrieves all the consents for a User.
      *
      * @param {UUID} userId The User's Id
      * @returns {Promise<ClientResponse<UserConsentResponse>>}
@@ -2019,6 +2019,13 @@ export declare class FusionAuthClient {
      * @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 the IP Access Control Lists with the specified criteria and pagination.
      *
@@ -2256,6 +2263,13 @@ export declare class FusionAuthClient {
      * @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.
      *
@@ -3521,7 +3535,7 @@ export interface EntityTypeSearchRequest {
     search?: EntityTypeSearchCriteria;
 }
 /**
- * Search request for entity types.
+ * Search response for entity types.
  *
  * @author Brian Pontarelli
  */
@@ -3685,10 +3699,12 @@ export declare enum EventType {
     UserDeactivate = "user.deactivate",
     UserDelete = "user.delete",
     UserDeleteComplete = "user.delete.complete",
-    UserLoginIdDuplicateOnCreate = "user.loginId.duplicate.create",
-    UserLoginIdDuplicateOnUpdate = "user.loginId.duplicate.update",
     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",
@@ -4108,8 +4124,35 @@ export interface GroupMember {
     groupId?: UUID;
     id?: UUID;
     insertInstant?: number;
+    user?: User;
     userId?: UUID;
 }
+/**
+ * Search criteria for Group Members
+ *
+ * @author Daniel DeGroff
+ */
+export interface GroupMemberSearchCriteria extends BaseSearchCriteria {
+    groupId?: 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;
+}
 /**
  * Group API request object.
  *
@@ -4212,7 +4255,7 @@ export declare enum IdentityProviderLinkingStrategy {
 /**
  * @author Daniel DeGroff
  */
-export interface IdentityProviderLinkRequest {
+export interface IdentityProviderLinkRequest extends BaseEventRequest {
     displayName?: string;
     identityProviderId?: UUID;
     identityProviderUserId?: string;
@@ -4650,9 +4693,15 @@ export declare enum KeyUse {
 export interface KickstartSuccessEvent extends BaseEvent {
     instanceId?: UUID;
 }
-export interface Lambda extends Enableable {
+/**
+ * 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;
@@ -4670,6 +4719,13 @@ export interface LambdaConfiguration {
 export interface LambdaConfiguration {
     reconcileId?: UUID;
 }
+/**
+ * @author Daniel DeGroff
+ */
+export declare enum LambdaEngineType {
+    GraalJS = "GraalJS",
+    Nashorn = "Nashorn"
+}
 /**
  * Lambda API request object.
  *
@@ -4711,7 +4767,11 @@ export declare enum LambdaType {
     SteamReconcile = "SteamReconcile",
     TwitchReconcile = "TwitchReconcile",
     XboxReconcile = "XboxReconcile",
-    ClientCredentialsJWTPopulate = "ClientCredentialsJWTPopulate"
+    ClientCredentialsJWTPopulate = "ClientCredentialsJWTPopulate",
+    SCIMServerGroupRequestConverter = "SCIMServerGroupRequestConverter",
+    SCIMServerGroupResponseConverter = "SCIMServerGroupResponseConverter",
+    SCIMServerUserRequestConverter = "SCIMServerUserRequestConverter",
+    SCIMServerUserResponseConverter = "SCIMServerUserResponseConverter"
 }
 /**
  * Models an LDAP connector.
@@ -5063,7 +5123,10 @@ export interface NintendoApplicationConfiguration extends BaseIdentityProviderAp
     buttonText?: string;
     client_id?: string;
     client_secret?: string;
+    emailClaim?: string;
     scope?: string;
+    uniqueIdClaim?: string;
+    usernameClaim?: string;
 }
 /**
  * Nintendo gaming login provider.
@@ -5074,7 +5137,10 @@ export interface NintendoIdentityProvider extends BaseIdentityProvider<NintendoA
     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.
@@ -5120,6 +5186,7 @@ export interface OAuthError {
     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",
@@ -5462,13 +5529,16 @@ export interface ReactorResponse {
  */
 export interface ReactorStatus {
     advancedIdentityProviders?: ReactorFeatureStatus;
+    advancedLambdas?: ReactorFeatureStatus;
     advancedMultiFactorAuthentication?: ReactorFeatureStatus;
     advancedRegistration?: ReactorFeatureStatus;
     applicationThemes?: ReactorFeatureStatus;
     breachedPasswordDetection?: ReactorFeatureStatus;
     connectors?: ReactorFeatureStatus;
     entityManagement?: ReactorFeatureStatus;
+    expiration?: string;
     licensed?: boolean;
+    scimServer?: ReactorFeatureStatus;
     threatDetection?: ReactorFeatureStatus;
 }
 /**
@@ -5997,6 +6067,7 @@ export interface Tenant {
     insertInstant?: number;
     issuer?: string;
     jwtConfiguration?: JWTConfiguration;
+    lambdaConfiguration?: TenantLambdaConfiguration;
     lastUpdateInstant?: number;
     loginConfiguration?: TenantLoginConfiguration;
     logoutURL?: string;
@@ -6009,6 +6080,7 @@ export interface Tenant {
     passwordValidationRules?: PasswordValidationRules;
     rateLimitConfiguration?: TenantRateLimitConfiguration;
     registrationConfiguration?: TenantRegistrationConfiguration;
+    scimServerConfiguration?: TenantSCIMServerConfiguration;
     ssoConfiguration?: TenantSSOConfiguration;
     state?: ObjectState;
     themeId?: UUID;
@@ -6049,6 +6121,17 @@ export interface TenantDeleteRequest extends BaseEventRequest {
 export interface TenantFormConfiguration {
     adminUserFormId?: UUID;
 }
+/**
+ * @author Rob Davis
+ */
+export interface TenantLambdaConfiguration {
+    scimEnterpriseUserRequestConverterId?: UUID;
+    scimEnterpriseUserResponseConverterId?: UUID;
+    scimGroupRequestConverterId?: UUID;
+    scimGroupResponseConverterId?: UUID;
+    scimUserRequestConverterId?: UUID;
+    scimUserResponseConverterId?: UUID;
+}
 /**
  * @author Daniel DeGroff
  */
@@ -6097,6 +6180,14 @@ 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
  */
@@ -6713,6 +6804,24 @@ export interface UserEmailUpdateEvent extends BaseEvent {
 export interface UserEmailVerifiedEvent extends BaseEvent {
     user?: User;
 }
+/**
+ * Models the User Identity Provider Link Event.
+ *
+ * @author Rob Davis
+ */
+export interface UserIdentityProviderLinkEvent extends BaseEvent {
+    identityProviderLink?: IdentityProviderLink;
+    user?: User;
+}
+/**
+ * Models the User Identity Provider Unlink Event.
+ *
+ * @author Rob Davis
+ */
+export interface UserIdentityProviderUnlinkEvent extends BaseEvent {
+    identityProviderLink?: IdentityProviderLink;
+    user?: User;
+}
 /**
  * @author Daniel DeGroff
  */