@fusionauth/typescript-client 1.37.0 → 1.38.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.
- package/build/src/FusionAuthClient.d.ts +138 -19
- package/build/src/FusionAuthClient.js +12 -0
- package/build/src/FusionAuthClient.js.map +1 -1
- package/dist/fusionauth-typescript-client.js +13 -1
- package/dist/fusionauth-typescript-client.min.js +1 -1
- package/dist/fusionauth-typescript-client.min.js.map +1 -1
- package/package.json +1 -1
|
@@ -2906,7 +2906,6 @@ export interface BaseElasticSearchCriteria extends BaseSearchCriteria {
|
|
|
2906
2906
|
* @author Brian Pontarelli
|
|
2907
2907
|
*/
|
|
2908
2908
|
export interface BaseEvent {
|
|
2909
|
-
applicationIds?: Array<UUID>;
|
|
2910
2909
|
createInstant?: number;
|
|
2911
2910
|
id?: UUID;
|
|
2912
2911
|
info?: EventInfo;
|
|
@@ -3738,6 +3737,18 @@ export declare enum EventType {
|
|
|
3738
3737
|
AuditLogCreate = "audit-log.create",
|
|
3739
3738
|
EventLogCreate = "event-log.create",
|
|
3740
3739
|
KickstartSuccess = "kickstart.success",
|
|
3740
|
+
GroupCreate = "group.create",
|
|
3741
|
+
GroupCreateComplete = "group.create.complete",
|
|
3742
|
+
GroupDelete = "group.delete",
|
|
3743
|
+
GroupDeleteComplete = "group.delete.complete",
|
|
3744
|
+
GroupMemberAdd = "group.member.add",
|
|
3745
|
+
GroupMemberAddComplete = "group.member.add.complete",
|
|
3746
|
+
GroupMemberRemove = "group.member.remove",
|
|
3747
|
+
GroupMemberRemoveComplete = "group.member.remove.complete",
|
|
3748
|
+
GroupMemberUpdate = "group.member.update",
|
|
3749
|
+
GroupMemberUpdateComplete = "group.member.update.complete",
|
|
3750
|
+
GroupUpdate = "group.update",
|
|
3751
|
+
GroupUpdateComplete = "group.update.complete",
|
|
3741
3752
|
UserAction = "user.action",
|
|
3742
3753
|
UserBulkCreate = "user.bulk.create",
|
|
3743
3754
|
UserCreate = "user.create",
|
|
@@ -4160,6 +4171,38 @@ export interface Group {
|
|
|
4160
4171
|
roles?: Record<UUID, Array<ApplicationRole>>;
|
|
4161
4172
|
tenantId?: UUID;
|
|
4162
4173
|
}
|
|
4174
|
+
/**
|
|
4175
|
+
* Models the Group Created Event.
|
|
4176
|
+
*
|
|
4177
|
+
* @author Daniel DeGroff
|
|
4178
|
+
*/
|
|
4179
|
+
export interface GroupCreateCompleteEvent extends BaseEvent {
|
|
4180
|
+
group?: Group;
|
|
4181
|
+
}
|
|
4182
|
+
/**
|
|
4183
|
+
* Models the Group Create Event.
|
|
4184
|
+
*
|
|
4185
|
+
* @author Daniel DeGroff
|
|
4186
|
+
*/
|
|
4187
|
+
export interface GroupCreateEvent extends BaseEvent {
|
|
4188
|
+
group?: Group;
|
|
4189
|
+
}
|
|
4190
|
+
/**
|
|
4191
|
+
* Models the Group Create Complete Event.
|
|
4192
|
+
*
|
|
4193
|
+
* @author Daniel DeGroff
|
|
4194
|
+
*/
|
|
4195
|
+
export interface GroupDeleteCompleteEvent extends BaseEvent {
|
|
4196
|
+
group?: Group;
|
|
4197
|
+
}
|
|
4198
|
+
/**
|
|
4199
|
+
* Models the Group Delete Event.
|
|
4200
|
+
*
|
|
4201
|
+
* @author Daniel DeGroff
|
|
4202
|
+
*/
|
|
4203
|
+
export interface GroupDeleteEvent extends BaseEvent {
|
|
4204
|
+
group?: Group;
|
|
4205
|
+
}
|
|
4163
4206
|
/**
|
|
4164
4207
|
* A User's membership into a Group
|
|
4165
4208
|
*
|
|
@@ -4173,6 +4216,42 @@ export interface GroupMember {
|
|
|
4173
4216
|
user?: User;
|
|
4174
4217
|
userId?: UUID;
|
|
4175
4218
|
}
|
|
4219
|
+
/**
|
|
4220
|
+
* Models the Group Member Add Complete Event.
|
|
4221
|
+
*
|
|
4222
|
+
* @author Daniel DeGroff
|
|
4223
|
+
*/
|
|
4224
|
+
export interface GroupMemberAddCompleteEvent extends BaseEvent {
|
|
4225
|
+
group?: Group;
|
|
4226
|
+
members?: Array<GroupMember>;
|
|
4227
|
+
}
|
|
4228
|
+
/**
|
|
4229
|
+
* Models the Group Member Add Event.
|
|
4230
|
+
*
|
|
4231
|
+
* @author Daniel DeGroff
|
|
4232
|
+
*/
|
|
4233
|
+
export interface GroupMemberAddEvent extends BaseEvent {
|
|
4234
|
+
group?: Group;
|
|
4235
|
+
members?: Array<GroupMember>;
|
|
4236
|
+
}
|
|
4237
|
+
/**
|
|
4238
|
+
* Models the Group Member Remove Complete Event.
|
|
4239
|
+
*
|
|
4240
|
+
* @author Daniel DeGroff
|
|
4241
|
+
*/
|
|
4242
|
+
export interface GroupMemberRemoveCompleteEvent extends BaseEvent {
|
|
4243
|
+
group?: Group;
|
|
4244
|
+
members?: Array<GroupMember>;
|
|
4245
|
+
}
|
|
4246
|
+
/**
|
|
4247
|
+
* Models the Group Member Remove Event.
|
|
4248
|
+
*
|
|
4249
|
+
* @author Daniel DeGroff
|
|
4250
|
+
*/
|
|
4251
|
+
export interface GroupMemberRemoveEvent extends BaseEvent {
|
|
4252
|
+
group?: Group;
|
|
4253
|
+
members?: Array<GroupMember>;
|
|
4254
|
+
}
|
|
4176
4255
|
/**
|
|
4177
4256
|
* Search criteria for Group Members
|
|
4178
4257
|
*
|
|
@@ -4180,6 +4259,7 @@ export interface GroupMember {
|
|
|
4180
4259
|
*/
|
|
4181
4260
|
export interface GroupMemberSearchCriteria extends BaseSearchCriteria {
|
|
4182
4261
|
groupId?: UUID;
|
|
4262
|
+
tenantId?: UUID;
|
|
4183
4263
|
userId?: UUID;
|
|
4184
4264
|
}
|
|
4185
4265
|
/**
|
|
@@ -4199,6 +4279,24 @@ export interface GroupMemberSearchResponse {
|
|
|
4199
4279
|
members?: Array<GroupMember>;
|
|
4200
4280
|
total?: number;
|
|
4201
4281
|
}
|
|
4282
|
+
/**
|
|
4283
|
+
* Models the Group Member Update Complete Event.
|
|
4284
|
+
*
|
|
4285
|
+
* @author Daniel DeGroff
|
|
4286
|
+
*/
|
|
4287
|
+
export interface GroupMemberUpdateCompleteEvent extends BaseEvent {
|
|
4288
|
+
group?: Group;
|
|
4289
|
+
members?: Array<GroupMember>;
|
|
4290
|
+
}
|
|
4291
|
+
/**
|
|
4292
|
+
* Models the Group Member Update Event.
|
|
4293
|
+
*
|
|
4294
|
+
* @author Daniel DeGroff
|
|
4295
|
+
*/
|
|
4296
|
+
export interface GroupMemberUpdateEvent extends BaseEvent {
|
|
4297
|
+
group?: Group;
|
|
4298
|
+
members?: Array<GroupMember>;
|
|
4299
|
+
}
|
|
4202
4300
|
/**
|
|
4203
4301
|
* Group API request object.
|
|
4204
4302
|
*
|
|
@@ -4217,6 +4315,24 @@ export interface GroupResponse {
|
|
|
4217
4315
|
group?: Group;
|
|
4218
4316
|
groups?: Array<Group>;
|
|
4219
4317
|
}
|
|
4318
|
+
/**
|
|
4319
|
+
* Models the Group Update Complete Event.
|
|
4320
|
+
*
|
|
4321
|
+
* @author Daniel DeGroff
|
|
4322
|
+
*/
|
|
4323
|
+
export interface GroupUpdateCompleteEvent extends BaseEvent {
|
|
4324
|
+
group?: Group;
|
|
4325
|
+
original?: Group;
|
|
4326
|
+
}
|
|
4327
|
+
/**
|
|
4328
|
+
* Models the Group Update Event.
|
|
4329
|
+
*
|
|
4330
|
+
* @author Daniel DeGroff
|
|
4331
|
+
*/
|
|
4332
|
+
export interface GroupUpdateEvent extends BaseEvent {
|
|
4333
|
+
group?: Group;
|
|
4334
|
+
original?: Group;
|
|
4335
|
+
}
|
|
4220
4336
|
export interface HistoryItem {
|
|
4221
4337
|
actionerUserId?: UUID;
|
|
4222
4338
|
comment?: string;
|
|
@@ -4595,12 +4711,13 @@ export interface JWTConfiguration extends Enableable {
|
|
|
4595
4711
|
timeToLiveInSeconds?: number;
|
|
4596
4712
|
}
|
|
4597
4713
|
/**
|
|
4598
|
-
* Models the JWT public key Refresh Token Revoke Event
|
|
4714
|
+
* Models the JWT public key Refresh Token Revoke Event. This event might be for a single
|
|
4599
4715
|
* token, a user or an entire application.
|
|
4600
4716
|
*
|
|
4601
4717
|
* @author Brian Pontarelli
|
|
4602
4718
|
*/
|
|
4603
4719
|
export interface JWTPublicKeyUpdateEvent extends BaseEvent {
|
|
4720
|
+
applicationIds?: Array<UUID>;
|
|
4604
4721
|
}
|
|
4605
4722
|
/**
|
|
4606
4723
|
* Models the JWT Refresh Event. This event will be fired when a JWT is "refreshed" (generated) using a Refresh Token.
|
|
@@ -4628,7 +4745,7 @@ export interface JWTRefreshResponse {
|
|
|
4628
4745
|
token?: string;
|
|
4629
4746
|
}
|
|
4630
4747
|
/**
|
|
4631
|
-
* Models the Refresh Token Revoke Event
|
|
4748
|
+
* Models the Refresh Token Revoke Event. This event might be for a single token, a user
|
|
4632
4749
|
* or an entire application.
|
|
4633
4750
|
*
|
|
4634
4751
|
* @author Brian Pontarelli
|
|
@@ -6605,7 +6722,7 @@ export interface UserAction {
|
|
|
6605
6722
|
userNotificationsEnabled?: boolean;
|
|
6606
6723
|
}
|
|
6607
6724
|
/**
|
|
6608
|
-
* Models the user action
|
|
6725
|
+
* Models the user action Event.
|
|
6609
6726
|
*
|
|
6610
6727
|
* @author Brian Pontarelli
|
|
6611
6728
|
*/
|
|
@@ -6614,6 +6731,7 @@ export interface UserActionEvent extends BaseEvent {
|
|
|
6614
6731
|
actioneeUserId?: UUID;
|
|
6615
6732
|
actionerUserId?: UUID;
|
|
6616
6733
|
actionId?: UUID;
|
|
6734
|
+
applicationIds?: Array<UUID>;
|
|
6617
6735
|
comment?: string;
|
|
6618
6736
|
email?: Email;
|
|
6619
6737
|
emailedUser?: boolean;
|
|
@@ -6722,7 +6840,7 @@ export interface UserActionResponse {
|
|
|
6722
6840
|
userActions?: Array<UserAction>;
|
|
6723
6841
|
}
|
|
6724
6842
|
/**
|
|
6725
|
-
* Models the User Bulk Create Event
|
|
6843
|
+
* Models the User Bulk Create Event.
|
|
6726
6844
|
*
|
|
6727
6845
|
* @author Brian Pontarelli
|
|
6728
6846
|
*/
|
|
@@ -6791,7 +6909,7 @@ export interface UserConsentResponse {
|
|
|
6791
6909
|
userConsents?: Array<UserConsent>;
|
|
6792
6910
|
}
|
|
6793
6911
|
/**
|
|
6794
|
-
* Models the User Created Event
|
|
6912
|
+
* Models the User Created Event.
|
|
6795
6913
|
* <p>
|
|
6796
6914
|
* 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.
|
|
6797
6915
|
*
|
|
@@ -6801,7 +6919,7 @@ export interface UserCreateCompleteEvent extends BaseEvent {
|
|
|
6801
6919
|
user?: User;
|
|
6802
6920
|
}
|
|
6803
6921
|
/**
|
|
6804
|
-
* Models the User Create Event
|
|
6922
|
+
* Models the User Create Event.
|
|
6805
6923
|
*
|
|
6806
6924
|
* @author Brian Pontarelli
|
|
6807
6925
|
*/
|
|
@@ -6809,7 +6927,7 @@ export interface UserCreateEvent extends BaseEvent {
|
|
|
6809
6927
|
user?: User;
|
|
6810
6928
|
}
|
|
6811
6929
|
/**
|
|
6812
|
-
* Models the User Deactivate Event
|
|
6930
|
+
* Models the User Deactivate Event.
|
|
6813
6931
|
*
|
|
6814
6932
|
* @author Brian Pontarelli
|
|
6815
6933
|
*/
|
|
@@ -6877,7 +6995,7 @@ export interface UserEmailUpdateEvent extends BaseEvent {
|
|
|
6877
6995
|
user?: User;
|
|
6878
6996
|
}
|
|
6879
6997
|
/**
|
|
6880
|
-
* Models the User Email Verify Event
|
|
6998
|
+
* Models the User Email Verify Event.
|
|
6881
6999
|
*
|
|
6882
7000
|
* @author Trevor Smith
|
|
6883
7001
|
*/
|
|
@@ -7009,7 +7127,7 @@ export interface UserPasswordUpdateEvent extends BaseEvent {
|
|
|
7009
7127
|
user?: User;
|
|
7010
7128
|
}
|
|
7011
7129
|
/**
|
|
7012
|
-
* Models the User Reactivate Event
|
|
7130
|
+
* Models the User Reactivate Event.
|
|
7013
7131
|
*
|
|
7014
7132
|
* @author Brian Pontarelli
|
|
7015
7133
|
*/
|
|
@@ -7039,9 +7157,10 @@ export interface UserRegistration {
|
|
|
7039
7157
|
verified?: boolean;
|
|
7040
7158
|
}
|
|
7041
7159
|
/**
|
|
7042
|
-
* Models the User Created Registration Event
|
|
7160
|
+
* Models the User Created Registration Event.
|
|
7043
7161
|
* <p>
|
|
7044
|
-
* 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
|
|
7162
|
+
* 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
|
|
7163
|
+
* transactional.
|
|
7045
7164
|
*
|
|
7046
7165
|
* @author Daniel DeGroff
|
|
7047
7166
|
*/
|
|
@@ -7051,7 +7170,7 @@ export interface UserRegistrationCreateCompleteEvent extends BaseEvent {
|
|
|
7051
7170
|
user?: User;
|
|
7052
7171
|
}
|
|
7053
7172
|
/**
|
|
7054
|
-
* Models the User Create Registration Event
|
|
7173
|
+
* Models the User Create Registration Event.
|
|
7055
7174
|
*
|
|
7056
7175
|
* @author Daniel DeGroff
|
|
7057
7176
|
*/
|
|
@@ -7061,7 +7180,7 @@ export interface UserRegistrationCreateEvent extends BaseEvent {
|
|
|
7061
7180
|
user?: User;
|
|
7062
7181
|
}
|
|
7063
7182
|
/**
|
|
7064
|
-
* Models the User Deleted Registration Event
|
|
7183
|
+
* Models the User Deleted Registration Event.
|
|
7065
7184
|
* <p>
|
|
7066
7185
|
* This is different than user.registration.delete in that it is sent after the TX has been committed. This event cannot be transactional.
|
|
7067
7186
|
*
|
|
@@ -7073,7 +7192,7 @@ export interface UserRegistrationDeleteCompleteEvent extends BaseEvent {
|
|
|
7073
7192
|
user?: User;
|
|
7074
7193
|
}
|
|
7075
7194
|
/**
|
|
7076
|
-
* Models the User Delete Registration Event
|
|
7195
|
+
* Models the User Delete Registration Event.
|
|
7077
7196
|
*
|
|
7078
7197
|
* @author Daniel DeGroff
|
|
7079
7198
|
*/
|
|
@@ -7083,7 +7202,7 @@ export interface UserRegistrationDeleteEvent extends BaseEvent {
|
|
|
7083
7202
|
user?: User;
|
|
7084
7203
|
}
|
|
7085
7204
|
/**
|
|
7086
|
-
* Models the User Update Registration Event
|
|
7205
|
+
* Models the User Update Registration Event.
|
|
7087
7206
|
* <p>
|
|
7088
7207
|
* This is different than user.registration.update in that it is sent after this event completes, this cannot be transactional.
|
|
7089
7208
|
*
|
|
@@ -7096,7 +7215,7 @@ export interface UserRegistrationUpdateCompleteEvent extends BaseEvent {
|
|
|
7096
7215
|
user?: User;
|
|
7097
7216
|
}
|
|
7098
7217
|
/**
|
|
7099
|
-
* Models the User Update Registration Event
|
|
7218
|
+
* Models the User Update Registration Event.
|
|
7100
7219
|
*
|
|
7101
7220
|
* @author Daniel DeGroff
|
|
7102
7221
|
*/
|
|
@@ -7107,7 +7226,7 @@ export interface UserRegistrationUpdateEvent extends BaseEvent {
|
|
|
7107
7226
|
user?: User;
|
|
7108
7227
|
}
|
|
7109
7228
|
/**
|
|
7110
|
-
* Models the User Registration Verified Event
|
|
7229
|
+
* Models the User Registration Verified Event.
|
|
7111
7230
|
*
|
|
7112
7231
|
* @author Trevor Smith
|
|
7113
7232
|
*/
|
|
@@ -7191,7 +7310,7 @@ export interface UserUpdateCompleteEvent extends BaseEvent {
|
|
|
7191
7310
|
user?: User;
|
|
7192
7311
|
}
|
|
7193
7312
|
/**
|
|
7194
|
-
* Models the User Update Event
|
|
7313
|
+
* Models the User Update Event.
|
|
7195
7314
|
*
|
|
7196
7315
|
* @author Brian Pontarelli
|
|
7197
7316
|
*/
|
|
@@ -4756,6 +4756,18 @@ var EventType;
|
|
|
4756
4756
|
EventType["AuditLogCreate"] = "audit-log.create";
|
|
4757
4757
|
EventType["EventLogCreate"] = "event-log.create";
|
|
4758
4758
|
EventType["KickstartSuccess"] = "kickstart.success";
|
|
4759
|
+
EventType["GroupCreate"] = "group.create";
|
|
4760
|
+
EventType["GroupCreateComplete"] = "group.create.complete";
|
|
4761
|
+
EventType["GroupDelete"] = "group.delete";
|
|
4762
|
+
EventType["GroupDeleteComplete"] = "group.delete.complete";
|
|
4763
|
+
EventType["GroupMemberAdd"] = "group.member.add";
|
|
4764
|
+
EventType["GroupMemberAddComplete"] = "group.member.add.complete";
|
|
4765
|
+
EventType["GroupMemberRemove"] = "group.member.remove";
|
|
4766
|
+
EventType["GroupMemberRemoveComplete"] = "group.member.remove.complete";
|
|
4767
|
+
EventType["GroupMemberUpdate"] = "group.member.update";
|
|
4768
|
+
EventType["GroupMemberUpdateComplete"] = "group.member.update.complete";
|
|
4769
|
+
EventType["GroupUpdate"] = "group.update";
|
|
4770
|
+
EventType["GroupUpdateComplete"] = "group.update.complete";
|
|
4759
4771
|
EventType["UserAction"] = "user.action";
|
|
4760
4772
|
EventType["UserBulkCreate"] = "user.bulk.create";
|
|
4761
4773
|
EventType["UserCreate"] = "user.create";
|