@fusionauth/typescript-client 1.34.0 → 1.36.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2220,7 +2220,7 @@ class FusionAuthClient {
2220
2220
  .go();
2221
2221
  }
2222
2222
  /**
2223
- * Retrieves all of the actions for the user with the given Id. This will return all time based actions that are active,
2223
+ * Retrieves all the actions for the user with the given Id. This will return all time based actions that are active,
2224
2224
  * and inactive as well as non-time based actions.
2225
2225
  *
2226
2226
  * @param {UUID} userId The Id of the user to fetch the actions for.
@@ -2234,7 +2234,7 @@ class FusionAuthClient {
2234
2234
  .go();
2235
2235
  }
2236
2236
  /**
2237
- * Retrieves all of the actions for the user with the given Id that are currently preventing the User from logging in.
2237
+ * Retrieves all the actions for the user with the given Id that are currently preventing the User from logging in.
2238
2238
  *
2239
2239
  * @param {UUID} userId The Id of the user to fetch the actions for.
2240
2240
  * @returns {Promise<ClientResponse<ActionResponse>>}
@@ -2248,7 +2248,7 @@ class FusionAuthClient {
2248
2248
  .go();
2249
2249
  }
2250
2250
  /**
2251
- * Retrieves all of the actions for the user with the given Id that are currently active.
2251
+ * Retrieves all the actions for the user with the given Id that are currently active.
2252
2252
  * An active action means one that is time based and has not been canceled, and has not ended.
2253
2253
  *
2254
2254
  * @param {UUID} userId The Id of the user to fetch the actions for.
@@ -2276,7 +2276,7 @@ class FusionAuthClient {
2276
2276
  .go();
2277
2277
  }
2278
2278
  /**
2279
- * Retrieves all of the applications.
2279
+ * Retrieves all the applications.
2280
2280
  *
2281
2281
  * @returns {Promise<ClientResponse<ApplicationResponse>>}
2282
2282
  */
@@ -2313,7 +2313,7 @@ class FusionAuthClient {
2313
2313
  .go();
2314
2314
  }
2315
2315
  /**
2316
- * Retrieves all of the connectors.
2316
+ * Retrieves all the connectors.
2317
2317
  *
2318
2318
  * @returns {Promise<ClientResponse<ConnectorResponse>>}
2319
2319
  */
@@ -2337,7 +2337,7 @@ class FusionAuthClient {
2337
2337
  .go();
2338
2338
  }
2339
2339
  /**
2340
- * Retrieves all of the consent.
2340
+ * Retrieves all the consent.
2341
2341
  *
2342
2342
  * @returns {Promise<ClientResponse<ConsentResponse>>}
2343
2343
  */
@@ -2394,7 +2394,7 @@ class FusionAuthClient {
2394
2394
  .go();
2395
2395
  }
2396
2396
  /**
2397
- * Retrieves all of the email templates.
2397
+ * Retrieves all the email templates.
2398
2398
  *
2399
2399
  * @returns {Promise<ClientResponse<EmailTemplateResponse>>}
2400
2400
  */
@@ -2449,7 +2449,7 @@ class FusionAuthClient {
2449
2449
  .go();
2450
2450
  }
2451
2451
  /**
2452
- * Retrieves all of the Entity Types.
2452
+ * Retrieves all the Entity Types.
2453
2453
  *
2454
2454
  * @returns {Promise<ClientResponse<EntityTypeResponse>>}
2455
2455
  */
@@ -2473,7 +2473,7 @@ class FusionAuthClient {
2473
2473
  .go();
2474
2474
  }
2475
2475
  /**
2476
- * Retrieves all of the families that a user belongs to.
2476
+ * Retrieves all the families that a user belongs to.
2477
2477
  *
2478
2478
  * @param {UUID} userId The User's id
2479
2479
  * @returns {Promise<ClientResponse<FamilyResponse>>}
@@ -2486,7 +2486,7 @@ class FusionAuthClient {
2486
2486
  .go();
2487
2487
  }
2488
2488
  /**
2489
- * Retrieves all of the members of a family by the unique Family Id.
2489
+ * Retrieves all the members of a family by the unique Family Id.
2490
2490
  *
2491
2491
  * @param {UUID} familyId The unique Id of the Family.
2492
2492
  * @returns {Promise<ClientResponse<FamilyResponse>>}
@@ -2525,7 +2525,7 @@ class FusionAuthClient {
2525
2525
  .go();
2526
2526
  }
2527
2527
  /**
2528
- * Retrieves all of the forms fields
2528
+ * Retrieves all the forms fields
2529
2529
  *
2530
2530
  * @returns {Promise<ClientResponse<FormFieldResponse>>}
2531
2531
  */
@@ -2536,7 +2536,7 @@ class FusionAuthClient {
2536
2536
  .go();
2537
2537
  }
2538
2538
  /**
2539
- * Retrieves all of the forms.
2539
+ * Retrieves all the forms.
2540
2540
  *
2541
2541
  * @returns {Promise<ClientResponse<FormResponse>>}
2542
2542
  */
@@ -2560,7 +2560,7 @@ class FusionAuthClient {
2560
2560
  .go();
2561
2561
  }
2562
2562
  /**
2563
- * Retrieves all of the groups.
2563
+ * Retrieves all the groups.
2564
2564
  *
2565
2565
  * @returns {Promise<ClientResponse<GroupResponse>>}
2566
2566
  */
@@ -2612,7 +2612,7 @@ class FusionAuthClient {
2612
2612
  .go();
2613
2613
  }
2614
2614
  /**
2615
- * Retrieves all of the identity providers.
2615
+ * Retrieves all the identity providers.
2616
2616
  *
2617
2617
  * @returns {Promise<ClientResponse<IdentityProviderResponse>>}
2618
2618
  */
@@ -2623,7 +2623,7 @@ class FusionAuthClient {
2623
2623
  .go();
2624
2624
  }
2625
2625
  /**
2626
- * Retrieves all of the actions for the user with the given Id that are currently inactive.
2626
+ * Retrieves all the actions for the user with the given Id that are currently inactive.
2627
2627
  * An inactive action means one that is time based and has been canceled or has expired, or is not time based.
2628
2628
  *
2629
2629
  * @param {UUID} userId The Id of the user to fetch the actions for.
@@ -2638,7 +2638,7 @@ class FusionAuthClient {
2638
2638
  .go();
2639
2639
  }
2640
2640
  /**
2641
- * Retrieves all of the applications that are currently inactive.
2641
+ * Retrieves all the applications that are currently inactive.
2642
2642
  *
2643
2643
  * @returns {Promise<ClientResponse<ApplicationResponse>>}
2644
2644
  */
@@ -2650,7 +2650,7 @@ class FusionAuthClient {
2650
2650
  .go();
2651
2651
  }
2652
2652
  /**
2653
- * Retrieves all of the user actions that are currently inactive.
2653
+ * Retrieves all the user actions that are currently inactive.
2654
2654
  *
2655
2655
  * @returns {Promise<ClientResponse<UserActionResponse>>}
2656
2656
  */
@@ -2734,7 +2734,7 @@ class FusionAuthClient {
2734
2734
  .go();
2735
2735
  }
2736
2736
  /**
2737
- * Retrieves all of the keys.
2737
+ * Retrieves all the keys.
2738
2738
  *
2739
2739
  * @returns {Promise<ClientResponse<KeyResponse>>}
2740
2740
  */
@@ -2758,7 +2758,7 @@ class FusionAuthClient {
2758
2758
  .go();
2759
2759
  }
2760
2760
  /**
2761
- * Retrieves all of the lambdas.
2761
+ * Retrieves all the lambdas.
2762
2762
  *
2763
2763
  * @returns {Promise<ClientResponse<LambdaResponse>>}
2764
2764
  */
@@ -2769,7 +2769,7 @@ class FusionAuthClient {
2769
2769
  .go();
2770
2770
  }
2771
2771
  /**
2772
- * Retrieves all of the lambdas for the provided type.
2772
+ * Retrieves all the lambdas for the provided type.
2773
2773
  *
2774
2774
  * @param {LambdaType} type The type of the lambda to return.
2775
2775
  * @returns {Promise<ClientResponse<LambdaResponse>>}
@@ -2826,7 +2826,7 @@ class FusionAuthClient {
2826
2826
  .go();
2827
2827
  }
2828
2828
  /**
2829
- * Retrieves all of the message templates.
2829
+ * Retrieves all the message templates.
2830
2830
  *
2831
2831
  * @returns {Promise<ClientResponse<MessageTemplateResponse>>}
2832
2832
  */
@@ -2850,7 +2850,7 @@ class FusionAuthClient {
2850
2850
  .go();
2851
2851
  }
2852
2852
  /**
2853
- * Retrieves all of the messengers.
2853
+ * Retrieves all the messengers.
2854
2854
  *
2855
2855
  * @returns {Promise<ClientResponse<MessengerResponse>>}
2856
2856
  */
@@ -2933,7 +2933,7 @@ class FusionAuthClient {
2933
2933
  .go();
2934
2934
  }
2935
2935
  /**
2936
- * Retrieves all of the children for the given parent email address.
2936
+ * Retrieves all the children for the given parent email address.
2937
2937
  *
2938
2938
  * @param {string} parentEmail The email of the parent.
2939
2939
  * @returns {Promise<ClientResponse<PendingResponse>>}
@@ -3078,7 +3078,7 @@ class FusionAuthClient {
3078
3078
  .go();
3079
3079
  }
3080
3080
  /**
3081
- * Retrieves all of the tenants.
3081
+ * Retrieves all the tenants.
3082
3082
  *
3083
3083
  * @returns {Promise<ClientResponse<TenantResponse>>}
3084
3084
  */
@@ -3102,7 +3102,7 @@ class FusionAuthClient {
3102
3102
  .go();
3103
3103
  }
3104
3104
  /**
3105
- * Retrieves all of the themes.
3105
+ * Retrieves all the themes.
3106
3106
  *
3107
3107
  * @returns {Promise<ClientResponse<ThemeResponse>>}
3108
3108
  */
@@ -3190,7 +3190,7 @@ class FusionAuthClient {
3190
3190
  .go();
3191
3191
  }
3192
3192
  /**
3193
- * Retrieves all of the user actions.
3193
+ * Retrieves all the user actions.
3194
3194
  *
3195
3195
  * @returns {Promise<ClientResponse<UserActionResponse>>}
3196
3196
  */
@@ -3268,7 +3268,7 @@ class FusionAuthClient {
3268
3268
  .go();
3269
3269
  }
3270
3270
  /**
3271
- * Retrieves all of the comments for the user with the given Id.
3271
+ * Retrieves all the comments for the user with the given Id.
3272
3272
  *
3273
3273
  * @param {UUID} userId The Id of the user.
3274
3274
  * @returns {Promise<ClientResponse<UserCommentResponse>>}
@@ -3294,7 +3294,7 @@ class FusionAuthClient {
3294
3294
  .go();
3295
3295
  }
3296
3296
  /**
3297
- * Retrieves all of the consents for a User.
3297
+ * Retrieves all the consents for a User.
3298
3298
  *
3299
3299
  * @param {UUID} userId The User's Id
3300
3300
  * @returns {Promise<ClientResponse<UserConsentResponse>>}
@@ -3668,6 +3668,19 @@ class FusionAuthClient {
3668
3668
  .withMethod("POST")
3669
3669
  .go();
3670
3670
  }
3671
+ /**
3672
+ * Searches group members with the specified criteria and pagination.
3673
+ *
3674
+ * @param {GroupMemberSearchRequest} request The search criteria and pagination information.
3675
+ * @returns {Promise<ClientResponse<GroupMemberSearchResponse>>}
3676
+ */
3677
+ searchGroupMembers(request) {
3678
+ return this.start()
3679
+ .withUri('/api/group/member/search')
3680
+ .withJSONBody(request)
3681
+ .withMethod("POST")
3682
+ .go();
3683
+ }
3671
3684
  /**
3672
3685
  * Searches the IP Access Control Lists with the specified criteria and pagination.
3673
3686
  *
@@ -4098,6 +4111,19 @@ class FusionAuthClient {
4098
4111
  .withMethod("PUT")
4099
4112
  .go();
4100
4113
  }
4114
+ /**
4115
+ * Creates a member in a group.
4116
+ *
4117
+ * @param {MemberRequest} request The request object that contains all the information used to create the group member(s).
4118
+ * @returns {Promise<ClientResponse<MemberResponse>>}
4119
+ */
4120
+ updateGroupMembers(request) {
4121
+ return this.start()
4122
+ .withUri('/api/group/member')
4123
+ .withJSONBody(request)
4124
+ .withMethod("PUT")
4125
+ .go();
4126
+ }
4101
4127
  /**
4102
4128
  * Updates the IP Access Control List with the given Id.
4103
4129
  *
@@ -4674,10 +4700,12 @@ var EventType;
4674
4700
  EventType["UserDeactivate"] = "user.deactivate";
4675
4701
  EventType["UserDelete"] = "user.delete";
4676
4702
  EventType["UserDeleteComplete"] = "user.delete.complete";
4677
- EventType["UserLoginIdDuplicateOnCreate"] = "user.loginId.duplicate.create";
4678
- EventType["UserLoginIdDuplicateOnUpdate"] = "user.loginId.duplicate.update";
4679
4703
  EventType["UserEmailUpdate"] = "user.email.update";
4680
4704
  EventType["UserEmailVerified"] = "user.email.verified";
4705
+ EventType["UserIdentityProviderLink"] = "user.identity-provider.link";
4706
+ EventType["UserIdentityProviderUnlink"] = "user.identity-provider.unlink";
4707
+ EventType["UserLoginIdDuplicateOnCreate"] = "user.loginId.duplicate.create";
4708
+ EventType["UserLoginIdDuplicateOnUpdate"] = "user.loginId.duplicate.update";
4681
4709
  EventType["UserLoginFailed"] = "user.login.failed";
4682
4710
  EventType["UserLoginNewDevice"] = "user.login.new-device";
4683
4711
  EventType["UserLoginSuccess"] = "user.login.success";
@@ -4876,6 +4904,14 @@ var KeyUse;
4876
4904
  KeyUse["SignAndVerify"] = "SignAndVerify";
4877
4905
  KeyUse["VerifyOnly"] = "VerifyOnly";
4878
4906
  })(KeyUse = exports.KeyUse || (exports.KeyUse = {}));
4907
+ /**
4908
+ * @author Daniel DeGroff
4909
+ */
4910
+ var LambdaEngineType;
4911
+ (function (LambdaEngineType) {
4912
+ LambdaEngineType["GraalJS"] = "GraalJS";
4913
+ LambdaEngineType["Nashorn"] = "Nashorn";
4914
+ })(LambdaEngineType = exports.LambdaEngineType || (exports.LambdaEngineType = {}));
4879
4915
  /**
4880
4916
  * The types of lambdas that indicate how they are invoked by FusionAuth.
4881
4917
  *
@@ -4902,6 +4938,10 @@ var LambdaType;
4902
4938
  LambdaType["TwitchReconcile"] = "TwitchReconcile";
4903
4939
  LambdaType["XboxReconcile"] = "XboxReconcile";
4904
4940
  LambdaType["ClientCredentialsJWTPopulate"] = "ClientCredentialsJWTPopulate";
4941
+ LambdaType["SCIMServerGroupRequestConverter"] = "SCIMServerGroupRequestConverter";
4942
+ LambdaType["SCIMServerGroupResponseConverter"] = "SCIMServerGroupResponseConverter";
4943
+ LambdaType["SCIMServerUserRequestConverter"] = "SCIMServerUserRequestConverter";
4944
+ LambdaType["SCIMServerUserResponseConverter"] = "SCIMServerUserResponseConverter";
4905
4945
  })(LambdaType = exports.LambdaType || (exports.LambdaType = {}));
4906
4946
  var LDAPSecurityMethod;
4907
4947
  (function (LDAPSecurityMethod) {